Description:
Multi-signature wallet contract requiring multiple confirmations for transaction execution.
Blockchain: Ethereum
Source Code: View Code On The Blockchain
Solidity Source Code:
{{
"language": "Solidity",
"sources": {
"@chainlink/contracts-ccip/contracts/interfaces/IRouterClient.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.4;
import {Client} from "../libraries/Client.sol";
interface IRouterClient {
error UnsupportedDestinationChain(uint64 destChainSelector);
error InsufficientFeeTokenAmount();
error InvalidMsgValue();
/// @notice Checks if the given chain ID is supported for sending/receiving.
/// @param destChainSelector The chain to check.
/// @return supported is true if it is supported, false if not.
function isChainSupported(
uint64 destChainSelector
) external view returns (bool supported);
/// @param destinationChainSelector The destination chainSelector.
/// @param message The cross-chain CCIP message including data and/or tokens.
/// @return fee returns execution fee for the message.
/// delivery to destination chain, denominated in the feeToken specified in the message.
/// @dev Reverts with appropriate reason upon invalid message.
function getFee(
uint64 destinationChainSelector,
Client.EVM2AnyMessage memory message
) external view returns (uint256 fee);
/// @notice Request a message to be sent to the destination chain.
/// @param destinationChainSelector The destination chain ID.
/// @param message The cross-chain CCIP message including data and/or tokens.
/// @return messageId The message ID.
/// @dev Note if msg.value is larger than the required fee (from getFee) we accept.
/// the overpayment with no refund.
/// @dev Reverts with appropriate reason upon invalid message.
function ccipSend(
uint64 destinationChainSelector,
Client.EVM2AnyMessage calldata message
) external payable returns (bytes32);
}
"
},
"@chainlink/contracts-ccip/contracts/libraries/Client.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
// End consumer library.
library Client {
/// @dev RMN depends on this struct, if changing, please notify the RMN maintainers.
struct EVMTokenAmount {
address token; // token address on the local chain.
uint256 amount; // Amount of tokens.
}
struct Any2EVMMessage {
bytes32 messageId; // MessageId corresponding to ccipSend on source.
uint64 sourceChainSelector; // Source chain selector.
bytes sender; // abi.decode(sender) if coming from an EVM chain.
bytes data; // payload sent in original message.
EVMTokenAmount[] destTokenAmounts; // Tokens and their amounts in their destination chain representation.
}
// If extraArgs is empty bytes, the default is 200k gas limit.
struct EVM2AnyMessage {
bytes receiver; // abi.encode(receiver address) for dest EVM chains.
bytes data; // Data payload.
EVMTokenAmount[] tokenAmounts; // Token transfers.
address feeToken; // Address of feeToken. address(0) means you will send msg.value.
bytes extraArgs; // Populate this with _argsToBytes(EVMExtraArgsV2).
}
// Tag to indicate only a gas limit. Only usable for EVM as destination chain.
bytes4 public constant EVM_EXTRA_ARGS_V1_TAG = 0x97a657c9;
struct EVMExtraArgsV1 {
uint256 gasLimit;
}
function _argsToBytes(
EVMExtraArgsV1 memory extraArgs
) internal pure returns (bytes memory bts) {
return abi.encodeWithSelector(EVM_EXTRA_ARGS_V1_TAG, extraArgs);
}
// Tag to indicate a gas limit (or dest chain equivalent processing units) and Out Of Order Execution. This tag is
// available for multiple chain families. If there is no chain family specific tag, this is the default available
// for a chain.
// Note: not available for Solana VM based chains.
bytes4 public constant GENERIC_EXTRA_ARGS_V2_TAG = 0x181dcf10;
/// @param gasLimit: gas limit for the callback on the destination chain.
/// @param allowOutOfOrderExecution: if true, it indicates that the message can be executed in any order relative to
/// other messages from the same sender. This value's default varies by chain. On some chains, a particular value is
/// enforced, meaning if the expected value is not set, the message request will revert.
/// @dev Fully compatible with the previously existing EVMExtraArgsV2.
struct GenericExtraArgsV2 {
uint256 gasLimit;
bool allowOutOfOrderExecution;
}
// Extra args tag for chains that use the Sui VM.
bytes4 public constant SUI_EXTRA_ARGS_V1_TAG = 0x21ea4ca9;
// Extra args tag for chains that use the Solana VM.
bytes4 public constant SVM_EXTRA_ARGS_V1_TAG = 0x1f3b3aba;
struct SVMExtraArgsV1 {
uint32 computeUnits;
uint64 accountIsWritableBitmap;
bool allowOutOfOrderExecution;
bytes32 tokenReceiver;
// Additional accounts needed for execution of CCIP receiver. Must be empty if message.receiver is zero.
// Token transfer related accounts are specified in the token pool lookup table on SVM.
bytes32[] accounts;
}
/// @dev The maximum number of accounts that can be passed in SVMExtraArgs.
uint256 public constant SVM_EXTRA_ARGS_MAX_ACCOUNTS = 64;
/// @dev The expected static payload size of a token transfer when Borsh encoded and submitted to SVM.
/// TokenPool extra data and offchain data sizes are dynamic, and should be accounted for separately.
uint256 public constant SVM_TOKEN_TRANSFER_DATA_OVERHEAD = (4 + 32) // source_pool
+ 32 // token_address
+ 4 // gas_amount
+ 4 // extra_data overhead
+ 32 // amount
+ 32 // size of the token lookup table account
+ 32 // token-related accounts in the lookup table, over-estimated to 32, typically between 11 - 13
+ 32 // token account belonging to the token receiver, e.g ATA, not included in the token lookup table
+ 32 // per-chain token pool config, not included in the token lookup table
+ 32 // per-chain token billing config, not always included in the token lookup table
+ 32; // OffRamp pool signer PDA, not included in the token lookup table
/// @dev Number of overhead accounts needed for message execution on SVM.
/// @dev These are message.receiver, and the OffRamp Signer PDA specific to the receiver.
uint256 public constant SVM_MESSAGING_ACCOUNTS_OVERHEAD = 2;
/// @dev The size of each SVM account address in bytes.
uint256 public constant SVM_ACCOUNT_BYTE_SIZE = 32;
struct SuiExtraArgsV1 {
uint256 gasLimit;
bool allowOutOfOrderExecution;
bytes32 tokenReceiver;
bytes32[] receiverObjectIds;
}
/// @dev The expected static payload size of a token transfer when Borsh encoded and submitted to SUI.
/// TokenPool extra data and offchain data sizes are dynamic, and should be accounted for separately.
uint256 public constant SUI_TOKEN_TRANSFER_DATA_OVERHEAD = (4 + 32) // source_pool
+ 32 // token_address
+ 4 // gas_amount
+ 4 // extra_data overhead
+ 32 // amount
+ 32 // size of the token lookup table account
+ 32 // token-related accounts in the lookup table, over-estimated to 32, typically between 11 - 13
+ 32 // token account belonging to the token receiver, e.g ATA, not included in the token lookup table
+ 32 // per-chain token pool config, not included in the token lookup table
+ 32; // per-chain token billing config, not always included in the token lookup table
/// @dev Number of overhead accounts needed for message execution on SUI.
/// @dev This is the message.receiver.
uint256 public constant SUI_MESSAGING_ACCOUNTS_OVERHEAD = 1;
/// @dev The maximum number of receiver object ids that can be passed in SuiExtraArgs.
uint256 public constant SUI_EXTRA_ARGS_MAX_RECEIVER_OBJECT_IDS = 64;
/// @dev The size of each SUI account address in bytes.
uint256 public constant SUI_ACCOUNT_BYTE_SIZE = 32;
function _argsToBytes(
GenericExtraArgsV2 memory extraArgs
) internal pure returns (bytes memory bts) {
return abi.encodeWithSelector(GENERIC_EXTRA_ARGS_V2_TAG, extraArgs);
}
function _svmArgsToBytes(
SVMExtraArgsV1 memory extraArgs
) internal pure returns (bytes memory bts) {
return abi.encodeWithSelector(SVM_EXTRA_ARGS_V1_TAG, extraArgs);
}
function _suiArgsToBytes(
SuiExtraArgsV1 memory extraArgs
) internal pure returns (bytes memory bts) {
return abi.encodeWithSelector(SUI_EXTRA_ARGS_V1_TAG, extraArgs);
}
/// @notice The CCV struct is used to represent a cross-chain verifier.
struct CCV {
/// @param The ccvAddress is the address of the verifier contract on the source chain
address ccvAddress;
/// @param args The args are the arguments that the verifier contract expects. They are opaque to CCIP and are only
/// used in the CCV.
bytes args;
}
bytes4 public constant GENERIC_EXTRA_ARGS_V3_TAG = 0x302326cb;
struct EVMExtraArgsV3 {
CCV[] requiredCCV;
CCV[] optionalCCV;
uint8 optionalThreshold;
/// @notice The finality config, 0 means the default finality that the CCV considers final. Any non-zero value means
/// a block depth.
uint16 finalityConfig;
address executor;
bytes executorArgs;
bytes tokenArgs;
}
function _argsToBytes(
EVMExtraArgsV3 memory extraArgs
) internal pure returns (bytes memory bts) {
return abi.encodeWithSelector(GENERIC_EXTRA_ARGS_V3_TAG, extraArgs);
}
}
"
},
"@chainlink/contracts/src/v0.8/shared/access/ConfirmedOwner.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {ConfirmedOwnerWithProposal} from "./ConfirmedOwnerWithProposal.sol";
/// @title The ConfirmedOwner contract
/// @notice A contract with helpers for basic contract ownership.
contract ConfirmedOwner is ConfirmedOwnerWithProposal {
constructor(
address newOwner
) ConfirmedOwnerWithProposal(newOwner, address(0)) {}
}
"
},
"@chainlink/contracts/src/v0.8/shared/access/ConfirmedOwnerWithProposal.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {IOwnable} from "../interfaces/IOwnable.sol";
/// @title The ConfirmedOwner contract
/// @notice A contract with helpers for basic contract ownership.
contract ConfirmedOwnerWithProposal is IOwnable {
address private s_owner;
address private s_pendingOwner;
event OwnershipTransferRequested(address indexed from, address indexed to);
event OwnershipTransferred(address indexed from, address indexed to);
constructor(address newOwner, address pendingOwner) {
// solhint-disable-next-line gas-custom-errors
require(newOwner != address(0), "Cannot set owner to zero");
s_owner = newOwner;
if (pendingOwner != address(0)) {
_transferOwnership(pendingOwner);
}
}
/// @notice Allows an owner to begin transferring ownership to a new address.
function transferOwnership(
address to
) public override onlyOwner {
_transferOwnership(to);
}
/// @notice Allows an ownership transfer to be completed by the recipient.
function acceptOwnership() external override {
// solhint-disable-next-line gas-custom-errors
require(msg.sender == s_pendingOwner, "Must be proposed owner");
address oldOwner = s_owner;
s_owner = msg.sender;
s_pendingOwner = address(0);
emit OwnershipTransferred(oldOwner, msg.sender);
}
/// @notice Get the current owner
function owner() public view override returns (address) {
return s_owner;
}
/// @notice validate, transfer ownership, and emit relevant events
function _transferOwnership(
address to
) private {
// solhint-disable-next-line gas-custom-errors
require(to != msg.sender, "Cannot transfer to self");
s_pendingOwner = to;
emit OwnershipTransferRequested(s_owner, to);
}
/// @notice validate access
function _validateOwnership() internal view {
// solhint-disable-next-line gas-custom-errors
require(msg.sender == s_owner, "Only callable by owner");
}
/// @notice Reverts if called by anyone other than the contract owner.
modifier onlyOwner() {
_validateOwnership();
_;
}
}
"
},
"@chainlink/contracts/src/v0.8/shared/access/OwnerIsCreator.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import {ConfirmedOwner} from "./ConfirmedOwner.sol";
/// @title The OwnerIsCreator contract
/// @notice A contract with helpers for basic contract ownership.
contract OwnerIsCreator is ConfirmedOwner {
constructor() ConfirmedOwner(msg.sender) {}
}
"
},
"@chainlink/contracts/src/v0.8/shared/interfaces/IOwnable.sol": {
"content": "// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
interface IOwnable {
function owner() external returns (address);
function transferOwnership(
address recipient
) external;
function acceptOwnership() external;
}
"
},
"@openzeppelin/contracts/security/ReentrancyGuard.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuard {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant _NOT_ENTERED = 1;
uint256 private constant _ENTERED = 2;
uint256 private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
"
},
"@openzeppelin/contracts/token/ERC20/extensions/draft-IERC20Permit.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
"
},
"@openzeppelin/contracts/token/ERC20/IERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address from,
address to,
uint256 amount
) external returns (bool);
}
"
},
"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20.sol";
import "../extensions/draft-IERC20Permit.sol";
import "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(
IERC20 token,
address spender,
uint256 value
) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
function safeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
function safePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length > 0) {
// Return data is optional
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
"
},
"@openzeppelin/contracts/utils/Address.sol": {
"content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
"
},
"contracts/TokenTransferor.sol": {
"content": "// SPDX-License-Identifier: MIT\r
pragma solidity 0.8.24;\r
\r
import {IRouterClient} from "@chainlink/contracts-ccip/contracts/interfaces/IRouterClient.sol";\r
import {OwnerIsCreator} from "@chainlink/contracts/src/v0.8/shared/access/OwnerIsCreator.sol";\r
import {Client} from "@chainlink/contracts-ccip/contracts/libraries/Client.sol";\r
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";\r
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";\r
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";\r
/**\r
* THIS IS AN EXAMPLE CONTRACT THAT USES HARDCODED VALUES FOR CLARITY.\r
* THIS IS AN EXAMPLE CONTRACT THAT USES UN-AUDITED CODE.\r
* DO NOT USE THIS CODE IN PRODUCTION.\r
*/\r
\r
/// @title - A simple contract for transferring tokens across chains.\r
contract TokenTransferor is OwnerIsCreator,ReentrancyGuard {\r
using SafeERC20 for IERC20;\r
\r
// Custom errors to provide more descriptive revert messages.\r
error NotEnoughBalance(uint256 currentBalance, uint256 requiredBalance); // Used to make sure contract has enough token balance\r
error NothingToWithdraw(); // Used when trying to withdraw Ether but there's nothing to withdraw.\r
error FailedToWithdrawEth(address owner, address target, uint256 value); // Used when the withdrawal of Ether fails.\r
error DestinationChainNotAllowlisted(uint64 destinationChainSelector); // Used when the destination chain has not been allowlisted by the contract owner.\r
error InvalidReceiverAddress(); // Used when the receiver address is 0.\r
// Event emitted when the tokens are transferred to an account on another chain.\r
event TokensTransferred(\r
bytes32 indexed messageId, // The unique ID of the message.\r
uint64 indexed destinationChainSelector, // The chain selector of the destination chain.\r
address receiver, // The address of the receiver on the destination chain.\r
address token, // The token address that was transferred.\r
uint256 tokenAmount, // The token amount that was transferred.\r
address feeToken, // the token address used to pay CCIP fees.\r
uint256 fees // The fees paid for sending the message.\r
);\r
\r
// Mapping to keep track of allowlisted destination chains.\r
mapping(uint64 => bool) public allowlistedChains;\r
\r
IRouterClient private s_router;\r
\r
IERC20 private s_linkToken;\r
\r
/// @notice Constructor initializes the contract with the router address.\r
/// @param _router The address of the router contract.\r
/// @param _link The address of the link contract.\r
constructor(address _router, address _link) {\r
s_router = IRouterClient(_router);\r
s_linkToken = IERC20(_link);\r
}\r
\r
/// @dev Modifier that checks if the chain with the given destinationChainSelector is allowlisted.\r
/// @param _destinationChainSelector The selector of the destination chain.\r
modifier onlyAllowlistedChain(uint64 _destinationChainSelector) {\r
if (!allowlistedChains[_destinationChainSelector])\r
revert DestinationChainNotAllowlisted(_destinationChainSelector);\r
_;\r
}\r
\r
/// @dev Modifier that checks the receiver address is not 0.\r
/// @param _receiver The receiver address.\r
modifier validateReceiver(address _receiver) {\r
if (_receiver == address(0)) revert InvalidReceiverAddress();\r
_;\r
}\r
\r
/// @dev Updates the allowlist status of a destination chain for transactions.\r
/// @notice This function can only be called by the owner.\r
/// @param _destinationChainSelector The selector of the destination chain to be updated.\r
/// @param allowed The allowlist status to be set for the destination chain.\r
function allowlistDestinationChain(\r
uint64 _destinationChainSelector,\r
bool allowed\r
) external onlyOwner {\r
allowlistedChains[_destinationChainSelector] = allowed;\r
}\r
\r
/// @notice Transfer tokens to receiver on the destination chain.\r
/// @notice pay in LINK.\r
/// @notice the token must be in the list of supported tokens.\r
/// @notice This function can only be called by the owner.\r
/// @dev Assumes your contract has sufficient LINK tokens to pay for the fees.\r
/// @param _destinationChainSelector The identifier (aka selector) for the destination blockchain.\r
/// @param _receiver The address of the recipient on the destination blockchain.\r
/// @param _token token address.\r
/// @param _amount token amount.\r
/// @return messageId The ID of the message that was sent.\r
function transferTokensPayLINK(\r
uint64 _destinationChainSelector,\r
address _receiver,\r
address _token,\r
uint256 _amount\r
)\r
external\r
onlyAllowlistedChain(_destinationChainSelector)\r
validateReceiver(_receiver)\r
nonReentrant \r
returns (bytes32 messageId)\r
{\r
// Create an EVM2AnyMessage struct in memory with necessary information for sending a cross-chain message\r
// address(linkToken) means fees are paid in LINK\r
Client.EVM2AnyMessage memory evm2AnyMessage = _buildCCIPMessage(\r
_receiver,\r
_token,\r
_amount,\r
address(s_linkToken)\r
);\r
\r
// Get the fee required to send the message\r
uint256 fees = s_router.getFee(\r
_destinationChainSelector,\r
evm2AnyMessage\r
);\r
\r
uint256 requiredLinkBalance;\r
if (_token == address(s_linkToken)) {\r
// Required LINK Balance is the sum of fees and amount to transfer, if the token to transfer is LINK\r
requiredLinkBalance = fees + _amount;\r
} else {\r
requiredLinkBalance = fees;\r
}\r
\r
// If sending a token other than LINK, approve it separately\r
if (_token != address(s_linkToken)) {\r
//transferFrom user to contract\r
IERC20(_token).transferFrom(address(msg.sender), address(this), _amount);\r
// approve the Router to spend tokens on contract's behalf. It will spend the amount of the given token\r
IERC20(_token).approve(address(s_router), _amount);\r
}\r
s_linkToken.transferFrom(address(msg.sender), address(this), requiredLinkBalance);\r
// approve the Router to transfer LINK tokens on contract's behalf. It will spend the requiredLinkBalance\r
s_linkToken.approve(address(s_router), requiredLinkBalance); \r
\r
//------------------\r
// Send the message through the router and store the returned message ID\r
messageId = s_router.ccipSend(\r
_destinationChainSelector,\r
evm2AnyMessage\r
);\r
\r
// Emit an event with message details\r
emit TokensTransferred(\r
messageId,\r
_destinationChainSelector,\r
_receiver,\r
_token,\r
_amount,\r
address(s_linkToken),\r
fees\r
);\r
\r
// Return the message ID\r
return messageId;\r
}\r
\r
/// @notice Transfer tokens to receiver on the destination chain.\r
/// @notice Pay in native gas such as ETH on Ethereum or POL on Polygon.\r
/// @notice the token must be in the list of supported tokens.\r
/// @notice This function can only be called by the owner.\r
/// @dev Assumes your contract has sufficient native gas like ETH on Ethereum or POL on Polygon.\r
/// @param _destinationChainSelector The identifier (aka selector) for the destination blockchain.\r
/// @param _receiver The address of the recipient on the destination blockchain.\r
/// @param _token token address.\r
/// @param _amount token amount.\r
/// @return messageId The ID of the message that was sent.\r
function transferTokensPayNative(\r
uint64 _destinationChainSelector,\r
address _receiver,\r
address _token,\r
uint256 _amount\r
)\r
external payable \r
onlyAllowlistedChain(_destinationChainSelector)\r
validateReceiver(_receiver)\r
nonReentrant \r
returns (bytes32 messageId)\r
{\r
// Create an EVM2AnyMessage struct in memory with necessary information for sending a cross-chain message\r
// address(0) means fees are paid in native gas\r
Client.EVM2AnyMessage memory evm2AnyMessage = _buildCCIPMessage(\r
_receiver,\r
_token,\r
_amount,\r
address(0)\r
);\r
\r
// Get the fee required to send the message\r
uint256 fees = s_router.getFee(\r
_destinationChainSelector,\r
evm2AnyMessage\r
);\r
\r
\r
//-----------\r
if (fees > address(this).balance)\r
revert NotEnoughBalance(address(this).balance, fees);\r
\r
//transferFrom user to contract\r
IERC20(_token).transferFrom(address(msg.sender), address(this), _amount);\r
// approve the Router to spend tokens on contract's behalf. It will spend the amount of the given token\r
IERC20(_token).approve(address(s_router), _amount);\r
\r
// Send the message through the router and store the returned message ID\r
messageId = s_router.ccipSend{value: fees}(\r
_destinationChainSelector,\r
evm2AnyMessage\r
);\r
\r
//transfer Remaining gas to user\r
\r
\r
\r
uint256 remainingFee=msg.value-fees;\r
if(remainingFee>0){\r
(bool success,)=address(msg.sender).call{value:msg.value-fees}("");\r
require(success, "transfer fail");\r
}\r
// Emit an event with message details\r
emit TokensTransferred(\r
messageId,\r
_destinationChainSelector,\r
_receiver,\r
_token,\r
_amount,\r
address(0),\r
fees\r
);\r
\r
// Return the message ID\r
return messageId;\r
}\r
\r
\r
function getFee(uint64 _destinationChainSelector,\r
address _receiver,\r
address _token,\r
uint256 _amount) public view returns(uint256){\r
// Create an EVM2AnyMessage struct in memory with necessary information for sending a cross-chain message\r
// address(0) means fees are paid in native gas\r
Client.EVM2AnyMessage memory evm2AnyMessage = _buildCCIPMessage(\r
_receiver,\r
_token,\r
_amount,\r
address(0)\r
);\r
\r
// Get the fee required to send the message\r
uint256 fees = s_router.getFee(\r
_destinationChainSelector,\r
evm2AnyMessage\r
);\r
return fees; \r
}\r
\r
\r
/// @notice Construct a CCIP message.\r
/// @dev This function will create an EVM2AnyMessage struct with all the necessary information for tokens transfer.\r
/// @param _receiver The address of the receiver.\r
/// @param _token The token to be transferred.\r
/// @param _amount The amount of the token to be transferred.\r
/// @param _feeTokenAddress The address of the token used for fees. Set address(0) for native gas.\r
/// @return Client.EVM2AnyMessage Returns an EVM2AnyMessage struct which contains information for sending a CCIP message.\r
function _buildCCIPMessage(\r
address _receiver,\r
address _token,\r
uint256 _amount,\r
address _feeTokenAddress\r
) private pure returns (Client.EVM2AnyMessage memory) {\r
// Set the token amounts\r
Client.EVMTokenAmount[]\r
memory tokenAmounts = new Client.EVMTokenAmount[](1);\r
tokenAmounts[0] = Client.EVMTokenAmount({\r
token: _token,\r
amount: _amount\r
});\r
\r
// Create an EVM2AnyMessage struct in memory with necessary information for sending a cross-chain message\r
return\r
Client.EVM2AnyMessage({\r
receiver: abi.encode(_receiver), // ABI-encoded receiver address\r
data: "", // No data\r
tokenAmounts: tokenAmounts, // The amount and type of token being transferred\r
extraArgs: Client._argsToBytes(\r
// Additional arguments, setting gas limit and allowing out-of-order execution.\r
// Best Practice: For simplicity, the values are hardcoded. It is advisable to use a more dynamic approach\r
// where you set the extra arguments off-chain. This allows adaptation depending on the lanes, messages,\r
// and ensures compatibility with future CCIP upgrades. Read more about it here: https://docs.chain.link/ccip/concepts/best-practices/evm#using-extraargs\r
Client.GenericExtraArgsV2({\r
gasLimit: 0, // Gas limit for the callback on the destination chain\r
allowOutOfOrderExecution: true // Allows the message to be executed out of order relative to other messages from the same sender\r
})\r
),\r
// Set the feeToken to a feeTokenAddress, indicating specific asset will be used for fees\r
feeToken: _feeTokenAddress\r
});\r
}\r
\r
/// @notice Fallback function to allow the contract to receive Ether.\r
/// @dev This function has no function body, making it a default function for receiving Ether.\r
/// It is automatically called when Ether is transferred to the contract without any data.\r
receive() external payable {}\r
\r
/// @notice Allows the contract owner to withdraw the entire balance of Ether from the contract.\r
/// @dev This function reverts if there are no funds to withdraw or if the transfer fails.\r
/// It should only be callable by the owner of the contract.\r
/// @param _beneficiary The address to which the Ether should be transferred.\r
function withdraw(address _beneficiary) public onlyOwner {\r
// Retrieve the balance of this contract\r
uint256 amount = address(this).balance;\r
\r
// Revert if there is nothing to withdraw\r
if (amount == 0) revert NothingToWithdraw();\r
\r
// Attempt to send the funds, capturing the success status and discarding any return data\r
(bool sent, ) = _beneficiary.call{value: amount}("");\r
\r
// Revert if the send failed, with information about the attempted transfer\r
if (!sent) revert FailedToWithdrawEth(msg.sender, _beneficiary, amount);\r
}\r
\r
/// @notice Allows the owner of the contract to withdraw all tokens of a specific ERC20 token.\r
/// @dev This function reverts with a 'NothingToWithdraw' error if there are no tokens to withdraw.\r
/// @param _beneficiary The address to which the tokens will be sent.\r
/// @param _token The contract address of the ERC20 token to be withdrawn.\r
function withdrawToken(\r
address _beneficiary,\r
address _token\r
) public onlyOwner {\r
// Retrieve the balance of this contract\r
uint256 amount = IERC20(_token).balanceOf(address(this));\r
\r
// Revert if there is nothing to withdraw\r
if (amount == 0) revert NothingToWithdraw();\r
\r
IERC20(_token).safeTransfer(_beneficiary, amount);\r
}\r
}\r
"
}
},
"settings": {
"optimizer": {
"enabled": true,
"runs": 200
},
"evmVersion": "paris",
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
}
}
}}
Submitted on: 2025-10-27 13:14:43
Comments
Log in to comment.
No comments yet.