docs: fix proof_getTransactionReceipt description#343
Open
peter941221 wants to merge 2 commits into
Open
Conversation
This file contains hidden or 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
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.
Fixes #339
This PR aligns the
proofnamespace docs with the current RPC contract insrc/Nethermind/Nethermind.JsonRpc/Modules/Proof/IProofRpcModule.cs.Failure mechanism:
proof_getTransactionReceiptwas documented as if it behaved likeeth_calland returned account/storage proofs.proof_getTransactionByHashwas also misdescribed as returning the result ofeth_getTransactionReceipt.blockHeaderas unconditional even though it is gated byincludeHeader.Semantic change:
proof_getTransactionByHashnow matches the implemented behavior:eth_getTransactionByHashdata plus a transaction inclusion proof againsttransactionsRoot, with optional RLP block header.proof_getTransactionReceiptnow matches the implemented behavior:eth_getTransactionReceiptdata plus transaction and receipt inclusion proofs againsttransactionsRootandreceiptsRoot, with optional RLP block header.blockHeaderis now documented as optional in both response sections.Preserved invariant:
Testing:
npm run build