Repository navigation
docs: Cookbook tab with six recipes, plus event and Foundry fixes - #91
Conversation
Add a Cookbook tab that groups the twelve existing example pages with six new recipes: read a balance, send SEI, deploy an ERC-20, listen to events, sponsor gas with Pimlico, and read a price feed. The recipes show viem, ethers, and web3.py in code groups with matching labels, so the reader's library choice applies to every block on the page. The example pages keep their URLs. The one-page Cosmos-SDK tab moves into Learn next to the SIP-03 guides, and /cookbook and /evm/evm-parity/examples redirect to the new overview. The price-feed recipe reads the API3 SEI/USD push feed, because the Oracle precompile is retired and the pull oracles need a signed update per call. Co-authored-by: Cursor <cursoragent@cursor.com>
On the public endpoints, filter-based watchers over HTTP miss or repeat events, and eth_uninstallFilter returns 403 on Sei Mainnet, which crashes ethers when a listener stops. eth_getLogs also rejects ranges longer than 2,000 blocks, so the ERC-20 history query from block 0 always failed. Watch over the WebSocket endpoint in the ERC-20, ERC-721, ERC-1155, and ethers quickstart examples, and query the latest 2,000 blocks for history. The ethers listener also declares the Transfer event that it listens for. Co-authored-by: Cursor <cursoragent@cursor.com>
Current Foundry releases only simulate forge create unless --broadcast is set, so the documented commands deployed nothing. Add the flag before --constructor-args, which takes every value after it, and pass plain constructor values: forge create rejects ABI-encoded arguments. 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 Overview Corrects copy-paste examples that failed on Sei’s public RPCs: live event watching uses WebSocket (with cleanup notes), historical logs are capped to 2,000 blocks, Oracle and wallet guides: Pyth docs reflect the 2026 Core upgrade (API key, Hermes URL, mainnet contract address); Pimlico samples append generated keys instead of overwriting Reviewed by Cursor Bugbot for commit d972568. Bugbot is set up for automated code reviews on this repo. Configure here. |
![seidroid[bot]](https://avatars.githubusercontent.com/in/2745135?s=60&v=4){kind=small}
There was a problem hiding this comment.
This PR adds a well-structured Cookbook tab with six recipes. It also fixes real problems in the existing pages: event watching now uses WebSocket, eth_getLogs queries now stay within the 2,000-block limit, and the forge create examples now pass --broadcast. Redirects and navigation look correct, and nothing blocks the merge. The main open issue is that the TypeScript run instructions use top-level await, which fails when tsx treats the scripts as CommonJS.
Findings: 0 blocking | 7 non-blocking | 3 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- REVIEW_GUIDELINES.md is empty, so this review applies only the AGENTS.md conventions.
- The Cursor second-opinion pass produced no output (cursor-review.md is empty).
- The other example pages under evm/evm-parity/examples/ could also use the 'You are done when you see' blocks and the synced viem/ethers/web3.py tab labels. Without them, the Cookbook tab mixes two page styles.
- After merge, run the 'Regenerate llms.txt' workflow, as the PR description notes. The new Cookbook section in generate-llms.mjs sits before 'EVM Development', so it matches pages correctly.
- 3 suggestion(s)/nit(s) flagged inline on specific lines.
Put back the contractions that were spelled out before the PR was opened to match the ASD-STE100 pass. The recipes keep the wording they were written and tested with. Co-authored-by: Cursor <cursoragent@cursor.com>
In a new npm project, tsx compiles a plain .ts file as CommonJS, so the recipe and quickstart examples fail with "Top-level await is currently not supported with the "cjs" output format". Tell readers to save TypeScript examples as .mts files, add the missing install step to the ERC-20 read-back, and note the convention in STYLE_GUIDE.md and the llms.txt config. Co-authored-by: Cursor <cursoragent@cursor.com>
Foundry resolves @openzeppelin/contracts on its own, but editors and other Solidity tools read the mapping from remappings.txt. The Foundry guide already has the same step. Co-authored-by: Cursor <cursoragent@cursor.com>
…g it The guide has you store PIMLICO_API_KEY in .env, and then the script wrote the generated PRIVATE_KEY over the whole file, so the API key was gone after the first run. Append the key instead, and drop a top-level return from the sending snippet. Co-authored-by: Cursor <cursoragent@cursor.com>
…ontract Since Pyth's Core upgrade on August 26, 2026, Hermes rejects requests without an API key, and Pyth lists 0x16392B49EA47D4A21bb17F69aA9E7aD570284838 as the Sei Mainnet contract. Send the key as a bearer token to Pyth's recommended Hermes base URL, list the mainnet and testnet addresses separately, replace the Pythnet description, and note that the update fee is currently zero on both networks. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
This PR adds a solid Cookbook tab with six recipes. It also fixes real problems in existing pages: event watchers now use WebSocket, log queries stay within the 2,000-block cap, Foundry commands pass --broadcast, the Pimlico script no longer overwrites .env, and the Pyth guide reflects the Core upgrade. Redirects, nav, link targets, and terminology all check out; only minor robustness and wording nits remain.
Findings: 0 blocking | 8 non-blocking | 4 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- REVIEW_GUIDELINES.md is empty, so this review applies AGENTS.md conventions only. The Cursor second-opinion pass produced no output. Codex reported no material issues.
- Several statements describe current network state and will go stale: the Pyth Mainnet contract has no SEI/USD price yet, the Pyth update fee is currently zero, and the API3 testnet feed was months old when tested. AGENTS.md prefers linking to live sources over hard-coding state that changes. Consider wording these so they age gracefully, or link to the authoritative page.
- In the ERC-20, ERC-721, and ERC-1155 example pages, the new ethers watchers open a
WebSocketProvider, butoff()never callswsProvider.destroy(). A copied script therefore keeps running after it stops listening. Consider addingawait wsProvider.destroy()to the stop example. - Follow-up already noted in the PR: bring the older example pages in line with the recipe conventions ("You are done when you see" blocks and web3.py tabs).
- 4 suggestion(s)/nit(s) flagged inline on specific lines.
off() removes the listener, but the WebSocket stays open, so a copied script keeps running after it stops listening. The stop examples now destroy the provider too, and the ERC-1155 example gets a stop example. Co-authored-by: Cursor <cursoragent@cursor.com>
web3.py rejects addresses that aren't checksummed, so pasting a lowercase address from a CLI raised InvalidAddress. Wrap the address placeholders in Web3.to_checksum_address. Co-authored-by: Cursor <cursoragent@cursor.com>
Describe network state in a way that doesn't go stale: the API3 testnet warning, the note about the new Pyth Mainnet contract, and the Pyth update fee. The Pyth fetch example now stops with a clear error when PYTH_API_KEY isn't set, instead of sending "Bearer undefined". Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
This PR adds a well-organized Cookbook tab with six recipes. It also fixes real problems in existing pages: forge create without --broadcast, unbounded eth_getLogs queries, HTTP filter watchers, the .env overwrite in the Pimlico guide, and the Pyth Core changes. I found no blockers. The main remaining issue is that the ethers watcher snippets tear down their listeners right after registering them.
Findings: 0 blocking | 7 non-blocking | 2 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The Cursor review pass produced no output (
cursor-review.mdwas empty).REVIEW_GUIDELINES.mdwas also empty, so this review follows AGENTS.md conventions only. - The ethers watcher snippets in
erc20.mdx,erc721.mdxandethers-quickstart.mdxshow the same thing as theerc1155.mdxinline comment: they register a listener, then immediatelyawait off()anddestroy()the provider. The old snippets also calledoffright away, but now the WebSocket provider is destroyed too. A reader who copies a snippet as-is gets a watcher that never fires. The cookbook recipe shows the better pattern: put the cleanup in a comment or a shutdown handler (for example,process.on('SIGINT', ...)). - I couldn't verify the Pyth changes, the new Hermes base URL (
pyth.dourolabs.app/hermes) and the new Sei Mainnet address0x16392B49…, from inside the repo. The PR says the end-to-end flow wasn't tested with a real key. Have someone confirm both against Pyth's contract-addresses page before merging, because a wrong oracle address in docs is costly. - The Pyth
<Warning>("Pyth upgraded Pyth Core on August 26, 2026...") is point-in-time wording. Consider removing or softening it once the upgrade is no longer recent. - After merge, remember to trigger the "Regenerate llms.txt" workflow so
llms.txtandllms-full.txtpick up the new Cookbook section. I couldn't runscripts/check-redirects.mjsin this environment, so rely on the CI result for the two new redirects. - 2 suggestion(s)/nit(s) flagged inline on specific lines.
The watcher snippets stopped right after they started, so a copied snippet never received an event, and destroying an ethers provider before it connected threw an error. Show the stop calls as a comment instead, as the listen-to-events recipe does. The WebSocket page had the same pattern. Co-authored-by: Cursor <cursoragent@cursor.com>
The note said to add constructor arguments after the contract path, but the example now has --broadcast in between. Say to put --constructor-args last instead, as the Foundry guide does. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
This is a well-scoped, carefully tested docs PR. It adds a Cookbook tab with six recipes and fixes real problems in existing pages: forge create --broadcast, WebSocket event watchers, bounded eth_getLogs ranges, and the Pimlico .env overwrite. I found no blocking issues, only a few small polish nits.
Findings: 0 blocking | 7 non-blocking | 2 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The Cursor second-opinion file (
cursor-review.md) was empty, so that pass produced no output. The Codex pass reported no material issues, and I agree that nothing here blocks the merge. - I couldn't run
node scripts/check-redirects.mjsin this environment. I checked by hand instead. Both new redirects (/cookbookand/evm/evm-parity/examples) point toevm/cookbook/index.mdx, which exists. Neither source collides with an existing redirect or page, since there's noevm/evm-parity/examples/index.mdx. CI should confirm this. - After merge, remember to run the "Regenerate llms.txt" workflow, as the PR notes say. The new
Cookbookmatcher inscripts/generate-llms.mjscomes beforeEVM Development, so the/evm/evm-parity/examples/*pages move into the new section. That looks intentional. - The ERC-20/721/1155 pages add a second
import { webSocket } from 'viem';in the middle of the page. That's fine for a snippet, but addingwebSocketto the page's top-level viem import would make a copy-pasted script cleaner. - Optional follow-up, already noted by the author: bring the older
evm-parity/examplespages in line with the recipe conventions ("You are done when you see" blocks and web3.py tabs) so the Cookbook tab reads consistently. - 2 suggestion(s)/nit(s) flagged inline on specific lines.
The watcher snippets imported webSocket a second time in the middle of the page. Add it to the setup block's viem import instead, so a copied script has one import line. Co-authored-by: Cursor <cursoragent@cursor.com>
… testnet address The ERC-20 recipe's Remix payload used a plain import, while the page shows a named import. Re-encode the exact source from the page. The Pyth guide now links the Sei Testnet address to Seiscan, like the mainnet one. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
This is a well-tested docs PR. It adds a Cookbook tab with six recipes and fixes real problems in the existing examples: HTTP-polled watchers, unbounded eth_getLogs ranges, a missing forge create --broadcast, the Pimlico script overwriting .env, and the changes from Pyth's Core upgrade. I found no blockers, only a few small consistency notes.
Findings: 0 blocking | 8 non-blocking | 2 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The Cursor second-opinion review (
cursor-review.md) was empty, so that pass produced no output. Codex reported no material issues. REVIEW_GUIDELINES.mdwas empty, so this review applied only the rules in AGENTS.md.- I couldn't run
node scripts/check-redirects.mjsin this environment because the command needed approval. CI should confirm that the new/cookbookand/evm/evm-parity/examplesredirects resolve toevm/cookbook/index. - I checked that the ERC-20, ERC-721, and ERC-1155 ABIs already declare the events their new WebSocket watchers subscribe to, and that
websocket.mdxuses aWebSocketProvider. Thedestroy()cleanup comments are correct. - The Pyth changes depend on external facts I can't verify here: the August 26, 2026 Core upgrade, the
pyth.dourolabs.app/hermesbase URL, and the new mainnet address0x16392B49…. The PR says the flow wasn't verified end to end with a real key. Have someone with a Pyth API key confirm before merge. - After merge, remember to trigger the 'Regenerate llms.txt' workflow, as the PR notes, so the new Cookbook section appears in
llms.txtandllms-full.txt. - 2 suggestion(s)/nit(s) flagged inline on specific lines.
Comments that couldn't be anchored to the diff
evm/evm-foundry.mdx:1410-- [nit] Good fix moving to plain constructor values.YOUR_ADDRESSis unquoted here, while the NFT line below quotes the URL. That's fine for an address, but readers sometimes paste values that contain spaces. Consider quoting placeholders the same way.
| // To stop: await usdc.removeAllListeners(); await provider.destroy(); | ||
| ``` | ||
|
|
||
| ```python web3.py |
There was a problem hiding this comment.
[nit] This page uses await usdc.on(...), but the updated ERC-20, ERC-721, and ERC-1155 pages call wsContract.on(...) without await. Both work, but awaiting on() surfaces subscription errors. Consider using the same form on every page.
|
|
||
| ```text | ||
| 1384.115892177302953913 SEI | ||
| ``` |
There was a problem hiding this comment.
[nit] The sample output shows a balance of about 1384 SEI, but the snippet reads the zero address. The text already calls the number illustrative. A neutral placeholder value, or a note to swap in your own address first, would make that clearer. The ERC-20 section below already does this.
Apply the ASD-STE100 rules from the language pass in #90 to the prose that this PR adds or changes. This undoes 7baa037, which put the contractions back. - Spell out contractions. - Give one instruction per sentence, and put the condition or purpose first. - Use the active voice, for example "tsx compiles a plain .ts file as CommonJS". - Replace figurative words ("lives in", "split the work", "go live") and -ing phrases. - Start the Pyth warning with the commands, then give the reason. Only prose changes. Code blocks, link targets, and heading anchors are unchanged. Three recipe descriptions in the frontmatter are shorter or no longer end in "using". Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
This PR adds a Cookbook tab with six recipes. It also fixes examples that were broken: event watching now uses WebSocket, log queries are bounded, forge create passes --broadcast, the Pimlico guide no longer overwrites .env, and the Pyth guide reflects Pyth's August 2026 upgrade. The navigation, redirects and code samples look correct. I found nothing blocking, only a couple of small notes.
Findings: 0 blocking | 6 non-blocking | 1 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The Cursor review file (
cursor-review.md) was empty, so that pass produced no output. Codex reported no material issues.REVIEW_GUIDELINES.mdwas also empty, so I used the AGENTS.md conventions instead. - I checked the redirects. The new ones (
/cookbookand/evm/evm-parity/examples→/evm/cookbook) point toevm/cookbook/index.mdx, which this PR adds. The old example pages keep their URLs, so they need no redirects. - Because the Cosmos-SDK tab is gone,
cosmos-sdk/indexnow appears only in the Learn group. The many existing redirects to/cosmos-sdkstill resolve. Please confirm the deprecation notice on that page still shows as intended in the new location (AGENTS.md requires it to stay visible). - Several recipes show hard-coded example output: block numbers, transaction hashes, the SEI/USD price, and the count of 319 transfers. Most are already labelled as illustrative. Consider marking all of them that way so readers don't treat the numbers as real network data.
- Follow-up, as the author already noted: bring the older
evm-parity/examplespages in line with the recipe conventions (web3.py tabs and "You are done when you see" blocks). After merge, run the llms.txt regeneration workflow. - 1 suggestion(s)/nit(s) flagged inline on specific lines.
Comments that couldn't be anchored to the diff
evm/oracles/pyth-network.mdx:1813-- [nit] This warning says the guide was updated for the Pyth Core upgrade on August 26, 2026, which is a point-in-time statement. Elsewhere this PR deliberately removes point-in-time wording. Consider rewording to describe the current requirements (Hermes needs an API key, and these are the current addresses) and keep the upgrade-guide link for background. That way the warning won't go stale.
| match: (p) => p.startsWith('/evm/cookbook') || p.startsWith('/evm/evm-parity/examples/'), | ||
| overview: [ | ||
| 'The Cookbook has task-focused recipes with runnable code, most of them in viem, ethers, and web3.py. The recipes read balances, send SEI, deploy and use ERC-20, ERC-721, and ERC-1155 tokens, listen to events, batch reads with Multicall3, sponsor gas with an ERC-4337 paymaster, and read the API3 SEI/USD price feed.', | ||
| 'The recipes rely on this public endpoint behavior. Watch live events over WebSocket (wss://evm-ws.sei-apis.com, wss://evm-ws-testnet.sei-apis.com), because HTTP polling watchers can miss or repeat events. The WebSocket endpoints do not serve eth_getLogs or filters. Fetch past events over HTTP with eth_getLogs, which covers at most 2,000 blocks per request.', |
There was a problem hiding this comment.
[nit] This overview says the WebSocket endpoints don't serve eth_getLogs or filters. The PR description only shows that eth_getLogs isn't served over WebSocket; the filter problem it describes is HTTP eth_uninstallFilter returning 403. Unless you've confirmed that WebSocket filter methods are also unavailable, drop "or filters" so the llms.txt text doesn't state something unverified.
Remove evm/videos.mdx, its nav group in the EVM tab, and the five Info callouts that link to it. Redirect /evm/videos to /evm, so old links still resolve. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
This is a well-tested docs PR. It adds a Cookbook tab with six recipes and fixes real bugs in existing examples: forge create without --broadcast, HTTP polling watchers, unbounded eth_getLogs, the .env overwrite in the Pimlico guide, and the Pyth Core upgrade. Nothing blocks the merge. The main gap is that the PR also deletes the Video Tutorials page, and the description never mentions it.
Findings: 0 blocking | 9 non-blocking | 3 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The PR deletes
evm/videos.mdxand its sidebar group, plus the 'Watch the video walkthrough' callouts in five pages, and redirects/evm/videosto/evm. The description says nothing about this. Either say in the description why the videos were removed, or split the removal into its own PR so maintainers can decide on it separately. Removing published content is out of scope for 'Cookbook + event/Foundry fixes'. - Moving the Cosmos-SDK page into Learn (Cosmos-SDK tab removed) keeps the deprecation notice and the URL, so it meets AGENTS.md. Like the videos change, it is a navigation change beyond the Cookbook scope. It is already called out in the description, so this is just a note.
- Several facts are now hard-coded in many places: the 2,000-block
eth_getLogscap, the fact that the public WebSocket endpoints don't serveeth_getLogs, and the 24-hour API3 heartbeat. They appear in the recipes, four example pages, STYLE_GUIDE.md, and the llms.txt config. If the RPC limits change, all of these copies go stale together. Consider stating each limit once (for example in the RPC reference) and linking to it. - The same paragraph ('The TypeScript examples use top-level
await. Save each one as a.mtsfile…') is copied into five recipes and two quickstarts. A shared snippet would keep the copies consistent. - I checked these claims against the repo: 'Sei does not burn the base fee' matches
gas-and-fees.mdx. ThegetLatestSeiPrice()60-second revert note matchesgetPriceNoOlderThan(..., 60)in the Pyth contract. No links to/evm/videosremain apart from the new redirect. - Second-opinion passes:
codex-review.mdandcursor-review.mdwere both empty, so neither Codex nor Cursor produced any output.REVIEW_GUIDELINES.mdwas also empty, so I used AGENTS.md conventions only. - 3 suggestion(s)/nit(s) flagged inline on specific lines.
| --- | ||
| Pyth Network is a first-party oracle that delivers high-fidelity, low-latency financial market data on-chain. Unlike traditional push-based oracles, Pyth uses a "pull" model: applications get signed price updates on demand. This significantly reduces gas costs and still keeps the data fresh. Pyth has more than 400 price feeds across cryptocurrencies, equities, FX, and commodities. It aggregates data directly from more than 120 institutional data publishers, including major exchanges and trading firms. | ||
|
|
||
| <Warning>Send a Pyth API key with every request to Hermes. On Sei Mainnet, use the new Pyth contract address. Pyth made both changes in its Pyth Core upgrade on August 26, 2026. This guide includes them. For background, see Pyth's [upgrade guide](https://docs.pyth.network/price-feeds/core/upgrade/preparing).</Warning> |
There was a problem hiding this comment.
[nit] "use the new Pyth contract address" will date badly. The address is only "new" relative to August 2026. Since the page already lists both addresses below, consider: "On Sei Mainnet, use the Pyth contract address listed in Step 1."
| "permanent": true | ||
| }, | ||
| { | ||
| "source": "/evm/videos", |
There was a problem hiding this comment.
[suggestion] This redirect exists because evm/videos.mdx is deleted, but the PR description doesn't mention the deletion. Please document why the videos were removed, or move this change to a separate PR.
| async def main(): | ||
| async with AsyncWeb3(WebSocketProvider("wss://evm-ws.sei-apis.com")) as w3: | ||
| transfer = w3.eth.contract(address=USDC, abi=TRANSFER_ABI).events.Transfer() | ||
|
|
There was a problem hiding this comment.
[nit] Here USDC goes straight into w3.eth.contract(address=...). The other web3.py recipes wrap addresses in Web3.to_checksum_address. This literal is already checksummed, so it works, but wrapping it would match the convention set in commit 1c6e52a and keep copy-pasted variants safe.
Remove learn/sip-03-exchange-migration.mdx, its Learn nav entry, and the card on the SIPs page that links to it. Redirect the old URL to the SIP-03 migration guide. That guide's frontmatter no longer promises exchange guidance, and the style guide now names one SIP-03 guide. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
The Cookbook tab, recipes, and the fixes for WebSocket watchers, Foundry --broadcast, Pyth, and Pimlico are well built and follow the repo conventions. One concern: the last two commits delete the SIP-03 exchange migration guide and the Videos page, and the PR description doesn't mention either deletion.
Findings: 0 blocking | 7 non-blocking | 2 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The last two commits ('remove the Videos page' and 'remove the SIP-03 exchange migration guide') have nothing to do with the Cookbook, and the PR description doesn't mention them. Explain why they are removed, or move them to a separate PR so they get their own review.
- Codex (P2, agreed):
learn/sip-03-exchange-migration.mdxis deleted and redirected to/learn/sip-03-migration. That page has none of the exchange or custodian guidance: the four migration options,FundsForwarder, or the address-association steps for exchanges. The 'exchange migration' and 'FundsForwarder' keywords are also dropped from its frontmatter. The deprecation date in the deleted page (June 15, 2026) has passed, so the content may be obsolete. If so, say that in the PR. If not, move the relevant exchange guidance into the user guide. - The committed
llms.txtandllms-full.txtstill mention/evm/videosand/learn/sip-03-exchange-migration. As the PR notes, run the 'Regenerate llms.txt' workflow after merge. REVIEW_GUIDELINES.mdis empty, so no repo-specific review guidelines were applied.- The Cursor review file is empty, so that pass produced no output.
- 2 suggestion(s)/nit(s) flagged inline on specific lines.
| "permanent": true | ||
| }, | ||
| { | ||
| "source": "/learn/sip-03-exchange-migration", |
There was a problem hiding this comment.
[suggestion] This redirect sends exchanges and custodians to the user-facing SIP-03 guide, which has none of the deleted page's exchange content (migration options, FundsForwarder, address association for exchanges). Either keep or migrate that guidance, or confirm in the PR that it is obsolete now that the deprecation date has passed. The PR description doesn't mention this removal. (Raised by Codex too.)
| "permanent": true | ||
| }, | ||
| { | ||
| "source": "/evm/videos", |
There was a problem hiding this comment.
[nit] The Videos page removal and its redirect to /evm aren't mentioned in the PR description. It's also unrelated to the Cookbook, so consider a separate PR or a line in the description explaining why the videos are dropped.
The deprecated Cosmos SDK page sat in Learn > Getting Started, the first group that new readers see. List it in the Governance group after the SIPs page instead, next to the SIP-3 overview. The page, its deprecation notice, and the redirects to /cosmos-sdk are unchanged. Co-authored-by: Cursor <cursoragent@cursor.com>
The Hardhat guide and the ERC-20 recipe name the networks seitestnet and seimainnet, but the verify page used sei_testnet and sei_mainnet. A reader who followed the guide and then ran the verify commands got an unknown-network error. Use the guide's names on the verify page. Co-authored-by: Cursor <cursoragent@cursor.com>
The sample outputs showed a SEI/USD price and a zero-address balance that read like real network data. Show <price>, <age>, and <balance> placeholders, and say what each one is. Co-authored-by: Cursor <cursoragent@cursor.com>
The deploy-and-verify example, both migration guides, and the Addr precompile page named the Hardhat networks sei, seiTestnet, or seiMainnet. Use the names from the Hardhat guide, so that one config works with the commands on every page. The LayerZero guide keeps sei-mainnet, because its config names every chain in that style, such as optimism-mainnet. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
This PR adds a well-built Cookbook tab with six recipes. It also fixes real bugs in existing examples: the missing forge create --broadcast, HTTP-polling event watchers, unbounded eth_getLogs queries, the Pimlico guide overwriting .env, and the Pyth guide's API key and mainnet address. The code and redirects look correct; my only concern is that two page deletions aren't mentioned in the PR description.
Findings: 0 blocking | 6 non-blocking | 1 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- Undocumented scope: commits 7cb4e67 (remove
evm/videos.mdx) and b142861 (removelearn/sip-03-exchange-migration.mdx) are not in the PR description's commit table or prose. Deleting the exchange/custodian SIP-03 guide is a content decision with external impact, because exchanges may link to it. A maintainer should approve it explicitly. Please add both deletions to the description. The redirects to/evmand/learn/sip-03-migrationare present. - The
/learn/sip-03-exchange-migration→/learn/sip-03-migrationredirect sends exchange readers to a page whose description and keywords this PR strips of exchange guidance (FundsForwarder, the exchange migration options). Confirm that the remaining page still covers what exchanges need, or that this content is intentionally retired. llms.txtandllms-full.txtstill list/evm/videosand/learn/sip-03-exchange-migrationuntil the scheduled regeneration runs. As the PR notes, trigger the "Regenerate llms.txt" workflow after merge. Per AGENTS.md, do not hand-edit these files.- The Pyth guide changes the Sei Mainnet contract address and the Hermes base URL based on Pyth's upgrade. The author could not verify this end to end without a real API key, so a maintainer with a Pyth key should spot-check the flow before or soon after merge.
- Second-opinion passes: Codex reported no material issues. The Cursor review file was empty, so that pass produced no output.
- 1 suggestion(s)/nit(s) flagged inline on specific lines.
Comments that couldn't be anchored to the diff
evm/oracles/pyth-network.mdx:2121-- [nit] The sample output now showsUpdate fee: 0.0 SEI. That reads as a point-in-time value, while the PR otherwise avoids point-in-time wording here. Consider a placeholder such as<fee> SEI, as in the cookbook recipes.
| "permanent": true | ||
| }, | ||
| { | ||
| "source": "/learn/sip-03-exchange-migration", |
There was a problem hiding this comment.
[suggestion] This redirect relies on removing learn/sip-03-exchange-migration.mdx, which the PR description doesn't mention. Please call out the deletion and confirm that sip-03-migration still covers the exchange/custodian guidance (FundsForwarder, migration options) that readers following this redirect expect.
There was a problem hiding this comment.
The Cookbook tab and its six recipes are well built and consistent. The forge create --broadcast, WebSocket watcher, bounded eth_getLogs, Pimlico .env and Pyth fixes are correct. Redirects are in place for every moved or removed page. There are no blockers, but the PR also deletes two pages, the SIP-03 exchange migration guide and the Videos page, and the PR description doesn't mention either deletion.
Findings: 0 blocking | 8 non-blocking | 2 posted inline
Blockers
- None at the file/PR level.
Non-blocking
- The PR deletes
learn/sip-03-exchange-migration.mdxandevm/videos.mdxin their own commits, but the PR description never mentions either deletion. A reviewer reading only the description would miss them. Record why they were removed, for example in a follow-up note or the changelog. - The exchange and custodian guidance is now gone from the docs. That covers the four migration options, the
FundsForwardercontract (including its OtterSec audit note), and the support contacts.learn/sip-03-migration.mdxhas none of this content. Confirm that dropping it was intended, or move the parts that still apply into the SIP-03 guide. - Hardhat network names are inconsistent. The docs pages now use
seitestnetandseimainnet. The Mintlify skills under.mintlify/skills/(sei-contracts, sei-migration) still configure and useseiTestnet. Align them in a follow-up so assistant answers match the docs. - After merge, run the 'Regenerate llms.txt' workflow, as the PR notes say.
llms-full.txtstill has the old network names (sei_testnet,--network sei) and the deleted pages. - The same
.mts/tsxparagraph appears word for word in five recipes. A shared snippet would make it easier to update. - Codex and Cursor produced no output:
codex-review.mdandcursor-review.mdare both empty. This review is a single pass. - 2 suggestion(s)/nit(s) flagged inline on specific lines.
| "permanent": true | ||
| }, | ||
| { | ||
| "source": "/learn/sip-03-exchange-migration", |
There was a problem hiding this comment.
[suggestion] This redirect sends exchange and custodian readers to /learn/sip-03-migration. That page has no exchange content: no FundsForwarder and no migration options for exchanges, and this PR also removes exchange migration from its keywords. Existing links and search results will land on a page that doesn't answer their question. Either move the exchange guidance that still applies into that page and link to an anchor, or add a short note there that the exchange guide was retired.
| --- | ||
| Pyth Network is a first-party oracle that delivers high-fidelity, low-latency financial market data on-chain. Unlike traditional push-based oracles, Pyth uses a "pull" model: applications get signed price updates on demand. This significantly reduces gas costs and still keeps the data fresh. Pyth has more than 400 price feeds across cryptocurrencies, equities, FX, and commodities. It aggregates data directly from more than 120 institutional data publishers, including major exchanges and trading firms. | ||
|
|
||
| <Warning>Send a Pyth API key with every request to Hermes. On Sei Mainnet, use the new Pyth contract address. Pyth made both changes in its Pyth Core upgrade on August 26, 2026. This guide includes them. For background, see Pyth's [upgrade guide](https://docs.pyth.network/price-feeds/core/upgrade/preparing).</Warning> |
There was a problem hiding this comment.
[nit] This warning says the change happened "on August 26, 2026". That is point-in-time wording, which commit 42801c6 tried to remove elsewhere. Consider saying "Since Pyth's Core upgrade" and keeping the date only behind the upgrade-guide link.
This branch was successfully deployed
1 participant
What is the purpose of the change?
This adds a Cookbook tab. The tab holds short, task-focused recipes for developers who want working code for one job. The code is in the library that they already use: viem, ethers, or web3.py. It closes the cookbook gap from the docs review against Solana's docs.
It also fixes existing pages whose examples do not work against the public endpoints or with current tooling. I found those while I tested the new recipes, and review found a few more.
1fca868e4f950fb352221forge create --broadcastin four pages7baa037f565cc3.mtsfiles (review feedback)a519486bee848f.env9275f0e1bda1f91c6e52a42801c6PYTH_API_KEY(review feedback)5f417aa21aec1c--constructor-argslast (review feedback)5a18ce3webSocketwith the other viem helpers (review feedback)28a37700d78c937baa037)8404fae88c41122140394b38af31seitestnetandseimainneton every page that has a Hardhat config (review feedback)Describe the changes to the documentation
Cookbook
/cookbookand/evm/evm-parity/examplesredirect to the new overview at/evm/cookbook.evm/cookbook/: read a balance, send SEI, deploy an ERC-20 (Foundry, Hardhat, or Remix), listen to events, sponsor gas with Pimlico, and read a price feed. Two of them have aRunSnippet.STYLE_GUIDE.mddescribes the Cookbook conventions, andscripts/generate-llms.mjsgets a Cookbook section for the weekly llms.txt run.The price-feed recipe uses the API3 SEI/USD push feed (
0x09c6e594DE2EB633902f00B87A43b27F80a31a60), which you can read with one free view call. Chainlink on Sei is Data Streams (credentials from Chainlink), and Pyth needs a signed update from its API before a read is current.Event watching and log queries
Tests against the public endpoints showed that HTTP watchers built on filters miss or repeat events. In one 40-second window, viem reported 2 of 12 transfers, and ethers reported 14. On Sei Mainnet,
eth_uninstallFilterreturns 403, which crashes ethers when a listener stops. The WebSocket endpoints serveeth_subscribebut noteth_getLogs.eth_getLogscaps a request at 2,000 blocks, so the ERC-20 history query from block 0 always failed.The ERC-20, ERC-721, ERC-1155, and ethers quickstart pages now watch events over WebSocket. The ERC-20 history query reads the latest 2,000 blocks. The ethers quickstart listener declares the
Transferevent that it listens for. Each watcher shows its cleanup as a comment. The cleanup removes the listener and closes the WebSocket provider. A copied snippet therefore listens until you stop it.Foundry
Current Foundry only simulates
forge createwithout--broadcast, so the documented commands deployed nothing. The examples inevm-foundry.mdx,deploy-verify.mdx,evm-verify-contracts.mdx, andmigrate-from-solana.mdxnow pass the flag, before--constructor-args(which takes every value after it). The Foundry guide also passed ABI-encoded constructor arguments, whichforge createrejects. It now passes plain values.Review follow-ups
.mtsfiles. In a new npm project,tsxcompiles a plain.tsfile as CommonJS, and top-levelawaitfails withTop-level await is currently not supported with the "cjs" output format. The recipes and the viem and ethers quickstarts now tell readers to save TypeScript examples as.mtsfiles.forge remappings > remappings.txt, like the Foundry guide.Web3.to_checksum_address.Pimlico guide
The guide tells you to put
PIMLICO_API_KEYin.env. Its script then wrote the generatedPRIVATE_KEYover the whole file, so the API key disappeared after the first run. It now appends the key. I also removed a top-levelreturnfrom one snippet.Pyth guide
Since Pyth's Core upgrade on August 26, 2026, Hermes rejects requests without an API key. Pyth's address list also shows
0x16392B49EA47D4A21bb17F69aA9E7aD570284838for Sei Mainnet instead of0x2880aB155794e7179c9eE2e38200202908C17B43, which Pyth still lists for Sei Testnet. The guide now:https://pyth.dourolabs.app/hermes)getLatestSeiPrice()revertsNotes
eth_getLogsfor the same blocks. Python ran on web3.py 7.7, 7.16, and 8.0, and all TypeScript passes a strict type check..mtsfiles in a fresh npm project without"type": "module"(the live watcher caught 36 of 36 transfers). The web3.py read-back worked with a lowercase USDC address, which raisedInvalidAddresswithout the checksum call. With the cleanup lines run after a pause, the ethers watchers exit on their own afterdestroy(). The Pimlico snippet keptPIMLICO_API_KEYin.env. The repo checks andmint broken-linkspass.llms.txtandllms-full.txtinclude the Cookbook.