docs: fix stale Base chain references (Arbitrum)#63
Merged
Conversation
📝 WalkthroughWalkthroughREADME.md is updated to replace all Base network references with Arbitrum equivalents, including RPC endpoints, chain IDs, USDC contract addresses, and client initialization examples across the overview, quickstart, client setup, transport configuration, and deployment documentation sections. ChangesREADME Arbitrum Migration
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 195-216: The README deployment example is using outdated
`Deployments` fields that do not match the public API. Update the example to
align with `Deployments` in `src/types.rs` by showing only the actual fields
(`perp` and `usdc`), and keep the Arbitrum Sepolia/Mainnet guidance consistent
with `PerpClient::new` and `PerpClient::new_arbitrum()` so readers can copy a
valid setup.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
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.
Documentation-only: the README was stale against the code itself, which already targets Arbitrum (
new_arbitrum,new_arbitrum_sepolia,ARBITRUM_CHAIN_ID = 42161,ARBITRUM_SEPOLIA_CHAIN_ID = 421614,ARBITRUM_USDC,ARBITRUM_SEPOLIA_USDCinsrc/client/mod.rs). No code changes.Corrections
0xC1a5D4E9...onsepolia.base.org->0xBEF280BefeE2Cb28c20D1E4Cc1da999B4DA0f1fD(PerpCity test USDC, not Circle's) onhttps://sepolia-rollup.arbitrum.io/rpcshared_endpoint("https://sepolia.base.org")->https://sepolia-rollup.arbitrum.io/rpc; chain id84532->421614base.g.alchemy.com/base-rpc.publicnode.com->arb-mainnet.g.alchemy.com/arbitrum-one-rpc.publicnode.comhttps://sepolia.base.org->https://sepolia-rollup.arbitrum.io/rpc(matches the actual defaults inexamples/)ARBITRUM_SEPOLIA_USDC; "For Base mainnet, usePerpClient::new_base_mainnet()(chain 8453, USDC 0x8335...2913)" -> "For Arbitrum One, usePerpClient::new_arbitrum()(chain 42161) withARBITRUM_USDC(0xaf88d065e77c8cC2239327C5EDb3A432268e5831)" —new_base_mainnetno longer existsCHANGELOG.md untouched (historical record).
Follow-ups (code comments still mention Base, intentionally not touched in this docs-only PR)
src/client/mod.rs:277: "every 1-2 seconds on Base L2"src/client/transactions.rs:31: "~2s on Base"src/hft/gas.rs:175,271: "2 Base L2 blocks", "typical Base L2"src/hft/state_cache.rs:3: "rate of change on Base L2"examples/hft_bot.rs:306: "~1s on Base L2"Summary by CodeRabbit