[SC-452] Refactor forwarders and receivers #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… from the domains
…ections on every bridge
lucas-manuel
requested changes
Jun 11, 2024
README.md
Outdated
| @@ -1,5 +1,20 @@ | |||
| # xchain-helpers | |||
|
|
|||
| This repository contains tooling for multichain testing such as cross-chain e2e testing support. | |||
| This repository three tools for use with multi-chain development. Domains refer to blockchains which are connected by bridges. Domains may have multiple bridges connecting them, for example both the Optimism Native Bridge and Circle CCTP connect Ethereum and Optimism domains. | |||
|
|
||
| ## Receivers | ||
|
|
||
| The most common pattern is to have an authorized contract forward a message to another "business logic" contract to abstract away bridge dependencies. Receivers are contracts which perform this generic translation - decoding the bridge-specific message and forwarding to another `target` contract. The `target` contract should have logic to restrict who can call it and permission this to one or more bridge receivers. |
There was a problem hiding this comment.
We should talk about how the receiver itself has the restrictions/requires specific to the bridge and talk about the use of fallbacks and how it routs the message
There was a problem hiding this comment.
added another paragraph
test/CircleCCTPIntegration.t.sol
Outdated
|
|
||
| // Use Optimism for failure tests as the code logic is the same | ||
|
|
||
| function test_invalidSourceAuthority() public { |
There was a problem hiding this comment.
This one should be third
|
|
||
| function test_base() public { | ||
| checkOptimismStyle(getChain("base").createFork()); | ||
| function test_invalidSourceAuthority() public { |
There was a problem hiding this comment.
This should be second
test/OptimismIntegration.t.sol
Outdated
| function test_optimism() public { | ||
| checkOptimismStyle(getChain("optimism").createFork()); | ||
| } | ||
| // Use Arbitrum One for failure test as the code logic is the same |
lucas-manuel
added
Status: Revisions Needed
and removed
Status: Ready for Review
labels
lucas-manuel
previously approved these changes
Jun 11, 2024
[SC-437] Fixing coverage by adding unit tests
|
Coverage after merging SC-452-refactor-forwards-receivers into master will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does two refactors:
XChainForwardersinto separate libraries for better organization. I've also added some missing L2 -> L1 messages on each forwarder.You can see concrete example of how these changes improve usage here: https://github.com/marsfoundation/spark-gov-relay/pull/18/files and here: https://github.com/marsfoundation/xchain-dsr-oracle/pull/20/files