Skip to content

Update wrapper.mdx#620

Merged
limitofzero merged 1 commit intomainfrom
pretf00d-patch-4
May 1, 2026
Merged

Update wrapper.mdx#620
limitofzero merged 1 commit intomainfrom
pretf00d-patch-4

Conversation

@pretf00d
Copy link
Copy Markdown
Contributor

@pretf00d pretf00d commented May 1, 2026

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

  • Documentation
    • Revised settlement wrapping reference documentation with terminology updates for consistent language throughout guide materials.

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.
@pretf00d pretf00d requested a review from a team as a code owner May 1, 2026 08:11
@vercel
Copy link
Copy Markdown

vercel Bot commented May 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview May 1, 2026 8:11am

Request Review

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 1, 2026

📝 Walkthrough

Walkthrough

The 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

Cohort / File(s) Summary
Documentation Terminology Update
docs/cow-protocol/reference/contracts/periphery/wrapper.mdx
Comprehensive terminology rebrand from "Generalized Wrappers" to "Atomic Bundles" across all narrative sections, including execution flows, design principles, integrator guidance, security requirements, and behavioral descriptions. No structural or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Wrappers once were, now bundles they are,
Atomic and bundled, shining like stars!
Same settlement dance, new name so bright,
Documentation blooms in this rebranding light!

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update wrapper.mdx' is vague and does not convey the meaningful change of rebranding wrapper terminology to bundle terminology throughout the documentation. Revise the title to be more specific, such as 'Rebrand wrapper references to atomic bundles in documentation' to clearly indicate the primary change.
Description check ❓ Inconclusive The PR description lacks substantive detail about the changes made and their purpose, with an incomplete checklist and missing context. Expand the description section to explain why the terminology shift from 'wrappers' to 'bundles' is needed, complete the changes checklist with specific items modified, and clarify the scope of changes made to the documentation file.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch pretf00d-patch-4

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 99b2eb7 and 5b110e1.

📒 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

Suggested change
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).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

Suggested change
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.

@Danziger Danziger self-requested a review May 1, 2026 12:06
@pretf00d
Copy link
Copy Markdown
Contributor Author

pretf00d commented May 1, 2026

"I have read the CLA Document and I hereby sign the CLA

@limitofzero limitofzero merged commit 1c595ec into main May 1, 2026
4 of 5 checks passed
@limitofzero limitofzero deleted the pretf00d-patch-4 branch May 1, 2026 14:48
@github-actions github-actions Bot locked and limited conversation to collaborators May 1, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants