feat: Add Arbitrum Spokepool and add generic cross-chain admin relayer function on HubPool #33
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| //SPDX-License-Identifier: Unlicense | ||
| pragma solidity ^0.8.0; | ||
|
|
||
| import "./SpokePool.sol"; | ||
| import "./SpokePoolInterface.sol"; | ||
|
|
||
| interface StandardBridgeLike { | ||
| function outboundTransfer( | ||
| address _l1Token, | ||
| address _to, | ||
| uint256 _amount, | ||
| bytes calldata _data | ||
| ) external payable returns (bytes memory); | ||
| } | ||
|
|
||
| /** | ||
| * @notice AVM specific SpokePool. | ||
| * @dev Uses AVM cross-domain-enabled logic for access control. | ||
| */ | ||
|
|
||
| contract Arbitrum_SpokePool is SpokePoolInterface, SpokePool { | ||
| // Address of the Arbitrum L2 token gateway. | ||
| address public l2GatewayRouter; | ||
|
|
||
| // Admin controlled mapping of arbitrum tokens to L1 counterpart. L1 counterpart addresses | ||
| // are neccessary to bridge tokens to L1. | ||
| mapping(address => address) public whitelistedTokens; | ||
|
Member
There was a problem hiding this comment. pain that we need this just for arbitrum but works kinda well given we have separate contracts for each chain. |
||
|
|
||
| event ArbitrumTokensBridged(address indexed l1Token, address target, uint256 numberOfTokensBridged); | ||
| event SetL2GatewayRouter(address indexed newL2GatewayRouter); | ||
| event WhitelistedTokens(address indexed l2Token, address indexed l1Token); | ||
|
|
||
| constructor( | ||
| address _l2GatewayRouter, | ||
| address _crossDomainAdmin, | ||
| address _hubPool, | ||
| address _wethAddress, | ||
| address timerAddress | ||
| ) SpokePool(_crossDomainAdmin, _hubPool, _wethAddress, timerAddress) { | ||
| _setL2GatewayRouter(_l2GatewayRouter); | ||
| } | ||
|
|
||
| modifier onlyFromCrossDomainAdmin() { | ||
| require(msg.sender == _applyL1ToL2Alias(crossDomainAdmin), "ONLY_COUNTERPART_GATEWAY"); | ||
| _; | ||
| } | ||
|
|
||
| /************************************** | ||
| * CROSS-CHAIN ADMIN FUNCTIONS * | ||
| **************************************/ | ||
|
|
||
| function setL2GatewayRouter(address newL2GatewayRouter) public onlyFromCrossDomainAdmin nonReentrant { | ||
| _setL2GatewayRouter(newL2GatewayRouter); | ||
| } | ||
|
|
||
| function whitelistToken(address l2Token, address l1Token) public onlyFromCrossDomainAdmin nonReentrant { | ||
| _whitelistToken(l2Token, l1Token); | ||
| } | ||
|
|
||
| function setCrossDomainAdmin(address newCrossDomainAdmin) public override onlyFromCrossDomainAdmin nonReentrant { | ||
| _setCrossDomainAdmin(newCrossDomainAdmin); | ||
| } | ||
|
|
||
| function setHubPool(address newHubPool) public override onlyFromCrossDomainAdmin nonReentrant { | ||
| _setHubPool(newHubPool); | ||
| } | ||
|
|
||
| function setEnableRoute( | ||
| address originToken, | ||
| uint32 destinationChainId, | ||
| bool enable | ||
| ) public override onlyFromCrossDomainAdmin nonReentrant { | ||
| _setEnableRoute(originToken, destinationChainId, enable); | ||
| } | ||
|
|
||
| function setDepositQuoteTimeBuffer(uint32 buffer) public override onlyFromCrossDomainAdmin nonReentrant { | ||
| _setDepositQuoteTimeBuffer(buffer); | ||
| } | ||
|
|
||
| function initializeRelayerRefund(bytes32 relayerRepaymentDistributionRoot, bytes32 slowRelayRoot) | ||
| public | ||
| override | ||
| onlyFromCrossDomainAdmin | ||
| nonReentrant | ||
| { | ||
| _initializeRelayerRefund(relayerRepaymentDistributionRoot, slowRelayRoot); | ||
| } | ||
|
|
||
| /************************************** | ||
| * INTERNAL FUNCTIONS * | ||
| **************************************/ | ||
|
|
||
| function _bridgeTokensToHubPool(DestinationDistributionLeaf memory distributionLeaf) internal override { | ||
| StandardBridgeLike(l2GatewayRouter).outboundTransfer( | ||
| whitelistedTokens[distributionLeaf.l2TokenAddress], // _l1Token. Address of the L1 token to bridge over. | ||
| hubPool, // _to. Withdraw, over the bridge, to the l1 hub pool contract. | ||
| distributionLeaf.amountToReturn, // _amount. | ||
| "" // _data. We don't need to send any data for the bridging action. | ||
| ); | ||
| emit ArbitrumTokensBridged(address(0), hubPool, distributionLeaf.amountToReturn); | ||
| } | ||
|
|
||
| function _setL2GatewayRouter(address _l2GatewayRouter) internal { | ||
| l2GatewayRouter = _l2GatewayRouter; | ||
| emit SetL2GatewayRouter(l2GatewayRouter); | ||
| } | ||
|
|
||
| function _whitelistToken(address _l2Token, address _l1Token) internal { | ||
| whitelistedTokens[_l2Token] = _l1Token; | ||
| emit WhitelistedTokens(_l2Token, _l1Token); | ||
| } | ||
|
|
||
| // l1 addresses are transformed during l1->l2 calls. See https://developer.offchainlabs.com/docs/l1_l2_messages#address-aliasing for more information. | ||
| function _applyL1ToL2Alias(address l1Address) internal pure returns (address l2Address) { | ||
| l2Address = address(uint160(l1Address) + uint160(0x1111000000000000000000000000000000001111)); | ||
| } | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // SPDX-License-Identifier: AGPL-3.0-only | ||
| pragma solidity ^0.8.0; | ||
|
|
||
| import "./Base_Adapter.sol"; | ||
| import "../interfaces/AdapterInterface.sol"; | ||
| import "../interfaces/WETH9.sol"; | ||
|
|
||
| import "@uma/core/contracts/common/implementation/Lockable.sol"; | ||
|
|
||
| import "@openzeppelin/contracts/token/ERC20/IERC20.sol"; | ||
| import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; | ||
|
|
||
| contract L1_Adapter is Base_Adapter, Lockable { | ||
|
Member
Author
There was a problem hiding this comment. @mrice32 @chrismaree I originally added this because I wanted to test |
||
| using SafeERC20 for IERC20; | ||
|
|
||
| constructor(address _hubPool) Base_Adapter(_hubPool) {} | ||
|
|
||
| function relayMessage(address target, bytes memory message) external payable override nonReentrant onlyHubPool { | ||
| _executeCall(target, message); | ||
| emit MessageRelayed(target, message); | ||
| } | ||
|
|
||
| function relayTokens( | ||
| address l1Token, | ||
| address l2Token, // l2Token is unused for L1. | ||
| uint256 amount, | ||
| address to | ||
| ) external payable override nonReentrant onlyHubPool { | ||
| IERC20(l1Token).safeTransfer(to, amount); | ||
| emit TokensRelayed(l1Token, l2Token, amount, to); | ||
| } | ||
|
|
||
| // Note: this snippet of code is copied from Governor.sol. | ||
| function _executeCall(address to, bytes memory data) private { | ||
| // Note: this snippet of code is copied from Governor.sol and modified to not include any "value" field. | ||
| // solhint-disable-next-line no-inline-assembly | ||
|
|
||
| bool success; | ||
| assembly { | ||
| let inputData := add(data, 0x20) | ||
| let inputDataSize := mload(data) | ||
| // Hardcode value to be 0 for relayed governance calls in order to avoid addressing complexity of bridging | ||
| // value cross-chain. | ||
| success := call(gas(), to, 0, inputData, inputDataSize, 0, 0) | ||
| } | ||
| require(success, "execute call failed"); | ||
| } | ||
|
|
||
| receive() external payable {} | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this does not have any tests. shall we add that in this PR or a separate one? we also need to write OP tests, which can happen either at the same time, if we choose to wait on adding the tests here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's do separate PR