Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename message => blob where applicable #995

Closed
1 of 3 tasks
Tracked by #650
rootulp opened this issue Nov 10, 2022 · 6 comments
Closed
1 of 3 tasks
Tracked by #650

Rename message => blob where applicable #995

rootulp opened this issue Nov 10, 2022 · 6 comments
Labels
ADR item is directly relevant to writing or modifying an ADR chore optional label for items that follow the `chore` conventional commit documentation Improvements or additions to documentation specs directly relevant to the specs

Comments

@rootulp
Copy link
Collaborator

rootulp commented Nov 10, 2022

Context

#978 (comment)

Problem

The codebase currently uses the previous term message in a number of locations where blob is more accurate after #978 merged.

Proposal

On a case by base basis, rename message, msg, or data => blob. Note: Cosmos SDK messages should still be called messages. We should only rename instances that refer to the data a user submits to be published to the Celestia blockchain.

@rootulp rootulp added good first issue Good for newcomers chore optional label for items that follow the `chore` conventional commit labels Nov 10, 2022
@evan-forbes evan-forbes added this to the Q4 2022 milestone Nov 15, 2022
@rootulp
Copy link
Collaborator Author

rootulp commented Nov 15, 2022

Also instances of data may need to be renamed to blob. Ex:

// - the commitment in each PFB should match that of its corresponding data
// - there should be no unpaid-for data

rootulp added a commit that referenced this issue Nov 17, 2022
Closes #1022

Does not rename all instances of `message` to `blob` see
#995
rach-id pushed a commit to rach-id/celestia-app that referenced this issue Nov 17, 2022
Closes celestiaorg#1022

Does not rename all instances of `message` to `blob` see
celestiaorg#995
@rootulp
Copy link
Collaborator Author

rootulp commented Nov 18, 2022

Will do this soon because it's leaking into other unrelated PRs. Unfortunately it may cause merge conflicts will several in-progress open PRs but the merge conflicts should be easy to resolve

@rootulp
Copy link
Collaborator Author

rootulp commented Nov 23, 2022

ADRs contain code blocks which are helpful at the time of reviewing the ADR but the code blocks have become stale so renaming portions of it to resolve this issue seems futile. We can either:

  1. remove all the code blocks that have diverged from their real implementations in main
  2. update all the code blocks

@evan-forbes
Copy link
Member

could we also just leave them the way they are? They might not be that useful for outside contributor or as live documentation, but they are still useful for us to remember the thinking around past decisions.

@rootulp
Copy link
Collaborator Author

rootulp commented Nov 23, 2022

Sure, will leave ADRs as-is for now.

evan-forbes pushed a commit that referenced this issue Nov 29, 2022
#995

Renames the following on a case by case basis:
- `Message` => `Blob`
- `message`, `msg`, `data` => `blob`

Does not address:
- ADRs
- specs

It's likely that I didn't catch every instance due to human error
@rootulp rootulp added specs directly relevant to the specs ADR item is directly relevant to writing or modifying an ADR labels Nov 30, 2022
@evan-forbes evan-forbes removed this from the Q4 2022 milestone Dec 8, 2022
@rootulp rootulp removed the good first issue Good for newcomers label Feb 8, 2023
@rootulp rootulp added the documentation Improvements or additions to documentation label Mar 23, 2023
@rootulp
Copy link
Collaborator Author

rootulp commented Mar 23, 2023

Spun out two new issues so closing this

@rootulp rootulp closed this as not planned Won't fix, can't repro, duplicate, stale Mar 23, 2023
cmwaters pushed a commit to celestiaorg/go-square that referenced this issue Dec 14, 2023
cmwaters pushed a commit to celestiaorg/go-square that referenced this issue Dec 14, 2023
celestiaorg/celestia-app#995

Renames the following on a case by case basis:
- `Message` => `Blob`
- `message`, `msg`, `data` => `blob`

Does not address:
- ADRs
- specs

It's likely that I didn't catch every instance due to human error
0xchainlover pushed a commit to celestia-org/celestia-app that referenced this issue Aug 1, 2024
0xchainlover pushed a commit to celestia-org/celestia-app that referenced this issue Aug 1, 2024
celestiaorg/celestia-app#995

Renames the following on a case by case basis:
- `Message` => `Blob`
- `message`, `msg`, `data` => `blob`

Does not address:
- ADRs
- specs

It's likely that I didn't catch every instance due to human error
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADR item is directly relevant to writing or modifying an ADR chore optional label for items that follow the `chore` conventional commit documentation Improvements or additions to documentation specs directly relevant to the specs
Projects
None yet
Development

No branches or pull requests

2 participants