Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I have read the CLA Document and I hereby sign the CLA You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot. |
📝 WalkthroughWalkthroughThis PR adds support for the Ink blockchain across documentation files and refactors the contract-addresses component. Changes include adding Ink to contract reference tables, periphery deployments, reward configurations, signing schemes, token governance, and tutorials. A TypeScript component introduces typed Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
| The payment is capped from above and below using the function $$\textrm{cap}(x) = \max(-c_l, \min(c_u, x))$$, where $$c_u$$ is the protocol fee (excluding partner fees) that the protocol earned from the trades in all solutions supplied by the solver in that auction and $$c_l$$ is chain-specific, determined by the following values: | ||
|
|
||
| - Ethereum mainnet, Arbitrum, and Base chain: $$0.010 \;\textrm{ETH}$$ | ||
| - Ethereum mainnet, Arbitrum, Base and Ink chain: $$0.010 \;\textrm{ETH}$$ |
There was a problem hiding this comment.
Not sure if this is the case (Ink == Mainnet)
| - BNB Chain: $$\min\{0.001 ~\textrm{BNB}, 6 ~\textrm{COW}\}$$ | ||
| - Linea: $$\min\{0.00003 ~\textrm{ETH}, 6 ~\textrm{COW}\}$$. | ||
| - Plasma: $$\min\{0.6 ~\textrm{XPL}, 6 ~\textrm{COW}\}$$. | ||
| - Ink: $$\min\{X.X ~\textrm{XPL}, 6 ~\textrm{COW}\}$$. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/components/contract-addresses/index.tsx (1)
59-67:⚠️ Potential issue | 🟡 MinorMissing
keyprop on<Link>elements will cause React warnings.When rendering an array of elements via
reduce, each element needs a uniquekeyprop to avoid React reconciliation warnings.🔧 Proposed fix
return chains.reduce( (acc, chain) => { if (acc.length) { acc.push(separator) } - acc.push(<Link to={explorerUrl(chain, address, { urlTrailing })}>{chain}</Link>) + acc.push(<Link key={chain} to={explorerUrl(chain, address, { urlTrailing })}>{chain}</Link>) return acc } , []); }
🤖 Fix all issues with AI agents
In `@docs/cow-protocol/reference/contracts/periphery/README.mdx`:
- Around line 45-56: The MDX array passed to explorerLinks is missing commas
after the "Ink" and "Optimism" entries which breaks parsing; update the array
inside the explorerLinks([...]) call (the list containing "Arbitrum One",
"Avalanche", ..., "Ink", "Lens", "Linea", "Optimism", "Plasma") to include the
missing commas so each string is a separate element and the MDX/JS is valid.
In `@docs/cow-protocol/reference/core/auctions/rewards.md`:
- Line 100: Replace the incorrect token symbol in the Ink reward line: change
the expression "Ink: $$\min\{X.X ~\textrm{XPL}, 6 ~\textrm{COW}\}$$." so that
the placeholder token symbol "XPL" is "ETH" (e.g., "Ink: $$\min\{X.X
~\textrm{ETH}, 6 ~\textrm{COW}\}$$."), preserving the LaTeX formatting and the
rest of the text.
🧹 Nitpick comments (1)
src/components/contract-addresses/index.tsx (1)
70-72: Consider moving theasArrayhelper aboveexplorerLinksfor better readability.While function hoisting makes this work, placing helper functions before their usage improves code flow and readability.
| {explorerLinks([ | ||
| "Ethereum", | ||
| "Sepolia", | ||
| "Gnosis", | ||
| "Base", | ||
| "Arbitrum One", | ||
| "Avalanche", | ||
| "Polygon", | ||
| "Lens", | ||
| "Base", | ||
| "BNB", | ||
| "Ethereum", | ||
| "Gnosis", | ||
| "Ink" | ||
| "Lens", | ||
| "Linea", | ||
| "Plasma", | ||
| "Optimism" | ||
| "Plasma", |
There was a problem hiding this comment.
Fix missing commas in the network list (build break).
The explorerLinks([...]) array is missing commas after "Ink" and "Optimism", which will invalidate the MDX/JS and fail builds.
🔧 Proposed fix
"Gnosis",
-"Ink"
+"Ink",
"Lens",
"Linea",
-"Optimism"
+"Optimism",
"Plasma",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| {explorerLinks([ | |
| "Ethereum", | |
| "Sepolia", | |
| "Gnosis", | |
| "Base", | |
| "Arbitrum One", | |
| "Avalanche", | |
| "Polygon", | |
| "Lens", | |
| "Base", | |
| "BNB", | |
| "Ethereum", | |
| "Gnosis", | |
| "Ink" | |
| "Lens", | |
| "Linea", | |
| "Plasma", | |
| "Optimism" | |
| "Plasma", | |
| {explorerLinks([ | |
| "Arbitrum One", | |
| "Avalanche", | |
| "Base", | |
| "BNB", | |
| "Ethereum", | |
| "Gnosis", | |
| "Ink", | |
| "Lens", | |
| "Linea", | |
| "Optimism", | |
| "Plasma", |
🤖 Prompt for AI Agents
In `@docs/cow-protocol/reference/contracts/periphery/README.mdx` around lines 45 -
56, The MDX array passed to explorerLinks is missing commas after the "Ink" and
"Optimism" entries which breaks parsing; update the array inside the
explorerLinks([...]) call (the list containing "Arbitrum One", "Avalanche", ...,
"Ink", "Lens", "Linea", "Optimism", "Plasma") to include the missing commas so
each string is a separate element and the MDX/JS is valid.
| - BNB Chain: $$\min\{0.001 ~\textrm{BNB}, 6 ~\textrm{COW}\}$$ | ||
| - Linea: $$\min\{0.00003 ~\textrm{ETH}, 6 ~\textrm{COW}\}$$. | ||
| - Plasma: $$\min\{0.6 ~\textrm{XPL}, 6 ~\textrm{COW}\}$$. | ||
| - Ink: $$\min\{X.X ~\textrm{XPL}, 6 ~\textrm{COW}\}$$. |
There was a problem hiding this comment.
Incorrect token symbol: Ink uses ETH, not XPL.
The placeholder shows X.X XPL but Ink is an OP Stack chain that uses ETH as its native token. XPL is Plasma's native token (copied from line 99).
🔧 Proposed fix
-- Ink: $$\min\{X.X ~\textrm{XPL}, 6 ~\textrm{COW}\}$$.
+- Ink: $$\min\{X.X ~\textrm{ETH}, 6 ~\textrm{COW}\}$$.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Ink: $$\min\{X.X ~\textrm{XPL}, 6 ~\textrm{COW}\}$$. | |
| - Ink: $$\min\{X.X ~\textrm{ETH}, 6 ~\textrm{COW}\}$$. |
🤖 Prompt for AI Agents
In `@docs/cow-protocol/reference/core/auctions/rewards.md` at line 100, Replace
the incorrect token symbol in the Ink reward line: change the expression "Ink:
$$\min\{X.X ~\textrm{XPL}, 6 ~\textrm{COW}\}$$." so that the placeholder token
symbol "XPL" is "ETH" (e.g., "Ink: $$\min\{X.X ~\textrm{ETH}, 6
~\textrm{COW}\}$$."), preserving the LaTeX formatting and the rest of the text.
1 participant
Description
Add Ink network.
Changes
Summary by CodeRabbit
Release Notes
New Features
Documentation