Update wrapper.mdx#620
Conversation
Hi guys - have swapped as much of the language from wrappers to bundles as I could - there's a lot of it in code which I haven't touched.
|
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. |
📝 WalkthroughWalkthroughThe documentation for the settlement-wrapping mechanism is rebranded from "Generalized Wrappers" to "Atomic Bundles" terminology throughout. All descriptive content, design principles, integrator guidance, security considerations, and implementation behaviors are updated to reflect the new terminology, while underlying contract references and method signatures remain unchanged. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/cow-protocol/reference/contracts/periphery/wrapper.mdx`:
- Line 7: The intro sentence still uses the old phrase "wrapper system"; update
that sentence to use the new terminology consistently by replacing "wrapper
system" with "Atomic Bundles" (or rephrasing to "Atomic Bundles system" /
"Atomic Bundles framework") so the line reads e.g. "This reference documents the
contract interfaces, implementation patterns, and on-chain behavior of Atomic
Bundles." Locate the phrase "wrapper system" in the intro sentence and make the
wording change in the wrapper.mdx document to complete the terminology
migration.
- Line 148: The sentence uses a double hyphen in "delegates to `_wrap()`--where"
which is a punctuation typo; update the text in wrapper.mdx to replace
`_wrap()--where` with a properly punctuated form such as `_wrap() — where` (em
dash with spaces) or `_wrap(), where` so it reads "delegates to `_wrap()` —
where integrators place their custom logic" (or the comma variant) and ensure
the reference to `_wrap()` remains intact.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 291b0523-097b-4434-8d39-f14de81eff05
📒 Files selected for processing (1)
docs/cow-protocol/reference/contracts/periphery/wrapper.mdx
| # Atomic Bundles | ||
|
|
||
| Generalized wrappers are smart contracts that enable custom logic to execute before and after CoW Protocol settlement operations. This reference documents the contract interfaces, implementation patterns, and on-chain behavior of the wrapper system. | ||
| Atomic Bundles are smart contracts that enable custom logic to execute before and after CoW Protocol settlement operations. This reference documents the contract interfaces, implementation patterns, and on-chain behavior of the wrapper system. |
There was a problem hiding this comment.
Complete the terminology migration in intro sentence.
Line 7 still says “wrapper system,” which conflicts with the new “Atomic Bundles” framing and the PR goal.
Suggested edit
-Atomic Bundles are smart contracts that enable custom logic to execute before and after CoW Protocol settlement operations. This reference documents the contract interfaces, implementation patterns, and on-chain behavior of the wrapper system.
+Atomic Bundles are smart contracts that enable custom logic to execute before and after CoW Protocol settlement operations. This reference documents the contract interfaces, implementation patterns, and on-chain behavior of the bundle system.📝 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.
| Atomic Bundles are smart contracts that enable custom logic to execute before and after CoW Protocol settlement operations. This reference documents the contract interfaces, implementation patterns, and on-chain behavior of the wrapper system. | |
| Atomic Bundles are smart contracts that enable custom logic to execute before and after CoW Protocol settlement operations. This reference documents the contract interfaces, implementation patterns, and on-chain behavior of the bundle system. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/cow-protocol/reference/contracts/periphery/wrapper.mdx` at line 7, The
intro sentence still uses the old phrase "wrapper system"; update that sentence
to use the new terminology consistently by replacing "wrapper system" with
"Atomic Bundles" (or rephrasing to "Atomic Bundles system" / "Atomic Bundles
framework") so the line reads e.g. "This reference documents the contract
interfaces, implementation patterns, and on-chain behavior of Atomic Bundles."
Locate the phrase "wrapper system" in the intro sentence and make the wording
change in the wrapper.mdx document to complete the terminology migration.
| #### `wrappedSettle` | ||
|
|
||
| Entry point for wrapper execution. Validates caller authentication and delegates to `_wrap()`--where integrators place their custom logic. See the [full implementation in `CowWrapper.sol`](https://github.com/cowprotocol/euler-integration-contracts/blob/master/src/CowWrapper.sol). | ||
| Entry point for bundle execution. Validates caller authentication and delegates to `_wrap()`--where integrators place their custom logic. See the [full implementation in `CowWrapper.sol`](https://github.com/cowprotocol/euler-integration-contracts/blob/master/src/CowWrapper.sol). |
There was a problem hiding this comment.
Fix punctuation around _wrap() clause.
_wrap()--where reads like a typo. Use an em dash (or standard punctuation) for readability.
Suggested edit
-Entry point for bundle execution. Validates caller authentication and delegates to `_wrap()`--where integrators place their custom logic. See the [full implementation in `CowWrapper.sol`](https://github.com/cowprotocol/euler-integration-contracts/blob/master/src/CowWrapper.sol).
+Entry point for bundle execution. Validates caller authentication and delegates to `_wrap()`—where integrators place their custom logic. See the [full implementation in `CowWrapper.sol`](https://github.com/cowprotocol/euler-integration-contracts/blob/master/src/CowWrapper.sol).📝 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.
| Entry point for bundle execution. Validates caller authentication and delegates to `_wrap()`--where integrators place their custom logic. See the [full implementation in `CowWrapper.sol`](https://github.com/cowprotocol/euler-integration-contracts/blob/master/src/CowWrapper.sol). | |
| Entry point for bundle execution. Validates caller authentication and delegates to `_wrap()`—where integrators place their custom logic. See the [full implementation in `CowWrapper.sol`](https://github.com/cowprotocol/euler-integration-contracts/blob/master/src/CowWrapper.sol). |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/cow-protocol/reference/contracts/periphery/wrapper.mdx` at line 148, The
sentence uses a double hyphen in "delegates to `_wrap()`--where" which is a
punctuation typo; update the text in wrapper.mdx to replace `_wrap()--where`
with a properly punctuated form such as `_wrap() — where` (em dash with spaces)
or `_wrap(), where` so it reads "delegates to `_wrap()` — where integrators
place their custom logic" (or the comma variant) and ensure the reference to
`_wrap()` remains intact.
|
"I have read the CLA Document and I hereby sign the CLA |
Hi guys - have swapped as much of the language from wrappers to bundles as I could - there's a lot of it in code which I haven't touched.
Description
Changes
Summary by CodeRabbit