Repository navigation
docs(sei-js): add the EVM parity matrix and plan (PLT-837) - #103
alexander-sei wants to merge 1 commit into
Conversation
Scores 24 developer workflows once each for viem, wagmi, and ethers, with links to the pages that cover them. Gaps that sei-js owns are listed apart from Sei network differences, and the plan page sets the scoring rules and the evm-compat report process. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
PR SummaryLow Risk Reviewed by Cursor Bugbot for commit 08b24e7. Bugbot is set up for automated code reviews on this repo. Configure here. |
There was a problem hiding this comment.
This PR adds a well-structured EVM parity matrix and plan for sei-js. I recounted every cell, and the tallies are right: viem 21/24, wagmi 12/23, ethers 21/24, 54/71 = 76%. All internal links and anchors resolve, the network facts match evm-compatibility.mdx and reference.mdx, and the copy follows AGENTS.md terminology. I found no blockers; the notes below cover merge order and upkeep.
Findings: 0 blocking | 6 non-blocking | 2 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- Merge order: the issue-template link (
?template=evm_compatibility.md) and theEVM_COMPAT_SLA.mdlink depend on sei-protocol/sei-js#361. Merge that PR first, or these links will 404 or fall back to a blank issue form. - Upkeep: the score table and the per-section matrices hold the same counts in two places. A short maintainer note (for example an HTML comment) saying to recount the summary table whenever a cell changes would help prevent drift.
- The second-opinion passes produced no output:
codex-review.mdandcursor-review.mdwere both empty, so this review is the only pass. REVIEW_GUIDELINES.mdwas empty, so I reviewed against AGENTS.md conventions only.- 2 suggestion(s)/nit(s) flagged inline on specific lines.
| | --- | --- | --- | | ||
| | Storage proofs (`eth_getProof`) | Network-limited | Not supported since v6.7.0. Every call returns JSON-RPC error `-32000`. [See Proof verification.](/evm/evm-parity/evm-compatibility#proof-verification) | | ||
| | Blob transactions (EIP-4844) | Network-limited | Sei runs Pectra without blob transactions. [See Transaction types.](/evm/evm-parity/transaction-types) | | ||
| | Pending transactions and the pending block | Network-limited | The `pending` block tag returns the latest block. Sei does not support pending-transaction filters or subscriptions. [See Pending state.](/evm/evm-parity/evm-compatibility#pending-state) | |
There was a problem hiding this comment.
[nit] Slightly over-broad: the linked Pending state section says eth_getTransactionCount(address, "pending") does count the sender's mempool transactions. Only eth_getBlockByNumber("pending") returns the latest block. Consider saying "The pending block returns the latest committed block" so readers don't assume pending nonces are unsupported.
| | Pointer contracts | Covered | Planned | Covered | [Pointer contracts](/evm/evm-parity/examples/pointer-contracts) | | ||
| | Address association (`0x` and `sei1` addresses) | Covered | Planned | Covered | [Accounts](/learn/accounts) (viem), [Address precompile](/evm/precompiles/cosmwasm-precompiles/addr) (ethers) | | ||
|
|
||
| The Scaffold Sei `precompiles` extension reads the Bank precompile in a wagmi app, but no page shows a precompile write with wagmi. In sei-js CI, a test compares the exported ABIs with the precompile ABIs in `sei-chain` v6.6.1. |
There was a problem hiding this comment.
[nit] The pinned sei-chain v6.6.1 will go stale as soon as the CI test is bumped. Consider linking to the test or workflow in sei-js instead of hard-coding the version, in line with the AGENTS.md guidance against hard-coding values that change.
What is the purpose of the change?
Adds new content for PLT-837: an EVM parity matrix and plan for sei-js. Both were first written on the
sdk-evm-paritybranch of sei-js and reverted there. This re-lands them in sei-docs, which is now the canonical docs home, and re-scores every row against the current docs and packages.The existing EVM compatibility page compares the Sei network with Ethereum. The new matrix answers a different question: which viem, wagmi, and ethers workflows these docs and
@sei-jsactually cover, and which gaps belong to sei-js rather than to the network.Describe the changes to the documentation
evm/sei-js/evm-parity.mdx(new): scores 24 developer workflows once each for viem, wagmi, and ethers, with links to the pages that cover each one. Gaps that sei-js owns are listed apart from Sei network differences. The current score is 54 of 71 scored cells (76%). Most open gaps are missing wagmi examples. No cell is marked Verified, because no automated check runs these workflows against a Sei node yet.evm/sei-js/evm-parity-plan.mdx(new): the goals (95% of scored cells, noevm-compatissue open longer than 14 days), principles, scoring rules, and how compatibility reports are classified.docs.json: adds both pages to the sei-js Library group.evm/sei-js/index.mdxandevm/evm-parity/evm-compatibility.mdx: a link to the matrix on each page, plus a link to the new issue template under Community and support.Target audience: developers who arrive with viem, wagmi, or ethers and want to know what works on Sei, and sei-js maintainers who keep the matrix current.
Notes
vale(no findings on the new pages),typos,mint broken-links --check-anchorson the changed pages, thedocs.jsonpage and redirect checks, and amint devrender.Made with Cursor