Skip to content

Fix ETH flow addresses#543

Merged
alfetopito merged 2 commits intomainfrom
fix-eth-flow-address
Oct 17, 2025
Merged

Fix ETH flow addresses#543
alfetopito merged 2 commits intomainfrom
fix-eth-flow-address

Conversation

@fedgiac
Copy link
Contributor

@fedgiac fedgiac commented Oct 16, 2025

Description

The current list of ETH-flow is highly misleading since it implies that the ETH-flow address is the same on Lens as for the other chains. Users relying on this address on Lens would lose their funds.

Changes

  • Separated Lens ETH-flow address
  • Removed disclaimer "generally deployed at the same address"
  • Added warning about loss of funds
  • Consistent alignment in source table

Other notes

I tried to make the table easier to review when adding networks in the future but I was unsuccessful. Options that could work would be to style this section with code (requires messing with React components, which I'm unfamiliar with) or relying on some relatively obscure package remark-grid-tables for better table formatting (idea from here).

How to review

Make sure all chains are included in the standard contract except for Lens.

Summary by CodeRabbit

  • Documentation
    • Reworked EthFlow deployment docs with an expanded, clearer environment table separating Production and Staging rows and including Lens-specific Production/Staging entries.
    • Added explicit Lens environment entries for better clarity.
    • Replaced the previous tip/layout with a prominent warning block stressing correct chain selection and stronger caution about irreversible fund loss when sending native tokens to EthFlow contracts on the wrong chain.

@fedgiac fedgiac requested a review from anxolin October 16, 2025 09:22
@fedgiac fedgiac requested a review from a team as a code owner October 16, 2025 09:22
@vercel
Copy link

vercel bot commented Oct 16, 2025

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

Project Deployment Preview Updated (UTC)
docs Ready Ready Preview Oct 16, 2025 10:38am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 16, 2025

Walkthrough

Replaced the EthFlow Deployments subsection with an expanded, table-driven Environment table (Production/Staging and Lens-specific rows) and a dedicated warning block stressing correct-chain targeting and irrecoverable loss when sending native tokens to the wrong chain.

Changes

Cohort / File(s) Summary
Documentation Update
docs/cow-protocol/reference/contracts/periphery/README.mdx
Replaced prior EthFlow Deployments tip and compact table with an expanded Environment table (Production & Staging rows plus Lens-specific entries); added explicit Lens entries; introduced a prominent warning block about sending native tokens to the wrong chain; removed the old tip layout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • feat: add lens and bnb #538: Modifies the same periphery README to add/adjust Lens and environment entries and warnings; likely overlaps in edits.

Suggested reviewers

  • pretf00d
  • fhenneke

Poem

🐰 A README hopped in, tidy and bright,
Rows split to Production and Staging's light,
Lens found its seat, warnings clear as a bell,
Hop careful with tokens — a costly farewell,
Docs groomed and snug, ready for flight ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly and concisely summarizes the primary change by indicating that the ETH flow addresses are being fixed, which matches the modifications made to separate and correct those addresses in the documentation.
Description Check ✅ Passed The description follows the repository template by providing a detailed explanation of why the changes are needed and a clearly bulleted list of the specific modifications under the “# Changes” section, with all required sections present and complete.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-eth-flow-address

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7731ce8 and 5519bfc.

📒 Files selected for processing (1)
  • docs/cow-protocol/reference/contracts/periphery/README.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/reference/contracts/periphery/README.mdx

[style] ~24-~24: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... to irrecoverable loss of funds! Be very careful to choose the right address in the chai...

(EN_WEAK_ADJECTIVE)


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
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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 28d6b39 and 7731ce8.

📒 Files selected for processing (1)
  • docs/cow-protocol/reference/contracts/periphery/README.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/reference/contracts/periphery/README.mdx

[grammar] ~17-~17: There might be a mistake here.
Context: ...62d157E00D13419D2D6E95), but not Lens! | | Production | `0x5A5b8aE7a0b4C0EAf453d...

(QB_NEW_EN)


[grammar] ~18-~18: There might be a mistake here.
Context: ...7a0b4C0EAf453d10DCcfbA413f07ebdC2) only! | Staging | `0xFb337f8a725A142f65fb9...

(QB_NEW_EN)


[style] ~24-~24: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... to irrecoverable loss of funds! Be very careful to choose the right address in the chai...

(EN_WEAK_ADJECTIVE)

@alfetopito alfetopito merged commit cdf6ba5 into main Oct 17, 2025
6 checks passed
@alfetopito alfetopito deleted the fix-eth-flow-address branch October 17, 2025 16:12
@github-actions github-actions bot locked and limited conversation to collaborators Oct 17, 2025
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.

2 participants