docs(blob): add links to inclusion and fraud proofs documentation #4298
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added verification of the initial total supply in TestGetCmdQueryAnnualProvisions. This ensures that the total supply is exactly 500,000,000 utia before calculating annual provisions, which is a critical assumption for the test. Resolves TODO comment in x/mint/client/testutil/suite_test.go
Added links to the Fraud Proofs specification and ADR-011 in the blob module README. This provides readers with detailed information about blob inclusion proofs and fraud proofs implementation. Resolves TODO in x/blob/README.md
VolodymyrBg
requested review from
cmwaters and
rach-id
and removed request for
a team
📝 WalkthroughWalkthroughThis pull request updates documentation and testing components. The README now includes direct references to the "Fraud Proofs specification" and "ADR-011: Optimistic Blob Size Independent Inclusion Proofs and PFB Fraud Proofs" instead of a placeholder. Additionally, the mint test suite has been modified to import the Changes
Sequence Diagram(s)sequenceDiagram
participant TS as Test Suite
participant BC as Bank Query Client
participant BS as Bank Service
TS->>BC: Initialize with Context (s.cctx.Context)
TS->>BC: Invoke TotalSupply(QueryTotalSupplyRequest)
BC->>BS: Forward request for total supply data
BS-->>BC: Respond with total supply value
TS->>TS: Validate returned total supply matches expected (500_000_000 utia)
Possibly related PRs
Suggested labels
Suggested reviewers
Tip 🌐 Web search-backed reviews and chat
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
rootulp
requested changes
Feb 5, 2025
|
In the future, you could split these into two separate PRs because they are unrelated TODOs. |
Co-authored-by: Rootul P <[email protected]>
Co-authored-by: Rootul P <[email protected]>
rootulp
requested changes
Feb 5, 2025
| bankClient := banktypes.NewQueryClient(s.cctx.Context) | ||
| resp, err := bankClient.TotalSupply(context.Background(), &banktypes.QueryTotalSupplyRequest{}) | ||
| s.Require().NoError(err) | ||
| expectedTotalSupply := sdk.NewInt(500_000_000).Mul(sdk.NewInt(1_000_000)) // 500_000_000 utia |
There was a problem hiding this comment.
This test fails for me
--- FAIL: TestMintIntegrationTestSuite (11.20s)
/Users/rootulp/git/rootulp/celestiaorg/celestia-app/x/mint/client/testutil/suite_test.go:35: setting up x/mint integration test suite
--- FAIL: TestMintIntegrationTestSuite/TestGetCmdQueryAnnualProvisions (0.00s)
/Users/rootulp/git/rootulp/celestiaorg/celestia-app/x/mint/client/testutil/suite_test.go:92:
Error Trace: /Users/rootulp/git/rootulp/celestiaorg/celestia-app/x/mint/client/testutil/suite_test.go:92
Error: Not equal:
expected: "500000000000000"
actual : "1000000028176989"
Diff:
--- Expected
+++ Actual
@@ -1 +1 @@
-500000000000000
+1000000028176989
Test: TestMintIntegrationTestSuite/TestGetCmdQueryAnnualProvisions
/Users/rootulp/git/rootulp/celestiaorg/celestia-app/x/mint/client/testutil/network.go:48: tearing down testnode
|
@VolodymyrBg instead of wasting your time on this PR that doesn't have much added value, if any, you can check these issues:
And we will gladly review your PRs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added links to the Fraud Proofs specification and ADR-011 in the blob module README.
This provides readers with detailed information about blob inclusion proofs and
fraud proofs implementation.
Resolves TODO in x/blob/README.md
Also
Added verification of the initial total supply in TestGetCmdQueryAnnualProvisions.
This ensures that the total supply is exactly 500,000,000 utia before calculating
annual provisions, which is a critical assumption for the test.
Resolves TODO comment in x/mint/client/testutil/suite_test.go