docs: update the blob module specs part 1 #1906

evan-forbes · 2023-06-12T03:03:06Z

Overview

mostly a minor update to the blob module specs, but this PR also adds some validity rules for BlobTxs/PFBs

part of #650

Checklist

New and updated code has appropriate documentation
New and updated code has new and/or updated testing
Required CI checks are passing
Visual proof for any user facing features like CLI or documentation updates
Linked issues closed with keywords

codecov-commenter · 2023-06-12T03:15:59Z

Codecov Report

Merging #1906 (ab80f8d) into main (c8f5c33) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1906   +/-   ##
=======================================
  Coverage   21.25%   21.25%           
=======================================
  Files         121      121           
  Lines       13679    13679           
=======================================
  Hits         2907     2907           
  Misses      10484    10484           
  Partials      288      288

evan-forbes · 2023-06-12T03:24:25Z

the markdown lint will continue to fail until we merge #1905

x/blob/README.md

staheri14

Great PR with great details and information! 👍
I have included my comments below. However, please feel free to address them either in this PR or in subsequent PRs as you deem appropriate.

x/blob/README.md

staheri14 · 2023-06-12T18:45:14Z

x/blob/README.md

    1. `NamespaceId  []byte`: the namespace this blob should be published to.
    1. `Data         []byte`: the data to be published.
-    1. `ShareVersion uint32`: the version of the share format used to encode this blob into a share.
+    1. `ShareVersion uint32`: the version of the share format used to encode
+       this blob into a share.
 1. A single `sdk.Tx` which is composed of:


I think it would be beneficial to mention that the sdk.Tx represents the encoded version of one ~~or multiple~~ MsgPayForBlobs, and then introduce Signer , NamespaceIds, and ShareCommitment as the components of MsgPayForBlobs (basically what is already in the specs after the is composed of:)

added a link to the sdk ADR that discusses the structure of sdk.Tx, but perhaps we can talk about this more elsewhere? I'm quite sure what to do yet.

x/blob/README.md

rootulp

[optional] there's another param in the blob module for GovMaxSquareSize

x/blob/README.md

evan-forbes · 2023-06-15T14:13:06Z

apologies for the delay on incorporating all the great feedback here! I need to debug a few more things in node for the testnet hardfork and then I'll get to this 🙂

x/blob/README.md

Co-authored-by: Sanaz Taheri <[email protected]> Co-authored-by: Rootul P <[email protected]>

….com/celestiaorg/celestia-app into evan/update-blob-module-specs-part-1

…re verison

staheri14

Thanks for addressing the comment, it looks good to me!

x/blob/README.md

staheri14 · 2023-06-19T17:33:11Z

x/blob/README.md

+In order for a proposal block to be considered valid, each `BlobTx`, and thus
+each PFB, to be included in a block must follow a set of validity rules.
+
+1. Signatures: All blob transactions must have valid signatures. This is


[Question for my own understanding] When the term "proposal block" is used in the context of "In order for a proposal block to be considered valid," does it refer to a block proposed during the consensus (and yet to be voted and committed) or one that has received the majority vote (hence committed)? I'm curious about when signatures and nonces are verified – during the voting phase or at the time of block execution (which I think corresponds to the processProposal). If signature verification is required during the voting process, then we would need to track the state changes resulting from proposals (but not committed blocks) in order to do so.

does it refer to a block proposed during the consensus (and yet to be voted and committed) or one that has received the majority vote (hence committed)?

both! we call ProcessProposal on proposals beofore voting, and while consensus nodes sync the chain

signatures, and therefore their nonces, are verified before the block is actually applied to the state in both cases. State can then be tracked rather easily since we already have the state from the previous block, which is all that is needed.

x/blob/README.md

rootulp

Only one blocking comment

x/blob/README.md

rootulp · 2023-06-19T18:52:00Z

x/blob/README.md

+  in this message. See
+  [ADR014](../../docs/architecture/adr-014-versioned-namespaces.md) for more
+  details on how this effects the share encoding and when it is updated.


[optional] ADR-014 doesn't describe share versions, it describe namespace versions.

ADR-007 introduces a share version: https://github.com/celestiaorg/celestia-app/blob/main/docs/architecture/adr-007-universal-share-prefix.md

my bad thanks for catching 920760c

Co-authored-by: Sanaz Taheri <[email protected]> Co-authored-by: Rootul P <[email protected]>

staheri14

🚀

* docs: minor update to the blob module * docs: add validity rules * docs: update event field * docs: Apply suggestions from code review Co-authored-by: Sanaz Taheri <[email protected]> Co-authored-by: Rootul P <[email protected]> * docs: minor update * docs: fill out fields of PFB in new format and link to ADR014 for share verison * docs: elaborate on size consistency * docs: link to reserved namespaces * docs: clarify and add link * docs: share commitments * docs: typo and link to reserved name space * docs: add link to sharesize * docs: add more info for shares commitments * docs: review feedback Co-authored-by: Sanaz Taheri <[email protected]> Co-authored-by: Rootul P <[email protected]> * docs: use adr 007 * docs: add link --------- Co-authored-by: Sanaz Taheri <[email protected]> Co-authored-by: Rootul P <[email protected]>

evan-forbes added 2 commits June 11, 2023 21:31

docs: minor update to the blob module

35a09a8

docs: add validity rules

6a52515

evan-forbes added specs directly relevant to the specs x/blob item is directly relevant to the blob module labels Jun 12, 2023

evan-forbes requested review from adlerjohn and staheri14 June 12, 2023 03:03

evan-forbes requested a review from rootulp as a code owner June 12, 2023 03:03

evan-forbes self-assigned this Jun 12, 2023

evan-forbes requested a review from cmwaters as a code owner June 12, 2023 03:03

MSevey requested a review from a team June 12, 2023 03:03

cmwaters previously approved these changes Jun 12, 2023

View reviewed changes

x/blob/README.md Outdated Show resolved Hide resolved

x/blob/README.md Show resolved Hide resolved

staheri14 previously approved these changes Jun 12, 2023

View reviewed changes

rootulp previously approved these changes Jun 13, 2023

View reviewed changes

x/blob/README.md Show resolved Hide resolved

rootulp reviewed Jun 16, 2023

View reviewed changes

x/blob/README.md Outdated Show resolved Hide resolved

x/blob/README.md Show resolved Hide resolved

x/blob/README.md Outdated Show resolved Hide resolved

evan-forbes added 2 commits June 18, 2023 21:53

docs: update event field

93af086

Merge branch 'main' into evan/update-blob-module-specs-part-1

5735b8c

evan-forbes dismissed stale reviews from rootulp and staheri14 via 5b69d04 June 19, 2023 03:40

docs: Apply suggestions from code review

5b69d04

Co-authored-by: Sanaz Taheri <[email protected]> Co-authored-by: Rootul P <[email protected]>

evan-forbes dismissed cmwaters’s stale review via 5b69d04 June 19, 2023 03:40

MSevey requested a review from a team June 19, 2023 03:40

evan-forbes added 6 commits June 18, 2023 22:41

docs: minor update

10b1e41

Merge branch 'evan/update-blob-module-specs-part-1' of https://github…

ac88274

….com/celestiaorg/celestia-app into evan/update-blob-module-specs-part-1

docs: fill out fields of PFB in new format and link to ADR014 for sha…

3508b36

…re verison

docs: elaborate on size consistency

4338e36

docs: link to reserved namespaces

6be08b4

docs: clarify and add link

60e4cce

evan-forbes added 4 commits June 18, 2023 23:40

docs: share commitments

1e600c1

docs: typo and link to reserved name space

695e892

docs: add link to sharesize

1db4f6e

docs: add more info for shares commitments

145e3ad

evan-forbes requested review from staheri14, rootulp and cmwaters June 19, 2023 05:03

Merge branch 'main' into evan/update-blob-module-specs-part-1

4790fa0

staheri14 previously approved these changes Jun 19, 2023

View reviewed changes

staheri14 reviewed Jun 19, 2023

View reviewed changes

x/blob/README.md Outdated Show resolved Hide resolved

evan-forbes mentioned this pull request Jun 19, 2023

Specify Blob Inclusion Fraud Proofs #1962

Open

rootulp reviewed Jun 19, 2023

View reviewed changes

docs: review feedback

e0f0699

Co-authored-by: Sanaz Taheri <[email protected]> Co-authored-by: Rootul P <[email protected]>

evan-forbes dismissed staheri14’s stale review via e0f0699 June 19, 2023 19:09

MSevey requested a review from a team June 19, 2023 19:10

evan-forbes and others added 3 commits June 19, 2023 14:22

docs: use adr 007

920760c

docs: add link

5cc0296

Merge branch 'main' into evan/update-blob-module-specs-part-1

ab80f8d

evan-forbes enabled auto-merge (squash) June 19, 2023 19:32

evan-forbes requested review from rootulp and staheri14 June 19, 2023 19:32

staheri14 approved these changes Jun 19, 2023

View reviewed changes

rootulp approved these changes Jun 19, 2023

View reviewed changes

evan-forbes merged commit ab71231 into main Jun 19, 2023

evan-forbes deleted the evan/update-blob-module-specs-part-1 branch June 19, 2023 21:22

evan-forbes mentioned this pull request Jun 20, 2023

specs: x/blob module #1067

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update the blob module specs part 1 #1906

docs: update the blob module specs part 1 #1906

evan-forbes commented Jun 12, 2023

codecov-commenter commented Jun 12, 2023 •

edited

Loading

evan-forbes commented Jun 12, 2023

staheri14 left a comment

staheri14 Jun 12, 2023 •

edited

Loading

evan-forbes Jun 19, 2023

rootulp left a comment

evan-forbes commented Jun 15, 2023 •

edited

Loading

staheri14 left a comment

staheri14 Jun 19, 2023

evan-forbes Jun 19, 2023

rootulp left a comment

rootulp Jun 19, 2023

evan-forbes Jun 19, 2023

staheri14 left a comment

docs: update the blob module specs part 1 #1906

docs: update the blob module specs part 1 #1906

Conversation

evan-forbes commented Jun 12, 2023

Overview

Checklist

codecov-commenter commented Jun 12, 2023 • edited Loading

Codecov Report

evan-forbes commented Jun 12, 2023

staheri14 left a comment

Choose a reason for hiding this comment

staheri14 Jun 12, 2023 • edited Loading

Choose a reason for hiding this comment

evan-forbes Jun 19, 2023

Choose a reason for hiding this comment

rootulp left a comment

Choose a reason for hiding this comment

evan-forbes commented Jun 15, 2023 • edited Loading

staheri14 left a comment

Choose a reason for hiding this comment

staheri14 Jun 19, 2023

Choose a reason for hiding this comment

evan-forbes Jun 19, 2023

Choose a reason for hiding this comment

rootulp left a comment

Choose a reason for hiding this comment

rootulp Jun 19, 2023

Choose a reason for hiding this comment

evan-forbes Jun 19, 2023

Choose a reason for hiding this comment

staheri14 left a comment

Choose a reason for hiding this comment

codecov-commenter commented Jun 12, 2023 •

edited

Loading

staheri14 Jun 12, 2023 •

edited

Loading

evan-forbes commented Jun 15, 2023 •

edited

Loading