Transaction Hash:
Block:
21687404 at Jan-23-2025 01:10:59 PM +UTC
Transaction Fee:
0.000913237143363131 ETH
$2.23
Gas Used:
115,177 Gas / 7.928988803 Gwei
Emitted Events:
298 |
KeyManager.SignatureAccepted( sigData=[{name:sig, type:uint256, order:1, indexed:false, value:1676386720411743461186831916538307292074860032601112902217130180287891230167, valueString:1676386720411743461186831916538307292074860032601112902217130180287891230167}, {name:nonce, type:uint256, order:2, indexed:false, value:47002, valueString:47002}, {name:kTimesGAddress, type:address, order:3, indexed:false, value:0x2104097E11aBA832BA2fb3afaFAc0240f6826a29, valueString:0x2104097E11aBA832BA2fb3afaFAc0240f6826a29}], signer=[Sender] 0xbd83375ede804c28dda3fe5b0741beb440606ef9 )
|
299 |
FiatTokenProxy.0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef( 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef, 0x000000000000000000000000f5e10380213880111522dd0efd3dbb45b9f62bcc, 0x00000000000000000000000099dd206bacd56e5f2469d96decbd411af76855dd, 000000000000000000000000000000000000000000000000000000068b979e26 )
|
Account State Difference:
Address | Before | After | State Difference | ||
---|---|---|---|---|---|
0x95222290...5CC4BAfe5
Miner
| (beaverbuild) | 16.189803785771953686 Eth | 16.189918962771953686 Eth | 0.000115177 | |
0xA0b86991...E3606eB48 | |||||
0xBd83375E...440606ef9 |
0.236894373137211447 Eth
Nonce: 253
|
0.235981135993848316 Eth
Nonce: 254
| 0.000913237143363131 | ||
0xcd351d36...68eBf08Be |
Execution Trace
Vault.allBatch( sigData=[{name:sig, type:uint256, order:1, indexed:false, value:1676386720411743461186831916538307292074860032601112902217130180287891230167, valueString:1676386720411743461186831916538307292074860032601112902217130180287891230167}, {name:nonce, type:uint256, order:2, indexed:false, value:47002, valueString:47002}, {name:kTimesGAddress, type:address, order:3, indexed:false, value:0x2104097E11aBA832BA2fb3afaFAc0240f6826a29, valueString:0x2104097E11aBA832BA2fb3afaFAc0240f6826a29}], deployFetchParamsArray=, fetchParamsArray=, transferParamsArray= )
KeyManager.consumeKeyNonce( sigData=[{name:sig, type:uint256, order:1, indexed:false, value:1676386720411743461186831916538307292074860032601112902217130180287891230167, valueString:1676386720411743461186831916538307292074860032601112902217130180287891230167}, {name:nonce, type:uint256, order:2, indexed:false, value:47002, valueString:47002}, {name:kTimesGAddress, type:address, order:3, indexed:false, value:0x2104097E11aBA832BA2fb3afaFAc0240f6826a29, valueString:0x2104097E11aBA832BA2fb3afaFAc0240f6826a29}], contractMsgHash=9BCC2E82F63709046B50A591298023328E039D2450F3E7DC71C26FAE1BFD1B79 )
-
Null: 0x000...001.a99313de( )
-
FiatTokenProxy.a9059cbb( )
-
FiatTokenV2_2.transfer( to=0x99Dd206BAcD56E5F2469d96DecbD411aF76855dD, value=28111773222 ) => ( True )
-
allBatch[Vault (ln:78)]
_deployAndFetchBatch[Vault (ln:93)]
_fetchBatch[Vault (ln:95)]
fetch[Vault (ln:290)]
_transferBatch[Vault (ln:97)]
_transfer[Vault (ln:197)]
call[Vault (ln:218)]
TransferNativeFailed[Vault (ln:220)]
call[Vault (ln:224)]
encodeWithSelector[Vault (ln:225)]
decode[Vault (ln:228)]
TransferTokenFailed[Vault (ln:229)]
encode[Vault (ln:89)]
File 1 of 4: Vault
File 2 of 4: KeyManager
File 3 of 4: FiatTokenProxy
File 4 of 4: FiatTokenV2_2
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "SafeERC20.sol"; import "IVault.sol"; import "IKeyManager.sol"; import "ICFReceiver.sol"; import "Shared.sol"; import "Deposit.sol"; import "AggKeyNonceConsumer.sol"; import "GovernanceCommunityGuarded.sol"; /** * @title Vault contract * @notice The vault for holding and transferring native or ERC20 tokens and deploying contracts for * fetching individual deposits. It also allows users to do cross-chain swaps and(or) calls by * making a function call directly to this contract. */ contract Vault is IVault, AggKeyNonceConsumer, GovernanceCommunityGuarded { using SafeERC20 for IERC20; uint256 private constant _AGG_KEY_EMERGENCY_TIMEOUT = 3 days; uint256 private constant _GAS_TO_FORWARD = 8_000; uint256 private constant _FINALIZE_GAS_BUFFER = 30_000; constructor(IKeyManager keyManager) AggKeyNonceConsumer(keyManager) {} /// @dev Get the governor address from the KeyManager. This is called by the onlyGovernor /// modifier in the GovernanceCommunityGuarded. This logic can't be moved to the /// GovernanceCommunityGuarded since it requires a reference to the KeyManager. function _getGovernor() internal view override returns (address) { return getKeyManager().getGovernanceKey(); } /// @dev Get the community key from the KeyManager. This is called by the isCommunityKey /// modifier in the GovernanceCommunityGuarded. This logic can't be moved to the /// GovernanceCommunityGuarded since it requires a reference to the KeyManager. function _getCommunityKey() internal view override returns (address) { return getKeyManager().getCommunityKey(); } /// @dev Ensure that a new keyManager has the getGovernanceKey(), getCommunityKey() /// and getLastValidateTime() are implemented. These are functions required for /// this contract to at least be able to use the emergency mechanism. function _checkUpdateKeyManager(IKeyManager keyManager, bool omitChecks) internal view override { address newGovKey = keyManager.getGovernanceKey(); address newCommKey = keyManager.getCommunityKey(); uint256 lastValidateTime = keyManager.getLastValidateTime(); if (!omitChecks) { // Ensure that the keys are the same require(newGovKey == _getGovernor() && newCommKey == _getCommunityKey()); Key memory newAggKey = keyManager.getAggregateKey(); Key memory currentAggKey = getKeyManager().getAggregateKey(); require( newAggKey.pubKeyX == currentAggKey.pubKeyX && newAggKey.pubKeyYParity == currentAggKey.pubKeyYParity ); // Ensure that the last validate time is not in the future require(lastValidateTime <= block.timestamp); } else { // Check that the addresses have been initialized require(newGovKey != address(0) && newCommKey != address(0)); } } ////////////////////////////////////////////////////////////// // // // Transfer and Fetch // // // ////////////////////////////////////////////////////////////// /** * @notice Can do a combination of all fcns in this contract. It first fetches all * deposits , then it performs all transfers specified with the rest * of the inputs, the same as transferBatch (where all inputs are again required * to be of equal length - however the lengths of the fetch inputs do not have to * be equal to lengths of the transfer inputs). Fetches/transfers of native tokens are * indicated with 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE as the token address. * @dev FetchAndDeploy is executed first to handle the edge case , which probably shouldn't * happen anyway, where a deploy and a fetch for the same address are in the same batch. * Transfers are executed last to ensure that all fetching has been completed first. * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param deployFetchParamsArray The array of deploy and fetch parameters * @param fetchParamsArray The array of fetch parameters * @param transferParamsArray The array of transfer parameters */ function allBatch( SigData calldata sigData, DeployFetchParams[] calldata deployFetchParamsArray, FetchParams[] calldata fetchParamsArray, TransferParams[] calldata transferParamsArray ) external override onlyNotSuspended consumesKeyNonce( sigData, keccak256(abi.encode(this.allBatch.selector, deployFetchParamsArray, fetchParamsArray, transferParamsArray)) ) { // Fetch by deploying new deposits _deployAndFetchBatch(deployFetchParamsArray); // Fetch from already deployed deposits _fetchBatch(fetchParamsArray); // Send all transfers _transferBatch(transferParamsArray); } /** * @notice Same functionality as allBatch but removing the contract deployments * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param fetchParamsArray The array of fetch parameters * @param transferParamsArray The array of transfer parameters */ function allBatchV2( SigData calldata sigData, FetchParams[] calldata fetchParamsArray, TransferParams[] calldata transferParamsArray ) external override onlyNotSuspended consumesKeyNonce( sigData, keccak256(abi.encode(this.allBatchV2.selector, fetchParamsArray, transferParamsArray)) ) { // Fetch from already deployed deposits _fetchBatch(fetchParamsArray); // Send all transfers _transferBatch(transferParamsArray); } ////////////////////////////////////////////////////////////// // // // Transfers // // // ////////////////////////////////////////////////////////////// /** * @notice Transfers native tokens or a ERC20 token from this vault to a recipient * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param transferParams The transfer parameters */ function transfer( SigData calldata sigData, TransferParams calldata transferParams ) external override onlyNotSuspended nzAddr(transferParams.token) nzAddr(transferParams.recipient) nzUint(transferParams.amount) consumesKeyNonce(sigData, keccak256(abi.encode(this.transfer.selector, transferParams))) { _transfer(transferParams.token, transferParams.recipient, transferParams.amount); } /** * @notice Fallback transfer tokens from this vault to a recipient with all the gas. * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param transferParams The transfer parameters */ function transferFallback( SigData calldata sigData, TransferParams calldata transferParams ) external onlyNotSuspended nzAddr(transferParams.token) nzAddr(transferParams.recipient) nzUint(transferParams.amount) consumesKeyNonce(sigData, keccak256(abi.encode(this.transferFallback.selector, transferParams))) { if (transferParams.token == _NATIVE_ADDR) { (bool success, ) = transferParams.recipient.call{value: transferParams.amount}(""); require(success, "Vault: transfer fallback failed"); } else { IERC20(transferParams.token).safeTransfer(transferParams.recipient, transferParams.amount); } } /** * @notice Transfers native tokens or ERC20 tokens from this vault to recipients. * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param transferParamsArray The array of transfer parameters. */ function transferBatch( SigData calldata sigData, TransferParams[] calldata transferParamsArray ) external override onlyNotSuspended consumesKeyNonce(sigData, keccak256(abi.encode(this.transferBatch.selector, transferParamsArray))) { _transferBatch(transferParamsArray); } /** * @notice Transfers native tokens or ERC20 tokens from this vault to recipients. * @param transferParamsArray The array of transfer parameters. */ function _transferBatch(TransferParams[] calldata transferParamsArray) private { uint256 length = transferParamsArray.length; for (uint256 i = 0; i < length; ) { _transfer(transferParamsArray[i].token, transferParamsArray[i].recipient, transferParamsArray[i].amount); unchecked { ++i; } } } /** * @notice Transfers ETH or a token from this vault to a recipient * @dev When transfering native tokens, using call function limiting the amount of gas so * the receivers can't consume all the gas. Setting that amount of gas to more than * 2300 to future-proof the contract in case of opcode gas costs changing. * @dev When transferring ERC20 tokens, if it fails ensure the transfer fails gracefully * to not revert an entire batch. e.g. usdc blacklisted recipient. Following safeTransfer * approach to support tokens that don't return a bool. * @param token The address of the token to be transferred * @param recipient The address of the recipient of the transfer * @param amount The amount to transfer, in wei (uint) */ function _transfer(address token, address payable recipient, uint256 amount) private { if (address(token) == _NATIVE_ADDR) { // solhint-disable-next-line avoid-low-level-calls (bool success, ) = recipient.call{gas: _GAS_TO_FORWARD, value: amount}(""); if (!success) { emit TransferNativeFailed(recipient, amount); } } else { // solhint-disable-next-line avoid-low-level-calls (bool success, bytes memory returndata) = token.call( abi.encodeWithSelector(IERC20(token).transfer.selector, recipient, amount) ); // No need to check token.code.length since it comes from a gated call bool transferred = success && (returndata.length == uint256(0) || abi.decode(returndata, (bool))); if (!transferred) emit TransferTokenFailed(recipient, amount, token, returndata); } } ////////////////////////////////////////////////////////////// // // // Fetch Deposits // // // ////////////////////////////////////////////////////////////// /** * @notice Retrieves any token from multiple address, deterministically generated using * create2, by creating a contract for that address, sending it to this vault. * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param deployFetchParamsArray The array of deploy and fetch parameters */ function deployAndFetchBatch( SigData calldata sigData, DeployFetchParams[] calldata deployFetchParamsArray ) external override onlyNotSuspended consumesKeyNonce(sigData, keccak256(abi.encode(this.deployAndFetchBatch.selector, deployFetchParamsArray))) { _deployAndFetchBatch(deployFetchParamsArray); } function _deployAndFetchBatch(DeployFetchParams[] calldata deployFetchParamsArray) private { // Deploy deposit contracts uint256 length = deployFetchParamsArray.length; for (uint256 i = 0; i < length; ) { new Deposit{salt: deployFetchParamsArray[i].swapID}(deployFetchParamsArray[i].token); unchecked { ++i; } } } /** * @notice Retrieves any token addresses where a Deposit contract is already deployed. * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param fetchParamsArray The array of fetch parameters */ function fetchBatch( SigData calldata sigData, FetchParams[] calldata fetchParamsArray ) external override onlyNotSuspended consumesKeyNonce(sigData, keccak256(abi.encode(this.fetchBatch.selector, fetchParamsArray))) { _fetchBatch(fetchParamsArray); } /** * @notice Retrieves any token from multiple addresses where a Deposit contract is already deployed. * It emits an event if the fetch fails. * @param fetchParamsArray The array of fetch parameters */ function _fetchBatch(FetchParams[] calldata fetchParamsArray) private { uint256 length = fetchParamsArray.length; for (uint256 i = 0; i < length; ) { Deposit(fetchParamsArray[i].fetchContract).fetch(fetchParamsArray[i].token); unchecked { ++i; } } } ////////////////////////////////////////////////////////////// // // // Initiate cross-chain swaps (source chain) // // // ////////////////////////////////////////////////////////////// /** * @notice Swaps native token for a token in another chain. The egress token will be transferred to the specified * destination address on the destination chain. * @dev Checking the validity of inputs shall be done as part of the event witnessing. Only the amount is checked * to explicity indicate that an amount is required. It isn't preventing spamming. * @param dstChain The destination chain according to the Chainflip Protocol's nomenclature. * @param dstAddress Bytes containing the destination address on the destination chain. * @param dstToken Destination token to be swapped to. * @param cfParameters Additional parameters to be passed to the Chainflip protocol. */ function xSwapNative( uint32 dstChain, bytes memory dstAddress, uint32 dstToken, bytes calldata cfParameters ) external payable override onlyNotSuspended nzUint(msg.value) { emit SwapNative(dstChain, dstAddress, dstToken, msg.value, msg.sender, cfParameters); } /** * @notice Swaps ERC20 token for a token in another chain. The desired token will be transferred to the specified * destination address on the destination chain. The provided ERC20 token must be supported by the Chainflip Protocol. * @dev Checking the validity of inputs shall be done as part of the event witnessing. Only the amount is checked * to explicity indicate that an amount is required. * @param dstChain The destination chain according to the Chainflip Protocol's nomenclature. * @param dstAddress Bytes containing the destination address on the destination chain. * @param dstToken Uint containing the specifics of the swap to be performed according to Chainflip's nomenclature. * @param srcToken Address of the source token to swap. * @param amount Amount of tokens to swap. * @param cfParameters Additional parameters to be passed to the Chainflip protocol. */ function xSwapToken( uint32 dstChain, bytes memory dstAddress, uint32 dstToken, IERC20 srcToken, uint256 amount, bytes calldata cfParameters ) external override onlyNotSuspended nzUint(amount) { srcToken.safeTransferFrom(msg.sender, address(this), amount); emit SwapToken(dstChain, dstAddress, dstToken, address(srcToken), amount, msg.sender, cfParameters); } ////////////////////////////////////////////////////////////// // // // Initiate cross-chain call and swap (source chain) // // // ////////////////////////////////////////////////////////////// /** * @notice Performs a cross-chain call to the destination address on the destination chain. Native tokens must be paid * to this contract. The swap intent determines if the provided tokens should be swapped to a different token * and transferred as part of the cross-chain call. Otherwise, all tokens are used as a payment for gas on the destination chain. * The message parameter is transmitted to the destination chain as part of the cross-chain call. * @dev Checking the validity of inputs shall be done as part of the event witnessing. Only the amount is checked * to explicity inidcate that an amount is required. It isn't preventing spamming. * @param dstChain The destination chain according to the Chainflip Protocol's nomenclature. * @param dstAddress Bytes containing the destination address on the destination chain. * @param dstToken Uint containing the specifics of the swap to be performed, if any, as part of the xCall. The string * must follow Chainflip's nomenclature. It can signal that no swap needs to take place * and the source token will be used for gas in a swapless xCall. * @param message General purpose message to be sent to the egress chain. Notice that the Chainflip protocol has a limit size * for the message. Ensure that the message length is smaller that the limit before starting a swap. * @param gasAmount The amount to be used for gas in the egress chain. * @param cfParameters Additional parameters to be passed to the Chainflip protocol. */ function xCallNative( uint32 dstChain, bytes calldata dstAddress, uint32 dstToken, bytes calldata message, uint256 gasAmount, bytes calldata cfParameters ) external payable override onlyNotSuspended nzUint(msg.value) { emit XCallNative(dstChain, dstAddress, dstToken, msg.value, msg.sender, message, gasAmount, cfParameters); } /** * @notice Performs a cross-chain call to the destination chain and destination address. An ERC20 token amount * needs to be approved to this contract. The ERC20 token must be supported by the Chainflip Protocol. * The swap intent determines whether the provided tokens should be swapped to a different token * by the Chainflip Protocol. If so, the swapped tokens will be transferred to the destination chain as part * of the cross-chain call. Otherwise, the tokens are used as a payment for gas on the destination chain. * The message parameter is transmitted to the destination chain as part of the cross-chain call. * @dev Checking the validity of inputs shall be done as part of the event witnessing. Only the amount is checked * to explicity indicate that an amount is required. * @param dstChain The destination chain according to the Chainflip Protocol's nomenclature. * @param dstAddress Bytes containing the destination address on the destination chain. * @param dstToken Uint containing the specifics of the swap to be performed, if any, as part of the xCall. The string * must follow Chainflip's nomenclature. It can signal that no swap needs to take place * and the source token will be used for gas in a swapless xCall. * @param message General purpose message to be sent to the egress chain. Notice that the Chainflip protocol has a limit size * for the message. Ensure that the message length is smaller that the limit before starting a swap. * @param gasAmount The amount to be used for gas in the egress chain. * @param srcToken Address of the source token. * @param amount Amount of tokens to swap. * @param cfParameters Additional parameters to be passed to the Chainflip protocol. */ function xCallToken( uint32 dstChain, bytes memory dstAddress, uint32 dstToken, bytes calldata message, uint256 gasAmount, IERC20 srcToken, uint256 amount, bytes calldata cfParameters ) external override onlyNotSuspended nzUint(amount) { srcToken.safeTransferFrom(msg.sender, address(this), amount); emit XCallToken( dstChain, dstAddress, dstToken, address(srcToken), amount, msg.sender, message, gasAmount, cfParameters ); } ////////////////////////////////////////////////////////////// // // // Gas topups // // // ////////////////////////////////////////////////////////////// /** * @notice Add gas (topup) to an existing cross-chain call with the unique identifier swapID. * Native tokens must be paid to this contract as part of the call. * @param swapID The unique identifier for this swap (bytes32) */ function addGasNative(bytes32 swapID) external payable override onlyNotSuspended nzUint(msg.value) { emit AddGasNative(swapID, msg.value); } /** * @notice Add gas (topup) to an existing cross-chain call with the unique identifier swapID. * A Chainflip supported token must be paid to this contract as part of the call. * @param swapID The unique identifier for this swap (bytes32) * @param token Address of the token to provide. * @param amount Amount of tokens to provide. */ function addGasToken( bytes32 swapID, uint256 amount, IERC20 token ) external override onlyNotSuspended nzUint(amount) { token.safeTransferFrom(msg.sender, address(this), amount); emit AddGasToken(swapID, amount, address(token)); } ////////////////////////////////////////////////////////////// // // // Execute cross-chain call and swap (dest. chain) // // // ////////////////////////////////////////////////////////////// /** * @notice Transfers native tokens or an ERC20 token from this vault to a recipient and makes a function * call completing a cross-chain swap and call. The ICFReceiver interface is expected on * the receiver's address. A message is passed to the receiver along with other * parameters specifying the origin of the swap. * @dev Not checking nzUint(amount) to prevent reversions in edge cases (e.g. all input amount used for gas). * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param transferParams The transfer parameters * @param srcChain The source chain where the call originated from. * @param srcAddress The address where the transfer originated within the ingress chain. * @param message The message to be passed to the recipient. */ function executexSwapAndCall( SigData calldata sigData, TransferParams calldata transferParams, uint32 srcChain, bytes calldata srcAddress, bytes calldata message ) external override onlyNotSuspended nzAddr(transferParams.token) nzAddr(transferParams.recipient) consumesKeyNonce( sigData, keccak256(abi.encode(this.executexSwapAndCall.selector, transferParams, srcChain, srcAddress, message)) ) { // Logic in another internal function to avoid the stackTooDeep error _executexSwapAndCall(transferParams, srcChain, srcAddress, message); } /** * @notice Logic for transferring the tokens and calling the recipient. It's on the receiver to * make sure the call doesn't revert, otherwise the tokens won't be transferred. * The _transfer function is not used because we want to be able to embed the native token * into the cfReceive call to avoid doing two external calls. * In case of revertion the tokens will remain in the Vault. Therefore, the destination * contract must ensure it doesn't revert e.g. using try-catch mechanisms. * @dev In the case of the ERC20 transfer reverting, not handling the error to allow for tx replay. * Also, to ensure the cfReceive call is made only if the transfer is successful. */ function _executexSwapAndCall( TransferParams calldata transferParams, uint32 srcChain, bytes calldata srcAddress, bytes calldata message ) private { uint256 nativeAmount; if (transferParams.amount > 0) { if (transferParams.token == _NATIVE_ADDR) { nativeAmount = transferParams.amount; } else { IERC20(transferParams.token).safeTransfer(transferParams.recipient, transferParams.amount); } } ICFReceiver(transferParams.recipient).cfReceive{value: nativeAmount}( srcChain, srcAddress, message, transferParams.token, transferParams.amount ); } ////////////////////////////////////////////////////////////// // // // Execute cross-chain call (dest. chain) // // // ////////////////////////////////////////////////////////////// /** * @notice Executes a cross-chain function call. The ICFReceiver interface is expected on * the receiver's address. A message is passed to the receiver along with other * parameters specifying the origin of the swap. This is used for cross-chain messaging * without any swap taking place on the Chainflip Protocol. * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param srcChain The source chain where the call originated from. * @param srcAddress The address where the transfer originated from in the ingressParams. * @param message The message to be passed to the recipient. */ function executexCall( SigData calldata sigData, address recipient, uint32 srcChain, bytes calldata srcAddress, bytes calldata message ) external override onlyNotSuspended nzAddr(recipient) consumesKeyNonce( sigData, keccak256(abi.encode(this.executexCall.selector, recipient, srcChain, srcAddress, message)) ) { ICFReceiver(recipient).cfReceivexCall(srcChain, srcAddress, message); } ////////////////////////////////////////////////////////////// // // // Auxiliary chain actions // // // ////////////////////////////////////////////////////////////// /** * @notice Transfer funds and pass calldata to be executed on a Multicall contract. * @dev For safety purposes it's preferred to execute calldata externally with * a limited amount of funds instead of executing arbitrary calldata here. * @dev Calls are not reverted upon Multicall.run() failure so the nonce gets consumed. The * gasMulticall parameters is needed to prevent an insufficient gas griefing attack. * The _GAS_BUFFER is a conservative estimation of the gas required to finalize the call. * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param transferParams The transfer parameters inluding the token and amount to be transferred * and the multicall contract address. * @param calls Array of actions to be executed. * @param gasMulticall Gas that must be forwarded to the multicall. */ function executeActions( SigData calldata sigData, TransferParams calldata transferParams, IMulticall.Call[] calldata calls, uint256 gasMulticall ) external override onlyNotSuspended consumesKeyNonce( sigData, keccak256(abi.encode(this.executeActions.selector, transferParams, calls, gasMulticall)) ) { // Fund and run multicall uint256 valueToSend; if (transferParams.amount > 0) { if (transferParams.token == _NATIVE_ADDR) { valueToSend = transferParams.amount; } else { IERC20(transferParams.token).approve(transferParams.recipient, transferParams.amount); } } // Ensure that the amount of gas supplied to the call to the Multicall contract is at least the gas // limit specified. We can do this by enforcing that we still have gasMulticall + gas buffer available. // The gas buffer is to ensure there is enough gas to finalize the call, including a safety margin. // The 63/64 rule specified in EIP-150 needs to be taken into account. require(gasleft() >= ((gasMulticall + _FINALIZE_GAS_BUFFER) * 64) / 63, "Vault: insufficient gas"); // solhint-disable-next-line avoid-low-level-calls (bool success, bytes memory reason) = transferParams.recipient.call{ gas: gasleft() - _FINALIZE_GAS_BUFFER, value: valueToSend }(abi.encodeWithSelector(IMulticall.run.selector, calls, transferParams.token, transferParams.amount)); if (!success) { if (transferParams.amount > 0 && transferParams.token != _NATIVE_ADDR) { IERC20(transferParams.token).approve(transferParams.recipient, 0); } emit ExecuteActionsFailed(transferParams.recipient, transferParams.amount, transferParams.token, reason); } else { require(transferParams.recipient.code.length > 0); } } ////////////////////////////////////////////////////////////// // // // Governance // // // ////////////////////////////////////////////////////////////// /** * @notice Withdraw all funds to governance address in case of emergency. This withdrawal needs * to be approved by the Community and it can only be executed if no nonce from the * current AggKey had been consumed in _AGG_KEY_TIMEOUT time. It is a last resort and * can be used to rectify an emergency. * @param tokens The addresses of the tokens to be transferred */ function govWithdraw( address[] calldata tokens ) external override onlyGovernor onlyCommunityGuardDisabled onlySuspended timeoutEmergency { // Could use msg.sender or getGovernor() but hardcoding the get call just for extra safety address payable recipient = payable(getKeyManager().getGovernanceKey()); // Transfer all native tokens and ERC20 Tokens for (uint256 i = 0; i < tokens.length; i++) { if (tokens[i] == _NATIVE_ADDR) { _transfer(_NATIVE_ADDR, recipient, address(this).balance); } else { _transfer(tokens[i], recipient, IERC20(tokens[i]).balanceOf(address(this))); } } } ////////////////////////////////////////////////////////////// // // // Modifiers // // // ////////////////////////////////////////////////////////////// /// @dev Check that no nonce has been consumed in the last 3 days - emergency modifier timeoutEmergency() { require( block.timestamp - getKeyManager().getLastValidateTime() >= _AGG_KEY_EMERGENCY_TIMEOUT, "Vault: not enough time" ); _; } ////////////////////////////////////////////////////////////// // // // Fallbacks // // // ////////////////////////////////////////////////////////////// /// @dev For receiving native tokens from the Deposit contracts receive() external payable { emit FetchedNative(msg.sender, msg.value); } } // 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 "draft-IERC20Permit.sol"; import "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"); } } } // 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); } // 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); } // 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); } } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IAggKeyNonceConsumer.sol"; import "IGovernanceCommunityGuarded.sol"; import "IMulticall.sol"; /** * @title Vault interface * @notice The interface for functions Vault implements */ interface IVault is IGovernanceCommunityGuarded, IAggKeyNonceConsumer { event FetchedNative(address indexed sender, uint256 amount); event TransferNativeFailed(address payable indexed recipient, uint256 amount); event TransferTokenFailed(address payable indexed recipient, uint256 amount, address indexed token, bytes reason); event SwapNative( uint32 dstChain, bytes dstAddress, uint32 dstToken, uint256 amount, address indexed sender, bytes cfParameters ); event SwapToken( uint32 dstChain, bytes dstAddress, uint32 dstToken, address srcToken, uint256 amount, address indexed sender, bytes cfParameters ); /// @dev bytes parameters is not indexed because indexing a dynamic type for it to be filtered /// makes it so we won't be able to decode it unless we specifically search for it. If we want /// to filter it and decode it then we would need to have both the indexed and the non-indexed /// version in the event. That is unnecessary. event XCallNative( uint32 dstChain, bytes dstAddress, uint32 dstToken, uint256 amount, address indexed sender, bytes message, uint256 gasAmount, bytes cfParameters ); event XCallToken( uint32 dstChain, bytes dstAddress, uint32 dstToken, address srcToken, uint256 amount, address indexed sender, bytes message, uint256 gasAmount, bytes cfParameters ); event AddGasNative(bytes32 swapID, uint256 amount); event AddGasToken(bytes32 swapID, uint256 amount, address token); event ExecuteActionsFailed( address payable indexed multicallAddress, uint256 amount, address indexed token, bytes reason ); function allBatch( SigData calldata sigData, DeployFetchParams[] calldata deployFetchParamsArray, FetchParams[] calldata fetchParamsArray, TransferParams[] calldata transferParamsArray ) external; function allBatchV2( SigData calldata sigData, FetchParams[] calldata fetchParamsArray, TransferParams[] calldata transferParamsArray ) external; ////////////////////////////////////////////////////////////// // // // Transfers // // // ////////////////////////////////////////////////////////////// function transfer(SigData calldata sigData, TransferParams calldata transferParams) external; function transferBatch(SigData calldata sigData, TransferParams[] calldata transferParamsArray) external; ////////////////////////////////////////////////////////////// // // // Fetch Deposits // // // ////////////////////////////////////////////////////////////// function deployAndFetchBatch( SigData calldata sigData, DeployFetchParams[] calldata deployFetchParamsArray ) external; function fetchBatch(SigData calldata sigData, FetchParams[] calldata fetchParamsArray) external; ////////////////////////////////////////////////////////////// // // // Initiate cross-chain swaps (source chain) // // // ////////////////////////////////////////////////////////////// function xSwapToken( uint32 dstChain, bytes calldata dstAddress, uint32 dstToken, IERC20 srcToken, uint256 amount, bytes calldata cfParameters ) external; function xSwapNative( uint32 dstChain, bytes calldata dstAddress, uint32 dstToken, bytes calldata cfParameters ) external payable; ////////////////////////////////////////////////////////////// // // // Initiate cross-chain call and swap (source chain) // // // ////////////////////////////////////////////////////////////// function xCallNative( uint32 dstChain, bytes calldata dstAddress, uint32 dstToken, bytes calldata message, uint256 gasAmount, bytes calldata cfParameters ) external payable; function xCallToken( uint32 dstChain, bytes calldata dstAddress, uint32 dstToken, bytes calldata message, uint256 gasAmount, IERC20 srcToken, uint256 amount, bytes calldata cfParameters ) external; ////////////////////////////////////////////////////////////// // // // Gas topups // // // ////////////////////////////////////////////////////////////// function addGasNative(bytes32 swapID) external payable; function addGasToken(bytes32 swapID, uint256 amount, IERC20 token) external; ////////////////////////////////////////////////////////////// // // // Execute cross-chain call and swap (dest. chain) // // // ////////////////////////////////////////////////////////////// function executexSwapAndCall( SigData calldata sigData, TransferParams calldata transferParams, uint32 srcChain, bytes calldata srcAddress, bytes calldata message ) external; ////////////////////////////////////////////////////////////// // // // Execute cross-chain call (dest. chain) // // // ////////////////////////////////////////////////////////////// function executexCall( SigData calldata sigData, address recipient, uint32 srcChain, bytes calldata srcAddress, bytes calldata message ) external; ////////////////////////////////////////////////////////////// // // // Auxiliary chain actions // // // ////////////////////////////////////////////////////////////// function executeActions( SigData calldata sigData, TransferParams calldata transferParams, IMulticall.Call[] calldata calls, uint256 gasMulticall ) external; ////////////////////////////////////////////////////////////// // // // Governance // // // ////////////////////////////////////////////////////////////// function govWithdraw(address[] calldata tokens) external; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IShared.sol"; import "IKeyManager.sol"; /** * @title AggKeyNonceConsumer interface */ interface IAggKeyNonceConsumer is IShared { event UpdatedKeyManager(address keyManager); ////////////////////////////////////////////////////////////// // // // State-changing functions // // // ////////////////////////////////////////////////////////////// /** * @notice Update KeyManager reference. Used if KeyManager contract is updated * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param keyManager New KeyManager's address * @param omitChecks Allow the omission of the extra checks in a special case */ function updateKeyManager(SigData calldata sigData, IKeyManager keyManager, bool omitChecks) external; ////////////////////////////////////////////////////////////// // // // Getters // // // ////////////////////////////////////////////////////////////// /** * @notice Get the KeyManager address/interface that's used to validate sigs * @return The KeyManager (IKeyManager) */ function getKeyManager() external view returns (IKeyManager); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IERC20.sol"; /** * @title Shared interface * @notice Holds structs needed by other interfaces */ interface IShared { /** * @dev SchnorrSECP256K1 requires that each key has a public key part (x coordinate), * a parity for the y coordinate (0 if the y ordinate of the public key is even, 1 * if it's odd) */ struct Key { uint256 pubKeyX; uint8 pubKeyYParity; } /** * @dev Contains a signature and the nonce used to create it. Also the recovered address * to check that the signature is valid */ struct SigData { uint256 sig; uint256 nonce; address kTimesGAddress; } /** * @param token The address of the token to be transferred * @param recipient The address of the recipient of the transfer * @param amount The amount to transfer, in wei (uint) */ struct TransferParams { address token; address payable recipient; uint256 amount; } /** * @param swapID The unique identifier for this swap (bytes32), used for create2 * @param token The token to be transferred */ struct DeployFetchParams { bytes32 swapID; address token; } /** * @param fetchContract The address of the deployed Deposit contract * @param token The token to be transferred */ struct FetchParams { address payable fetchContract; address token; } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IShared.sol"; /** * @title KeyManager interface * @notice The interface for functions KeyManager implements */ interface IKeyManager is IShared { event AggKeySetByAggKey(Key oldAggKey, Key newAggKey); event AggKeySetByGovKey(Key oldAggKey, Key newAggKey); event GovKeySetByAggKey(address oldGovKey, address newGovKey); event GovKeySetByGovKey(address oldGovKey, address newGovKey); event CommKeySetByAggKey(address oldCommKey, address newCommKey); event CommKeySetByCommKey(address oldCommKey, address newCommKey); event SignatureAccepted(SigData sigData, address signer); event GovernanceAction(bytes32 message); ////////////////////////////////////////////////////////////// // // // State-changing functions // // // ////////////////////////////////////////////////////////////// function consumeKeyNonce(SigData memory sigData, bytes32 contractMsgHash) external; function setAggKeyWithAggKey(SigData memory sigData, Key memory newAggKey) external; function setAggKeyWithGovKey(Key memory newAggKey) external; function setGovKeyWithAggKey(SigData calldata sigData, address newGovKey) external; function setGovKeyWithGovKey(address newGovKey) external; function setCommKeyWithAggKey(SigData calldata sigData, address newCommKey) external; function setCommKeyWithCommKey(address newCommKey) external; function govAction(bytes32 message) external; ////////////////////////////////////////////////////////////// // // // Non-state-changing functions // // // ////////////////////////////////////////////////////////////// function getAggregateKey() external view returns (Key memory); function getGovernanceKey() external view returns (address); function getCommunityKey() external view returns (address); function isNonceUsedByAggKey(uint256 nonce) external view returns (bool); function getLastValidateTime() external view returns (uint256); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IShared.sol"; /** * @title GovernanceCommunityGuarded interface */ interface IGovernanceCommunityGuarded is IShared { event CommunityGuardDisabled(bool communityGuardDisabled); event Suspended(bool suspended); ////////////////////////////////////////////////////////////// // // // State-changing functions // // // ////////////////////////////////////////////////////////////// /** * @notice Enable Community Guard */ function enableCommunityGuard() external; /** * @notice Disable Community Guard */ function disableCommunityGuard() external; /** * @notice Can be used to suspend contract execution - only executable by * governance and only to be used in case of emergency. */ function suspend() external; /** * @notice Resume contract execution */ function resume() external; ////////////////////////////////////////////////////////////// // // // Getters // // // ////////////////////////////////////////////////////////////// /** * @notice Get the Community Key * @return The CommunityKey */ function getCommunityKey() external view returns (address); /** * @notice Get the Community Guard state * @return The Community Guard state */ function getCommunityGuardDisabled() external view returns (bool); /** * @notice Get suspended state * @return The suspended state */ function getSuspendedState() external view returns (bool); /** * @notice Get governor address * @return The governor address */ function getGovernor() external view returns (address); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; interface IMulticall { enum CallType { Default, FullTokenBalance, FullNativeBalance, CollectTokenBalance } struct Call { CallType callType; address target; uint256 value; bytes callData; bytes payload; } error AlreadyRunning(); error CallFailed(uint256 callPosition, bytes reason); function run(Call[] calldata calls, address tokenIn, uint256 amountIn) external payable; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @title CF Receiver interface * @dev The ICFReceiver interface is the interface required to receive tokens and * cross-chain calls from the Chainflip Protocol. */ interface ICFReceiver { /** * @notice Receiver of a cross-chain swap and call made by the Chainflip Protocol. * @param srcChain The source chain according to the Chainflip Protocol's nomenclature. * @param srcAddress Bytes containing the source address on the source chain. * @param message The message sent on the source chain. This is a general purpose message. * @param token Address of the token received. _NATIVE_ADDR if it's native tokens. * @param amount Amount of tokens received. This will match msg.value for native tokens. */ function cfReceive( uint32 srcChain, bytes calldata srcAddress, bytes calldata message, address token, uint256 amount ) external payable; /** * @notice Receiver of a cross-chain call made by the Chainflip Protocol. * @param srcChain The source chain according to the Chainflip Protocol's nomenclature. * @param srcAddress Bytes containing the source address on the source chain. * @param message The message sent on the source chain. This is a general purpose message. */ function cfReceivexCall(uint32 srcChain, bytes calldata srcAddress, bytes calldata message) external; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IShared.sol"; /** * @title Shared contract * @notice Holds constants and modifiers that are used in multiple contracts * @dev It would be nice if this could be a library, but modifiers can't be exported :( */ abstract contract Shared is IShared { /// @dev The address used to indicate whether transfer should send native or a token address internal constant _NATIVE_ADDR = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE; address internal constant _ZERO_ADDR = address(0); bytes32 internal constant _NULL = ""; uint256 internal constant _E_18 = 1e18; /// @dev Checks that a uint isn't zero/empty modifier nzUint(uint256 u) { require(u != 0, "Shared: uint input is empty"); _; } /// @dev Checks that an address isn't zero/empty modifier nzAddr(address a) { require(a != _ZERO_ADDR, "Shared: address input is empty"); _; } /// @dev Checks that a bytes32 isn't zero/empty modifier nzBytes32(bytes32 b) { require(b != _NULL, "Shared: bytes32 input is empty"); _; } /// @dev Checks that the pubKeyX is populated modifier nzKey(Key memory key) { require(key.pubKeyX != 0, "Shared: pubKeyX is empty"); _; } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IERC20Lite.sol"; /** * @title Deposit contract * @notice Creates a contract with a known address and withdraws tokens from it. * After deployment, the Vault will call fetch() to withdraw tokens. * @dev Any change in this contract, including comments, will affect the final * bytecode and therefore will affect the create2 derived addresses. * Do NOT modify unless the consequences of doing so are fully understood. */ contract Deposit { address payable private immutable vault; /** * @notice Upon deployment it fetches the tokens (native or ERC20) to the Vault. * @param token The address of the token to fetch */ constructor(address token) { vault = payable(msg.sender); // Slightly cheaper to use msg.sender instead of Vault. if (token == 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) { // solhint-disable-next-line avoid-low-level-calls (bool success, ) = msg.sender.call{value: address(this).balance}(""); require(success); } else { // IERC20Lite.transfer doesn't have a return bool to avoid reverts on non-standard ERC20s IERC20Lite(token).transfer(msg.sender, IERC20Lite(token).balanceOf(address(this))); } } /** * @notice Allows the Vault to fetch ERC20 tokens from this contract. * @param token The address of the token to fetch */ function fetch(address token) external { require(msg.sender == vault); // IERC20Lite.transfer doesn't have a return bool to avoid reverts on non-standard ERC20s IERC20Lite(token).transfer(msg.sender, IERC20Lite(token).balanceOf(address(this))); } /// @notice Receives native tokens, emits an event and sends them to the Vault. Note that this // requires the sender to forward some more gas than for a simple transfer. receive() external payable { // solhint-disable-next-line avoid-low-level-calls (bool success, ) = vault.call{value: address(this).balance}(""); require(success); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @title ERC20 Lite Interface * @notice The interface for functions ERC20Lite implements. This is intended to * be used only in the Deposit contract. * @dev Any change in this contract, including comments, will affect the final * bytecode and therefore will affect the create2 derived addresses. * Do NOT modify unless the consequences of doing so are fully understood. */ interface IERC20Lite { /// @dev Removed the return bool to avoid reverts on non-standard ERC20s. function transfer(address, uint256) external; function balanceOf(address) external view returns (uint256); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IKeyManager.sol"; import "IAggKeyNonceConsumer.sol"; import "Shared.sol"; /** * @title AggKeyNonceConsumer contract * @notice Manages the reference to the KeyManager contract. The address * is set in the constructor and can only be updated with a valid * signature validated by the current KeyManager contract. This shall * be done if the KeyManager contract is updated. */ abstract contract AggKeyNonceConsumer is Shared, IAggKeyNonceConsumer { /// @dev The KeyManager used to checks sigs used in functions here IKeyManager private _keyManager; constructor(IKeyManager keyManager) nzAddr(address(keyManager)) { _keyManager = keyManager; } ////////////////////////////////////////////////////////////// // // // State-changing functions // // // ////////////////////////////////////////////////////////////// /** * @notice Update KeyManager reference. Used if KeyManager contract is updated * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param keyManager New KeyManager's address * @param omitChecks Allow the omission of the extra checks in a special case */ function updateKeyManager( SigData calldata sigData, IKeyManager keyManager, bool omitChecks ) external override nzAddr(address(keyManager)) consumesKeyNonce(sigData, keccak256(abi.encode(this.updateKeyManager.selector, keyManager, omitChecks))) { // Check that the new KeyManager is a contract require(address(keyManager).code.length > 0); // Allow the child to check compatibility with the new KeyManager _checkUpdateKeyManager(keyManager, omitChecks); _keyManager = keyManager; emit UpdatedKeyManager(address(keyManager)); } /// @dev This will be called when upgrading to a new KeyManager. This allows the child's contract /// to check its compatibility with the new KeyManager. This is to prevent the contract from // getting bricked. There is no good way to enforce the implementation of consumeKeyNonce(). function _checkUpdateKeyManager(IKeyManager keyManager, bool omitChecks) internal view virtual; ////////////////////////////////////////////////////////////// // // // Getters // // // ////////////////////////////////////////////////////////////// /** * @notice Get the KeyManager address/interface that's used to validate sigs * @return The KeyManager (IKeyManager) */ function getKeyManager() public view override returns (IKeyManager) { return _keyManager; } ////////////////////////////////////////////////////////////// // // // Modifiers // // // ////////////////////////////////////////////////////////////// /// @dev Calls consumeKeyNonce in _keyManager modifier consumesKeyNonce(SigData calldata sigData, bytes32 contractMsgHash) { getKeyManager().consumeKeyNonce(sigData, contractMsgHash); _; } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IGovernanceCommunityGuarded.sol"; import "AggKeyNonceConsumer.sol"; import "Shared.sol"; /** * @title GovernanceCommunityGuarded contract * @notice Allows the governor to perform certain actions for the procotol's safety in * case of emergency. The aim is to allow the governor to suspend execution of * critical functions. * Also, it allows the CommunityKey to safeguard certain functions so the * governor can execute them iff the communityKey allows it. */ abstract contract GovernanceCommunityGuarded is Shared, IGovernanceCommunityGuarded { /// @dev Community Guard Disabled bool private _communityGuardDisabled; /// @dev Whether execution is suspended bool private _suspended = false; /** * @notice Get the governor's address. The contracts inheriting this (StateChainGateway and Vault) * get the governor's address from the KeyManager through the AggKeyNonceConsumer's * inheritance. Therefore, the implementation of this function must be left * to the children. This is not implemented as a virtual onlyGovernor modifier to force * the children to implement this function - virtual modifiers don't enforce that. * @return The governor's address */ function _getGovernor() internal view virtual returns (address); /** * @notice Get the community's address. The contracts inheriting this (StateChainGateway and Vault) * get the community's address from the KeyManager through the AggKeyNonceConsumer's * inheritance. Therefore, the implementation of this function must be left * to the children. This is not implemented as a virtual onlyCommunityKey modifier to force * the children to implement this function - virtual modifiers don't enforce that. * @return The community's address */ function _getCommunityKey() internal view virtual returns (address); ////////////////////////////////////////////////////////////// // // // State-changing functions // // // ////////////////////////////////////////////////////////////// /** * @notice Enable Community Guard */ function enableCommunityGuard() external override onlyCommunityKey onlyCommunityGuardDisabled { _communityGuardDisabled = false; emit CommunityGuardDisabled(false); } /** * @notice Disable Community Guard */ function disableCommunityGuard() external override onlyCommunityKey onlyCommunityGuardEnabled { _communityGuardDisabled = true; emit CommunityGuardDisabled(true); } /** * @notice Can be used to suspend contract execution - only executable by * governance and only to be used in case of emergency. */ function suspend() external override onlyGovernor onlyNotSuspended { _suspended = true; emit Suspended(true); } /** * @notice Resume contract execution */ function resume() external override onlyGovernor onlySuspended { _suspended = false; emit Suspended(false); } ////////////////////////////////////////////////////////////// // // // Getters // // // ////////////////////////////////////////////////////////////// /** * @notice Get the Community Key * @return The CommunityKey */ function getCommunityKey() external view override returns (address) { return _getCommunityKey(); } /** * @notice Get the Community Guard state * @return The Community Guard state */ function getCommunityGuardDisabled() external view override returns (bool) { return _communityGuardDisabled; } /** * @notice Get suspended state * @return The suspended state */ function getSuspendedState() external view override returns (bool) { return _suspended; } /** * @notice Get governor address * @return The governor address */ function getGovernor() external view override returns (address) { return _getGovernor(); } ////////////////////////////////////////////////////////////// // // // Modifiers // // // ////////////////////////////////////////////////////////////// /// @dev Check that the caller is the Community Key address. modifier onlyCommunityKey() { require(msg.sender == _getCommunityKey(), "Governance: not Community Key"); _; } /// @dev Check that community has disabled the community guard. modifier onlyCommunityGuardDisabled() { require(_communityGuardDisabled, "Governance: community guard enabled"); _; } /// @dev Check that community has disabled the community guard. modifier onlyCommunityGuardEnabled() { require(!_communityGuardDisabled, "Governance: community guard disabled"); _; } /// @notice Ensure that the caller is the governor address. Calls the getGovernor /// function which is implemented by the children. modifier onlyGovernor() { require(msg.sender == _getGovernor(), "Governance: not governor"); _; } // @notice Check execution is suspended modifier onlySuspended() { require(_suspended, "Governance: not suspended"); _; } // @notice Check execution is not suspended modifier onlyNotSuspended() { require(!_suspended, "Governance: suspended"); _; } }
File 2 of 4: KeyManager
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IKeyManager.sol"; import "SchnorrSECP256K1.sol"; import "Shared.sol"; /** * @title KeyManager contract * @notice Holds the aggregate and governance keys, functions to update them, and * consumeKeyNonce so other contracts can verify signatures and updates _lastValidateTime */ contract KeyManager is SchnorrSECP256K1, Shared, IKeyManager { uint256 private constant _AGG_KEY_TIMEOUT = 2 days; /// @dev The current (schnorr) aggregate key. Key private _aggKey; /// @dev The current governance key. address private _govKey; /// @dev The current community key. address private _commKey; /// @dev The last time that a sig was verified (used for a dead man's switch) uint256 private _lastValidateTime; mapping(uint256 => bool) private _isNonceUsedByAggKey; constructor( Key memory initialAggKey, address initialGovKey, address initialCommKey ) nzAddr(initialGovKey) nzAddr(initialCommKey) nzKey(initialAggKey) validAggKey(initialAggKey) { _aggKey = initialAggKey; _govKey = initialGovKey; _commKey = initialCommKey; _lastValidateTime = block.timestamp; } ////////////////////////////////////////////////////////////// // // // State-changing functions // // // ////////////////////////////////////////////////////////////// /** * @notice Checks the validity of a signature and msgHash, then updates _lastValidateTime * @dev It would be nice to split this up, but these checks * need to be made atomicly always. This needs to be available * in this contract and in the Vault etc * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param msgHash The hash of the message being signed. The hash of the function * call parameters is concatenated and hashed together with the nonce, the * address of the caller, the chainId, and the address of this contract. */ function _consumeKeyNonce(SigData calldata sigData, bytes32 msgHash) internal { Key memory key = _aggKey; require( verifySignature(msgHash, sigData.sig, key.pubKeyX, key.pubKeyYParity, sigData.kTimesGAddress), "KeyManager: Sig invalid" ); require(!_isNonceUsedByAggKey[sigData.nonce], "KeyManager: nonce already used"); _lastValidateTime = block.timestamp; _isNonceUsedByAggKey[sigData.nonce] = true; // Disable because tx.origin is not being used in the logic // solhint-disable-next-line avoid-tx-origin emit SignatureAccepted(sigData, tx.origin); } /** * @notice Concatenates the contractMsgHash with the nonce, the address of the caller, * the chainId, and the address of this contract, then hashes that and verifies the * signature. This is done to prevent replay attacks. * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param contractMsgHash The hash of the function's call parameters. This will be hashed * over other parameters to prevent replay attacks. */ function consumeKeyNonce(SigData calldata sigData, bytes32 contractMsgHash) external override { bytes32 msgHash = keccak256( abi.encode(contractMsgHash, sigData.nonce, msg.sender, block.chainid, address(this)) ); _consumeKeyNonce(sigData, msgHash); } /** * @notice Set a new aggregate key. Requires a signature from the current aggregate key * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param newAggKey The new aggregate key to be set. The x component of the pubkey (uint256), * the parity of the y component (uint8) */ function setAggKeyWithAggKey( SigData calldata sigData, Key calldata newAggKey ) external override nzKey(newAggKey) validAggKey(newAggKey) consumeKeyNonceKeyManager(sigData, keccak256(abi.encode(this.setAggKeyWithAggKey.selector, newAggKey))) { emit AggKeySetByAggKey(_aggKey, newAggKey); _aggKey = newAggKey; } /** * @notice Set a new aggregate key. Can only be called by the current governance key * @param newAggKey The new aggregate key to be set. The x component of the pubkey (uint256), * the parity of the y component (uint8) */ function setAggKeyWithGovKey( Key calldata newAggKey ) external override nzKey(newAggKey) validAggKey(newAggKey) timeoutEmergency onlyGovernor { emit AggKeySetByGovKey(_aggKey, newAggKey); _aggKey = newAggKey; } /** * @notice Set a new aggregate key. Requires a signature from the current aggregate key * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param newGovKey The new governance key to be set. */ function setGovKeyWithAggKey( SigData calldata sigData, address newGovKey ) external override nzAddr(newGovKey) consumeKeyNonceKeyManager(sigData, keccak256(abi.encode(this.setGovKeyWithAggKey.selector, newGovKey))) { emit GovKeySetByAggKey(_govKey, newGovKey); _govKey = newGovKey; } /** * @notice Set a new governance key. Can only be called by current governance key * @param newGovKey The new governance key to be set. */ function setGovKeyWithGovKey(address newGovKey) external override nzAddr(newGovKey) onlyGovernor { emit GovKeySetByGovKey(_govKey, newGovKey); _govKey = newGovKey; } /** * @notice Set a new community key. Requires a signature from the current aggregate key * @param sigData Struct containing the signature data over the message * to verify, signed by the aggregate key. * @param newCommKey The new community key to be set. */ function setCommKeyWithAggKey( SigData calldata sigData, address newCommKey ) external override nzAddr(newCommKey) consumeKeyNonceKeyManager(sigData, keccak256(abi.encode(this.setCommKeyWithAggKey.selector, newCommKey))) { emit CommKeySetByAggKey(_commKey, newCommKey); _commKey = newCommKey; } /** * @notice Update the Community Key. Can only be called by the current Community Key. * @param newCommKey New Community key address. */ function setCommKeyWithCommKey(address newCommKey) external override onlyCommunityKey nzAddr(newCommKey) { emit CommKeySetByCommKey(_commKey, newCommKey); _commKey = newCommKey; } /** * @notice Emit an event containing an action message. Can only be called by the governor. */ function govAction(bytes32 message) external override onlyGovernor { emit GovernanceAction(message); } ////////////////////////////////////////////////////////////// // // // Non-state-changing functions // // // ////////////////////////////////////////////////////////////// /** * @notice Get the current aggregate key * @return The Key struct for the aggregate key */ function getAggregateKey() external view override returns (Key memory) { return _aggKey; } /** * @notice Get the current governance key * @return The Key struct for the governance key */ function getGovernanceKey() external view override returns (address) { return _getGovernanceKey(); } /** * @notice Get the current community key * @return The Key struct for the community key */ function getCommunityKey() external view override returns (address) { return _getCommunityKey(); } /** * @notice Get the last time that a function was called which * required a signature from _aggregateKeyData or _governanceKeyData * @return The last time consumeKeyNonce was called, in unix time (uint256) */ function getLastValidateTime() external view override returns (uint256) { return _lastValidateTime; } /** * @notice Get whether or not the specific keyID has used this nonce before * since it cannot be used again * @return Whether the nonce has already been used (bool) */ function isNonceUsedByAggKey(uint256 nonce) external view override returns (bool) { return _isNonceUsedByAggKey[nonce]; } /** * @notice Get the current governance key * @return The Key struct for the governance key */ function _getGovernanceKey() internal view returns (address) { return _govKey; } /** * @notice Get the current community key * @return The Key struct for the community key */ function _getCommunityKey() internal view returns (address) { return _commKey; } ////////////////////////////////////////////////////////////// // // // Modifiers // // // ////////////////////////////////////////////////////////////// /// @dev Check that enough time has passed for setAggKeyWithGovKey. Needs /// to be done as a modifier so that it can happen before consumeKeyNonce modifier timeoutEmergency() { require(block.timestamp - _lastValidateTime >= _AGG_KEY_TIMEOUT, "KeyManager: not enough time"); _; } /// @dev Check that an aggregate key is capable of having its signatures /// verified by the schnorr lib. modifier validAggKey(Key memory key) { verifySigningKeyX(key.pubKeyX); _; } /// @dev Check that the sender is the governance address modifier onlyGovernor() { require(msg.sender == _getGovernanceKey(), "KeyManager: not governor"); _; } /// @dev Check that the caller is the Community Key address. modifier onlyCommunityKey() { require(msg.sender == _getCommunityKey(), "KeyManager: not Community Key"); _; } /// @dev For functions in this contract that require a signature from the aggregate key // the msg.sender can't be hashed as anyone can make the call. Instead the // address of this contract is used as the sender and hashed in the message. modifier consumeKeyNonceKeyManager(SigData calldata sigData, bytes32 contractMsgHash) { bytes32 msgHash = keccak256( abi.encode(contractMsgHash, sigData.nonce, address(this), block.chainid, address(this)) ); _consumeKeyNonce(sigData, msgHash); _; } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IShared.sol"; /** * @title KeyManager interface * @notice The interface for functions KeyManager implements */ interface IKeyManager is IShared { event AggKeySetByAggKey(Key oldAggKey, Key newAggKey); event AggKeySetByGovKey(Key oldAggKey, Key newAggKey); event GovKeySetByAggKey(address oldGovKey, address newGovKey); event GovKeySetByGovKey(address oldGovKey, address newGovKey); event CommKeySetByAggKey(address oldCommKey, address newCommKey); event CommKeySetByCommKey(address oldCommKey, address newCommKey); event SignatureAccepted(SigData sigData, address signer); event GovernanceAction(bytes32 message); ////////////////////////////////////////////////////////////// // // // State-changing functions // // // ////////////////////////////////////////////////////////////// function consumeKeyNonce(SigData memory sigData, bytes32 contractMsgHash) external; function setAggKeyWithAggKey(SigData memory sigData, Key memory newAggKey) external; function setAggKeyWithGovKey(Key memory newAggKey) external; function setGovKeyWithAggKey(SigData calldata sigData, address newGovKey) external; function setGovKeyWithGovKey(address newGovKey) external; function setCommKeyWithAggKey(SigData calldata sigData, address newCommKey) external; function setCommKeyWithCommKey(address newCommKey) external; function govAction(bytes32 message) external; ////////////////////////////////////////////////////////////// // // // Non-state-changing functions // // // ////////////////////////////////////////////////////////////// function getAggregateKey() external view returns (Key memory); function getGovernanceKey() external view returns (address); function getCommunityKey() external view returns (address); function isNonceUsedByAggKey(uint256 nonce) external view returns (bool); function getLastValidateTime() external view returns (uint256); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IERC20.sol"; /** * @title Shared interface * @notice Holds structs needed by other interfaces */ interface IShared { /** * @dev SchnorrSECP256K1 requires that each key has a public key part (x coordinate), * a parity for the y coordinate (0 if the y ordinate of the public key is even, 1 * if it's odd) */ struct Key { uint256 pubKeyX; uint8 pubKeyYParity; } /** * @dev Contains a signature and the nonce used to create it. Also the recovered address * to check that the signature is valid */ struct SigData { uint256 sig; uint256 nonce; address kTimesGAddress; } /** * @param token The address of the token to be transferred * @param recipient The address of the recipient of the transfer * @param amount The amount to transfer, in wei (uint) */ struct TransferParams { address token; address payable recipient; uint256 amount; } /** * @param swapID The unique identifier for this swap (bytes32), used for create2 * @param token The token to be transferred */ struct DeployFetchParams { bytes32 swapID; address token; } /** * @param fetchContract The address of the deployed Deposit contract * @param token The token to be transferred */ struct FetchParams { address payable fetchContract; address token; } } // 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); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /// @notice Slightly modified from https://github.com/smartcontractkit/chainlink/pull/1272/files abstract contract SchnorrSECP256K1 { // See https://en.bitcoin.it/wiki/Secp256k1 for this constant. // Group order of secp256k1 uint256 private constant Q = // solium-disable-next-line indentation 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141; // solium-disable-next-line zeppelin/no-arithmetic-operations uint256 private constant HALF_Q = (Q >> 1) + 1; /** ************************************************************************** @notice verifySignature returns true iff passed a valid Schnorr signature. @dev See https://en.wikipedia.org/wiki/Schnorr_signature for reference. @dev In what follows, let d be your secret key, PK be your public key, PKx be the x ordinate of your public key, and PKyp be the parity bit for the y ordinate (i.e., 0 if PKy is even, 1 if odd.) ************************************************************************** @dev TO CREATE A VALID SIGNATURE FOR THIS METHOD @dev First PKx must be less than HALF_Q. Then follow these instructions (see evm/test/schnorr_test.js, for an example of carrying them out): @dev 1. Hash the target message to a bytes32, called msgHash here, using keccak256 @dev 2. Pick k uniformly and cryptographically securely randomly from {0,...,Q-1}. It is critical that k remains confidential, as your private key can be reconstructed from k and the signature. @dev 3. Compute k*g in the secp256k1 group, where g is the group generator. (This is the same as computing the public key from the secret key k. But it's OK if k*g's x ordinate is greater than HALF_Q.) @dev 4. Compute the ethereum address for k*g. This is the lower 160 bits of the keccak hash of the concatenated affine coordinates of k*g, as 32-byte big-endians. (For instance, you could pass k to ethereumjs-utils's privateToAddress to compute this, though that should be strictly a development convenience, not for handling live secrets, unless you've locked your javascript environment down very carefully.) Call this address nonceTimesGeneratorAddress. @dev 5. Compute e=uint256(keccak256(PKx as a 32-byte big-endian ‖ PKyp as a single byte ‖ msgHash ‖ nonceTimesGeneratorAddress)) This value e is called "msgChallenge" in verifySignature's source code below. Here "‖" means concatenation of the listed byte arrays. @dev 6. Let d be your secret key. Compute s = (k - d * e) % Q. Add Q to it, if it's negative. This is your signature. (d is your secret key.) ************************************************************************** @dev TO VERIFY A SIGNATURE @dev Given a signature (s, e) of msgHash, constructed as above, compute S=e*PK+s*generator in the secp256k1 group law, and then the ethereum address of S, as described in step 4. Call that nonceTimesGeneratorAddress. Then call the verifySignature method as: @dev verifySignature(PKx, PKyp, s, msgHash, nonceTimesGeneratorAddress) ************************************************************************** @dev This signging scheme deviates slightly from the classical Schnorr signature, in that the address of k*g is used in place of k*g itself, both when calculating e and when verifying sum S as described in the verification paragraph above. This reduces the difficulty of brute-forcing a signature by trying random secp256k1 points in place of k*g in the signature verification process from 256 bits to 160 bits. However, the difficulty of cracking the public key using "baby-step, giant-step" is only 128 bits, so this weakening constitutes no compromise in the security of the signatures or the key. @dev The constraint signingPubKeyX < HALF_Q comes from Eq. (281), p. 24 of Yellow Paper version 78d7b9a. ecrecover only accepts "s" inputs less than HALF_Q, to protect against a signature- malleability vulnerability in ECDSA. Schnorr does not have this vulnerability, but we must account for ecrecover's defense anyway. And since we are abusing ecrecover by putting signingPubKeyX in ecrecover's "s" argument the constraint applies to signingPubKeyX, even though it represents a value in the base field, and has no natural relationship to the order of the curve's cyclic group. ************************************************************************** @param msgHash is a 256-bit hash of the message being signed. @param signature is the actual signature, described as s in the above instructions. @param signingPubKeyX is the x ordinate of the public key. This must be less than HALF_Q. @param pubKeyYParity is 0 if the y ordinate of the public key is even, 1 if it's odd. @param nonceTimesGeneratorAddress is the ethereum address of k*g in the above instructions ************************************************************************** @return True if passed a valid signature, false otherwise. */ function verifySignature( bytes32 msgHash, uint256 signature, uint256 signingPubKeyX, uint8 pubKeyYParity, address nonceTimesGeneratorAddress ) internal pure returns (bool) { require(signingPubKeyX < HALF_Q, "Public-key x >= HALF_Q"); // Avoid signature malleability from multiple representations for ℤ/Qℤ elts require(signature < Q, "Sig must be reduced modulo Q"); // Forbid trivial inputs, to avoid ecrecover edge cases. The main thing to // avoid is something which causes ecrecover to return 0x0: then trivial // signatures could be constructed with the nonceTimesGeneratorAddress input // set to 0x0. // // solium-disable-next-line indentation require( nonceTimesGeneratorAddress != address(0) && signingPubKeyX > 0 && signature > 0 && msgHash > 0, "No zero inputs allowed" ); uint256 msgChallenge = uint256( keccak256(abi.encodePacked(signingPubKeyX, pubKeyYParity, msgHash, nonceTimesGeneratorAddress)) ); // Verify msgChallenge * signingPubKey + signature * generator == // nonce * generator // // https://ethresear.ch/t/you-can-kinda-abuse-ecrecover-to-do-ecmul-in-secp256k1-today/2384/9 // The point corresponding to the address returned by // ecrecover(-s*r,v,r,e*r) is (r⁻¹ mod Q)*(e*r*R-(-s)*r*g)=e*R+s*g, where R // is the (v,r) point. See https://crypto.stackexchange.com/a/18106 // // solium-disable-next-line indentation address recoveredAddress = ecrecover( // solium-disable-next-line zeppelin/no-arithmetic-operations bytes32(Q - mulmod(signingPubKeyX, signature, Q)), // https://ethereum.github.io/yellowpaper/paper.pdf p. 24, "The // value 27 represents an even y value and 28 represents an odd // y value." (pubKeyYParity == 0) ? 27 : 28, bytes32(signingPubKeyX), bytes32(mulmod(msgChallenge, signingPubKeyX, Q)) ); require(recoveredAddress != address(0), "Schnorr: recoveredAddress is 0"); return nonceTimesGeneratorAddress == recoveredAddress; } function verifySigningKeyX(uint256 signingPubKeyX) internal pure { require(signingPubKeyX < HALF_Q, "Public-key x >= HALF_Q"); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "IShared.sol"; /** * @title Shared contract * @notice Holds constants and modifiers that are used in multiple contracts * @dev It would be nice if this could be a library, but modifiers can't be exported :( */ abstract contract Shared is IShared { /// @dev The address used to indicate whether transfer should send native or a token address internal constant _NATIVE_ADDR = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE; address internal constant _ZERO_ADDR = address(0); bytes32 internal constant _NULL = ""; uint256 internal constant _E_18 = 1e18; /// @dev Checks that a uint isn't zero/empty modifier nzUint(uint256 u) { require(u != 0, "Shared: uint input is empty"); _; } /// @dev Checks that an address isn't zero/empty modifier nzAddr(address a) { require(a != _ZERO_ADDR, "Shared: address input is empty"); _; } /// @dev Checks that a bytes32 isn't zero/empty modifier nzBytes32(bytes32 b) { require(b != _NULL, "Shared: bytes32 input is empty"); _; } /// @dev Checks that the pubKeyX is populated modifier nzKey(Key memory key) { require(key.pubKeyX != 0, "Shared: pubKeyX is empty"); _; } }
File 3 of 4: FiatTokenProxy
pragma solidity ^0.4.24; // File: zos-lib/contracts/upgradeability/Proxy.sol /** * @title Proxy * @dev Implements delegation of calls to other contracts, with proper * forwarding of return values and bubbling of failures. * It defines a fallback function that delegates all calls to the address * returned by the abstract _implementation() internal function. */ contract Proxy { /** * @dev Fallback function. * Implemented entirely in `_fallback`. */ function () payable external { _fallback(); } /** * @return The Address of the implementation. */ function _implementation() internal view returns (address); /** * @dev Delegates execution to an implementation contract. * This is a low level function that doesn't return to its internal call site. * It will return to the external caller whatever the implementation returns. * @param implementation Address to delegate. */ function _delegate(address implementation) internal { assembly { // Copy msg.data. We take full control of memory in this inline assembly // block because it will not return to Solidity code. We overwrite the // Solidity scratch pad at memory position 0. calldatacopy(0, 0, calldatasize) // Call the implementation. // out and outsize are 0 because we don't know the size yet. let result := delegatecall(gas, implementation, 0, calldatasize, 0, 0) // Copy the returned data. returndatacopy(0, 0, returndatasize) switch result // delegatecall returns 0 on error. case 0 { revert(0, returndatasize) } default { return(0, returndatasize) } } } /** * @dev Function that is run as the first thing in the fallback function. * Can be redefined in derived contracts to add functionality. * Redefinitions must call super._willFallback(). */ function _willFallback() internal { } /** * @dev fallback implementation. * Extracted to enable manual triggering. */ function _fallback() internal { _willFallback(); _delegate(_implementation()); } } // File: openzeppelin-solidity/contracts/AddressUtils.sol /** * Utility library of inline functions on addresses */ library AddressUtils { /** * Returns whether the target address is a contract * @dev This function will return false if invoked during the constructor of a contract, * as the code is not actually created until after the constructor finishes. * @param addr address to check * @return whether the target address is a contract */ function isContract(address addr) internal view returns (bool) { uint256 size; // XXX Currently there is no better way to check if there is a contract in an address // than to check the size of the code at that address. // See https://ethereum.stackexchange.com/a/14016/36603 // for more details about how this works. // TODO Check this again before the Serenity release, because all addresses will be // contracts then. // solium-disable-next-line security/no-inline-assembly assembly { size := extcodesize(addr) } return size > 0; } } // File: zos-lib/contracts/upgradeability/UpgradeabilityProxy.sol /** * @title UpgradeabilityProxy * @dev This contract implements a proxy that allows to change the * implementation address to which it will delegate. * Such a change is called an implementation upgrade. */ contract UpgradeabilityProxy is Proxy { /** * @dev Emitted when the implementation is upgraded. * @param implementation Address of the new implementation. */ event Upgraded(address implementation); /** * @dev Storage slot with the address of the current implementation. * This is the keccak-256 hash of "org.zeppelinos.proxy.implementation", and is * validated in the constructor. */ bytes32 private constant IMPLEMENTATION_SLOT = 0x7050c9e0f4ca769c69bd3a8ef740bc37934f8e2c036e5a723fd8ee048ed3f8c3; /** * @dev Contract constructor. * @param _implementation Address of the initial implementation. */ constructor(address _implementation) public { assert(IMPLEMENTATION_SLOT == keccak256("org.zeppelinos.proxy.implementation")); _setImplementation(_implementation); } /** * @dev Returns the current implementation. * @return Address of the current implementation */ function _implementation() internal view returns (address impl) { bytes32 slot = IMPLEMENTATION_SLOT; assembly { impl := sload(slot) } } /** * @dev Upgrades the proxy to a new implementation. * @param newImplementation Address of the new implementation. */ function _upgradeTo(address newImplementation) internal { _setImplementation(newImplementation); emit Upgraded(newImplementation); } /** * @dev Sets the implementation address of the proxy. * @param newImplementation Address of the new implementation. */ function _setImplementation(address newImplementation) private { require(AddressUtils.isContract(newImplementation), "Cannot set a proxy implementation to a non-contract address"); bytes32 slot = IMPLEMENTATION_SLOT; assembly { sstore(slot, newImplementation) } } } // File: zos-lib/contracts/upgradeability/AdminUpgradeabilityProxy.sol /** * @title AdminUpgradeabilityProxy * @dev This contract combines an upgradeability proxy with an authorization * mechanism for administrative tasks. * All external functions in this contract must be guarded by the * `ifAdmin` modifier. See ethereum/solidity#3864 for a Solidity * feature proposal that would enable this to be done automatically. */ contract AdminUpgradeabilityProxy is UpgradeabilityProxy { /** * @dev Emitted when the administration has been transferred. * @param previousAdmin Address of the previous admin. * @param newAdmin Address of the new admin. */ event AdminChanged(address previousAdmin, address newAdmin); /** * @dev Storage slot with the admin of the contract. * This is the keccak-256 hash of "org.zeppelinos.proxy.admin", and is * validated in the constructor. */ bytes32 private constant ADMIN_SLOT = 0x10d6a54a4754c8869d6886b5f5d7fbfa5b4522237ea5c60d11bc4e7a1ff9390b; /** * @dev Modifier to check whether the `msg.sender` is the admin. * If it is, it will run the function. Otherwise, it will delegate the call * to the implementation. */ modifier ifAdmin() { if (msg.sender == _admin()) { _; } else { _fallback(); } } /** * Contract constructor. * It sets the `msg.sender` as the proxy administrator. * @param _implementation address of the initial implementation. */ constructor(address _implementation) UpgradeabilityProxy(_implementation) public { assert(ADMIN_SLOT == keccak256("org.zeppelinos.proxy.admin")); _setAdmin(msg.sender); } /** * @return The address of the proxy admin. */ function admin() external view ifAdmin returns (address) { return _admin(); } /** * @return The address of the implementation. */ function implementation() external view ifAdmin returns (address) { return _implementation(); } /** * @dev Changes the admin of the proxy. * Only the current admin can call this function. * @param newAdmin Address to transfer proxy administration to. */ function changeAdmin(address newAdmin) external ifAdmin { require(newAdmin != address(0), "Cannot change the admin of a proxy to the zero address"); emit AdminChanged(_admin(), newAdmin); _setAdmin(newAdmin); } /** * @dev Upgrade the backing implementation of the proxy. * Only the admin can call this function. * @param newImplementation Address of the new implementation. */ function upgradeTo(address newImplementation) external ifAdmin { _upgradeTo(newImplementation); } /** * @dev Upgrade the backing implementation of the proxy and call a function * on the new implementation. * This is useful to initialize the proxied contract. * @param newImplementation Address of the new implementation. * @param data Data to send as msg.data in the low level call. * It should include the signature and the parameters of the function to be * called, as described in * https://solidity.readthedocs.io/en/develop/abi-spec.html#function-selector-and-argument-encoding. */ function upgradeToAndCall(address newImplementation, bytes data) payable external ifAdmin { _upgradeTo(newImplementation); require(address(this).call.value(msg.value)(data)); } /** * @return The admin slot. */ function _admin() internal view returns (address adm) { bytes32 slot = ADMIN_SLOT; assembly { adm := sload(slot) } } /** * @dev Sets the address of the proxy admin. * @param newAdmin Address of the new proxy admin. */ function _setAdmin(address newAdmin) internal { bytes32 slot = ADMIN_SLOT; assembly { sstore(slot, newAdmin) } } /** * @dev Only fall back when the sender is not the admin. */ function _willFallback() internal { require(msg.sender != _admin(), "Cannot call fallback function from the proxy admin"); super._willFallback(); } } // File: contracts/FiatTokenProxy.sol /** * Copyright CENTRE SECZ 2018 * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is furnished to * do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ pragma solidity ^0.4.24; /** * @title FiatTokenProxy * @dev This contract proxies FiatToken calls and enables FiatToken upgrades */ contract FiatTokenProxy is AdminUpgradeabilityProxy { constructor(address _implementation) public AdminUpgradeabilityProxy(_implementation) { } }
File 4 of 4: FiatTokenV2_2
/** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { EIP712Domain } from "./EIP712Domain.sol"; // solhint-disable-line no-unused-import import { Blacklistable } from "../v1/Blacklistable.sol"; // solhint-disable-line no-unused-import import { FiatTokenV1 } from "../v1/FiatTokenV1.sol"; // solhint-disable-line no-unused-import import { FiatTokenV2 } from "./FiatTokenV2.sol"; // solhint-disable-line no-unused-import import { FiatTokenV2_1 } from "./FiatTokenV2_1.sol"; import { EIP712 } from "../util/EIP712.sol"; // solhint-disable func-name-mixedcase /** * @title FiatToken V2.2 * @notice ERC20 Token backed by fiat reserves, version 2.2 */ contract FiatTokenV2_2 is FiatTokenV2_1 { /** * @notice Initialize v2.2 * @param accountsToBlacklist A list of accounts to migrate from the old blacklist * @param newSymbol New token symbol * data structure to the new blacklist data structure. */ function initializeV2_2( address[] calldata accountsToBlacklist, string calldata newSymbol ) external { // solhint-disable-next-line reason-string require(_initializedVersion == 2); // Update fiat token symbol symbol = newSymbol; // Add previously blacklisted accounts to the new blacklist data structure // and remove them from the old blacklist data structure. for (uint256 i = 0; i < accountsToBlacklist.length; i++) { require( _deprecatedBlacklisted[accountsToBlacklist[i]], "FiatTokenV2_2: Blacklisting previously unblacklisted account!" ); _blacklist(accountsToBlacklist[i]); delete _deprecatedBlacklisted[accountsToBlacklist[i]]; } _blacklist(address(this)); delete _deprecatedBlacklisted[address(this)]; _initializedVersion = 3; } /** * @dev Internal function to get the current chain id. * @return The current chain id. */ function _chainId() internal virtual view returns (uint256) { uint256 chainId; assembly { chainId := chainid() } return chainId; } /** * @inheritdoc EIP712Domain */ function _domainSeparator() internal override view returns (bytes32) { return EIP712.makeDomainSeparator(name, "2", _chainId()); } /** * @notice Update allowance with a signed permit * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param owner Token owner's address (Authorizer) * @param spender Spender's address * @param value Amount of allowance * @param deadline The time at which the signature expires (unix time), or max uint256 value to signal no expiration * @param signature Signature bytes signed by an EOA wallet or a contract wallet */ function permit( address owner, address spender, uint256 value, uint256 deadline, bytes memory signature ) external whenNotPaused { _permit(owner, spender, value, deadline, signature); } /** * @notice Execute a transfer with a signed authorization * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param signature Signature bytes signed by an EOA wallet or a contract wallet */ function transferWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, bytes memory signature ) external whenNotPaused notBlacklisted(from) notBlacklisted(to) { _transferWithAuthorization( from, to, value, validAfter, validBefore, nonce, signature ); } /** * @notice Receive a transfer with a signed authorization from the payer * @dev This has an additional check to ensure that the payee's address * matches the caller of this function to prevent front-running attacks. * EOA wallet signatures should be packed in the order of r, s, v. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param signature Signature bytes signed by an EOA wallet or a contract wallet */ function receiveWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, bytes memory signature ) external whenNotPaused notBlacklisted(from) notBlacklisted(to) { _receiveWithAuthorization( from, to, value, validAfter, validBefore, nonce, signature ); } /** * @notice Attempt to cancel an authorization * @dev Works only if the authorization is not yet used. * EOA wallet signatures should be packed in the order of r, s, v. * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param signature Signature bytes signed by an EOA wallet or a contract wallet */ function cancelAuthorization( address authorizer, bytes32 nonce, bytes memory signature ) external whenNotPaused { _cancelAuthorization(authorizer, nonce, signature); } /** * @dev Helper method that sets the blacklist state of an account on balanceAndBlacklistStates. * If _shouldBlacklist is true, we apply a (1 << 255) bitmask with an OR operation on the * account's balanceAndBlacklistState. This flips the high bit for the account to 1, * indicating that the account is blacklisted. * * If _shouldBlacklist if false, we reset the account's balanceAndBlacklistStates to their * balances. This clears the high bit for the account, indicating that the account is unblacklisted. * @param _account The address of the account. * @param _shouldBlacklist True if the account should be blacklisted, false if the account should be unblacklisted. */ function _setBlacklistState(address _account, bool _shouldBlacklist) internal override { balanceAndBlacklistStates[_account] = _shouldBlacklist ? balanceAndBlacklistStates[_account] | (1 << 255) : _balanceOf(_account); } /** * @dev Helper method that sets the balance of an account on balanceAndBlacklistStates. * Since balances are stored in the last 255 bits of the balanceAndBlacklistStates value, * we need to ensure that the updated balance does not exceed (2^255 - 1). * Since blacklisted accounts' balances cannot be updated, the method will also * revert if the account is blacklisted * @param _account The address of the account. * @param _balance The new fiat token balance of the account (max: (2^255 - 1)). */ function _setBalance(address _account, uint256 _balance) internal override { require( _balance <= ((1 << 255) - 1), "FiatTokenV2_2: Balance exceeds (2^255 - 1)" ); require( !_isBlacklisted(_account), "FiatTokenV2_2: Account is blacklisted" ); balanceAndBlacklistStates[_account] = _balance; } /** * @inheritdoc Blacklistable */ function _isBlacklisted(address _account) internal override view returns (bool) { return balanceAndBlacklistStates[_account] >> 255 == 1; } /** * @dev Helper method to obtain the balance of an account. Since balances * are stored in the last 255 bits of the balanceAndBlacklistStates value, * we apply a ((1 << 255) - 1) bit bitmask with an AND operation on the * balanceAndBlacklistState to obtain the balance. * @param _account The address of the account. * @return The fiat token balance of the account. */ function _balanceOf(address _account) internal override view returns (uint256) { return balanceAndBlacklistStates[_account] & ((1 << 255) - 1); } /** * @inheritdoc FiatTokenV1 */ function approve(address spender, uint256 value) external override whenNotPaused returns (bool) { _approve(msg.sender, spender, value); return true; } /** * @inheritdoc FiatTokenV2 */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external override whenNotPaused { _permit(owner, spender, value, deadline, v, r, s); } /** * @inheritdoc FiatTokenV2 */ function increaseAllowance(address spender, uint256 increment) external override whenNotPaused returns (bool) { _increaseAllowance(msg.sender, spender, increment); return true; } /** * @inheritdoc FiatTokenV2 */ function decreaseAllowance(address spender, uint256 decrement) external override whenNotPaused returns (bool) { _decreaseAllowance(msg.sender, spender, decrement); return true; } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.2 <0.8.0; /** * @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 * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize, which returns 0 for contracts in // construction, since the code is only stored at the end of the // constructor execution. uint256 size; // solhint-disable-next-line no-inline-assembly assembly { size := extcodesize(account) } return size > 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"); // solhint-disable-next-line avoid-low-level-calls, avoid-call-value (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 functionCall(target, data, "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"); require(isContract(target), "Address: call to non-contract"); // solhint-disable-next-line avoid-low-level-calls (bool success, bytes memory returndata) = target.call{ value: value }(data); return _verifyCallResult(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) { require(isContract(target), "Address: static call to non-contract"); // solhint-disable-next-line avoid-low-level-calls (bool success, bytes memory returndata) = target.staticcall(data); return _verifyCallResult(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) { require(isContract(target), "Address: delegate call to non-contract"); // solhint-disable-next-line avoid-low-level-calls (bool success, bytes memory returndata) = target.delegatecall(data); return _verifyCallResult(success, returndata, errorMessage); } function _verifyCallResult(bool success, bytes memory returndata, string memory errorMessage) private pure returns(bytes memory) { if (success) { return returndata; } else { // 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 // solhint-disable-next-line no-inline-assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert(errorMessage); } } } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.0 <0.8.0; import "./IERC20.sol"; import "../../math/SafeMath.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 SafeMath for uint256; 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' // solhint-disable-next-line max-line-length 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).add(value); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal { uint256 newAllowance = token.allowance(address(this), spender).sub(value, "SafeERC20: decreased allowance below zero"); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } /** * @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 // solhint-disable-next-line max-line-length require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed"); } } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.0 <0.8.0; /** * @dev Interface of the ERC20 standard as defined in the EIP. */ interface IERC20 { /** * @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 `recipient`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address recipient, 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 `sender` to `recipient` 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 sender, address recipient, uint256 amount) external returns (bool); /** * @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); } // SPDX-License-Identifier: MIT pragma solidity >=0.6.0 <0.8.0; /** * @dev Wrappers over Solidity's arithmetic operations with added overflow * checks. * * Arithmetic operations in Solidity wrap on overflow. This can easily result * in bugs, because programmers usually assume that an overflow raises an * error, which is the standard behavior in high level programming languages. * `SafeMath` restores this intuition by reverting the transaction when an * operation overflows. * * Using this library instead of the unchecked operations eliminates an entire * class of bugs, so it's recommended to use it always. */ library SafeMath { /** * @dev Returns the addition of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) { uint256 c = a + b; if (c < a) return (false, 0); return (true, c); } /** * @dev Returns the substraction of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b > a) return (false, 0); return (true, a - b); } /** * @dev Returns the multiplication of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) { // Gas optimization: this is cheaper than requiring 'a' not being zero, but the // benefit is lost if 'b' is also tested. // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 if (a == 0) return (true, 0); uint256 c = a * b; if (c / a != b) return (false, 0); return (true, c); } /** * @dev Returns the division of two unsigned integers, with a division by zero flag. * * _Available since v3.4._ */ function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b == 0) return (false, 0); return (true, a / b); } /** * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag. * * _Available since v3.4._ */ function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b == 0) return (false, 0); return (true, a % b); } /** * @dev Returns the addition of two unsigned integers, reverting on * overflow. * * Counterpart to Solidity's `+` operator. * * Requirements: * * - Addition cannot overflow. */ function add(uint256 a, uint256 b) internal pure returns (uint256) { uint256 c = a + b; require(c >= a, "SafeMath: addition overflow"); return c; } /** * @dev Returns the subtraction of two unsigned integers, reverting on * overflow (when the result is negative). * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub(uint256 a, uint256 b) internal pure returns (uint256) { require(b <= a, "SafeMath: subtraction overflow"); return a - b; } /** * @dev Returns the multiplication of two unsigned integers, reverting on * overflow. * * Counterpart to Solidity's `*` operator. * * Requirements: * * - Multiplication cannot overflow. */ function mul(uint256 a, uint256 b) internal pure returns (uint256) { if (a == 0) return 0; uint256 c = a * b; require(c / a == b, "SafeMath: multiplication overflow"); return c; } /** * @dev Returns the integer division of two unsigned integers, reverting on * division by zero. The result is rounded towards zero. * * Counterpart to Solidity's `/` operator. Note: this function uses a * `revert` opcode (which leaves remaining gas untouched) while Solidity * uses an invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function div(uint256 a, uint256 b) internal pure returns (uint256) { require(b > 0, "SafeMath: division by zero"); return a / b; } /** * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), * reverting when dividing by zero. * * Counterpart to Solidity's `%` operator. This function uses a `revert` * opcode (which leaves remaining gas untouched) while Solidity uses an * invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function mod(uint256 a, uint256 b) internal pure returns (uint256) { require(b > 0, "SafeMath: modulo by zero"); return a % b; } /** * @dev Returns the subtraction of two unsigned integers, reverting with custom message on * overflow (when the result is negative). * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {trySub}. * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b <= a, errorMessage); return a - b; } /** * @dev Returns the integer division of two unsigned integers, reverting with custom message on * division by zero. The result is rounded towards zero. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {tryDiv}. * * Counterpart to Solidity's `/` operator. Note: this function uses a * `revert` opcode (which leaves remaining gas untouched) while Solidity * uses an invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b > 0, errorMessage); return a / b; } /** * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), * reverting with custom message when dividing by zero. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {tryMod}. * * Counterpart to Solidity's `%` operator. This function uses a `revert` * opcode (which leaves remaining gas untouched) while Solidity uses an * invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b > 0, errorMessage); return a % b; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { FiatTokenV2 } from "./FiatTokenV2.sol"; // solhint-disable func-name-mixedcase /** * @title FiatToken V2.1 * @notice ERC20 Token backed by fiat reserves, version 2.1 */ contract FiatTokenV2_1 is FiatTokenV2 { /** * @notice Initialize v2.1 * @param lostAndFound The address to which the locked funds are sent */ function initializeV2_1(address lostAndFound) external { // solhint-disable-next-line reason-string require(_initializedVersion == 1); uint256 lockedAmount = _balanceOf(address(this)); if (lockedAmount > 0) { _transfer(address(this), lostAndFound, lockedAmount); } _blacklist(address(this)); _initializedVersion = 2; } /** * @notice Version string for the EIP712 domain separator * @return Version string */ function version() external pure returns (string memory) { return "2"; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { FiatTokenV1_1 } from "../v1.1/FiatTokenV1_1.sol"; import { EIP712 } from "../util/EIP712.sol"; import { EIP3009 } from "./EIP3009.sol"; import { EIP2612 } from "./EIP2612.sol"; /** * @title FiatToken V2 * @notice ERC20 Token backed by fiat reserves, version 2 */ contract FiatTokenV2 is FiatTokenV1_1, EIP3009, EIP2612 { uint8 internal _initializedVersion; /** * @notice Initialize v2 * @param newName New token name */ function initializeV2(string calldata newName) external { // solhint-disable-next-line reason-string require(initialized && _initializedVersion == 0); name = newName; _DEPRECATED_CACHED_DOMAIN_SEPARATOR = EIP712.makeDomainSeparator( newName, "2" ); _initializedVersion = 1; } /** * @notice Increase the allowance by a given increment * @param spender Spender's address * @param increment Amount of increase in allowance * @return True if successful */ function increaseAllowance(address spender, uint256 increment) external virtual whenNotPaused notBlacklisted(msg.sender) notBlacklisted(spender) returns (bool) { _increaseAllowance(msg.sender, spender, increment); return true; } /** * @notice Decrease the allowance by a given decrement * @param spender Spender's address * @param decrement Amount of decrease in allowance * @return True if successful */ function decreaseAllowance(address spender, uint256 decrement) external virtual whenNotPaused notBlacklisted(msg.sender) notBlacklisted(spender) returns (bool) { _decreaseAllowance(msg.sender, spender, decrement); return true; } /** * @notice Execute a transfer with a signed authorization * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function transferWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) external whenNotPaused notBlacklisted(from) notBlacklisted(to) { _transferWithAuthorization( from, to, value, validAfter, validBefore, nonce, v, r, s ); } /** * @notice Receive a transfer with a signed authorization from the payer * @dev This has an additional check to ensure that the payee's address * matches the caller of this function to prevent front-running attacks. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function receiveWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) external whenNotPaused notBlacklisted(from) notBlacklisted(to) { _receiveWithAuthorization( from, to, value, validAfter, validBefore, nonce, v, r, s ); } /** * @notice Attempt to cancel an authorization * @dev Works only if the authorization is not yet used. * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function cancelAuthorization( address authorizer, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) external whenNotPaused { _cancelAuthorization(authorizer, nonce, v, r, s); } /** * @notice Update allowance with a signed permit * @param owner Token owner's address (Authorizer) * @param spender Spender's address * @param value Amount of allowance * @param deadline The time at which the signature expires (unix time), or max uint256 value to signal no expiration * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external virtual whenNotPaused notBlacklisted(owner) notBlacklisted(spender) { _permit(owner, spender, value, deadline, v, r, s); } /** * @dev Internal function to increase the allowance by a given increment * @param owner Token owner's address * @param spender Spender's address * @param increment Amount of increase */ function _increaseAllowance( address owner, address spender, uint256 increment ) internal override { _approve(owner, spender, allowed[owner][spender].add(increment)); } /** * @dev Internal function to decrease the allowance by a given decrement * @param owner Token owner's address * @param spender Spender's address * @param decrement Amount of decrease */ function _decreaseAllowance( address owner, address spender, uint256 decrement ) internal override { _approve( owner, spender, allowed[owner][spender].sub( decrement, "ERC20: decreased allowance below zero" ) ); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; // solhint-disable func-name-mixedcase /** * @title EIP712 Domain */ contract EIP712Domain { // was originally DOMAIN_SEPARATOR // but that has been moved to a method so we can override it in V2_2+ bytes32 internal _DEPRECATED_CACHED_DOMAIN_SEPARATOR; /** * @notice Get the EIP712 Domain Separator. * @return The bytes32 EIP712 domain separator. */ function DOMAIN_SEPARATOR() external view returns (bytes32) { return _domainSeparator(); } /** * @dev Internal method to get the EIP712 Domain Separator. * @return The bytes32 EIP712 domain separator. */ function _domainSeparator() internal virtual view returns (bytes32) { return _DEPRECATED_CACHED_DOMAIN_SEPARATOR; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { AbstractFiatTokenV2 } from "./AbstractFiatTokenV2.sol"; import { EIP712Domain } from "./EIP712Domain.sol"; import { SignatureChecker } from "../util/SignatureChecker.sol"; import { MessageHashUtils } from "../util/MessageHashUtils.sol"; /** * @title EIP-3009 * @notice Provide internal implementation for gas-abstracted transfers * @dev Contracts that inherit from this must wrap these with publicly * accessible functions, optionally adding modifiers where necessary */ abstract contract EIP3009 is AbstractFiatTokenV2, EIP712Domain { // keccak256("TransferWithAuthorization(address from,address to,uint256 value,uint256 validAfter,uint256 validBefore,bytes32 nonce)") bytes32 public constant TRANSFER_WITH_AUTHORIZATION_TYPEHASH = 0x7c7c6cdb67a18743f49ec6fa9b35f50d52ed05cbed4cc592e13b44501c1a2267; // keccak256("ReceiveWithAuthorization(address from,address to,uint256 value,uint256 validAfter,uint256 validBefore,bytes32 nonce)") bytes32 public constant RECEIVE_WITH_AUTHORIZATION_TYPEHASH = 0xd099cc98ef71107a616c4f0f941f04c322d8e254fe26b3c6668db87aae413de8; // keccak256("CancelAuthorization(address authorizer,bytes32 nonce)") bytes32 public constant CANCEL_AUTHORIZATION_TYPEHASH = 0x158b0a9edf7a828aad02f63cd515c68ef2f50ba807396f6d12842833a1597429; /** * @dev authorizer address => nonce => bool (true if nonce is used) */ mapping(address => mapping(bytes32 => bool)) private _authorizationStates; event AuthorizationUsed(address indexed authorizer, bytes32 indexed nonce); event AuthorizationCanceled( address indexed authorizer, bytes32 indexed nonce ); /** * @notice Returns the state of an authorization * @dev Nonces are randomly generated 32-byte data unique to the * authorizer's address * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @return True if the nonce is used */ function authorizationState(address authorizer, bytes32 nonce) external view returns (bool) { return _authorizationStates[authorizer][nonce]; } /** * @notice Execute a transfer with a signed authorization * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function _transferWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) internal { _transferWithAuthorization( from, to, value, validAfter, validBefore, nonce, abi.encodePacked(r, s, v) ); } /** * @notice Execute a transfer with a signed authorization * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param signature Signature byte array produced by an EOA wallet or a contract wallet */ function _transferWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, bytes memory signature ) internal { _requireValidAuthorization(from, nonce, validAfter, validBefore); _requireValidSignature( from, keccak256( abi.encode( TRANSFER_WITH_AUTHORIZATION_TYPEHASH, from, to, value, validAfter, validBefore, nonce ) ), signature ); _markAuthorizationAsUsed(from, nonce); _transfer(from, to, value); } /** * @notice Receive a transfer with a signed authorization from the payer * @dev This has an additional check to ensure that the payee's address * matches the caller of this function to prevent front-running attacks. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function _receiveWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) internal { _receiveWithAuthorization( from, to, value, validAfter, validBefore, nonce, abi.encodePacked(r, s, v) ); } /** * @notice Receive a transfer with a signed authorization from the payer * @dev This has an additional check to ensure that the payee's address * matches the caller of this function to prevent front-running attacks. * EOA wallet signatures should be packed in the order of r, s, v. * @param from Payer's address (Authorizer) * @param to Payee's address * @param value Amount to be transferred * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) * @param nonce Unique nonce * @param signature Signature byte array produced by an EOA wallet or a contract wallet */ function _receiveWithAuthorization( address from, address to, uint256 value, uint256 validAfter, uint256 validBefore, bytes32 nonce, bytes memory signature ) internal { require(to == msg.sender, "FiatTokenV2: caller must be the payee"); _requireValidAuthorization(from, nonce, validAfter, validBefore); _requireValidSignature( from, keccak256( abi.encode( RECEIVE_WITH_AUTHORIZATION_TYPEHASH, from, to, value, validAfter, validBefore, nonce ) ), signature ); _markAuthorizationAsUsed(from, nonce); _transfer(from, to, value); } /** * @notice Attempt to cancel an authorization * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function _cancelAuthorization( address authorizer, bytes32 nonce, uint8 v, bytes32 r, bytes32 s ) internal { _cancelAuthorization(authorizer, nonce, abi.encodePacked(r, s, v)); } /** * @notice Attempt to cancel an authorization * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param signature Signature byte array produced by an EOA wallet or a contract wallet */ function _cancelAuthorization( address authorizer, bytes32 nonce, bytes memory signature ) internal { _requireUnusedAuthorization(authorizer, nonce); _requireValidSignature( authorizer, keccak256( abi.encode(CANCEL_AUTHORIZATION_TYPEHASH, authorizer, nonce) ), signature ); _authorizationStates[authorizer][nonce] = true; emit AuthorizationCanceled(authorizer, nonce); } /** * @notice Validates that signature against input data struct * @param signer Signer's address * @param dataHash Hash of encoded data struct * @param signature Signature byte array produced by an EOA wallet or a contract wallet */ function _requireValidSignature( address signer, bytes32 dataHash, bytes memory signature ) private view { require( SignatureChecker.isValidSignatureNow( signer, MessageHashUtils.toTypedDataHash(_domainSeparator(), dataHash), signature ), "FiatTokenV2: invalid signature" ); } /** * @notice Check that an authorization is unused * @param authorizer Authorizer's address * @param nonce Nonce of the authorization */ function _requireUnusedAuthorization(address authorizer, bytes32 nonce) private view { require( !_authorizationStates[authorizer][nonce], "FiatTokenV2: authorization is used or canceled" ); } /** * @notice Check that authorization is valid * @param authorizer Authorizer's address * @param nonce Nonce of the authorization * @param validAfter The time after which this is valid (unix time) * @param validBefore The time before which this is valid (unix time) */ function _requireValidAuthorization( address authorizer, bytes32 nonce, uint256 validAfter, uint256 validBefore ) private view { require( now > validAfter, "FiatTokenV2: authorization is not yet valid" ); require(now < validBefore, "FiatTokenV2: authorization is expired"); _requireUnusedAuthorization(authorizer, nonce); } /** * @notice Mark an authorization as used * @param authorizer Authorizer's address * @param nonce Nonce of the authorization */ function _markAuthorizationAsUsed(address authorizer, bytes32 nonce) private { _authorizationStates[authorizer][nonce] = true; emit AuthorizationUsed(authorizer, nonce); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { AbstractFiatTokenV2 } from "./AbstractFiatTokenV2.sol"; import { EIP712Domain } from "./EIP712Domain.sol"; import { MessageHashUtils } from "../util/MessageHashUtils.sol"; import { SignatureChecker } from "../util/SignatureChecker.sol"; /** * @title EIP-2612 * @notice Provide internal implementation for gas-abstracted approvals */ abstract contract EIP2612 is AbstractFiatTokenV2, EIP712Domain { // keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)") bytes32 public constant PERMIT_TYPEHASH = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9; mapping(address => uint256) private _permitNonces; /** * @notice Nonces for permit * @param owner Token owner's address (Authorizer) * @return Next nonce */ function nonces(address owner) external view returns (uint256) { return _permitNonces[owner]; } /** * @notice Verify a signed approval permit and execute if valid * @param owner Token owner's address (Authorizer) * @param spender Spender's address * @param value Amount of allowance * @param deadline The time at which the signature expires (unix time), or max uint256 value to signal no expiration * @param v v of the signature * @param r r of the signature * @param s s of the signature */ function _permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) internal { _permit(owner, spender, value, deadline, abi.encodePacked(r, s, v)); } /** * @notice Verify a signed approval permit and execute if valid * @dev EOA wallet signatures should be packed in the order of r, s, v. * @param owner Token owner's address (Authorizer) * @param spender Spender's address * @param value Amount of allowance * @param deadline The time at which the signature expires (unix time), or max uint256 value to signal no expiration * @param signature Signature byte array signed by an EOA wallet or a contract wallet */ function _permit( address owner, address spender, uint256 value, uint256 deadline, bytes memory signature ) internal { require( deadline == type(uint256).max || deadline >= now, "FiatTokenV2: permit is expired" ); bytes32 typedDataHash = MessageHashUtils.toTypedDataHash( _domainSeparator(), keccak256( abi.encode( PERMIT_TYPEHASH, owner, spender, value, _permitNonces[owner]++, deadline ) ) ); require( SignatureChecker.isValidSignatureNow( owner, typedDataHash, signature ), "EIP2612: invalid signature" ); _approve(owner, spender, value); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { AbstractFiatTokenV1 } from "../v1/AbstractFiatTokenV1.sol"; abstract contract AbstractFiatTokenV2 is AbstractFiatTokenV1 { function _increaseAllowance( address owner, address spender, uint256 increment ) internal virtual; function _decreaseAllowance( address owner, address spender, uint256 decrement ) internal virtual; } /** * SPDX-License-Identifier: MIT * * Copyright (c) 2016 Smart Contract Solutions, Inc. * Copyright (c) 2018-2020 CENTRE SECZ * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ pragma solidity 0.6.12; import { Ownable } from "./Ownable.sol"; /** * @notice Base contract which allows children to implement an emergency stop * mechanism * @dev Forked from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/feb665136c0dae9912e08397c1a21c4af3651ef3/contracts/lifecycle/Pausable.sol * Modifications: * 1. Added pauser role, switched pause/unpause to be onlyPauser (6/14/2018) * 2. Removed whenNotPause/whenPaused from pause/unpause (6/14/2018) * 3. Removed whenPaused (6/14/2018) * 4. Switches ownable library to use ZeppelinOS (7/12/18) * 5. Remove constructor (7/13/18) * 6. Reformat, conform to Solidity 0.6 syntax and add error messages (5/13/20) * 7. Make public functions external (5/27/20) */ contract Pausable is Ownable { event Pause(); event Unpause(); event PauserChanged(address indexed newAddress); address public pauser; bool public paused = false; /** * @dev Modifier to make a function callable only when the contract is not paused. */ modifier whenNotPaused() { require(!paused, "Pausable: paused"); _; } /** * @dev throws if called by any account other than the pauser */ modifier onlyPauser() { require(msg.sender == pauser, "Pausable: caller is not the pauser"); _; } /** * @dev called by the owner to pause, triggers stopped state */ function pause() external onlyPauser { paused = true; emit Pause(); } /** * @dev called by the owner to unpause, returns to normal state */ function unpause() external onlyPauser { paused = false; emit Unpause(); } /** * @notice Updates the pauser address. * @param _newPauser The address of the new pauser. */ function updatePauser(address _newPauser) external onlyOwner { require( _newPauser != address(0), "Pausable: new pauser is the zero address" ); pauser = _newPauser; emit PauserChanged(pauser); } } /** * SPDX-License-Identifier: MIT * * Copyright (c) 2018 zOS Global Limited. * Copyright (c) 2018-2020 CENTRE SECZ * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ pragma solidity 0.6.12; /** * @notice The Ownable contract has an owner address, and provides basic * authorization control functions * @dev Forked from https://github.com/OpenZeppelin/openzeppelin-labs/blob/3887ab77b8adafba4a26ace002f3a684c1a3388b/upgradeability_ownership/contracts/ownership/Ownable.sol * Modifications: * 1. Consolidate OwnableStorage into this contract (7/13/18) * 2. Reformat, conform to Solidity 0.6 syntax, and add error messages (5/13/20) * 3. Make public functions external (5/27/20) */ contract Ownable { // Owner of the contract address private _owner; /** * @dev Event to show ownership has been transferred * @param previousOwner representing the address of the previous owner * @param newOwner representing the address of the new owner */ event OwnershipTransferred(address previousOwner, address newOwner); /** * @dev The constructor sets the original owner of the contract to the sender account. */ constructor() public { setOwner(msg.sender); } /** * @dev Tells the address of the owner * @return the address of the owner */ function owner() external view returns (address) { return _owner; } /** * @dev Sets a new owner address */ function setOwner(address newOwner) internal { _owner = newOwner; } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { require(msg.sender == _owner, "Ownable: caller is not the owner"); _; } /** * @dev Allows the current owner to transfer control of the contract to a newOwner. * @param newOwner The address to transfer ownership to. */ function transferOwnership(address newOwner) external onlyOwner { require( newOwner != address(0), "Ownable: new owner is the zero address" ); emit OwnershipTransferred(_owner, newOwner); setOwner(newOwner); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { SafeMath } from "@openzeppelin/contracts/math/SafeMath.sol"; import { AbstractFiatTokenV1 } from "./AbstractFiatTokenV1.sol"; import { Ownable } from "./Ownable.sol"; import { Pausable } from "./Pausable.sol"; import { Blacklistable } from "./Blacklistable.sol"; /** * @title FiatToken * @dev ERC20 Token backed by fiat reserves */ contract FiatTokenV1 is AbstractFiatTokenV1, Ownable, Pausable, Blacklistable { using SafeMath for uint256; string public name; string public symbol; uint8 public decimals; string public currency; address public masterMinter; bool internal initialized; /// @dev A mapping that stores the balance and blacklist states for a given address. /// The first bit defines whether the address is blacklisted (1 if blacklisted, 0 otherwise). /// The last 255 bits define the balance for the address. mapping(address => uint256) internal balanceAndBlacklistStates; mapping(address => mapping(address => uint256)) internal allowed; uint256 internal totalSupply_ = 0; mapping(address => bool) internal minters; mapping(address => uint256) internal minterAllowed; event Mint(address indexed minter, address indexed to, uint256 amount); event Burn(address indexed burner, uint256 amount); event MinterConfigured(address indexed minter, uint256 minterAllowedAmount); event MinterRemoved(address indexed oldMinter); event MasterMinterChanged(address indexed newMasterMinter); /** * @notice Initializes the fiat token contract. * @param tokenName The name of the fiat token. * @param tokenSymbol The symbol of the fiat token. * @param tokenCurrency The fiat currency that the token represents. * @param tokenDecimals The number of decimals that the token uses. * @param newMasterMinter The masterMinter address for the fiat token. * @param newPauser The pauser address for the fiat token. * @param newBlacklister The blacklister address for the fiat token. * @param newOwner The owner of the fiat token. */ function initialize( string memory tokenName, string memory tokenSymbol, string memory tokenCurrency, uint8 tokenDecimals, address newMasterMinter, address newPauser, address newBlacklister, address newOwner ) public { require(!initialized, "FiatToken: contract is already initialized"); require( newMasterMinter != address(0), "FiatToken: new masterMinter is the zero address" ); require( newPauser != address(0), "FiatToken: new pauser is the zero address" ); require( newBlacklister != address(0), "FiatToken: new blacklister is the zero address" ); require( newOwner != address(0), "FiatToken: new owner is the zero address" ); name = tokenName; symbol = tokenSymbol; currency = tokenCurrency; decimals = tokenDecimals; masterMinter = newMasterMinter; pauser = newPauser; blacklister = newBlacklister; setOwner(newOwner); initialized = true; } /** * @dev Throws if called by any account other than a minter. */ modifier onlyMinters() { require(minters[msg.sender], "FiatToken: caller is not a minter"); _; } /** * @notice Mints fiat tokens to an address. * @param _to The address that will receive the minted tokens. * @param _amount The amount of tokens to mint. Must be less than or equal * to the minterAllowance of the caller. * @return True if the operation was successful. */ function mint(address _to, uint256 _amount) external whenNotPaused onlyMinters notBlacklisted(msg.sender) notBlacklisted(_to) returns (bool) { require(_to != address(0), "FiatToken: mint to the zero address"); require(_amount > 0, "FiatToken: mint amount not greater than 0"); uint256 mintingAllowedAmount = minterAllowed[msg.sender]; require( _amount <= mintingAllowedAmount, "FiatToken: mint amount exceeds minterAllowance" ); totalSupply_ = totalSupply_.add(_amount); _setBalance(_to, _balanceOf(_to).add(_amount)); minterAllowed[msg.sender] = mintingAllowedAmount.sub(_amount); emit Mint(msg.sender, _to, _amount); emit Transfer(address(0), _to, _amount); return true; } /** * @dev Throws if called by any account other than the masterMinter */ modifier onlyMasterMinter() { require( msg.sender == masterMinter, "FiatToken: caller is not the masterMinter" ); _; } /** * @notice Gets the minter allowance for an account. * @param minter The address to check. * @return The remaining minter allowance for the account. */ function minterAllowance(address minter) external view returns (uint256) { return minterAllowed[minter]; } /** * @notice Checks if an account is a minter. * @param account The address to check. * @return True if the account is a minter, false if the account is not a minter. */ function isMinter(address account) external view returns (bool) { return minters[account]; } /** * @notice Gets the remaining amount of fiat tokens a spender is allowed to transfer on * behalf of the token owner. * @param owner The token owner's address. * @param spender The spender's address. * @return The remaining allowance. */ function allowance(address owner, address spender) external override view returns (uint256) { return allowed[owner][spender]; } /** * @notice Gets the totalSupply of the fiat token. * @return The totalSupply of the fiat token. */ function totalSupply() external override view returns (uint256) { return totalSupply_; } /** * @notice Gets the fiat token balance of an account. * @param account The address to check. * @return balance The fiat token balance of the account. */ function balanceOf(address account) external override view returns (uint256) { return _balanceOf(account); } /** * @notice Sets a fiat token allowance for a spender to spend on behalf of the caller. * @param spender The spender's address. * @param value The allowance amount. * @return True if the operation was successful. */ function approve(address spender, uint256 value) external virtual override whenNotPaused notBlacklisted(msg.sender) notBlacklisted(spender) returns (bool) { _approve(msg.sender, spender, value); return true; } /** * @dev Internal function to set allowance. * @param owner Token owner's address. * @param spender Spender's address. * @param value Allowance amount. */ function _approve( address owner, address spender, uint256 value ) internal override { require(owner != address(0), "ERC20: approve from the zero address"); require(spender != address(0), "ERC20: approve to the zero address"); allowed[owner][spender] = value; emit Approval(owner, spender, value); } /** * @notice Transfers tokens from an address to another by spending the caller's allowance. * @dev The caller must have some fiat token allowance on the payer's tokens. * @param from Payer's address. * @param to Payee's address. * @param value Transfer amount. * @return True if the operation was successful. */ function transferFrom( address from, address to, uint256 value ) external override whenNotPaused notBlacklisted(msg.sender) notBlacklisted(from) notBlacklisted(to) returns (bool) { require( value <= allowed[from][msg.sender], "ERC20: transfer amount exceeds allowance" ); _transfer(from, to, value); allowed[from][msg.sender] = allowed[from][msg.sender].sub(value); return true; } /** * @notice Transfers tokens from the caller. * @param to Payee's address. * @param value Transfer amount. * @return True if the operation was successful. */ function transfer(address to, uint256 value) external override whenNotPaused notBlacklisted(msg.sender) notBlacklisted(to) returns (bool) { _transfer(msg.sender, to, value); return true; } /** * @dev Internal function to process transfers. * @param from Payer's address. * @param to Payee's address. * @param value Transfer amount. */ function _transfer( address from, address to, uint256 value ) internal override { require(from != address(0), "ERC20: transfer from the zero address"); require(to != address(0), "ERC20: transfer to the zero address"); require( value <= _balanceOf(from), "ERC20: transfer amount exceeds balance" ); _setBalance(from, _balanceOf(from).sub(value)); _setBalance(to, _balanceOf(to).add(value)); emit Transfer(from, to, value); } /** * @notice Adds or updates a new minter with a mint allowance. * @param minter The address of the minter. * @param minterAllowedAmount The minting amount allowed for the minter. * @return True if the operation was successful. */ function configureMinter(address minter, uint256 minterAllowedAmount) external whenNotPaused onlyMasterMinter returns (bool) { minters[minter] = true; minterAllowed[minter] = minterAllowedAmount; emit MinterConfigured(minter, minterAllowedAmount); return true; } /** * @notice Removes a minter. * @param minter The address of the minter to remove. * @return True if the operation was successful. */ function removeMinter(address minter) external onlyMasterMinter returns (bool) { minters[minter] = false; minterAllowed[minter] = 0; emit MinterRemoved(minter); return true; } /** * @notice Allows a minter to burn some of its own tokens. * @dev The caller must be a minter, must not be blacklisted, and the amount to burn * should be less than or equal to the account's balance. * @param _amount the amount of tokens to be burned. */ function burn(uint256 _amount) external whenNotPaused onlyMinters notBlacklisted(msg.sender) { uint256 balance = _balanceOf(msg.sender); require(_amount > 0, "FiatToken: burn amount not greater than 0"); require(balance >= _amount, "FiatToken: burn amount exceeds balance"); totalSupply_ = totalSupply_.sub(_amount); _setBalance(msg.sender, balance.sub(_amount)); emit Burn(msg.sender, _amount); emit Transfer(msg.sender, address(0), _amount); } /** * @notice Updates the master minter address. * @param _newMasterMinter The address of the new master minter. */ function updateMasterMinter(address _newMasterMinter) external onlyOwner { require( _newMasterMinter != address(0), "FiatToken: new masterMinter is the zero address" ); masterMinter = _newMasterMinter; emit MasterMinterChanged(masterMinter); } /** * @inheritdoc Blacklistable */ function _blacklist(address _account) internal override { _setBlacklistState(_account, true); } /** * @inheritdoc Blacklistable */ function _unBlacklist(address _account) internal override { _setBlacklistState(_account, false); } /** * @dev Helper method that sets the blacklist state of an account. * @param _account The address of the account. * @param _shouldBlacklist True if the account should be blacklisted, false if the account should be unblacklisted. */ function _setBlacklistState(address _account, bool _shouldBlacklist) internal virtual { _deprecatedBlacklisted[_account] = _shouldBlacklist; } /** * @dev Helper method that sets the balance of an account. * @param _account The address of the account. * @param _balance The new fiat token balance of the account. */ function _setBalance(address _account, uint256 _balance) internal virtual { balanceAndBlacklistStates[_account] = _balance; } /** * @inheritdoc Blacklistable */ function _isBlacklisted(address _account) internal virtual override view returns (bool) { return _deprecatedBlacklisted[_account]; } /** * @dev Helper method to obtain the balance of an account. * @param _account The address of the account. * @return The fiat token balance of the account. */ function _balanceOf(address _account) internal virtual view returns (uint256) { return balanceAndBlacklistStates[_account]; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { Ownable } from "./Ownable.sol"; /** * @title Blacklistable Token * @dev Allows accounts to be blacklisted by a "blacklister" role */ abstract contract Blacklistable is Ownable { address public blacklister; mapping(address => bool) internal _deprecatedBlacklisted; event Blacklisted(address indexed _account); event UnBlacklisted(address indexed _account); event BlacklisterChanged(address indexed newBlacklister); /** * @dev Throws if called by any account other than the blacklister. */ modifier onlyBlacklister() { require( msg.sender == blacklister, "Blacklistable: caller is not the blacklister" ); _; } /** * @dev Throws if argument account is blacklisted. * @param _account The address to check. */ modifier notBlacklisted(address _account) { require( !_isBlacklisted(_account), "Blacklistable: account is blacklisted" ); _; } /** * @notice Checks if account is blacklisted. * @param _account The address to check. * @return True if the account is blacklisted, false if the account is not blacklisted. */ function isBlacklisted(address _account) external view returns (bool) { return _isBlacklisted(_account); } /** * @notice Adds account to blacklist. * @param _account The address to blacklist. */ function blacklist(address _account) external onlyBlacklister { _blacklist(_account); emit Blacklisted(_account); } /** * @notice Removes account from blacklist. * @param _account The address to remove from the blacklist. */ function unBlacklist(address _account) external onlyBlacklister { _unBlacklist(_account); emit UnBlacklisted(_account); } /** * @notice Updates the blacklister address. * @param _newBlacklister The address of the new blacklister. */ function updateBlacklister(address _newBlacklister) external onlyOwner { require( _newBlacklister != address(0), "Blacklistable: new blacklister is the zero address" ); blacklister = _newBlacklister; emit BlacklisterChanged(blacklister); } /** * @dev Checks if account is blacklisted. * @param _account The address to check. * @return true if the account is blacklisted, false otherwise. */ function _isBlacklisted(address _account) internal virtual view returns (bool); /** * @dev Helper method that blacklists an account. * @param _account The address to blacklist. */ function _blacklist(address _account) internal virtual; /** * @dev Helper method that unblacklists an account. * @param _account The address to unblacklist. */ function _unBlacklist(address _account) internal virtual; } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; abstract contract AbstractFiatTokenV1 is IERC20 { function _approve( address owner, address spender, uint256 value ) internal virtual; function _transfer( address from, address to, uint256 value ) internal virtual; } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { Ownable } from "../v1/Ownable.sol"; import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/SafeERC20.sol"; contract Rescuable is Ownable { using SafeERC20 for IERC20; address private _rescuer; event RescuerChanged(address indexed newRescuer); /** * @notice Returns current rescuer * @return Rescuer's address */ function rescuer() external view returns (address) { return _rescuer; } /** * @notice Revert if called by any account other than the rescuer. */ modifier onlyRescuer() { require(msg.sender == _rescuer, "Rescuable: caller is not the rescuer"); _; } /** * @notice Rescue ERC20 tokens locked up in this contract. * @param tokenContract ERC20 token contract address * @param to Recipient address * @param amount Amount to withdraw */ function rescueERC20( IERC20 tokenContract, address to, uint256 amount ) external onlyRescuer { tokenContract.safeTransfer(to, amount); } /** * @notice Updates the rescuer address. * @param newRescuer The address of the new rescuer. */ function updateRescuer(address newRescuer) external onlyOwner { require( newRescuer != address(0), "Rescuable: new rescuer is the zero address" ); _rescuer = newRescuer; emit RescuerChanged(newRescuer); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { FiatTokenV1 } from "../v1/FiatTokenV1.sol"; import { Rescuable } from "./Rescuable.sol"; /** * @title FiatTokenV1_1 * @dev ERC20 Token backed by fiat reserves */ contract FiatTokenV1_1 is FiatTokenV1, Rescuable { } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; import { ECRecover } from "./ECRecover.sol"; import { IERC1271 } from "../interface/IERC1271.sol"; /** * @dev Signature verification helper that can be used instead of `ECRecover.recover` to seamlessly support both ECDSA * signatures from externally owned accounts (EOAs) as well as ERC1271 signatures from smart contract wallets. * * Adapted from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/21bb89ef5bfc789b9333eb05e3ba2b7b284ac77c/contracts/utils/cryptography/SignatureChecker.sol */ library SignatureChecker { /** * @dev Checks if a signature is valid for a given signer and data hash. If the signer is a smart contract, the * signature is validated against that smart contract using ERC1271, otherwise it's validated using `ECRecover.recover`. * @param signer Address of the claimed signer * @param digest Keccak-256 hash digest of the signed message * @param signature Signature byte array associated with hash */ function isValidSignatureNow( address signer, bytes32 digest, bytes memory signature ) external view returns (bool) { if (!isContract(signer)) { return ECRecover.recover(digest, signature) == signer; } return isValidERC1271SignatureNow(signer, digest, signature); } /** * @dev Checks if a signature is valid for a given signer and data hash. The signature is validated * against the signer smart contract using ERC1271. * @param signer Address of the claimed signer * @param digest Keccak-256 hash digest of the signed message * @param signature Signature byte array associated with hash * * NOTE: Unlike ECDSA signatures, contract signatures are revocable, and the outcome of this function can thus * change through time. It could return true at block N and false at block N+1 (or the opposite). */ function isValidERC1271SignatureNow( address signer, bytes32 digest, bytes memory signature ) internal view returns (bool) { (bool success, bytes memory result) = signer.staticcall( abi.encodeWithSelector( IERC1271.isValidSignature.selector, digest, signature ) ); return (success && result.length >= 32 && abi.decode(result, (bytes32)) == bytes32(IERC1271.isValidSignature.selector)); } /** * @dev Checks if the input address is a smart contract. */ function isContract(address addr) internal view returns (bool) { uint256 size; assembly { size := extcodesize(addr) } return size > 0; } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; /** * @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing. * * The library provides methods for generating a hash of a message that conforms to the * https://eips.ethereum.org/EIPS/eip-191[EIP 191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712] * specifications. */ library MessageHashUtils { /** * @dev Returns the keccak256 digest of an EIP-712 typed data (EIP-191 version `0x01`). * Adapted from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/21bb89ef5bfc789b9333eb05e3ba2b7b284ac77c/contracts/utils/cryptography/MessageHashUtils.sol * * The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with * `\\x19\\x01` and hashing the result. It corresponds to the hash signed by the * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712. * * @param domainSeparator Domain separator * @param structHash Hashed EIP-712 data struct * @return digest The keccak256 digest of an EIP-712 typed data */ function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) { assembly { let ptr := mload(0x40) mstore(ptr, "\\x19\\x01") mstore(add(ptr, 0x02), domainSeparator) mstore(add(ptr, 0x22), structHash) digest := keccak256(ptr, 0x42) } } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; /** * @title EIP712 * @notice A library that provides EIP712 helper functions */ library EIP712 { /** * @notice Make EIP712 domain separator * @param name Contract name * @param version Contract version * @param chainId Blockchain ID * @return Domain separator */ function makeDomainSeparator( string memory name, string memory version, uint256 chainId ) internal view returns (bytes32) { return keccak256( abi.encode( // keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)") 0x8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f, keccak256(bytes(name)), keccak256(bytes(version)), chainId, address(this) ) ); } /** * @notice Make EIP712 domain separator * @param name Contract name * @param version Contract version * @return Domain separator */ function makeDomainSeparator(string memory name, string memory version) internal view returns (bytes32) { uint256 chainId; assembly { chainId := chainid() } return makeDomainSeparator(name, version, chainId); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; /** * @title ECRecover * @notice A library that provides a safe ECDSA recovery function */ library ECRecover { /** * @notice Recover signer's address from a signed message * @dev Adapted from: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/65e4ffde586ec89af3b7e9140bdc9235d1254853/contracts/cryptography/ECDSA.sol * Modifications: Accept v, r, and s as separate arguments * @param digest Keccak-256 hash digest of the signed message * @param v v of the signature * @param r r of the signature * @param s s of the signature * @return Signer address */ function recover( bytes32 digest, uint8 v, bytes32 r, bytes32 s ) internal pure returns (address) { // EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature // unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines // the valid range for s in (281): 0 < s < secp256k1n ÷ 2 + 1, and for v in (282): v ∈ {27, 28}. Most // signatures from current libraries generate a unique signature with an s-value in the lower half order. // // If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value // with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or // vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept // these malleable signatures as well. if ( uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0 ) { revert("ECRecover: invalid signature 's' value"); } if (v != 27 && v != 28) { revert("ECRecover: invalid signature 'v' value"); } // If the signature is valid (and not malleable), return the signer address address signer = ecrecover(digest, v, r, s); require(signer != address(0), "ECRecover: invalid signature"); return signer; } /** * @notice Recover signer's address from a signed message * @dev Adapted from: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/0053ee040a7ff1dbc39691c9e67a69f564930a88/contracts/utils/cryptography/ECDSA.sol * @param digest Keccak-256 hash digest of the signed message * @param signature Signature byte array associated with hash * @return Signer address */ function recover(bytes32 digest, bytes memory signature) internal pure returns (address) { require(signature.length == 65, "ECRecover: invalid signature length"); bytes32 r; bytes32 s; uint8 v; // ecrecover takes the signature parameters, and the only way to get them // currently is to use assembly. /// @solidity memory-safe-assembly assembly { r := mload(add(signature, 0x20)) s := mload(add(signature, 0x40)) v := byte(0, mload(add(signature, 0x60))) } return recover(digest, v, r, s); } } /** * SPDX-License-Identifier: Apache-2.0 * * Copyright (c) 2023, Circle Internet Financial, LLC. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity 0.6.12; /** * @dev Interface of the ERC1271 standard signature validation method for * contracts as defined in https://eips.ethereum.org/EIPS/eip-1271[ERC-1271]. */ interface IERC1271 { /** * @dev Should return whether the signature provided is valid for the provided data * @param hash Hash of the data to be signed * @param signature Signature byte array associated with the provided data hash * @return magicValue bytes4 magic value 0x1626ba7e when function passes */ function isValidSignature(bytes32 hash, bytes memory signature) external view returns (bytes4 magicValue); }