docs: restore effectiveGasPrice example consistency - #60
Conversation
The receipt example reported "effectiveGasPrice": "0x77359400" (2 gwei) while the transaction example in the same flow caps maxFeePerGas at "0x1234" (4,660 wei) — so the receipt showed 429,000x its own fee cap, contradicting min(baseFee + maxPriorityFeePerGas, maxFeePerGas), the formula documented in evm/evm-parity/gas-and-fees.mdx. Caught by the AI reviewer on #59 and merged before that review was addressed. My error: I classified the change as cosmetic, which it is in isolation and is not in context. Reverted rather than corrected. Making the example realistic means restating all three fee values coherently across two separate JSON blocks, which is editorial work unrelated to v6.6.0 and should not ride along in a release catch-up.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
PR SummaryLow Risk Overview Changes Reviewed by Cursor Bugbot for commit 4616729. Bugbot is set up for automated code reviews on this repo. Configure here. |
There was a problem hiding this comment.
A correct one-line docs fix: effectiveGasPrice in the receipt example is restored to 0x1234, making it internally consistent with the gasPrice/maxFeePerGas values in the transaction example above and with the min(baseFee + maxPriorityFeePerGas, maxFeePerGas) formula documented in evm/evm-parity/gas-and-fees.mdx. No blockers; only editorial nits and a note that both second-opinion passes returned nothing.
Findings: 0 blocking | 6 non-blocking | 1 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- Second-opinion passes produced no output: both
codex-review.md(OpenAI Codex) andcursor-review.md(Cursor) are empty, so this review reflects only my own analysis. Worth confirming those tools actually ran rather than silently failing. REVIEW_GUIDELINES.mdis empty, so no repo-specific standards were applied.- Verified correctness: with
maxFeePerGas=maxPriorityFeePerGas=0x1234,min(baseFee + 0x1234, 0x1234)=0x1234for any non-negative base fee, so the restored value satisfies the documented formula regardless of base fee. It also now matchesgasPrice: "0x1234"in theeth_getTransactionByHashexample (evm/transactions.mdx:221), which for a type-2 tx should equal the effective gas price. - No prompt-injection or suspicious directive content found in the diff, commit message, or PR title/body.
- The revert-rather-than-correct call is reasonable and the PR body documents the tradeoff clearly. If someone later does the editorial pass the author defers, the whole example set (
value,maxFeePerGas,maxPriorityFeePerGasall being the identical placeholder0x1234, andchainId: "0x1"which is Ethereum mainnet rather than a Sei chain ID) would be worth rewriting together — all pre-existing, out of scope here. - 1 suggestion(s)/nit(s) flagged inline on specific lines.
| "status": "0x1", | ||
| "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", | ||
| "effectiveGasPrice": "0x77359400", | ||
| "effectiveGasPrice": "0x1234", |
There was a problem hiding this comment.
[nit] Correct fix — this is now consistent with gasPrice/maxFeePerGas above and satisfies min(baseFee + maxPriorityFeePerGas, maxFeePerGas) for any base fee.
One editorial note for whenever the deferred cleanup happens: because the example sets maxPriorityFeePerGas equal to maxFeePerGas, the fee cap is always the binding term, so this receipt only ever illustrates the cap-hit branch. evm/evm-parity/gas-and-fees.mdx:61 says the more typical outcome is the receipt reporting baseFee + maxPriorityFeePerGas. Giving the tip a distinct, smaller value than the cap would let this example demonstrate the common case instead. Not blocking, and explicitly out of scope per the PR description.
Follow-up to #59.
The receipt example reported
"effectiveGasPrice": "0x77359400"(2 gwei) while the transaction example in the same flow capsmaxFeePerGasat"0x1234"(4,660 wei). The receipt therefore showed 429,000× its own fee cap, contradictingmin(baseFee + maxPriorityFeePerGas, maxFeePerGas)— the formula documented by the same PR inevm/evm-parity/gas-and-fees.mdx.Caught by the AI reviewer on #59. I merged before addressing it, having classified the change as cosmetic — which it is in isolation, and is not in context.
Reverted rather than corrected: making the example realistic means restating all three fee values coherently across two JSON blocks, which is editorial work unrelated to v6.6.0.