Update trampoline #524
Update trampoline #524
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... 📒 Files selected for processing (1)
WalkthroughThe documentation for CoW Protocol's periphery contracts was restructured from a single markdown table into a more detailed, sectioned format. Each contract now features its own subsection with headings, updated addresses, explicit network mappings, and clearer links to documentation and source code. Some contract addresses and supported networks were also updated. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Tip CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.Add a configuration file to your project to customize how CodeRabbit runs ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/cow-protocol/reference/contracts/periphery/README.mdx (4)
19-23: Normalize chain names & explorer URLs for consistencyIn the network lists you mix “Arbitrum one” (lower-case “one”) with the official spelling “Arbitrum One”, and you use
snowscan.xyzfor Avalanche while every other chain points to its canonical explorer. Consistent naming & canonical explorers make it easier for readers (and scripts that scrape the docs) to reason about the data.-| Arbitrum one](https://arbiscan.io/address/… +| Arbitrum One](https://arbiscan.io/address/… -| Avalanche](https://snowscan.xyz/address/… +| Avalanche](https://snowtrace.io/address/…(Apply the same normalisation across both “Production” and “Staging” rows.)
30-42: Convert HooksTrampoline address to EIP-55 checksum & reuse the EthFlow table layoutThe address is currently all lower-case while the rest of the doc uses checksum notation. Using the same format avoids accidental copy-paste errors and makes visual verification easier. In addition, the long bullet list of networks is harder to scan than the table you already use for EthFlow.
-**Address**: `0x60bf78233f48ec42ee3f101b9a05ec7878728006` +**Address**: `0x60Bf78233F48Ec42eE3f101B9a05eC7878728006`Consider replacing the “Address / Networks” bullet section with a two-column table (
Network | Address) like the one used for EthFlow and CoWUidGenerator for uniformity.
50-59: Minor consistency nits in ComposableCoW section
- Chain list repeats the same naming / explorer issues noted above (e.g. “Arbitrum one”,
snowscan.xyz).- As with HooksTrampoline, the address is lower-case; convert to checksum for coherence.
-**Address**: `0xfdafc9d1902f4e0b84f65f49f244b32b31013b74` +**Address**: `0xfDaFc9D1902F4E0b84F65F49F244B32B31013B74`Applying these tweaks keeps the documentation polished and machine-friendly.
68-70: Fix mixed-case mismatch between link and literal addressThe Base entry links to the lower-case address but shows a checksummed literal. While both resolve, using the same casing avoids confusion.
-| [Base](https://basescan.org/address/0x96dddac514d0799e34e3f642c5006852ad24cd68) | `0x96ddDAC514d0799e34e3F642c5006852aD24CD68` | +[Base](https://basescan.org/address/0x96ddDAC514d0799e34e3F642c5006852aD24CD68) | `0x96ddDAC514d0799e34e3F642c5006852aD24CD68` |(Also check whether Arbitrum One and other L2s should be listed for this contract to mirror the earlier sections.)
Description
This PR updates the trampoline contract to the latest version.
Additional networks
The contract was deployed also to many new networks like Binance, Optimism, Lens, Polygon and Avalanche
Bonus
Adding all the periphery contracts in a single table with all the networks and relevant links made it a bit hard to mantain.
Instead, I broke it down in sections, so it can be easier to read and maintain.
Before:
After:
Out of scope 1
There's a discussion on hooks, with a nice introduction to them with the goal of clarifying all aspects of them and properly defining the rules.
I believe that after properly defining that, we could move some of that content to https://docs.cow.fi/ because the hooks page and hook trampoline page are insufficient.
Out of scope also more improvements in the docs other than what I described in BONUS.
Test review the page
Review page: https://docs-git-update-trampoline-cowswap.vercel.app/cow-protocol/reference/contracts/periphery
For reference: https://docs.cow.fi/cow-protocol/reference/contracts/periphery
Summary by CodeRabbit