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.

Sign up for GitHub

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

Jump to bottom

Update x/blob/README.md #1268

Closed
rootulp opened this issue Jan 19, 2023 · 1 comment · Fixed by #1272
Closed

Update x/blob/README.md #1268

rootulp opened this issue Jan 19, 2023 · 1 comment · Fixed by #1272
Assignees
@rootulp
Labels
documentation Improvements or additions to documentation x/blob item is directly relevant to the blob module

Comments

@rootulp
Copy link
Collaborator

rootulp commented Jan 19, 2023 •
edited
Loading

Context

The x/blob module contains docs at x/blob/README.md

Problem

The implementation has changed so some things in the docs are inaccurate.

Proposal

  1. MsgPayForBlob transactions use a dedicated reserved namespace
  2. A MsgPayForBlob can support multiple blobs
  3. There is no more transaction malleation, instead PrepareProposal does index wrapping
  4. Explain the different types of transactions (blob tx vs. index wrapped tx)
  5. [optional] include a diagram of transaction flow from end user to in a block
  6. links to code need to be updated. E.g.

    celestia-app/x/blob/README.md

    Line 23 in 76153bf

    - [`MsgWirePayForBlob`](https://github.com/celestiaorg/celestia-app/blob/8b9c4c9d13fe0ccb6ea936cc26dee3f52b6f6129/proto/blob/tx.proto#L17-L19) is a message that is created and signed by the user but it never ends up on-chain.
@rootulp rootulp added the documentation Improvements or additions to documentation label Jan 19, 2023
@rootulp rootulp self-assigned this Jan 19, 2023
@rootulp rootulp mentioned this issue Jan 19, 2023
Merged
@evan-forbes
Copy link
Member

evan-forbes commented Jan 19, 2023 •
edited
Loading

this can supersede #1113

@evan-forbes evan-forbes added the x/blob item is directly relevant to the blob module label Jan 19, 2023
@rootulp rootulp mentioned this issue Jan 19, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rootulp rootulp

Labels
documentation Improvements or additions to documentation x/blob item is directly relevant to the blob module
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update x/blob/README.md rootulp/celestia-app
2 participants
@rootulp @evan-forbes