-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into nmlinaric/permissionless-token-adapter
- Loading branch information
Showing
18 changed files
with
1,313 additions
and
23 deletions.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| // The Licensed Work is (c) 2022 Sygma | ||
| // SPDX-License-Identifier: LGPL-3.0-only | ||
|
|
||
| pragma solidity 0.8.11; | ||
|
|
||
| import "@openzeppelin/contracts/access/Ownable.sol"; | ||
|
|
||
| contract Retry is Ownable { | ||
|
|
||
| event Retry(uint8 sourceDomainID, uint8 destinationDomainID, uint256 blockHeight, bytes32 resourceID); | ||
|
|
||
| /** | ||
| @notice This method is used to trigger the process for retrying failed deposits on the MPC side. | ||
| @notice Only callable by admin. | ||
| @param sourceDomainID ID of the retry source. | ||
| @param destinationDomainID ID of the transfer destination. | ||
| @param blockHeight Block height on origin chain which contains failed deposits. | ||
| @param resourceID Resource ID of transfers that are to be retried. | ||
| */ | ||
| function retry(uint8 sourceDomainID, uint8 destinationDomainID, uint256 blockHeight, bytes32 resourceID) external onlyOwner { | ||
| emit Retry(sourceDomainID, destinationDomainID, blockHeight, resourceID); | ||
| } | ||
|
|
||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| // SPDX-License-Identifier: BUSL-1.1 | ||
| pragma solidity ^0.8.11; | ||
|
|
||
| import "@openzeppelin/contracts/access/AccessControl.sol"; | ||
| import "../../interfaces/IBridge.sol"; | ||
| import "../../interfaces/IFeeHandler.sol"; | ||
|
|
||
|
|
||
| contract NativeTokenAdapter is AccessControl { | ||
| IBridge public immutable _bridge; | ||
| bytes32 public immutable _resourceID; | ||
|
|
||
| event Withdrawal(address recipient, uint amount); | ||
|
|
||
| error SenderNotAdmin(); | ||
| error InsufficientMsgValueAmount(uint256 amount); | ||
| error MsgValueLowerThanFee(uint256 amount); | ||
| error TokenWithdrawalFailed(); | ||
| error InsufficientBalance(); | ||
| error FailedFundsTransfer(); | ||
|
|
||
| modifier onlyAdmin() { | ||
| if (!hasRole(DEFAULT_ADMIN_ROLE, msg.sender)) revert SenderNotAdmin(); | ||
| _; | ||
| } | ||
|
|
||
| constructor(address bridge, bytes32 resourceID) { | ||
| _bridge = IBridge(bridge); | ||
| _resourceID = resourceID; | ||
| _setupRole(DEFAULT_ADMIN_ROLE, msg.sender); | ||
| } | ||
|
|
||
| function deposit(uint8 destinationDomainID, string calldata recipientAddress) external payable { | ||
| if (msg.value <= 0) revert InsufficientMsgValueAmount(msg.value); | ||
| address feeHandlerRouter = _bridge._feeHandler(); | ||
| (uint256 fee, ) = IFeeHandler(feeHandlerRouter).calculateFee( | ||
| address(this), | ||
| _bridge._domainID(), | ||
| destinationDomainID, | ||
| _resourceID, | ||
| "", // depositData - not parsed | ||
| "" // feeData - not parsed | ||
| ); | ||
|
|
||
| if (msg.value < fee) revert MsgValueLowerThanFee(msg.value); | ||
| uint256 transferAmount = msg.value - fee; | ||
|
|
||
| bytes memory depositData = abi.encodePacked( | ||
| transferAmount, | ||
| bytes(recipientAddress).length, | ||
| recipientAddress | ||
| ); | ||
|
|
||
| _bridge.deposit{value: fee}(destinationDomainID, _resourceID, depositData, ""); | ||
|
|
||
| address nativeHandlerAddress = _bridge._resourceIDToHandlerAddress(_resourceID); | ||
| (bool success, ) = nativeHandlerAddress.call{value: transferAmount}(""); | ||
| if(!success) revert FailedFundsTransfer(); | ||
| } | ||
|
|
||
| receive() external payable {} | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| // The Licensed Work is (c) 2022 Sygma | ||
| // SPDX-License-Identifier: LGPL-3.0-only | ||
| pragma solidity 0.8.11; | ||
|
|
||
| import "../interfaces/IHandler.sol"; | ||
| import "./ERCHandlerHelpers.sol"; | ||
|
|
||
| /** | ||
| @title Handles native token deposits and deposit executions. | ||
| @author ChainSafe Systems. | ||
| @notice This contract is intended to be used with the Bridge contract. | ||
| */ | ||
| contract NativeTokenHandler is IHandler, ERCHandlerHelpers { | ||
|
|
||
| address public immutable _nativeTokenAdapterAddress; | ||
|
|
||
| /** | ||
| @param bridgeAddress Contract address of previously deployed Bridge. | ||
| */ | ||
| constructor( | ||
| address bridgeAddress, | ||
| address nativeTokenAdapterAddress | ||
| ) ERCHandlerHelpers(bridgeAddress) { | ||
| _nativeTokenAdapterAddress = nativeTokenAdapterAddress; | ||
| } | ||
|
|
||
| event Withdrawal(address recipient, uint256 amount); | ||
| event FundsTransferred(address recipient, uint256 amount); | ||
|
|
||
| error FailedFundsTransfer(); | ||
| error InsufficientBalance(); | ||
| error InvalidSender(address sender); | ||
|
|
||
| /** | ||
| @notice A deposit is initiated by making a deposit to the NativeTokenAdapter which constructs the required | ||
| deposit data and propagates it to the Bridge contract. | ||
| @param resourceID ResourceID used to find address of token to be used for deposit. | ||
| @param depositor Address of account making the deposit in the Bridge contract. | ||
| @param data Consists of {amount} padded to 32 bytes. | ||
| @notice Data passed into the function should be constructed as follows: | ||
| amount uint256 bytes 0 - 32 | ||
| destinationRecipientAddress length uint256 bytes 32 - 64 | ||
| destinationRecipientAddress bytes bytes 64 - END | ||
| @return deposit amount internal representation. | ||
| */ | ||
| function deposit( | ||
| bytes32 resourceID, | ||
| address depositor, | ||
| bytes calldata data | ||
| ) external override onlyBridge returns (bytes memory) { | ||
| uint256 amount; | ||
| (amount) = abi.decode(data, (uint256)); | ||
|
|
||
| if(depositor != _nativeTokenAdapterAddress) revert InvalidSender(depositor); | ||
|
|
||
| address tokenAddress = _resourceIDToTokenContractAddress[resourceID]; | ||
|
|
||
| return abi.encodePacked(convertToInternalBalance(tokenAddress, amount)); | ||
| } | ||
|
|
||
| /** | ||
| @notice Proposal execution should be initiated when a proposal is finalized in the Bridge contract | ||
| by a relayer on the deposit's destination chain. | ||
| @param resourceID ResourceID to be used when making deposits. | ||
| @param data Consists of {amount}, {lenDestinationRecipientAddress} | ||
| and {destinationRecipientAddress}. | ||
| @notice Data passed into the function should be constructed as follows: | ||
| amount uint256 bytes 0 - 32 | ||
| destinationRecipientAddress length uint256 bytes 32 - 64 // not used | ||
| destinationRecipientAddress bytes bytes 64 - 84 | ||
| */ | ||
| function executeProposal(bytes32 resourceID, bytes calldata data) external override onlyBridge returns (bytes memory) { | ||
| (uint256 amount) = abi.decode(data, (uint256)); | ||
| address tokenAddress = _resourceIDToTokenContractAddress[resourceID]; | ||
| address recipientAddress = address(bytes20(bytes(data[64:84]))); | ||
| uint256 convertedAmount = convertToExternalBalance(tokenAddress, amount); | ||
|
|
||
| (bool success, ) = address(recipientAddress).call{value: convertedAmount}(""); | ||
| if(!success) revert FailedFundsTransfer(); | ||
| emit FundsTransferred(recipientAddress, amount); | ||
|
|
||
| return abi.encode(tokenAddress, address(recipientAddress), convertedAmount); | ||
| } | ||
|
|
||
| /** | ||
| @notice Used to manually release ERC20 tokens from ERC20Safe. | ||
| @param data Consists of {tokenAddress}, {recipient}, and {amount} all padded to 32 bytes. | ||
| @notice Data passed into the function should be constructed as follows: | ||
| tokenAddress address bytes 0 - 32 | ||
| recipient address bytes 32 - 64 | ||
| amount uint bytes 64 - 96 | ||
| */ | ||
| function withdraw(bytes memory data) external override onlyBridge { | ||
| address recipient; | ||
| uint amount; | ||
|
|
||
| if (address(this).balance <= amount) revert InsufficientBalance(); | ||
| (, recipient, amount) = abi.decode(data, (address, address, uint)); | ||
|
|
||
| (bool success, ) = address(recipient).call{value: amount}(""); | ||
| if(!success) revert FailedFundsTransfer(); | ||
| emit Withdrawal(recipient, amount); | ||
| } | ||
|
|
||
| /** | ||
| @notice Sets {_resourceIDToContractAddress} with {contractAddress}, | ||
| {_tokenContractAddressToTokenProperties[tokenAddress].resourceID} with {resourceID} and | ||
| {_tokenContractAddressToTokenProperties[tokenAddress].isWhitelisted} to true for {contractAddress} in ERCHandlerHelpers contract. | ||
| Sets decimals value for contractAddress if value is provided in args. | ||
| @param resourceID ResourceID to be used when making deposits. | ||
| @param contractAddress Address of contract to be called when a deposit is made and a deposited is executed. | ||
| @param args Additional data passed to the handler - this should be 1 byte containing number of decimals places. | ||
| */ | ||
| function setResource(bytes32 resourceID, address contractAddress, bytes calldata args) external onlyBridge { | ||
| _setResource(resourceID, contractAddress); | ||
|
|
||
| if (args.length > 0) { | ||
| uint8 externalTokenDecimals = uint8(bytes1(args)); | ||
| _setDecimals(contractAddress, externalTokenDecimals); | ||
| } | ||
| } | ||
|
|
||
| receive() external payable {} | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| // The Licensed Work is (c) 2022 Sygma | ||
| // SPDX-License-Identifier: LGPL-3.0-only | ||
| pragma solidity 0.8.11; | ||
|
|
||
| interface IBasicFeeHandler { | ||
|
|
||
| /** | ||
| @notice Exposes getter function for _domainResourceIDToFee | ||
| */ | ||
| function _domainResourceIDToFee(uint8 destinationDomainID, bytes32 resourceID) pure external returns (uint256); | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| const RetryContract = artifacts.require("Retry"); | ||
|
|
||
| module.exports = async function (deployer) { | ||
| await deployer.deploy(RetryContract); | ||
| const RetryInstance = await RetryContract.deployed(); | ||
|
|
||
| console.table({ | ||
| "Retry Address": RetryInstance.address, | ||
| }); | ||
| } |
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
Oops, something went wrong.