Warning! Contract bytecode has been changed and doesn't match the verified one. Therefore, interaction with this smart contract may be risky.
- Contract name:
- StablePoolFactory
- Optimization enabled
- true
- Compiler version
- v0.7.3+commit.9bfce1f6
- Optimization runs
- 200
- EVM Version
- default
- Verified at
- 2022-07-05T12:26:52.446282Z
Constructor Arguments
000000000000000000000000a18808989e7eb0fcf0932fd00d007f3c118b78e7
Arg [0] (address) : 0xa18808989e7eb0fcf0932fd00d007f3c118b78e7
Contract source code
// SPDX-License-Identifier: GPL-3.0-or-later // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. pragma solidity ^0.7.0; // solhint-disable /** * @dev Reverts if `condition` is false, with a revert reason containing `errorCode`. Only codes up to 999 are * supported. */ function _require(bool condition, uint256 errorCode) pure { if (!condition) _revert(errorCode); } /** * @dev Reverts with a revert reason containing `errorCode`. Only codes up to 999 are supported. */ function _revert(uint256 errorCode) pure { // We're going to dynamically create a revert string based on the error code, with the following format: // 'BAL#{errorCode}' // where the code is left-padded with zeroes to three digits (so they range from 000 to 999). // // We don't have revert strings embedded in the contract to save bytecode size: it takes much less space to store a // number (8 to 16 bits) than the individual string characters. // // The dynamic string creation algorithm that follows could be implemented in Solidity, but assembly allows for a // much denser implementation, again saving bytecode size. Given this function unconditionally reverts, this is a // safe place to rely on it without worrying about how its usage might affect e.g. memory contents. assembly { // First, we need to compute the ASCII representation of the error code. We assume that it is in the 0-999 // range, so we only need to convert three digits. To convert the digits to ASCII, we add 0x30, the value for // the '0' character. let units := add(mod(errorCode, 10), 0x30) errorCode := div(errorCode, 10) let tenths := add(mod(errorCode, 10), 0x30) errorCode := div(errorCode, 10) let hundreds := add(mod(errorCode, 10), 0x30) // With the individual characters, we can now construct the full string. The "BAL#" part is a known constant // (0x42414c23): we simply shift this by 24 (to provide space for the 3 bytes of the error code), and add the // characters to it, each shifted by a multiple of 8. // The revert reason is then shifted left by 200 bits (256 minus the length of the string, 7 characters * 8 bits // per character = 56) to locate it in the most significant part of the 256 slot (the beginning of a byte // array). let revertReason := shl(200, add(0x42414c23000000, add(add(units, shl(8, tenths)), shl(16, hundreds)))) // We can now encode the reason in memory, which can be safely overwritten as we're about to revert. The encoded // message will have the following layout: // [ revert reason identifier ] [ string location offset ] [ string length ] [ string contents ] // The Solidity revert reason identifier is 0x08c739a0, the function selector of the Error(string) function. We // also write zeroes to the next 28 bytes of memory, but those are about to be overwritten. mstore(0x0, 0x08c379a000000000000000000000000000000000000000000000000000000000) // Next is the offset to the location of the string, which will be placed immediately after (20 bytes away). mstore(0x04, 0x0000000000000000000000000000000000000000000000000000000000000020) // The string length is fixed: 7 characters. mstore(0x24, 7) // Finally, the string itself is stored. mstore(0x44, revertReason) // Even if the string is only 7 bytes long, we need to return a full 32 byte slot containing it. The length of // the encoded message is therefore 4 + 32 + 32 + 32 = 100. revert(0, 100) } } library Errors { // Math uint256 internal constant ADD_OVERFLOW = 0; uint256 internal constant SUB_OVERFLOW = 1; uint256 internal constant SUB_UNDERFLOW = 2; uint256 internal constant MUL_OVERFLOW = 3; uint256 internal constant ZERO_DIVISION = 4; uint256 internal constant DIV_INTERNAL = 5; uint256 internal constant X_OUT_OF_BOUNDS = 6; uint256 internal constant Y_OUT_OF_BOUNDS = 7; uint256 internal constant PRODUCT_OUT_OF_BOUNDS = 8; uint256 internal constant INVALID_EXPONENT = 9; // Input uint256 internal constant OUT_OF_BOUNDS = 100; uint256 internal constant UNSORTED_ARRAY = 101; uint256 internal constant UNSORTED_TOKENS = 102; uint256 internal constant INPUT_LENGTH_MISMATCH = 103; uint256 internal constant ZERO_TOKEN = 104; // Shared pools uint256 internal constant MIN_TOKENS = 200; uint256 internal constant MAX_TOKENS = 201; uint256 internal constant MAX_SWAP_FEE_PERCENTAGE = 202; uint256 internal constant MIN_SWAP_FEE_PERCENTAGE = 203; uint256 internal constant MINIMUM_BPT = 204; uint256 internal constant CALLER_NOT_VAULT = 205; uint256 internal constant UNINITIALIZED = 206; uint256 internal constant BPT_IN_MAX_AMOUNT = 207; uint256 internal constant BPT_OUT_MIN_AMOUNT = 208; uint256 internal constant EXPIRED_PERMIT = 209; uint256 internal constant NOT_TWO_TOKENS = 210; // Pools uint256 internal constant MIN_AMP = 300; uint256 internal constant MAX_AMP = 301; uint256 internal constant MIN_WEIGHT = 302; uint256 internal constant MAX_STABLE_TOKENS = 303; uint256 internal constant MAX_IN_RATIO = 304; uint256 internal constant MAX_OUT_RATIO = 305; uint256 internal constant MIN_BPT_IN_FOR_TOKEN_OUT = 306; uint256 internal constant MAX_OUT_BPT_FOR_TOKEN_IN = 307; uint256 internal constant NORMALIZED_WEIGHT_INVARIANT = 308; uint256 internal constant INVALID_TOKEN = 309; uint256 internal constant UNHANDLED_JOIN_KIND = 310; uint256 internal constant ZERO_INVARIANT = 311; uint256 internal constant ORACLE_INVALID_SECONDS_QUERY = 312; uint256 internal constant ORACLE_NOT_INITIALIZED = 313; uint256 internal constant ORACLE_QUERY_TOO_OLD = 314; uint256 internal constant ORACLE_INVALID_INDEX = 315; uint256 internal constant ORACLE_BAD_SECS = 316; uint256 internal constant AMP_END_TIME_TOO_CLOSE = 317; uint256 internal constant AMP_ONGOING_UPDATE = 318; uint256 internal constant AMP_RATE_TOO_HIGH = 319; uint256 internal constant AMP_NO_ONGOING_UPDATE = 320; uint256 internal constant STABLE_INVARIANT_DIDNT_CONVERGE = 321; uint256 internal constant STABLE_GET_BALANCE_DIDNT_CONVERGE = 322; uint256 internal constant RELAYER_NOT_CONTRACT = 323; uint256 internal constant BASE_POOL_RELAYER_NOT_CALLED = 324; uint256 internal constant REBALANCING_RELAYER_REENTERED = 325; uint256 internal constant GRADUAL_UPDATE_TIME_TRAVEL = 326; uint256 internal constant SWAPS_DISABLED = 327; uint256 internal constant CALLER_IS_NOT_LBP_OWNER = 328; uint256 internal constant PRICE_RATE_OVERFLOW = 329; uint256 internal constant INVALID_JOIN_EXIT_KIND_WHILE_SWAPS_DISABLED = 330; uint256 internal constant WEIGHT_CHANGE_TOO_FAST = 331; uint256 internal constant LOWER_GREATER_THAN_UPPER_TARGET = 332; uint256 internal constant UPPER_TARGET_TOO_HIGH = 333; uint256 internal constant UNHANDLED_BY_LINEAR_POOL = 334; uint256 internal constant OUT_OF_TARGET_RANGE = 335; uint256 internal constant UNHANDLED_EXIT_KIND = 336; uint256 internal constant UNAUTHORIZED_EXIT = 337; uint256 internal constant MAX_MANAGEMENT_SWAP_FEE_PERCENTAGE = 338; uint256 internal constant UNHANDLED_BY_MANAGED_POOL = 339; uint256 internal constant UNHANDLED_BY_PHANTOM_POOL = 340; uint256 internal constant TOKEN_DOES_NOT_HAVE_RATE_PROVIDER = 341; uint256 internal constant INVALID_INITIALIZATION = 342; uint256 internal constant OUT_OF_NEW_TARGET_RANGE = 343; uint256 internal constant UNAUTHORIZED_OPERATION = 344; uint256 internal constant UNINITIALIZED_POOL_CONTROLLER = 345; // Lib uint256 internal constant REENTRANCY = 400; uint256 internal constant SENDER_NOT_ALLOWED = 401; uint256 internal constant PAUSED = 402; uint256 internal constant PAUSE_WINDOW_EXPIRED = 403; uint256 internal constant MAX_PAUSE_WINDOW_DURATION = 404; uint256 internal constant MAX_BUFFER_PERIOD_DURATION = 405; uint256 internal constant INSUFFICIENT_BALANCE = 406; uint256 internal constant INSUFFICIENT_ALLOWANCE = 407; uint256 internal constant ERC20_TRANSFER_FROM_ZERO_ADDRESS = 408; uint256 internal constant ERC20_TRANSFER_TO_ZERO_ADDRESS = 409; uint256 internal constant ERC20_MINT_TO_ZERO_ADDRESS = 410; uint256 internal constant ERC20_BURN_FROM_ZERO_ADDRESS = 411; uint256 internal constant ERC20_APPROVE_FROM_ZERO_ADDRESS = 412; uint256 internal constant ERC20_APPROVE_TO_ZERO_ADDRESS = 413; uint256 internal constant ERC20_TRANSFER_EXCEEDS_ALLOWANCE = 414; uint256 internal constant ERC20_DECREASED_ALLOWANCE_BELOW_ZERO = 415; uint256 internal constant ERC20_TRANSFER_EXCEEDS_BALANCE = 416; uint256 internal constant ERC20_BURN_EXCEEDS_ALLOWANCE = 417; uint256 internal constant SAFE_ERC20_CALL_FAILED = 418; uint256 internal constant ADDRESS_INSUFFICIENT_BALANCE = 419; uint256 internal constant ADDRESS_CANNOT_SEND_VALUE = 420; uint256 internal constant SAFE_CAST_VALUE_CANT_FIT_INT256 = 421; uint256 internal constant GRANT_SENDER_NOT_ADMIN = 422; uint256 internal constant REVOKE_SENDER_NOT_ADMIN = 423; uint256 internal constant RENOUNCE_SENDER_NOT_ALLOWED = 424; uint256 internal constant BUFFER_PERIOD_EXPIRED = 425; uint256 internal constant CALLER_IS_NOT_OWNER = 426; uint256 internal constant NEW_OWNER_IS_ZERO = 427; uint256 internal constant CODE_DEPLOYMENT_FAILED = 428; uint256 internal constant CALL_TO_NON_CONTRACT = 429; uint256 internal constant LOW_LEVEL_CALL_FAILED = 430; uint256 internal constant NOT_PAUSED = 431; uint256 internal constant ADDRESS_ALREADY_ALLOWLISTED = 432; uint256 internal constant ADDRESS_NOT_ALLOWLISTED = 433; // Vault uint256 internal constant INVALID_POOL_ID = 500; uint256 internal constant CALLER_NOT_POOL = 501; uint256 internal constant SENDER_NOT_ASSET_MANAGER = 502; uint256 internal constant USER_DOESNT_ALLOW_RELAYER = 503; uint256 internal constant INVALID_SIGNATURE = 504; uint256 internal constant EXIT_BELOW_MIN = 505; uint256 internal constant JOIN_ABOVE_MAX = 506; uint256 internal constant SWAP_LIMIT = 507; uint256 internal constant SWAP_DEADLINE = 508; uint256 internal constant CANNOT_SWAP_SAME_TOKEN = 509; uint256 internal constant UNKNOWN_AMOUNT_IN_FIRST_SWAP = 510; uint256 internal constant MALCONSTRUCTED_MULTIHOP_SWAP = 511; uint256 internal constant INTERNAL_BALANCE_OVERFLOW = 512; uint256 internal constant INSUFFICIENT_INTERNAL_BALANCE = 513; uint256 internal constant INVALID_ETH_INTERNAL_BALANCE = 514; uint256 internal constant INVALID_POST_LOAN_BALANCE = 515; uint256 internal constant INSUFFICIENT_ETH = 516; uint256 internal constant UNALLOCATED_ETH = 517; uint256 internal constant ETH_TRANSFER = 518; uint256 internal constant CANNOT_USE_ETH_SENTINEL = 519; uint256 internal constant TOKENS_MISMATCH = 520; uint256 internal constant TOKEN_NOT_REGISTERED = 521; uint256 internal constant TOKEN_ALREADY_REGISTERED = 522; uint256 internal constant TOKENS_ALREADY_SET = 523; uint256 internal constant TOKENS_LENGTH_MUST_BE_2 = 524; uint256 internal constant NONZERO_TOKEN_BALANCE = 525; uint256 internal constant BALANCE_TOTAL_OVERFLOW = 526; uint256 internal constant POOL_NO_TOKENS = 527; uint256 internal constant INSUFFICIENT_FLASH_LOAN_BALANCE = 528; // Fees uint256 internal constant SWAP_FEE_PERCENTAGE_TOO_HIGH = 600; uint256 internal constant FLASH_LOAN_FEE_PERCENTAGE_TOO_HIGH = 601; uint256 internal constant INSUFFICIENT_FLASH_LOAN_FEE_AMOUNT = 602; } /** * @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); } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. interface IAuthorizer { /** * @dev Returns true if `account` can perform the action described by `actionId` in the contract `where`. */ function canPerform( bytes32 actionId, address account, address where ) external view returns (bool); } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev Interface for the TemporarilyPausable helper. */ interface ITemporarilyPausable { /** * @dev Emitted every time the pause state changes by `_setPaused`. */ event PausedStateChanged(bool paused); /** * @dev Returns the current paused state. */ function getPausedState() external view returns ( bool paused, uint256 pauseWindowEndTime, uint256 bufferPeriodEndTime ); } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. pragma experimental ABIEncoderV2; // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. interface IPoolSwapStructs { // This is not really an interface - it just defines common structs used by other interfaces: IGeneralPool and // IMinimalSwapInfoPool. // // This data structure represents a request for a token swap, where `kind` indicates the swap type ('given in' or // 'given out') which indicates whether or not the amount sent by the pool is known. // // The pool receives `tokenIn` and sends `tokenOut`. `amount` is the number of `tokenIn` tokens the pool will take // in, or the number of `tokenOut` tokens the Pool will send out, depending on the given swap `kind`. // // All other fields are not strictly necessary for most swaps, but are provided to support advanced scenarios in // some Pools. // // `poolId` is the ID of the Pool involved in the swap - this is useful for Pool contracts that implement more than // one Pool. // // The meaning of `lastChangeBlock` depends on the Pool specialization: // - Two Token or Minimal Swap Info: the last block in which either `tokenIn` or `tokenOut` changed its total // balance. // - General: the last block in which *any* of the Pool's registered tokens changed its total balance. // // `from` is the origin address for the funds the Pool receives, and `to` is the destination address // where the Pool sends the outgoing tokens. // // `userData` is extra data provided by the caller - typically a signature from a trusted party. struct SwapRequest { IVault.SwapKind kind; IERC20 tokenIn; IERC20 tokenOut; uint256 amount; // Misc data bytes32 poolId; uint256 lastChangeBlock; address from; address to; bytes userData; } } /** * @dev Interface for adding and removing liquidity that all Pool contracts should implement. Note that this is not * the complete Pool contract interface, as it is missing the swap hooks. Pool contracts should also inherit from * either IGeneralPool or IMinimalSwapInfoPool */ interface IBasePool is IPoolSwapStructs { /** * @dev Called by the Vault when a user calls `IVault.joinPool` to add liquidity to this Pool. Returns how many of * each registered token the user should provide, as well as the amount of protocol fees the Pool owes to the Vault. * The Vault will then take tokens from `sender` and add them to the Pool's balances, as well as collect * the reported amount in protocol fees, which the pool should calculate based on `protocolSwapFeePercentage`. * * Protocol fees are reported and charged on join events so that the Pool is free of debt whenever new users join. * * `sender` is the account performing the join (from which tokens will be withdrawn), and `recipient` is the account * designated to receive any benefits (typically pool shares). `balances` contains the total balances * for each token the Pool registered in the Vault, in the same order that `IVault.getPoolTokens` would return. * * `lastChangeBlock` is the last block in which *any* of the Pool's registered tokens last changed its total * balance. * * `userData` contains any pool-specific instructions needed to perform the calculations, such as the type of * join (e.g., proportional given an amount of pool shares, single-asset, multi-asset, etc.) * * Contracts implementing this function should check that the caller is indeed the Vault before performing any * state-changing operations, such as minting pool shares. */ function onJoinPool( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, bytes memory userData ) external returns (uint256[] memory amountsIn, uint256[] memory dueProtocolFeeAmounts); /** * @dev Called by the Vault when a user calls `IVault.exitPool` to remove liquidity from this Pool. Returns how many * tokens the Vault should deduct from the Pool's balances, as well as the amount of protocol fees the Pool owes * to the Vault. The Vault will then take tokens from the Pool's balances and send them to `recipient`, * as well as collect the reported amount in protocol fees, which the Pool should calculate based on * `protocolSwapFeePercentage`. * * Protocol fees are charged on exit events to guarantee that users exiting the Pool have paid their share. * * `sender` is the account performing the exit (typically the pool shareholder), and `recipient` is the account * to which the Vault will send the proceeds. `balances` contains the total token balances for each token * the Pool registered in the Vault, in the same order that `IVault.getPoolTokens` would return. * * `lastChangeBlock` is the last block in which *any* of the Pool's registered tokens last changed its total * balance. * * `userData` contains any pool-specific instructions needed to perform the calculations, such as the type of * exit (e.g., proportional given an amount of pool shares, single-asset, multi-asset, etc.) * * Contracts implementing this function should check that the caller is indeed the Vault before performing any * state-changing operations, such as burning pool shares. */ function onExitPool( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, bytes memory userData ) external returns (uint256[] memory amountsOut, uint256[] memory dueProtocolFeeAmounts); function getPoolId() external view returns (bytes32); } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev Library for encoding and decoding values stored inside a 256 bit word. Typically used to pack multiple values in * a single storage slot, saving gas by performing less storage accesses. * * Each value is defined by its size and the least significant bit in the word, also known as offset. For example, two * 128 bit values may be encoded in a word by assigning one an offset of 0, and the other an offset of 128. * * We could use Solidity structs to pack values together in a single storage slot instead of relying on a custom and * error-prone library, but unfortunately Solidity only allows for structs to live in either storage, calldata or * memory. Because a memory struct uses not just memory but also a slot in the stack (to store its memory location), * using memory for word-sized values (i.e. of 256 bits or less) is strictly less gas performant, and doesn't even * prevent stack-too-deep issues. This is compounded by the fact that Balancer contracts typically are memory-intensive, * and the cost of accesing memory increases quadratically with the number of allocated words. Manual packing and * unpacking is therefore the preferred approach. */ library WordCodec { // Masks are values with the least significant N bits set. They can be used to extract an encoded value from a word, // or to insert a new one replacing the old. uint256 private constant _MASK_1 = 2**(1) - 1; uint256 private constant _MASK_5 = 2**(5) - 1; uint256 private constant _MASK_7 = 2**(7) - 1; uint256 private constant _MASK_10 = 2**(10) - 1; uint256 private constant _MASK_16 = 2**(16) - 1; uint256 private constant _MASK_22 = 2**(22) - 1; uint256 private constant _MASK_31 = 2**(31) - 1; uint256 private constant _MASK_32 = 2**(32) - 1; uint256 private constant _MASK_53 = 2**(53) - 1; uint256 private constant _MASK_64 = 2**(64) - 1; uint256 private constant _MASK_96 = 2**(96) - 1; uint256 private constant _MASK_128 = 2**(128) - 1; uint256 private constant _MASK_192 = 2**(192) - 1; // Largest positive values that can be represented as N bits signed integers. int256 private constant _MAX_INT_22 = 2**(21) - 1; int256 private constant _MAX_INT_53 = 2**(52) - 1; // In-place insertion /** * @dev Inserts a boolean value shifted by an offset into a 256 bit word, replacing the old value. Returns the new * word. */ function insertBool( bytes32 word, bool value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_1 << offset)); return clearedWord | bytes32(uint256(value ? 1 : 0) << offset); } // Unsigned /** * @dev Inserts a 5 bit unsigned integer shifted by an offset into a 256 bit word, replacing the old value. Returns * the new word. * * Assumes `value` only uses its least significant 5 bits, otherwise it may overwrite sibling bytes. */ function insertUint5( bytes32 word, uint256 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_5 << offset)); return clearedWord | bytes32(value << offset); } /** * @dev Inserts a 7 bit unsigned integer shifted by an offset into a 256 bit word, replacing the old value. Returns * the new word. * * Assumes `value` only uses its least significant 7 bits, otherwise it may overwrite sibling bytes. */ function insertUint7( bytes32 word, uint256 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_7 << offset)); return clearedWord | bytes32(value << offset); } /** * @dev Inserts a 10 bit unsigned integer shifted by an offset into a 256 bit word, replacing the old value. Returns * the new word. * * Assumes `value` only uses its least significant 10 bits, otherwise it may overwrite sibling bytes. */ function insertUint10( bytes32 word, uint256 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_10 << offset)); return clearedWord | bytes32(value << offset); } /** * @dev Inserts a 16 bit unsigned integer shifted by an offset into a 256 bit word, replacing the old value. * Returns the new word. * * Assumes `value` only uses its least significant 16 bits, otherwise it may overwrite sibling bytes. */ function insertUint16( bytes32 word, uint256 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_16 << offset)); return clearedWord | bytes32(value << offset); } /** * @dev Inserts a 31 bit unsigned integer shifted by an offset into a 256 bit word, replacing the old value. Returns * the new word. * * Assumes `value` can be represented using 31 bits. */ function insertUint31( bytes32 word, uint256 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_31 << offset)); return clearedWord | bytes32(value << offset); } /** * @dev Inserts a 32 bit unsigned integer shifted by an offset into a 256 bit word, replacing the old value. Returns * the new word. * * Assumes `value` only uses its least significant 32 bits, otherwise it may overwrite sibling bytes. */ function insertUint32( bytes32 word, uint256 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_32 << offset)); return clearedWord | bytes32(value << offset); } /** * @dev Inserts a 64 bit unsigned integer shifted by an offset into a 256 bit word, replacing the old value. Returns * the new word. * * Assumes `value` only uses its least significant 64 bits, otherwise it may overwrite sibling bytes. */ function insertUint64( bytes32 word, uint256 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_64 << offset)); return clearedWord | bytes32(value << offset); } // Signed /** * @dev Inserts a 22 bits signed integer shifted by an offset into a 256 bit word, replacing the old value. Returns * the new word. * * Assumes `value` can be represented using 22 bits. */ function insertInt22( bytes32 word, int256 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_22 << offset)); // Integer values need masking to remove the upper bits of negative values. return clearedWord | bytes32((uint256(value) & _MASK_22) << offset); } // Bytes /** * @dev Inserts 192 bit shifted by an offset into a 256 bit word, replacing the old value. Returns the new word. * * Assumes `value` can be represented using 192 bits. */ function insertBits192( bytes32 word, bytes32 value, uint256 offset ) internal pure returns (bytes32) { bytes32 clearedWord = bytes32(uint256(word) & ~(_MASK_192 << offset)); return clearedWord | bytes32((uint256(value) & _MASK_192) << offset); } // Encoding // Unsigned /** * @dev Encodes an unsigned integer shifted by an offset. This performs no size checks: it is up to the caller to * ensure that the values are bounded. * * The return value can be logically ORed with other encoded values to form a 256 bit word. */ function encodeUint(uint256 value, uint256 offset) internal pure returns (bytes32) { return bytes32(value << offset); } // Signed /** * @dev Encodes a 22 bits signed integer shifted by an offset. * * The return value can be logically ORed with other encoded values to form a 256 bit word. */ function encodeInt22(int256 value, uint256 offset) internal pure returns (bytes32) { // Integer values need masking to remove the upper bits of negative values. return bytes32((uint256(value) & _MASK_22) << offset); } /** * @dev Encodes a 53 bits signed integer shifted by an offset. * * The return value can be logically ORed with other encoded values to form a 256 bit word. */ function encodeInt53(int256 value, uint256 offset) internal pure returns (bytes32) { // Integer values need masking to remove the upper bits of negative values. return bytes32((uint256(value) & _MASK_53) << offset); } // Decoding /** * @dev Decodes and returns a boolean shifted by an offset from a 256 bit word. */ function decodeBool(bytes32 word, uint256 offset) internal pure returns (bool) { return (uint256(word >> offset) & _MASK_1) == 1; } // Unsigned /** * @dev Decodes and returns a 5 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint5(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_5; } /** * @dev Decodes and returns a 7 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint7(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_7; } /** * @dev Decodes and returns a 10 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint10(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_10; } /** * @dev Decodes and returns a 16 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint16(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_16; } /** * @dev Decodes and returns a 31 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint31(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_31; } /** * @dev Decodes and returns a 32 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint32(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_32; } /** * @dev Decodes and returns a 64 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint64(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_64; } /** * @dev Decodes and returns a 96 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint96(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_96; } /** * @dev Decodes and returns a 128 bit unsigned integer shifted by an offset from a 256 bit word. */ function decodeUint128(bytes32 word, uint256 offset) internal pure returns (uint256) { return uint256(word >> offset) & _MASK_128; } // Signed /** * @dev Decodes and returns a 22 bits signed integer shifted by an offset from a 256 bit word. */ function decodeInt22(bytes32 word, uint256 offset) internal pure returns (int256) { int256 value = int256(uint256(word >> offset) & _MASK_22); // In case the decoded value is greater than the max positive integer that can be represented with 22 bits, // we know it was originally a negative integer. Therefore, we mask it to restore the sign in the 256 bit // representation. return value > _MAX_INT_22 ? (value | int256(~_MASK_22)) : value; } /** * @dev Decodes and returns a 53 bits signed integer shifted by an offset from a 256 bit word. */ function decodeInt53(bytes32 word, uint256 offset) internal pure returns (int256) { int256 value = int256(uint256(word >> offset) & _MASK_53); // In case the decoded value is greater than the max positive integer that can be represented with 53 bits, // we know it was originally a negative integer. Therefore, we mask it to restore the sign in the 256 bit // representation. return value > _MAX_INT_53 ? (value | int256(~_MASK_53)) : value; } } /** * @dev Wrappers over Solidity's arithmetic operations with added overflow checks. * Adapted from OpenZeppelin's SafeMath library. */ library Math { /** * @dev Returns the absolute value of a signed integer. */ function abs(int256 a) internal pure returns (uint256) { return a > 0 ? uint256(a) : uint256(-a); } /** * @dev Returns the addition of two unsigned integers of 256 bits, reverting on overflow. */ function add(uint256 a, uint256 b) internal pure returns (uint256) { uint256 c = a + b; _require(c >= a, Errors.ADD_OVERFLOW); return c; } /** * @dev Returns the addition of two signed integers, reverting on overflow. */ function add(int256 a, int256 b) internal pure returns (int256) { int256 c = a + b; _require((b >= 0 && c >= a) || (b < 0 && c < a), Errors.ADD_OVERFLOW); return c; } /** * @dev Returns the subtraction of two unsigned integers of 256 bits, reverting on overflow. */ function sub(uint256 a, uint256 b) internal pure returns (uint256) { _require(b <= a, Errors.SUB_OVERFLOW); uint256 c = a - b; return c; } /** * @dev Returns the subtraction of two signed integers, reverting on overflow. */ function sub(int256 a, int256 b) internal pure returns (int256) { int256 c = a - b; _require((b >= 0 && c <= a) || (b < 0 && c > a), Errors.SUB_OVERFLOW); return c; } /** * @dev Returns the largest of two numbers of 256 bits. */ function max(uint256 a, uint256 b) internal pure returns (uint256) { return a >= b ? a : b; } /** * @dev Returns the smallest of two numbers of 256 bits. */ function min(uint256 a, uint256 b) internal pure returns (uint256) { return a < b ? a : b; } function mul(uint256 a, uint256 b) internal pure returns (uint256) { uint256 c = a * b; _require(a == 0 || c / a == b, Errors.MUL_OVERFLOW); return c; } function div( uint256 a, uint256 b, bool roundUp ) internal pure returns (uint256) { return roundUp ? divUp(a, b) : divDown(a, b); } function divDown(uint256 a, uint256 b) internal pure returns (uint256) { _require(b != 0, Errors.ZERO_DIVISION); return a / b; } function divUp(uint256 a, uint256 b) internal pure returns (uint256) { _require(b != 0, Errors.ZERO_DIVISION); if (a == 0) { return 0; } else { return 1 + (a - 1) / b; } } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev Allows for a contract to be paused during an initial period after deployment, disabling functionality. Can be * used as an emergency switch in case a security vulnerability or threat is identified. * * The contract can only be paused during the Pause Window, a period that starts at deployment. It can also be * unpaused and repaused any number of times during this period. This is intended to serve as a safety measure: it lets * system managers react quickly to potentially dangerous situations, knowing that this action is reversible if careful * analysis later determines there was a false alarm. * * If the contract is paused when the Pause Window finishes, it will remain in the paused state through an additional * Buffer Period, after which it will be automatically unpaused forever. This is to ensure there is always enough time * to react to an emergency, even if the threat is discovered shortly before the Pause Window expires. * * Note that since the contract can only be paused within the Pause Window, unpausing during the Buffer Period is * irreversible. */ abstract contract TemporarilyPausable is ITemporarilyPausable { // The Pause Window and Buffer Period are timestamp-based: they should not be relied upon for sub-minute accuracy. // solhint-disable not-rely-on-time uint256 private constant _MAX_PAUSE_WINDOW_DURATION = 90 days; uint256 private constant _MAX_BUFFER_PERIOD_DURATION = 30 days; uint256 private immutable _pauseWindowEndTime; uint256 private immutable _bufferPeriodEndTime; bool private _paused; constructor(uint256 pauseWindowDuration, uint256 bufferPeriodDuration) { _require(pauseWindowDuration <= _MAX_PAUSE_WINDOW_DURATION, Errors.MAX_PAUSE_WINDOW_DURATION); _require(bufferPeriodDuration <= _MAX_BUFFER_PERIOD_DURATION, Errors.MAX_BUFFER_PERIOD_DURATION); uint256 pauseWindowEndTime = block.timestamp + pauseWindowDuration; _pauseWindowEndTime = pauseWindowEndTime; _bufferPeriodEndTime = pauseWindowEndTime + bufferPeriodDuration; } /** * @dev Reverts if the contract is paused. */ modifier whenNotPaused() { _ensureNotPaused(); _; } /** * @dev Returns the current contract pause status, as well as the end times of the Pause Window and Buffer * Period. */ function getPausedState() external view override returns ( bool paused, uint256 pauseWindowEndTime, uint256 bufferPeriodEndTime ) { paused = !_isNotPaused(); pauseWindowEndTime = _getPauseWindowEndTime(); bufferPeriodEndTime = _getBufferPeriodEndTime(); } /** * @dev Sets the pause state to `paused`. The contract can only be paused until the end of the Pause Window, and * unpaused until the end of the Buffer Period. * * Once the Buffer Period expires, this function reverts unconditionally. */ function _setPaused(bool paused) internal { if (paused) { _require(block.timestamp < _getPauseWindowEndTime(), Errors.PAUSE_WINDOW_EXPIRED); } else { _require(block.timestamp < _getBufferPeriodEndTime(), Errors.BUFFER_PERIOD_EXPIRED); } _paused = paused; emit PausedStateChanged(paused); } /** * @dev Reverts if the contract is paused. */ function _ensureNotPaused() internal view { _require(_isNotPaused(), Errors.PAUSED); } /** * @dev Reverts if the contract is not paused. */ function _ensurePaused() internal view { _require(!_isNotPaused(), Errors.NOT_PAUSED); } /** * @dev Returns true if the contract is unpaused. * * Once the Buffer Period expires, the gas cost of calling this function is reduced dramatically, as storage is no * longer accessed. */ function _isNotPaused() internal view returns (bool) { // After the Buffer Period, the (inexpensive) timestamp check short-circuits the storage access. return block.timestamp > _getBufferPeriodEndTime() || !_paused; } // These getters lead to reduced bytecode size by inlining the immutable variables in a single place. function _getPauseWindowEndTime() private view returns (uint256) { return _pauseWindowEndTime; } function _getBufferPeriodEndTime() private view returns (uint256) { return _bufferPeriodEndTime; } } /** * @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, 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, Errors.ADD_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) { return sub(a, b, Errors.SUB_OVERFLOW); } /** * @dev Returns the subtraction of two unsigned integers, reverting with custom message on * overflow (when the result is negative). * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub(uint256 a, uint256 b, uint256 errorCode) internal pure returns (uint256) { _require(b <= a, errorCode); uint256 c = a - b; return c; } } /** * @dev Implementation of the {IERC20} interface. * * This implementation is agnostic to the way tokens are created. This means * that a supply mechanism has to be added in a derived contract using {_mint}. * For a generic mechanism see {ERC20PresetMinterPauser}. * * TIP: For a detailed writeup see our guide * https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How * to implement supply mechanisms]. * * We have followed general OpenZeppelin guidelines: functions revert instead * of returning `false` on failure. This behavior is nonetheless conventional * and does not conflict with the expectations of ERC20 applications. * * Additionally, an {Approval} event is emitted on calls to {transferFrom}. * This allows applications to reconstruct the allowance for all accounts just * by listening to said events. Other implementations of the EIP may not emit * these events, as it isn't required by the specification. * * Finally, the non-standard {decreaseAllowance} and {increaseAllowance} * functions have been added to mitigate the well-known issues around setting * allowances. See {IERC20-approve}. */ contract ERC20 is IERC20 { using SafeMath for uint256; mapping(address => uint256) private _balances; mapping(address => mapping(address => uint256)) private _allowances; uint256 private _totalSupply; string private _name; string private _symbol; uint8 private _decimals; /** * @dev Sets the values for {name} and {symbol}, initializes {decimals} with * a default value of 18. * * To select a different value for {decimals}, use {_setupDecimals}. * * All three of these values are immutable: they can only be set once during * construction. */ constructor(string memory name_, string memory symbol_) { _name = name_; _symbol = symbol_; _decimals = 18; } /** * @dev Returns the name of the token. */ function name() public view returns (string memory) { return _name; } /** * @dev Returns the symbol of the token, usually a shorter version of the * name. */ function symbol() public view returns (string memory) { return _symbol; } /** * @dev Returns the number of decimals used to get its user representation. * For example, if `decimals` equals `2`, a balance of `505` tokens should * be displayed to a user as `5,05` (`505 / 10 ** 2`). * * Tokens usually opt for a value of 18, imitating the relationship between * Ether and Wei. This is the value {ERC20} uses, unless {_setupDecimals} is * called. * * NOTE: This information is only used for _display_ purposes: it in * no way affects any of the arithmetic of the contract, including * {IERC20-balanceOf} and {IERC20-transfer}. */ function decimals() public view returns (uint8) { return _decimals; } /** * @dev See {IERC20-totalSupply}. */ function totalSupply() public view override returns (uint256) { return _totalSupply; } /** * @dev See {IERC20-balanceOf}. */ function balanceOf(address account) public view override returns (uint256) { return _balances[account]; } /** * @dev See {IERC20-transfer}. * * Requirements: * * - `recipient` cannot be the zero address. * - the caller must have a balance of at least `amount`. */ function transfer(address recipient, uint256 amount) public virtual override returns (bool) { _transfer(msg.sender, recipient, amount); return true; } /** * @dev See {IERC20-allowance}. */ function allowance(address owner, address spender) public view virtual override returns (uint256) { return _allowances[owner][spender]; } /** * @dev See {IERC20-approve}. * * Requirements: * * - `spender` cannot be the zero address. */ function approve(address spender, uint256 amount) public virtual override returns (bool) { _approve(msg.sender, spender, amount); return true; } /** * @dev See {IERC20-transferFrom}. * * Emits an {Approval} event indicating the updated allowance. This is not * required by the EIP. See the note at the beginning of {ERC20}. * * Requirements: * * - `sender` and `recipient` cannot be the zero address. * - `sender` must have a balance of at least `amount`. * - the caller must have allowance for ``sender``'s tokens of at least * `amount`. */ function transferFrom( address sender, address recipient, uint256 amount ) public virtual override returns (bool) { _transfer(sender, recipient, amount); _approve( sender, msg.sender, _allowances[sender][msg.sender].sub(amount, Errors.ERC20_TRANSFER_EXCEEDS_ALLOWANCE) ); return true; } /** * @dev Atomically increases the allowance granted to `spender` by the caller. * * This is an alternative to {approve} that can be used as a mitigation for * problems described in {IERC20-approve}. * * Emits an {Approval} event indicating the updated allowance. * * Requirements: * * - `spender` cannot be the zero address. */ function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) { _approve(msg.sender, spender, _allowances[msg.sender][spender].add(addedValue)); return true; } /** * @dev Atomically decreases the allowance granted to `spender` by the caller. * * This is an alternative to {approve} that can be used as a mitigation for * problems described in {IERC20-approve}. * * Emits an {Approval} event indicating the updated allowance. * * Requirements: * * - `spender` cannot be the zero address. * - `spender` must have allowance for the caller of at least * `subtractedValue`. */ function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) { _approve( msg.sender, spender, _allowances[msg.sender][spender].sub(subtractedValue, Errors.ERC20_DECREASED_ALLOWANCE_BELOW_ZERO) ); return true; } /** * @dev Moves tokens `amount` from `sender` to `recipient`. * * This is internal function is equivalent to {transfer}, and can be used to * e.g. implement automatic token fees, slashing mechanisms, etc. * * Emits a {Transfer} event. * * Requirements: * * - `sender` cannot be the zero address. * - `recipient` cannot be the zero address. * - `sender` must have a balance of at least `amount`. */ function _transfer( address sender, address recipient, uint256 amount ) internal virtual { _require(sender != address(0), Errors.ERC20_TRANSFER_FROM_ZERO_ADDRESS); _require(recipient != address(0), Errors.ERC20_TRANSFER_TO_ZERO_ADDRESS); _beforeTokenTransfer(sender, recipient, amount); _balances[sender] = _balances[sender].sub(amount, Errors.ERC20_TRANSFER_EXCEEDS_BALANCE); _balances[recipient] = _balances[recipient].add(amount); emit Transfer(sender, recipient, amount); } /** @dev Creates `amount` tokens and assigns them to `account`, increasing * the total supply. * * Emits a {Transfer} event with `from` set to the zero address. * * Requirements: * * - `to` cannot be the zero address. */ function _mint(address account, uint256 amount) internal virtual { _beforeTokenTransfer(address(0), account, amount); _totalSupply = _totalSupply.add(amount); _balances[account] = _balances[account].add(amount); emit Transfer(address(0), account, amount); } /** * @dev Destroys `amount` tokens from `account`, reducing the * total supply. * * Emits a {Transfer} event with `to` set to the zero address. * * Requirements: * * - `account` cannot be the zero address. * - `account` must have at least `amount` tokens. */ function _burn(address account, uint256 amount) internal virtual { _require(account != address(0), Errors.ERC20_BURN_FROM_ZERO_ADDRESS); _beforeTokenTransfer(account, address(0), amount); _balances[account] = _balances[account].sub(amount, Errors.ERC20_BURN_EXCEEDS_ALLOWANCE); _totalSupply = _totalSupply.sub(amount); emit Transfer(account, address(0), amount); } /** * @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens. * * This internal function is equivalent to `approve`, and can be used to * e.g. set automatic allowances for certain subsystems, etc. * * Emits an {Approval} event. * * Requirements: * * - `owner` cannot be the zero address. * - `spender` cannot be the zero address. */ function _approve( address owner, address spender, uint256 amount ) internal virtual { _allowances[owner][spender] = amount; emit Approval(owner, spender, amount); } /** * @dev Sets {decimals} to a value other than the default one of 18. * * WARNING: This function should only be called from the constructor. Most * applications that interact with token contracts will not expect * {decimals} to ever change, and may work incorrectly if it does. */ function _setupDecimals(uint8 decimals_) internal { _decimals = decimals_; } /** * @dev Hook that is called before any transfer of tokens. This includes * minting and burning. * * Calling conditions: * * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens * will be to transferred to `to`. * - when `from` is zero, `amount` tokens will be minted for `to`. * - when `to` is zero, `amount` of ``from``'s tokens will be burned. * - `from` and `to` are never both zero. * * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. */ function _beforeTokenTransfer( address from, address to, uint256 amount ) internal virtual {} } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. interface IAssetManager { /** * @notice Emitted when asset manager is rebalanced */ event Rebalance(bytes32 poolId); /** * @notice Sets the config */ function setConfig(bytes32 poolId, bytes calldata config) external; /** * Note: No function to read the asset manager config is included in IAssetManager * as the signature is expected to vary between asset manager implementations */ /** * @notice Returns the asset manager's token */ function getToken() external view returns (IERC20); /** * @return the current assets under management of this asset manager */ function getAUM(bytes32 poolId) external view returns (uint256); /** * @return poolCash - The up-to-date cash balance of the pool * @return poolManaged - The up-to-date managed balance of the pool */ function getPoolBalances(bytes32 poolId) external view returns (uint256 poolCash, uint256 poolManaged); /** * @return The difference in tokens between the target investment * and the currently invested amount (i.e. the amount that can be invested) */ function maxInvestableBalance(bytes32 poolId) external view returns (int256); /** * @notice Updates the Vault on the value of the pool's investment returns */ function updateBalanceOfPool(bytes32 poolId) external; /** * @notice Determines whether the pool should rebalance given the provided balances */ function shouldRebalance(uint256 cash, uint256 managed) external view returns (bool); /** * @notice Rebalances funds between the pool and the asset manager to maintain target investment percentage. * @param poolId - the poolId of the pool to be rebalanced * @param force - a boolean representing whether a rebalance should be forced even when the pool is near balance */ function rebalance(bytes32 poolId, bool force) external; /** * @notice allows an authorized rebalancer to remove capital to facilitate large withdrawals * @param poolId - the poolId of the pool to withdraw funds back to * @param amount - the amount of tokens to withdraw back to the pool */ function capitalOut(bytes32 poolId, uint256 amount) external; } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @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); } /** * @dev https://eips.ethereum.org/EIPS/eip-712[EIP 712] is a standard for hashing and signing of typed structured data. * * The encoding specified in the EIP is very generic, and such a generic implementation in Solidity is not feasible, * thus this contract does not implement the encoding itself. Protocols need to implement the type-specific encoding * they need in their contracts using a combination of `abi.encode` and `keccak256`. * * This contract implements the EIP 712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding * scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA * ({_hashTypedDataV4}). * * The implementation of the domain separator was designed to be as efficient as possible while still properly updating * the chain id to protect against replay attacks on an eventual fork of the chain. * * NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method * https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask]. * * _Available since v3.4._ */ abstract contract EIP712 { /* solhint-disable var-name-mixedcase */ bytes32 private immutable _HASHED_NAME; bytes32 private immutable _HASHED_VERSION; bytes32 private immutable _TYPE_HASH; /* solhint-enable var-name-mixedcase */ /** * @dev Initializes the domain separator and parameter caches. * * The meaning of `name` and `version` is specified in * https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP 712]: * * - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol. * - `version`: the current major version of the signing domain. * * NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart * contract upgrade]. */ constructor(string memory name, string memory version) { _HASHED_NAME = keccak256(bytes(name)); _HASHED_VERSION = keccak256(bytes(version)); _TYPE_HASH = keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"); } /** * @dev Returns the domain separator for the current chain. */ function _domainSeparatorV4() internal view virtual returns (bytes32) { return keccak256(abi.encode(_TYPE_HASH, _HASHED_NAME, _HASHED_VERSION, _getChainId(), address(this))); } /** * @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this * function returns the hash of the fully encoded EIP712 message for this domain. * * This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example: * * ```solidity * bytes32 digest = _hashTypedDataV4(keccak256(abi.encode( * keccak256("Mail(address to,string contents)"), * mailTo, * keccak256(bytes(mailContents)) * ))); * address signer = ECDSA.recover(digest, signature); * ``` */ function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) { return keccak256(abi.encodePacked("\x19\x01", _domainSeparatorV4(), structHash)); } function _getChainId() private view returns (uint256 chainId) { // Silence state mutability warning without generating bytecode. // See https://github.com/ethereum/solidity/issues/10090#issuecomment-741789128 and // https://github.com/ethereum/solidity/issues/2691 this; // solhint-disable-next-line no-inline-assembly assembly { chainId := chainid() } } } /** * @dev Implementation 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. * * _Available since v3.4._ */ abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712 { mapping(address => uint256) private _nonces; // solhint-disable-next-line var-name-mixedcase bytes32 private immutable _PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); /** * @dev Initializes the {EIP712} domain separator using the `name` parameter, and setting `version` to `"1"`. * * It's a good idea to use the same `name` that is defined as the ERC20 token name. */ constructor(string memory name) EIP712(name, "1") {} /** * @dev See {IERC20Permit-permit}. */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) public virtual override { // solhint-disable-next-line not-rely-on-time _require(block.timestamp <= deadline, Errors.EXPIRED_PERMIT); uint256 nonce = _nonces[owner]; bytes32 structHash = keccak256(abi.encode(_PERMIT_TYPEHASH, owner, spender, value, nonce, deadline)); bytes32 hash = _hashTypedDataV4(structHash); address signer = ecrecover(hash, v, r, s); _require((signer != address(0)) && (signer == owner), Errors.INVALID_SIGNATURE); _nonces[owner] = nonce + 1; _approve(owner, spender, value); } /** * @dev See {IERC20Permit-nonces}. */ function nonces(address owner) public view override returns (uint256) { return _nonces[owner]; } /** * @dev See {IERC20Permit-DOMAIN_SEPARATOR}. */ // solhint-disable-next-line func-name-mixedcase function DOMAIN_SEPARATOR() external view override returns (bytes32) { return _domainSeparatorV4(); } } /** * @title Highly opinionated token implementation * @author Balancer Labs * @dev * - Includes functions to increase and decrease allowance as a workaround * for the well-known issue with `approve`: * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 * - Allows for 'infinite allowance', where an allowance of 0xff..ff is not * decreased by calls to transferFrom * - Lets a token holder use `transferFrom` to send their own tokens, * without first setting allowance * - Emits 'Approval' events whenever allowance is changed by `transferFrom` * - Assigns infinite allowance for all token holders to the Vault */ contract BalancerPoolToken is ERC20Permit { IVault private immutable _vault; constructor( string memory tokenName, string memory tokenSymbol, IVault vault ) ERC20(tokenName, tokenSymbol) ERC20Permit(tokenName) { _vault = vault; } function getVault() public view returns (IVault) { return _vault; } // Overrides /** * @dev Override to grant the Vault infinite allowance, causing for Pool Tokens to not require approval. * * This is sound as the Vault already provides authorization mechanisms when initiation token transfers, which this * contract inherits. */ function allowance(address owner, address spender) public view override returns (uint256) { if (spender == address(getVault())) { return uint256(-1); } else { return super.allowance(owner, spender); } } /** * @dev Override to allow for 'infinite allowance' and let the token owner use `transferFrom` with no self-allowance */ function transferFrom( address sender, address recipient, uint256 amount ) public override returns (bool) { uint256 currentAllowance = allowance(sender, msg.sender); _require(msg.sender == sender || currentAllowance >= amount, Errors.ERC20_TRANSFER_EXCEEDS_ALLOWANCE); _transfer(sender, recipient, amount); if (msg.sender != sender && currentAllowance != uint256(-1)) { // Because of the previous require, we know that if msg.sender != sender then currentAllowance >= amount _approve(sender, msg.sender, currentAllowance - amount); } return true; } /** * @dev Override to allow decreasing allowance by more than the current amount (setting it to zero) */ function decreaseAllowance(address spender, uint256 amount) public override returns (bool) { uint256 currentAllowance = allowance(msg.sender, spender); if (amount >= currentAllowance) { _approve(msg.sender, spender, 0); } else { // No risk of underflow due to if condition _approve(msg.sender, spender, currentAllowance - amount); } return true; } // Internal functions function _mintPoolTokens(address recipient, uint256 amount) internal { _mint(recipient, amount); } function _burnPoolTokens(address sender, uint256 amount) internal { _burn(sender, amount); } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. interface IAuthentication { /** * @dev Returns the action identifier associated with the external function described by `selector`. */ function getActionId(bytes4 selector) external view returns (bytes32); } /** * @dev Building block for performing access control on external functions. * * This contract is used via the `authenticate` modifier (or the `_authenticateCaller` function), which can be applied * to external functions to only make them callable by authorized accounts. * * Derived contracts must implement the `_canPerform` function, which holds the actual access control logic. */ abstract contract Authentication is IAuthentication { bytes32 private immutable _actionIdDisambiguator; /** * @dev The main purpose of the `actionIdDisambiguator` is to prevent accidental function selector collisions in * multi contract systems. * * There are two main uses for it: * - if the contract is a singleton, any unique identifier can be used to make the associated action identifiers * unique. The contract's own address is a good option. * - if the contract belongs to a family that shares action identifiers for the same functions, an identifier * shared by the entire family (and no other contract) should be used instead. */ constructor(bytes32 actionIdDisambiguator) { _actionIdDisambiguator = actionIdDisambiguator; } /** * @dev Reverts unless the caller is allowed to call this function. Should only be applied to external functions. */ modifier authenticate() { _authenticateCaller(); _; } /** * @dev Reverts unless the caller is allowed to call the entry point function. */ function _authenticateCaller() internal view { bytes32 actionId = getActionId(msg.sig); _require(_canPerform(actionId, msg.sender), Errors.SENDER_NOT_ALLOWED); } function getActionId(bytes4 selector) public view override returns (bytes32) { // Each external function is dynamically assigned an action identifier as the hash of the disambiguator and the // function selector. Disambiguation is necessary to avoid potential collisions in the function selectors of // multiple contracts. return keccak256(abi.encodePacked(_actionIdDisambiguator, selector)); } function _canPerform(bytes32 actionId, address user) internal view virtual returns (bool); } /** * @dev Base authorization layer implementation for Pools. * * The owner account can call some of the permissioned functions - access control of the rest is delegated to the * Authorizer. Note that this owner is immutable: more sophisticated permission schemes, such as multiple ownership, * granular roles, etc., could be built on top of this by making the owner a smart contract. * * Access control of all other permissioned functions is delegated to an Authorizer. It is also possible to delegate * control of *all* permissioned functions to the Authorizer by setting the owner address to `_DELEGATE_OWNER`. */ abstract contract BasePoolAuthorization is Authentication { address private immutable _owner; address private constant _DELEGATE_OWNER = 0xBA1BA1ba1BA1bA1bA1Ba1BA1ba1BA1bA1ba1ba1B; constructor(address owner) { _owner = owner; } function getOwner() public view returns (address) { return _owner; } function getAuthorizer() external view returns (IAuthorizer) { return _getAuthorizer(); } function _canPerform(bytes32 actionId, address account) internal view override returns (bool) { if ((getOwner() != _DELEGATE_OWNER) && _isOwnerOnlyAction(actionId)) { // Only the owner can perform "owner only" actions, unless the owner is delegated. return msg.sender == getOwner(); } else { // Non-owner actions are always processed via the Authorizer, as "owner only" ones are when delegated. return _getAuthorizer().canPerform(actionId, account, address(this)); } } function _isOwnerOnlyAction(bytes32 actionId) internal view virtual returns (bool); function _getAuthorizer() internal view virtual returns (IAuthorizer); } // solhint-disable max-states-count /** * @dev Reference implementation for the base layer of a Pool contract that manages a single Pool with optional * Asset Managers, an admin-controlled swap fee percentage, and an emergency pause mechanism. * * Note that neither swap fees nor the pause mechanism are used by this contract. They are passed through so that * derived contracts can use them via the `_addSwapFeeAmount` and `_subtractSwapFeeAmount` functions, and the * `whenNotPaused` modifier. * * No admin permissions are checked here: instead, this contract delegates that to the Vault's own Authorizer. * * Because this contract doesn't implement the swap hooks, derived contracts should generally inherit from * BaseGeneralPool or BaseMinimalSwapInfoPool. Otherwise, subclasses must inherit from the corresponding interfaces * and implement the swap callbacks themselves. */ abstract contract BasePool is IBasePool, BasePoolAuthorization, BalancerPoolToken, TemporarilyPausable { using WordCodec for bytes32; using FixedPoint for uint256; uint256 private constant _MIN_TOKENS = 2; uint256 private constant _DEFAULT_MINIMUM_BPT = 1e6; // 1e18 corresponds to 1.0, or a 100% fee uint256 private constant _MIN_SWAP_FEE_PERCENTAGE = 1e12; // 0.0001% uint256 private constant _MAX_SWAP_FEE_PERCENTAGE = 1e17; // 10% - this fits in 64 bits // Storage slot that can be used to store unrelated pieces of information. In particular, by default is used // to store only the swap fee percentage of a pool. But it can be extended to store some more pieces of information. // The swap fee percentage is stored in the most-significant 64 bits, therefore the remaining 192 bits can be // used to store any other piece of information. bytes32 private _miscData; uint256 private constant _SWAP_FEE_PERCENTAGE_OFFSET = 192; bytes32 private immutable _poolId; event SwapFeePercentageChanged(uint256 swapFeePercentage); constructor( IVault vault, IVault.PoolSpecialization specialization, string memory name, string memory symbol, IERC20[] memory tokens, address[] memory assetManagers, uint256 swapFeePercentage, uint256 pauseWindowDuration, uint256 bufferPeriodDuration, address owner ) // Base Pools are expected to be deployed using factories. By using the factory address as the action // disambiguator, we make all Pools deployed by the same factory share action identifiers. This allows for // simpler management of permissions (such as being able to manage granting the 'set fee percentage' action in // any Pool created by the same factory), while still making action identifiers unique among different factories // if the selectors match, preventing accidental errors. Authentication(bytes32(uint256(msg.sender))) BalancerPoolToken(name, symbol, vault) BasePoolAuthorization(owner) TemporarilyPausable(pauseWindowDuration, bufferPeriodDuration) { _require(tokens.length >= _MIN_TOKENS, Errors.MIN_TOKENS); _require(tokens.length <= _getMaxTokens(), Errors.MAX_TOKENS); // The Vault only requires the token list to be ordered for the Two Token Pools specialization. However, // to make the developer experience consistent, we are requiring this condition for all the native pools. // Also, since these Pools will register tokens only once, we can ensure the Pool tokens will follow the same // order. We rely on this property to make Pools simpler to write, as it lets us assume that the // order of token-specific parameters (such as token weights) will not change. InputHelpers.ensureArrayIsSorted(tokens); _setSwapFeePercentage(swapFeePercentage); bytes32 poolId = vault.registerPool(specialization); vault.registerTokens(poolId, tokens, assetManagers); // Set immutable state variables - these cannot be read from during construction _poolId = poolId; } // Getters / Setters function getPoolId() public view override returns (bytes32) { return _poolId; } function _getTotalTokens() internal view virtual returns (uint256); function _getMaxTokens() internal pure virtual returns (uint256); /** * @dev Returns the minimum BPT supply. This amount is minted to the zero address during initialization, effectively * locking it. * * This is useful to make sure Pool initialization happens only once, but derived Pools can change this value (even * to zero) by overriding this function. */ function _getMinimumBpt() internal pure virtual returns (uint256) { return _DEFAULT_MINIMUM_BPT; } function getSwapFeePercentage() public view returns (uint256) { return _miscData.decodeUint64(_SWAP_FEE_PERCENTAGE_OFFSET); } function setSwapFeePercentage(uint256 swapFeePercentage) public virtual authenticate whenNotPaused { _setSwapFeePercentage(swapFeePercentage); } function _setSwapFeePercentage(uint256 swapFeePercentage) private { _require(swapFeePercentage >= _MIN_SWAP_FEE_PERCENTAGE, Errors.MIN_SWAP_FEE_PERCENTAGE); _require(swapFeePercentage <= _MAX_SWAP_FEE_PERCENTAGE, Errors.MAX_SWAP_FEE_PERCENTAGE); _miscData = _miscData.insertUint64(swapFeePercentage, _SWAP_FEE_PERCENTAGE_OFFSET); emit SwapFeePercentageChanged(swapFeePercentage); } function setAssetManagerPoolConfig(IERC20 token, bytes memory poolConfig) public virtual authenticate whenNotPaused { _setAssetManagerPoolConfig(token, poolConfig); } function _setAssetManagerPoolConfig(IERC20 token, bytes memory poolConfig) private { bytes32 poolId = getPoolId(); (, , , address assetManager) = getVault().getPoolTokenInfo(poolId, token); IAssetManager(assetManager).setConfig(poolId, poolConfig); } function setPaused(bool paused) external authenticate { _setPaused(paused); } function _isOwnerOnlyAction(bytes32 actionId) internal view virtual override returns (bool) { return (actionId == getActionId(this.setSwapFeePercentage.selector)) || (actionId == getActionId(this.setAssetManagerPoolConfig.selector)); } function _getMiscData() internal view returns (bytes32) { return _miscData; } /** * Inserts data into the least-significant 192 bits of the misc data storage slot. * Note that the remaining 64 bits are used for the swap fee percentage and cannot be overloaded. */ function _setMiscData(bytes32 newData) internal { _miscData = _miscData.insertBits192(newData, 0); } // Join / Exit Hooks modifier onlyVault(bytes32 poolId) { _require(msg.sender == address(getVault()), Errors.CALLER_NOT_VAULT); _require(poolId == getPoolId(), Errors.INVALID_POOL_ID); _; } function onJoinPool( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, bytes memory userData ) public virtual override onlyVault(poolId) returns (uint256[] memory, uint256[] memory) { uint256[] memory scalingFactors = _scalingFactors(); if (totalSupply() == 0) { (uint256 bptAmountOut, uint256[] memory amountsIn) = _onInitializePool( poolId, sender, recipient, scalingFactors, userData ); // On initialization, we lock _getMinimumBpt() by minting it for the zero address. This BPT acts as a // minimum as it will never be burned, which reduces potential issues with rounding, and also prevents the // Pool from ever being fully drained. _require(bptAmountOut >= _getMinimumBpt(), Errors.MINIMUM_BPT); _mintPoolTokens(address(0), _getMinimumBpt()); _mintPoolTokens(recipient, bptAmountOut - _getMinimumBpt()); // amountsIn are amounts entering the Pool, so we round up. _downscaleUpArray(amountsIn, scalingFactors); return (amountsIn, new uint256[](_getTotalTokens())); } else { _upscaleArray(balances, scalingFactors); (uint256 bptAmountOut, uint256[] memory amountsIn, uint256[] memory dueProtocolFeeAmounts) = _onJoinPool( poolId, sender, recipient, balances, lastChangeBlock, protocolSwapFeePercentage, scalingFactors, userData ); // Note we no longer use `balances` after calling `_onJoinPool`, which may mutate it. _mintPoolTokens(recipient, bptAmountOut); // amountsIn are amounts entering the Pool, so we round up. _downscaleUpArray(amountsIn, scalingFactors); // dueProtocolFeeAmounts are amounts exiting the Pool, so we round down. _downscaleDownArray(dueProtocolFeeAmounts, scalingFactors); return (amountsIn, dueProtocolFeeAmounts); } } function onExitPool( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, bytes memory userData ) public virtual override onlyVault(poolId) returns (uint256[] memory, uint256[] memory) { uint256[] memory scalingFactors = _scalingFactors(); _upscaleArray(balances, scalingFactors); (uint256 bptAmountIn, uint256[] memory amountsOut, uint256[] memory dueProtocolFeeAmounts) = _onExitPool( poolId, sender, recipient, balances, lastChangeBlock, protocolSwapFeePercentage, scalingFactors, userData ); // Note we no longer use `balances` after calling `_onExitPool`, which may mutate it. _burnPoolTokens(sender, bptAmountIn); // Both amountsOut and dueProtocolFeeAmounts are amounts exiting the Pool, so we round down. _downscaleDownArray(amountsOut, scalingFactors); _downscaleDownArray(dueProtocolFeeAmounts, scalingFactors); return (amountsOut, dueProtocolFeeAmounts); } // Query functions /** * @dev Returns the amount of BPT that would be granted to `recipient` if the `onJoinPool` hook were called by the * Vault with the same arguments, along with the number of tokens `sender` would have to supply. * * This function is not meant to be called directly, but rather from a helper contract that fetches current Vault * data, such as the protocol swap fee percentage and Pool balances. * * Like `IVault.queryBatchSwap`, this function is not view due to internal implementation details: the caller must * explicitly use eth_call instead of eth_sendTransaction. */ function queryJoin( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, bytes memory userData ) external returns (uint256 bptOut, uint256[] memory amountsIn) { InputHelpers.ensureInputLengthMatch(balances.length, _getTotalTokens()); _queryAction( poolId, sender, recipient, balances, lastChangeBlock, protocolSwapFeePercentage, userData, _onJoinPool, _downscaleUpArray ); // The `return` opcode is executed directly inside `_queryAction`, so execution never reaches this statement, // and we don't need to return anything here - it just silences compiler warnings. return (bptOut, amountsIn); } /** * @dev Returns the amount of BPT that would be burned from `sender` if the `onExitPool` hook were called by the * Vault with the same arguments, along with the number of tokens `recipient` would receive. * * This function is not meant to be called directly, but rather from a helper contract that fetches current Vault * data, such as the protocol swap fee percentage and Pool balances. * * Like `IVault.queryBatchSwap`, this function is not view due to internal implementation details: the caller must * explicitly use eth_call instead of eth_sendTransaction. */ function queryExit( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, bytes memory userData ) external returns (uint256 bptIn, uint256[] memory amountsOut) { InputHelpers.ensureInputLengthMatch(balances.length, _getTotalTokens()); _queryAction( poolId, sender, recipient, balances, lastChangeBlock, protocolSwapFeePercentage, userData, _onExitPool, _downscaleDownArray ); // The `return` opcode is executed directly inside `_queryAction`, so execution never reaches this statement, // and we don't need to return anything here - it just silences compiler warnings. return (bptIn, amountsOut); } // Internal hooks to be overridden by derived contracts - all token amounts (except BPT) in these interfaces are // upscaled. /** * @dev Called when the Pool is joined for the first time; that is, when the BPT total supply is zero. * * Returns the amount of BPT to mint, and the token amounts the Pool will receive in return. * * Minted BPT will be sent to `recipient`, except for _getMinimumBpt(), which will be deducted from this amount and * sent to the zero address instead. This will cause that BPT to remain forever locked there, preventing total BTP * from ever dropping below that value, and ensuring `_onInitializePool` can only be called once in the entire * Pool's lifetime. * * The tokens granted to the Pool will be transferred from `sender`. These amounts are considered upscaled and will * be downscaled (rounding up) before being returned to the Vault. */ function _onInitializePool( bytes32 poolId, address sender, address recipient, uint256[] memory scalingFactors, bytes memory userData ) internal virtual returns (uint256 bptAmountOut, uint256[] memory amountsIn); /** * @dev Called whenever the Pool is joined after the first initialization join (see `_onInitializePool`). * * Returns the amount of BPT to mint, the token amounts that the Pool will receive in return, and the number of * tokens to pay in protocol swap fees. * * Implementations of this function might choose to mutate the `balances` array to save gas (e.g. when * performing intermediate calculations, such as subtraction of due protocol fees). This can be done safely. * * Minted BPT will be sent to `recipient`. * * The tokens granted to the Pool will be transferred from `sender`. These amounts are considered upscaled and will * be downscaled (rounding up) before being returned to the Vault. * * Due protocol swap fees will be taken from the Pool's balance in the Vault (see `IBasePool.onJoinPool`). These * amounts are considered upscaled and will be downscaled (rounding down) before being returned to the Vault. */ function _onJoinPool( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, uint256[] memory scalingFactors, bytes memory userData ) internal virtual returns ( uint256 bptAmountOut, uint256[] memory amountsIn, uint256[] memory dueProtocolFeeAmounts ); /** * @dev Called whenever the Pool is exited. * * Returns the amount of BPT to burn, the token amounts for each Pool token that the Pool will grant in return, and * the number of tokens to pay in protocol swap fees. * * Implementations of this function might choose to mutate the `balances` array to save gas (e.g. when * performing intermediate calculations, such as subtraction of due protocol fees). This can be done safely. * * BPT will be burnt from `sender`. * * The Pool will grant tokens to `recipient`. These amounts are considered upscaled and will be downscaled * (rounding down) before being returned to the Vault. * * Due protocol swap fees will be taken from the Pool's balance in the Vault (see `IBasePool.onExitPool`). These * amounts are considered upscaled and will be downscaled (rounding down) before being returned to the Vault. */ function _onExitPool( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, uint256[] memory scalingFactors, bytes memory userData ) internal virtual returns ( uint256 bptAmountIn, uint256[] memory amountsOut, uint256[] memory dueProtocolFeeAmounts ); // Internal functions /** * @dev Adds swap fee amount to `amount`, returning a higher value. */ function _addSwapFeeAmount(uint256 amount) internal view returns (uint256) { // This returns amount + fee amount, so we round up (favoring a higher fee amount). return amount.divUp(FixedPoint.ONE.sub(getSwapFeePercentage())); } /** * @dev Subtracts swap fee amount from `amount`, returning a lower value. */ function _subtractSwapFeeAmount(uint256 amount) internal view returns (uint256) { // This returns amount - fee amount, so we round up (favoring a higher fee amount). uint256 feeAmount = amount.mulUp(getSwapFeePercentage()); return amount.sub(feeAmount); } // Scaling /** * @dev Returns a scaling factor that, when multiplied to a token amount for `token`, normalizes its balance as if * it had 18 decimals. */ function _computeScalingFactor(IERC20 token) internal view returns (uint256) { if (address(token) == address(this)) { return FixedPoint.ONE; } // Tokens that don't implement the `decimals` method are not supported. uint256 tokenDecimals = ERC20(address(token)).decimals(); // Tokens with more than 18 decimals are not supported. uint256 decimalsDifference = Math.sub(18, tokenDecimals); return FixedPoint.ONE * 10**decimalsDifference; } /** * @dev Returns the scaling factor for one of the Pool's tokens. Reverts if `token` is not a token registered by the * Pool. * * All scaling factors are fixed-point values with 18 decimals, to allow for this function to be overridden by * derived contracts that need to apply further scaling, making these factors potentially non-integer. * * The largest 'base' scaling factor (i.e. in tokens with less than 18 decimals) is 10**18, which in fixed-point is * 10**36. This value can be multiplied with a 112 bit Vault balance with no overflow by a factor of ~1e7, making * even relatively 'large' factors safe to use. * * The 1e7 figure is the result of 2**256 / (1e18 * 1e18 * 2**112). */ function _scalingFactor(IERC20 token) internal view virtual returns (uint256); /** * @dev Same as `_scalingFactor()`, except for all registered tokens (in the same order as registered). The Vault * will always pass balances in this order when calling any of the Pool hooks. */ function _scalingFactors() internal view virtual returns (uint256[] memory); function getScalingFactors() external view returns (uint256[] memory) { return _scalingFactors(); } /** * @dev Applies `scalingFactor` to `amount`, resulting in a larger or equal value depending on whether it needed * scaling or not. */ function _upscale(uint256 amount, uint256 scalingFactor) internal pure returns (uint256) { // Upscale rounding wouldn't necessarily always go in the same direction: in a swap for example the balance of // token in should be rounded up, and that of token out rounded down. This is the only place where we round in // the same direction for all amounts, as the impact of this rounding is expected to be minimal (and there's no // rounding error unless `_scalingFactor()` is overriden). return FixedPoint.mulDown(amount, scalingFactor); } /** * @dev Same as `_upscale`, but for an entire array. This function does not return anything, but instead *mutates* * the `amounts` array. */ function _upscaleArray(uint256[] memory amounts, uint256[] memory scalingFactors) internal view { for (uint256 i = 0; i < _getTotalTokens(); ++i) { amounts[i] = FixedPoint.mulDown(amounts[i], scalingFactors[i]); } } /** * @dev Reverses the `scalingFactor` applied to `amount`, resulting in a smaller or equal value depending on * whether it needed scaling or not. The result is rounded down. */ function _downscaleDown(uint256 amount, uint256 scalingFactor) internal pure returns (uint256) { return FixedPoint.divDown(amount, scalingFactor); } /** * @dev Same as `_downscaleDown`, but for an entire array. This function does not return anything, but instead * *mutates* the `amounts` array. */ function _downscaleDownArray(uint256[] memory amounts, uint256[] memory scalingFactors) internal view { for (uint256 i = 0; i < _getTotalTokens(); ++i) { amounts[i] = FixedPoint.divDown(amounts[i], scalingFactors[i]); } } /** * @dev Reverses the `scalingFactor` applied to `amount`, resulting in a smaller or equal value depending on * whether it needed scaling or not. The result is rounded up. */ function _downscaleUp(uint256 amount, uint256 scalingFactor) internal pure returns (uint256) { return FixedPoint.divUp(amount, scalingFactor); } /** * @dev Same as `_downscaleUp`, but for an entire array. This function does not return anything, but instead * *mutates* the `amounts` array. */ function _downscaleUpArray(uint256[] memory amounts, uint256[] memory scalingFactors) internal view { for (uint256 i = 0; i < _getTotalTokens(); ++i) { amounts[i] = FixedPoint.divUp(amounts[i], scalingFactors[i]); } } function _getAuthorizer() internal view override returns (IAuthorizer) { // Access control management is delegated to the Vault's Authorizer. This lets Balancer Governance manage which // accounts can call permissioned functions: for example, to perform emergency pauses. // If the owner is delegated, then *all* permissioned functions, including `setSwapFeePercentage`, will be under // Governance control. return getVault().getAuthorizer(); } function _queryAction( bytes32 poolId, address sender, address recipient, uint256[] memory balances, uint256 lastChangeBlock, uint256 protocolSwapFeePercentage, bytes memory userData, function(bytes32, address, address, uint256[] memory, uint256, uint256, uint256[] memory, bytes memory) internal returns (uint256, uint256[] memory, uint256[] memory) _action, function(uint256[] memory, uint256[] memory) internal view _downscaleArray ) private { // This uses the same technique used by the Vault in queryBatchSwap. Refer to that function for a detailed // explanation. if (msg.sender != address(this)) { // We perform an external call to ourselves, forwarding the same calldata. In this call, the else clause of // the preceding if statement will be executed instead. // solhint-disable-next-line avoid-low-level-calls (bool success, ) = address(this).call(msg.data); // solhint-disable-next-line no-inline-assembly assembly { // This call should always revert to decode the bpt and token amounts from the revert reason switch success case 0 { // Note we are manually writing the memory slot 0. We can safely overwrite whatever is // stored there as we take full control of the execution and then immediately return. // We copy the first 4 bytes to check if it matches with the expected signature, otherwise // there was another revert reason and we should forward it. returndatacopy(0, 0, 0x04) let error := and(mload(0), 0xffffffff00000000000000000000000000000000000000000000000000000000) // If the first 4 bytes don't match with the expected signature, we forward the revert reason. if eq(eq(error, 0x43adbafb00000000000000000000000000000000000000000000000000000000), 0) { returndatacopy(0, 0, returndatasize()) revert(0, returndatasize()) } // The returndata contains the signature, followed by the raw memory representation of the // `bptAmount` and `tokenAmounts` (array: length + data). We need to return an ABI-encoded // representation of these. // An ABI-encoded response will include one additional field to indicate the starting offset of // the `tokenAmounts` array. The `bptAmount` will be laid out in the first word of the // returndata. // // In returndata: // [ signature ][ bptAmount ][ tokenAmounts length ][ tokenAmounts values ] // [ 4 bytes ][ 32 bytes ][ 32 bytes ][ (32 * length) bytes ] // // We now need to return (ABI-encoded values): // [ bptAmount ][ tokeAmounts offset ][ tokenAmounts length ][ tokenAmounts values ] // [ 32 bytes ][ 32 bytes ][ 32 bytes ][ (32 * length) bytes ] // We copy 32 bytes for the `bptAmount` from returndata into memory. // Note that we skip the first 4 bytes for the error signature returndatacopy(0, 0x04, 32) // The offsets are 32-bytes long, so the array of `tokenAmounts` will start after // the initial 64 bytes. mstore(0x20, 64) // We now copy the raw memory array for the `tokenAmounts` from returndata into memory. // Since bpt amount and offset take up 64 bytes, we start copying at address 0x40. We also // skip the first 36 bytes from returndata, which correspond to the signature plus bpt amount. returndatacopy(0x40, 0x24, sub(returndatasize(), 36)) // We finally return the ABI-encoded uint256 and the array, which has a total length equal to // the size of returndata, plus the 32 bytes of the offset but without the 4 bytes of the // error signature. return(0, add(returndatasize(), 28)) } default { // This call should always revert, but we fail nonetheless if that didn't happen invalid() } } } else { uint256[] memory scalingFactors = _scalingFactors(); _upscaleArray(balances, scalingFactors); (uint256 bptAmount, uint256[] memory tokenAmounts, ) = _action( poolId, sender, recipient, balances, lastChangeBlock, protocolSwapFeePercentage, scalingFactors, userData ); _downscaleArray(tokenAmounts, scalingFactors); // solhint-disable-next-line no-inline-assembly assembly { // We will return a raw representation of `bptAmount` and `tokenAmounts` in memory, which is composed of // a 32-byte uint256, followed by a 32-byte for the array length, and finally the 32-byte uint256 values // Because revert expects a size in bytes, we multiply the array length (stored at `tokenAmounts`) by 32 let size := mul(mload(tokenAmounts), 32) // We store the `bptAmount` in the previous slot to the `tokenAmounts` array. We can make sure there // will be at least one available slot due to how the memory scratch space works. // We can safely overwrite whatever is stored in this slot as we will revert immediately after that. let start := sub(tokenAmounts, 0x20) mstore(start, bptAmount) // We send one extra value for the error signature "QueryError(uint256,uint256[])" which is 0x43adbafb // We use the previous slot to `bptAmount`. mstore(sub(start, 0x20), 0x0000000000000000000000000000000000000000000000000000000043adbafb) start := sub(start, 0x04) // When copying from `tokenAmounts` into returndata, we copy the additional 68 bytes to also return // the `bptAmount`, the array 's length, and the error signature. revert(start, add(size, 68)) } } } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev Interface for the SignatureValidator helper, used to support meta-transactions. */ interface ISignaturesValidator { /** * @dev Returns the EIP712 domain separator. */ function getDomainSeparator() external view returns (bytes32); /** * @dev Returns the next nonce used by an address to sign messages. */ function getNextNonce(address user) external view returns (uint256); } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev Interface for WETH9. * See https://github.com/gnosis/canonical-weth/blob/0dd1ea3e295eef916d0c6223ec63141137d22d67/contracts/WETH9.sol */ interface IWETH is IERC20 { function deposit() external payable; function withdraw(uint256 amount) external; } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev This is an empty interface used to represent either ERC20-conforming token contracts or ETH (using the zero * address sentinel value). We're just relying on the fact that `interface` can be used to declare new address-like * types. * * This concept is unrelated to a Pool's Asset Managers. */ interface IAsset { // solhint-disable-previous-line no-empty-blocks } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // Inspired by Aave Protocol's IFlashLoanReceiver. interface IFlashLoanRecipient { /** * @dev When `flashLoan` is called on the Vault, it invokes the `receiveFlashLoan` hook on the recipient. * * At the time of the call, the Vault will have transferred `amounts` for `tokens` to the recipient. Before this * call returns, the recipient must have transferred `amounts` plus `feeAmounts` for each token back to the * Vault, or else the entire flash loan will revert. * * `userData` is the same value passed in the `IVault.flashLoan` call. */ function receiveFlashLoan( IERC20[] memory tokens, uint256[] memory amounts, uint256[] memory feeAmounts, bytes memory userData ) external; } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. interface IProtocolFeesCollector { event SwapFeePercentageChanged(uint256 newSwapFeePercentage); event FlashLoanFeePercentageChanged(uint256 newFlashLoanFeePercentage); function withdrawCollectedFees( IERC20[] calldata tokens, uint256[] calldata amounts, address recipient ) external; function setSwapFeePercentage(uint256 newSwapFeePercentage) external; function setFlashLoanFeePercentage(uint256 newFlashLoanFeePercentage) external; function getSwapFeePercentage() external view returns (uint256); function getFlashLoanFeePercentage() external view returns (uint256); function getCollectedFeeAmounts(IERC20[] memory tokens) external view returns (uint256[] memory feeAmounts); function getAuthorizer() external view returns (IAuthorizer); function vault() external view returns (IVault); } /** * @dev Full external interface for the Vault core contract - no external or public methods exist in the contract that * don't override one of these declarations. */ interface IVault is ISignaturesValidator, ITemporarilyPausable { // Generalities about the Vault: // // - Whenever documentation refers to 'tokens', it strictly refers to ERC20-compliant token contracts. Tokens are // transferred out of the Vault by calling the `IERC20.transfer` function, and transferred in by calling // `IERC20.transferFrom`. In these cases, the sender must have previously allowed the Vault to use their tokens by // calling `IERC20.approve`. The only deviation from the ERC20 standard that is supported is functions not returning // a boolean value: in these scenarios, a non-reverting call is assumed to be successful. // // - All non-view functions in the Vault are non-reentrant: calling them while another one is mid-execution (e.g. // while execution control is transferred to a token contract during a swap) will result in a revert. View // functions can be called in a re-reentrant way, but doing so might cause them to return inconsistent results. // Contracts calling view functions in the Vault must make sure the Vault has not already been entered. // // - View functions revert if referring to either unregistered Pools, or unregistered tokens for registered Pools. // Authorizer // // Some system actions are permissioned, like setting and collecting protocol fees. This permissioning system exists // outside of the Vault in the Authorizer contract: the Vault simply calls the Authorizer to check if the caller // can perform a given action. /** * @dev Returns the Vault's Authorizer. */ function getAuthorizer() external view returns (IAuthorizer); /** * @dev Sets a new Authorizer for the Vault. The caller must be allowed by the current Authorizer to do this. * * Emits an `AuthorizerChanged` event. */ function setAuthorizer(IAuthorizer newAuthorizer) external; /** * @dev Emitted when a new authorizer is set by `setAuthorizer`. */ event AuthorizerChanged(IAuthorizer indexed newAuthorizer); // Relayers // // Additionally, it is possible for an account to perform certain actions on behalf of another one, using their // Vault ERC20 allowance and Internal Balance. These accounts are said to be 'relayers' for these Vault functions, // and are expected to be smart contracts with sound authentication mechanisms. For an account to be able to wield // this power, two things must occur: // - The Authorizer must grant the account the permission to be a relayer for the relevant Vault function. This // means that Balancer governance must approve each individual contract to act as a relayer for the intended // functions. // - Each user must approve the relayer to act on their behalf. // This double protection means users cannot be tricked into approving malicious relayers (because they will not // have been allowed by the Authorizer via governance), nor can malicious relayers approved by a compromised // Authorizer or governance drain user funds, since they would also need to be approved by each individual user. /** * @dev Returns true if `user` has approved `relayer` to act as a relayer for them. */ function hasApprovedRelayer(address user, address relayer) external view returns (bool); /** * @dev Allows `relayer` to act as a relayer for `sender` if `approved` is true, and disallows it otherwise. * * Emits a `RelayerApprovalChanged` event. */ function setRelayerApproval( address sender, address relayer, bool approved ) external; /** * @dev Emitted every time a relayer is approved or disapproved by `setRelayerApproval`. */ event RelayerApprovalChanged(address indexed relayer, address indexed sender, bool approved); // Internal Balance // // Users can deposit tokens into the Vault, where they are allocated to their Internal Balance, and later // transferred or withdrawn. It can also be used as a source of tokens when joining Pools, as a destination // when exiting them, and as either when performing swaps. This usage of Internal Balance results in greatly reduced // gas costs when compared to relying on plain ERC20 transfers, leading to large savings for frequent users. // // Internal Balance management features batching, which means a single contract call can be used to perform multiple // operations of different kinds, with different senders and recipients, at once. /** * @dev Returns `user`'s Internal Balance for a set of tokens. */ function getInternalBalance(address user, IERC20[] memory tokens) external view returns (uint256[] memory); /** * @dev Performs a set of user balance operations, which involve Internal Balance (deposit, withdraw or transfer) * and plain ERC20 transfers using the Vault's allowance. This last feature is particularly useful for relayers, as * it lets integrators reuse a user's Vault allowance. * * For each operation, if the caller is not `sender`, it must be an authorized relayer for them. */ function manageUserBalance(UserBalanceOp[] memory ops) external payable; /** * @dev Data for `manageUserBalance` operations, which include the possibility for ETH to be sent and received without manual WETH wrapping or unwrapping. */ struct UserBalanceOp { UserBalanceOpKind kind; IAsset asset; uint256 amount; address sender; address payable recipient; } // There are four possible operations in `manageUserBalance`: // // - DEPOSIT_INTERNAL // Increases the Internal Balance of the `recipient` account by transferring tokens from the corresponding // `sender`. The sender must have allowed the Vault to use their tokens via `IERC20.approve()`. // // ETH can be used by passing the ETH sentinel value as the asset and forwarding ETH in the call: it will be wrapped // and deposited as WETH. Any ETH amount remaining will be sent back to the caller (not the sender, which is // relevant for relayers). // // Emits an `InternalBalanceChanged` event. // // // - WITHDRAW_INTERNAL // Decreases the Internal Balance of the `sender` account by transferring tokens to the `recipient`. // // ETH can be used by passing the ETH sentinel value as the asset. This will deduct WETH instead, unwrap it and send // it to the recipient as ETH. // // Emits an `InternalBalanceChanged` event. // // // - TRANSFER_INTERNAL // Transfers tokens from the Internal Balance of the `sender` account to the Internal Balance of `recipient`. // // Reverts if the ETH sentinel value is passed. // // Emits an `InternalBalanceChanged` event. // // // - TRANSFER_EXTERNAL // Transfers tokens from `sender` to `recipient`, using the Vault's ERC20 allowance. This is typically used by // relayers, as it lets them reuse a user's Vault allowance. // // Reverts if the ETH sentinel value is passed. // // Emits an `ExternalBalanceTransfer` event. enum UserBalanceOpKind { DEPOSIT_INTERNAL, WITHDRAW_INTERNAL, TRANSFER_INTERNAL, TRANSFER_EXTERNAL } /** * @dev Emitted when a user's Internal Balance changes, either from calls to `manageUserBalance`, or through * interacting with Pools using Internal Balance. * * Because Internal Balance works exclusively with ERC20 tokens, ETH deposits and withdrawals will use the WETH * address. */ event InternalBalanceChanged(address indexed user, IERC20 indexed token, int256 delta); /** * @dev Emitted when a user's Vault ERC20 allowance is used by the Vault to transfer tokens to an external account. */ event ExternalBalanceTransfer(IERC20 indexed token, address indexed sender, address recipient, uint256 amount); // Pools // // There are three specialization settings for Pools, which allow for cheaper swaps at the cost of reduced // functionality: // // - General: no specialization, suited for all Pools. IGeneralPool is used for swap request callbacks, passing the // balance of all tokens in the Pool. These Pools have the largest swap costs (because of the extra storage reads), // which increase with the number of registered tokens. // // - Minimal Swap Info: IMinimalSwapInfoPool is used instead of IGeneralPool, which saves gas by only passing the // balance of the two tokens involved in the swap. This is suitable for some pricing algorithms, like the weighted // constant product one popularized by Balancer V1. Swap costs are smaller compared to general Pools, and are // independent of the number of registered tokens. // // - Two Token: only allows two tokens to be registered. This achieves the lowest possible swap gas cost. Like // minimal swap info Pools, these are called via IMinimalSwapInfoPool. enum PoolSpecialization { GENERAL, MINIMAL_SWAP_INFO, TWO_TOKEN } /** * @dev Registers the caller account as a Pool with a given specialization setting. Returns the Pool's ID, which * is used in all Pool-related functions. Pools cannot be deregistered, nor can the Pool's specialization be * changed. * * The caller is expected to be a smart contract that implements either `IGeneralPool` or `IMinimalSwapInfoPool`, * depending on the chosen specialization setting. This contract is known as the Pool's contract. * * Note that the same contract may register itself as multiple Pools with unique Pool IDs, or in other words, * multiple Pools may share the same contract. * * Emits a `PoolRegistered` event. */ function registerPool(PoolSpecialization specialization) external returns (bytes32); /** * @dev Emitted when a Pool is registered by calling `registerPool`. */ event PoolRegistered(bytes32 indexed poolId, address indexed poolAddress, PoolSpecialization specialization); /** * @dev Returns a Pool's contract address and specialization setting. */ function getPool(bytes32 poolId) external view returns (address, PoolSpecialization); /** * @dev Registers `tokens` for the `poolId` Pool. Must be called by the Pool's contract. * * Pools can only interact with tokens they have registered. Users join a Pool by transferring registered tokens, * exit by receiving registered tokens, and can only swap registered tokens. * * Each token can only be registered once. For Pools with the Two Token specialization, `tokens` must have a length * of two, that is, both tokens must be registered in the same `registerTokens` call, and they must be sorted in * ascending order. * * The `tokens` and `assetManagers` arrays must have the same length, and each entry in these indicates the Asset * Manager for the corresponding token. Asset Managers can manage a Pool's tokens via `managePoolBalance`, * depositing and withdrawing them directly, and can even set their balance to arbitrary amounts. They are therefore * expected to be highly secured smart contracts with sound design principles, and the decision to register an * Asset Manager should not be made lightly. * * Pools can choose not to assign an Asset Manager to a given token by passing in the zero address. Once an Asset * Manager is set, it cannot be changed except by deregistering the associated token and registering again with a * different Asset Manager. * * Emits a `TokensRegistered` event. */ function registerTokens( bytes32 poolId, IERC20[] memory tokens, address[] memory assetManagers ) external; /** * @dev Emitted when a Pool registers tokens by calling `registerTokens`. */ event TokensRegistered(bytes32 indexed poolId, IERC20[] tokens, address[] assetManagers); /** * @dev Deregisters `tokens` for the `poolId` Pool. Must be called by the Pool's contract. * * Only registered tokens (via `registerTokens`) can be deregistered. Additionally, they must have zero total * balance. For Pools with the Two Token specialization, `tokens` must have a length of two, that is, both tokens * must be deregistered in the same `deregisterTokens` call. * * A deregistered token can be re-registered later on, possibly with a different Asset Manager. * * Emits a `TokensDeregistered` event. */ function deregisterTokens(bytes32 poolId, IERC20[] memory tokens) external; /** * @dev Emitted when a Pool deregisters tokens by calling `deregisterTokens`. */ event TokensDeregistered(bytes32 indexed poolId, IERC20[] tokens); /** * @dev Returns detailed information for a Pool's registered token. * * `cash` is the number of tokens the Vault currently holds for the Pool. `managed` is the number of tokens * withdrawn and held outside the Vault by the Pool's token Asset Manager. The Pool's total balance for `token` * equals the sum of `cash` and `managed`. * * Internally, `cash` and `managed` are stored using 112 bits. No action can ever cause a Pool's token `cash`, * `managed` or `total` balance to be greater than 2^112 - 1. * * `lastChangeBlock` is the number of the block in which `token`'s total balance was last modified (via either a * join, exit, swap, or Asset Manager update). This value is useful to avoid so-called 'sandwich attacks', for * example when developing price oracles. A change of zero (e.g. caused by a swap with amount zero) is considered a * change for this purpose, and will update `lastChangeBlock`. * * `assetManager` is the Pool's token Asset Manager. */ function getPoolTokenInfo(bytes32 poolId, IERC20 token) external view returns ( uint256 cash, uint256 managed, uint256 lastChangeBlock, address assetManager ); /** * @dev Returns a Pool's registered tokens, the total balance for each, and the latest block when *any* of * the tokens' `balances` changed. * * The order of the `tokens` array is the same order that will be used in `joinPool`, `exitPool`, as well as in all * Pool hooks (where applicable). Calls to `registerTokens` and `deregisterTokens` may change this order. * * If a Pool only registers tokens once, and these are sorted in ascending order, they will be stored in the same * order as passed to `registerTokens`. * * Total balances include both tokens held by the Vault and those withdrawn by the Pool's Asset Managers. These are * the amounts used by joins, exits and swaps. For a detailed breakdown of token balances, use `getPoolTokenInfo` * instead. */ function getPoolTokens(bytes32 poolId) external view returns ( IERC20[] memory tokens, uint256[] memory balances, uint256 lastChangeBlock ); /** * @dev Called by users to join a Pool, which transfers tokens from `sender` into the Pool's balance. This will * trigger custom Pool behavior, which will typically grant something in return to `recipient` - often tokenized * Pool shares. * * If the caller is not `sender`, it must be an authorized relayer for them. * * The `assets` and `maxAmountsIn` arrays must have the same length, and each entry indicates the maximum amount * to send for each asset. The amounts to send are decided by the Pool and not the Vault: it just enforces * these maximums. * * If joining a Pool that holds WETH, it is possible to send ETH directly: the Vault will do the wrapping. To enable * this mechanism, the IAsset sentinel value (the zero address) must be passed in the `assets` array instead of the * WETH address. Note that it is not possible to combine ETH and WETH in the same join. Any excess ETH will be sent * back to the caller (not the sender, which is important for relayers). * * `assets` must have the same length and order as the array returned by `getPoolTokens`. This prevents issues when * interacting with Pools that register and deregister tokens frequently. If sending ETH however, the array must be * sorted *before* replacing the WETH address with the ETH sentinel value (the zero address), which means the final * `assets` array might not be sorted. Pools with no registered tokens cannot be joined. * * If `fromInternalBalance` is true, the caller's Internal Balance will be preferred: ERC20 transfers will only * be made for the difference between the requested amount and Internal Balance (if any). Note that ETH cannot be * withdrawn from Internal Balance: attempting to do so will trigger a revert. * * This causes the Vault to call the `IBasePool.onJoinPool` hook on the Pool's contract, where Pools implement * their own custom logic. This typically requires additional information from the user (such as the expected number * of Pool shares). This can be encoded in the `userData` argument, which is ignored by the Vault and passed * directly to the Pool's contract, as is `recipient`. * * Emits a `PoolBalanceChanged` event. */ function joinPool( bytes32 poolId, address sender, address recipient, JoinPoolRequest memory request ) external payable; struct JoinPoolRequest { IAsset[] assets; uint256[] maxAmountsIn; bytes userData; bool fromInternalBalance; } /** * @dev Called by users to exit a Pool, which transfers tokens from the Pool's balance to `recipient`. This will * trigger custom Pool behavior, which will typically ask for something in return from `sender` - often tokenized * Pool shares. The amount of tokens that can be withdrawn is limited by the Pool's `cash` balance (see * `getPoolTokenInfo`). * * If the caller is not `sender`, it must be an authorized relayer for them. * * The `tokens` and `minAmountsOut` arrays must have the same length, and each entry in these indicates the minimum * token amount to receive for each token contract. The amounts to send are decided by the Pool and not the Vault: * it just enforces these minimums. * * If exiting a Pool that holds WETH, it is possible to receive ETH directly: the Vault will do the unwrapping. To * enable this mechanism, the IAsset sentinel value (the zero address) must be passed in the `assets` array instead * of the WETH address. Note that it is not possible to combine ETH and WETH in the same exit. * * `assets` must have the same length and order as the array returned by `getPoolTokens`. This prevents issues when * interacting with Pools that register and deregister tokens frequently. If receiving ETH however, the array must * be sorted *before* replacing the WETH address with the ETH sentinel value (the zero address), which means the * final `assets` array might not be sorted. Pools with no registered tokens cannot be exited. * * If `toInternalBalance` is true, the tokens will be deposited to `recipient`'s Internal Balance. Otherwise, * an ERC20 transfer will be performed. Note that ETH cannot be deposited to Internal Balance: attempting to * do so will trigger a revert. * * `minAmountsOut` is the minimum amount of tokens the user expects to get out of the Pool, for each token in the * `tokens` array. This array must match the Pool's registered tokens. * * This causes the Vault to call the `IBasePool.onExitPool` hook on the Pool's contract, where Pools implement * their own custom logic. This typically requires additional information from the user (such as the expected number * of Pool shares to return). This can be encoded in the `userData` argument, which is ignored by the Vault and * passed directly to the Pool's contract. * * Emits a `PoolBalanceChanged` event. */ function exitPool( bytes32 poolId, address sender, address payable recipient, ExitPoolRequest memory request ) external; struct ExitPoolRequest { IAsset[] assets; uint256[] minAmountsOut; bytes userData; bool toInternalBalance; } /** * @dev Emitted when a user joins or exits a Pool by calling `joinPool` or `exitPool`, respectively. */ event PoolBalanceChanged( bytes32 indexed poolId, address indexed liquidityProvider, IERC20[] tokens, int256[] deltas, uint256[] protocolFeeAmounts ); enum PoolBalanceChangeKind { JOIN, EXIT } // Swaps // // Users can swap tokens with Pools by calling the `swap` and `batchSwap` functions. To do this, // they need not trust Pool contracts in any way: all security checks are made by the Vault. They must however be // aware of the Pools' pricing algorithms in order to estimate the prices Pools will quote. // // The `swap` function executes a single swap, while `batchSwap` can perform multiple swaps in sequence. // In each individual swap, tokens of one kind are sent from the sender to the Pool (this is the 'token in'), // and tokens of another kind are sent from the Pool to the recipient in exchange (this is the 'token out'). // More complex swaps, such as one token in to multiple tokens out can be achieved by batching together // individual swaps. // // There are two swap kinds: // - 'given in' swaps, where the amount of tokens in (sent to the Pool) is known, and the Pool determines (via the // `onSwap` hook) the amount of tokens out (to send to the recipient). // - 'given out' swaps, where the amount of tokens out (received from the Pool) is known, and the Pool determines // (via the `onSwap` hook) the amount of tokens in (to receive from the sender). // // Additionally, it is possible to chain swaps using a placeholder input amount, which the Vault replaces with // the calculated output of the previous swap. If the previous swap was 'given in', this will be the calculated // tokenOut amount. If the previous swap was 'given out', it will use the calculated tokenIn amount. These extended // swaps are known as 'multihop' swaps, since they 'hop' through a number of intermediate tokens before arriving at // the final intended token. // // In all cases, tokens are only transferred in and out of the Vault (or withdrawn from and deposited into Internal // Balance) after all individual swaps have been completed, and the net token balance change computed. This makes // certain swap patterns, such as multihops, or swaps that interact with the same token pair in multiple Pools, cost // much less gas than they would otherwise. // // It also means that under certain conditions it is possible to perform arbitrage by swapping with multiple // Pools in a way that results in net token movement out of the Vault (profit), with no tokens being sent in (only // updating the Pool's internal accounting). // // To protect users from front-running or the market changing rapidly, they supply a list of 'limits' for each token // involved in the swap, where either the maximum number of tokens to send (by passing a positive value) or the // minimum amount of tokens to receive (by passing a negative value) is specified. // // Additionally, a 'deadline' timestamp can also be provided, forcing the swap to fail if it occurs after // this point in time (e.g. if the transaction failed to be included in a block promptly). // // If interacting with Pools that hold WETH, it is possible to both send and receive ETH directly: the Vault will do // the wrapping and unwrapping. To enable this mechanism, the IAsset sentinel value (the zero address) must be // passed in the `assets` array instead of the WETH address. Note that it is possible to combine ETH and WETH in the // same swap. Any excess ETH will be sent back to the caller (not the sender, which is relevant for relayers). // // Finally, Internal Balance can be used when either sending or receiving tokens. enum SwapKind { GIVEN_IN, GIVEN_OUT } /** * @dev Performs a swap with a single Pool. * * If the swap is 'given in' (the number of tokens to send to the Pool is known), it returns the amount of tokens * taken from the Pool, which must be greater than or equal to `limit`. * * If the swap is 'given out' (the number of tokens to take from the Pool is known), it returns the amount of tokens * sent to the Pool, which must be less than or equal to `limit`. * * Internal Balance usage and the recipient are determined by the `funds` struct. * * Emits a `Swap` event. */ function swap( SingleSwap memory singleSwap, FundManagement memory funds, uint256 limit, uint256 deadline ) external payable returns (uint256); /** * @dev Data for a single swap executed by `swap`. `amount` is either `amountIn` or `amountOut` depending on * the `kind` value. * * `assetIn` and `assetOut` are either token addresses, or the IAsset sentinel value for ETH (the zero address). * Note that Pools never interact with ETH directly: it will be wrapped to or unwrapped from WETH by the Vault. * * The `userData` field is ignored by the Vault, but forwarded to the Pool in the `onSwap` hook, and may be * used to extend swap behavior. */ struct SingleSwap { bytes32 poolId; SwapKind kind; IAsset assetIn; IAsset assetOut; uint256 amount; bytes userData; } /** * @dev Performs a series of swaps with one or multiple Pools. In each individual swap, the caller determines either * the amount of tokens sent to or received from the Pool, depending on the `kind` value. * * Returns an array with the net Vault asset balance deltas. Positive amounts represent tokens (or ETH) sent to the * Vault, and negative amounts represent tokens (or ETH) sent by the Vault. Each delta corresponds to the asset at * the same index in the `assets` array. * * Swaps are executed sequentially, in the order specified by the `swaps` array. Each array element describes a * Pool, the token to be sent to this Pool, the token to receive from it, and an amount that is either `amountIn` or * `amountOut` depending on the swap kind. * * Multihop swaps can be executed by passing an `amount` value of zero for a swap. This will cause the amount in/out * of the previous swap to be used as the amount in for the current one. In a 'given in' swap, 'tokenIn' must equal * the previous swap's `tokenOut`. For a 'given out' swap, `tokenOut` must equal the previous swap's `tokenIn`. * * The `assets` array contains the addresses of all assets involved in the swaps. These are either token addresses, * or the IAsset sentinel value for ETH (the zero address). Each entry in the `swaps` array specifies tokens in and * out by referencing an index in `assets`. Note that Pools never interact with ETH directly: it will be wrapped to * or unwrapped from WETH by the Vault. * * Internal Balance usage, sender, and recipient are determined by the `funds` struct. The `limits` array specifies * the minimum or maximum amount of each token the vault is allowed to transfer. * * `batchSwap` can be used to make a single swap, like `swap` does, but doing so requires more gas than the * equivalent `swap` call. * * Emits `Swap` events. */ function batchSwap( SwapKind kind, BatchSwapStep[] memory swaps, IAsset[] memory assets, FundManagement memory funds, int256[] memory limits, uint256 deadline ) external payable returns (int256[] memory); /** * @dev Data for each individual swap executed by `batchSwap`. The asset in and out fields are indexes into the * `assets` array passed to that function, and ETH assets are converted to WETH. * * If `amount` is zero, the multihop mechanism is used to determine the actual amount based on the amount in/out * from the previous swap, depending on the swap kind. * * The `userData` field is ignored by the Vault, but forwarded to the Pool in the `onSwap` hook, and may be * used to extend swap behavior. */ struct BatchSwapStep { bytes32 poolId; uint256 assetInIndex; uint256 assetOutIndex; uint256 amount; bytes userData; } /** * @dev Emitted for each individual swap performed by `swap` or `batchSwap`. */ event Swap( bytes32 indexed poolId, IERC20 indexed tokenIn, IERC20 indexed tokenOut, uint256 amountIn, uint256 amountOut ); /** * @dev All tokens in a swap are either sent from the `sender` account to the Vault, or from the Vault to the * `recipient` account. * * If the caller is not `sender`, it must be an authorized relayer for them. * * If `fromInternalBalance` is true, the `sender`'s Internal Balance will be preferred, performing an ERC20 * transfer for the difference between the requested amount and the User's Internal Balance (if any). The `sender` * must have allowed the Vault to use their tokens via `IERC20.approve()`. This matches the behavior of * `joinPool`. * * If `toInternalBalance` is true, tokens will be deposited to `recipient`'s internal balance instead of * transferred. This matches the behavior of `exitPool`. * * Note that ETH cannot be deposited to or withdrawn from Internal Balance: attempting to do so will trigger a * revert. */ struct FundManagement { address sender; bool fromInternalBalance; address payable recipient; bool toInternalBalance; } /** * @dev Simulates a call to `batchSwap`, returning an array of Vault asset deltas. Calls to `swap` cannot be * simulated directly, but an equivalent `batchSwap` call can and will yield the exact same result. * * Each element in the array corresponds to the asset at the same index, and indicates the number of tokens (or ETH) * the Vault would take from the sender (if positive) or send to the recipient (if negative). The arguments it * receives are the same that an equivalent `batchSwap` call would receive. * * Unlike `batchSwap`, this function performs no checks on the sender or recipient field in the `funds` struct. * This makes it suitable to be called by off-chain applications via eth_call without needing to hold tokens, * approve them for the Vault, or even know a user's address. * * Note that this function is not 'view' (due to implementation details): the client code must explicitly execute * eth_call instead of eth_sendTransaction. */ function queryBatchSwap( SwapKind kind, BatchSwapStep[] memory swaps, IAsset[] memory assets, FundManagement memory funds ) external returns (int256[] memory assetDeltas); // Flash Loans /** * @dev Performs a 'flash loan', sending tokens to `recipient`, executing the `receiveFlashLoan` hook on it, * and then reverting unless the tokens plus a proportional protocol fee have been returned. * * The `tokens` and `amounts` arrays must have the same length, and each entry in these indicates the loan amount * for each token contract. `tokens` must be sorted in ascending order. * * The 'userData' field is ignored by the Vault, and forwarded as-is to `recipient` as part of the * `receiveFlashLoan` call. * * Emits `FlashLoan` events. */ function flashLoan( IFlashLoanRecipient recipient, IERC20[] memory tokens, uint256[] memory amounts, bytes memory userData ) external; /** * @dev Emitted for each individual flash loan performed by `flashLoan`. */ event FlashLoan(IFlashLoanRecipient indexed recipient, IERC20 indexed token, uint256 amount, uint256 feeAmount); // Asset Management // // Each token registered for a Pool can be assigned an Asset Manager, which is able to freely withdraw the Pool's // tokens from the Vault, deposit them, or assign arbitrary values to its `managed` balance (see // `getPoolTokenInfo`). This makes them extremely powerful and dangerous. Even if an Asset Manager only directly // controls one of the tokens in a Pool, a malicious manager could set that token's balance to manipulate the // prices of the other tokens, and then drain the Pool with swaps. The risk of using Asset Managers is therefore // not constrained to the tokens they are managing, but extends to the entire Pool's holdings. // // However, a properly designed Asset Manager smart contract can be safely used for the Pool's benefit, // for example by lending unused tokens out for interest, or using them to participate in voting protocols. // // This concept is unrelated to the IAsset interface. /** * @dev Performs a set of Pool balance operations, which may be either withdrawals, deposits or updates. * * Pool Balance management features batching, which means a single contract call can be used to perform multiple * operations of different kinds, with different Pools and tokens, at once. * * For each operation, the caller must be registered as the Asset Manager for `token` in `poolId`. */ function managePoolBalance(PoolBalanceOp[] memory ops) external; struct PoolBalanceOp { PoolBalanceOpKind kind; bytes32 poolId; IERC20 token; uint256 amount; } /** * Withdrawals decrease the Pool's cash, but increase its managed balance, leaving the total balance unchanged. * * Deposits increase the Pool's cash, but decrease its managed balance, leaving the total balance unchanged. * * Updates don't affect the Pool's cash balance, but because the managed balance changes, it does alter the total. * The external amount can be either increased or decreased by this call (i.e., reporting a gain or a loss). */ enum PoolBalanceOpKind { WITHDRAW, DEPOSIT, UPDATE } /** * @dev Emitted when a Pool's token Asset Manager alters its balance via `managePoolBalance`. */ event PoolBalanceManaged( bytes32 indexed poolId, address indexed assetManager, IERC20 indexed token, int256 cashDelta, int256 managedDelta ); // Protocol Fees // // Some operations cause the Vault to collect tokens in the form of protocol fees, which can then be withdrawn by // permissioned accounts. // // There are two kinds of protocol fees: // // - flash loan fees: charged on all flash loans, as a percentage of the amounts lent. // // - swap fees: a percentage of the fees charged by Pools when performing swaps. For a number of reasons, including // swap gas costs and interface simplicity, protocol swap fees are not charged on each individual swap. Rather, // Pools are expected to keep track of how much they have charged in swap fees, and pay any outstanding debts to the // Vault when they are joined or exited. This prevents users from joining a Pool with unpaid debt, as well as // exiting a Pool in debt without first paying their share. /** * @dev Returns the current protocol fee module. */ function getProtocolFeesCollector() external view returns (IProtocolFeesCollector); /** * @dev Safety mechanism to pause most Vault operations in the event of an emergency - typically detection of an * error in some part of the system. * * The Vault can only be paused during an initial time period, after which pausing is forever disabled. * * While the contract is paused, the following features are disabled: * - depositing and transferring internal balance * - transferring external balance (using the Vault's allowance) * - swaps * - joining Pools * - Asset Manager interactions * * Internal Balance can still be withdrawn, and Pools exited. */ function setPaused(bool paused) external; /** * @dev Returns the Vault's WETH instance. */ function WETH() external view returns (IWETH); // solhint-disable-previous-line func-name-mixedcase } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev Base contract for Pool factories. * * Pools are deployed from factories to allow third parties to reason about them. Unknown Pools may have arbitrary * logic: being able to assert that a Pool's behavior follows certain rules (those imposed by the contracts created by * the factory) is very powerful. */ abstract contract BasePoolFactory { IVault private immutable _vault; mapping(address => bool) private _isPoolFromFactory; event PoolCreated(address indexed pool); constructor(IVault vault) { _vault = vault; } /** * @dev Returns the Vault's address. */ function getVault() public view returns (IVault) { return _vault; } /** * @dev Returns true if `pool` was created by this factory. */ function isPoolFromFactory(address pool) external view returns (bool) { return _isPoolFromFactory[pool]; } /** * @dev Registers a new created pool. * * Emits a `PoolCreated` event. */ function _register(address pool) internal { _isPoolFromFactory[pool] = true; emit PoolCreated(pool); } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev Utility to create Pool factories for Pools that use the `TemporarilyPausable` contract. * * By calling `TemporarilyPausable`'s constructor with the result of `getPauseConfiguration`, all Pools created by this * factory will share the same Pause Window end time, after which both old and new Pools will not be pausable. */ contract FactoryWidePauseWindow { // This contract relies on timestamps in a similar way as `TemporarilyPausable` does - the same caveats apply. // solhint-disable not-rely-on-time uint256 private constant _INITIAL_PAUSE_WINDOW_DURATION = 90 days; uint256 private constant _BUFFER_PERIOD_DURATION = 30 days; // Time when the pause window for all created Pools expires, and the pause window duration of new Pools becomes // zero. uint256 private immutable _poolsPauseWindowEndTime; constructor() { _poolsPauseWindowEndTime = block.timestamp + _INITIAL_PAUSE_WINDOW_DURATION; } /** * @dev Returns the current `TemporarilyPausable` configuration that will be applied to Pools created by this * factory. * * `pauseWindowDuration` will decrease over time until it reaches zero, at which point both it and * `bufferPeriodDuration` will be zero forever, meaning deployed Pools will not be pausable. */ function getPauseConfiguration() public view returns (uint256 pauseWindowDuration, uint256 bufferPeriodDuration) { uint256 currentTime = block.timestamp; if (currentTime < _poolsPauseWindowEndTime) { // The buffer period is always the same since its duration is related to how much time is needed to respond // to a potential emergency. The Pause Window duration however decreases as the end time approaches. pauseWindowDuration = _poolsPauseWindowEndTime - currentTime; // No need for checked arithmetic. bufferPeriodDuration = _BUFFER_PERIOD_DURATION; } else { // After the end time, newly created Pools have no Pause Window, nor Buffer Period (since they are not // pausable in the first place). pauseWindowDuration = 0; bufferPeriodDuration = 0; } } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // 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. /* solhint-disable */ /** * @dev Exponentiation and logarithm functions for 18 decimal fixed point numbers (both base and exponent/argument). * * Exponentiation and logarithm with arbitrary bases (x^y and log_x(y)) are implemented by conversion to natural * exponentiation and logarithm (where the base is Euler's number). * * @author Fernando Martinelli - @fernandomartinelli * @author Sergio Yuhjtman - @sergioyuhjtman * @author Daniel Fernandez - @dmf7z */ library LogExpMath { // All fixed point multiplications and divisions are inlined. This means we need to divide by ONE when multiplying // two numbers, and multiply by ONE when dividing them. // All arguments and return values are 18 decimal fixed point numbers. int256 constant ONE_18 = 1e18; // Internally, intermediate values are computed with higher precision as 20 decimal fixed point numbers, and in the // case of ln36, 36 decimals. int256 constant ONE_20 = 1e20; int256 constant ONE_36 = 1e36; // The domain of natural exponentiation is bound by the word size and number of decimals used. // // Because internally the result will be stored using 20 decimals, the largest possible result is // (2^255 - 1) / 10^20, which makes the largest exponent ln((2^255 - 1) / 10^20) = 130.700829182905140221. // The smallest possible result is 10^(-18), which makes largest negative argument // ln(10^(-18)) = -41.446531673892822312. // We use 130.0 and -41.0 to have some safety margin. int256 constant MAX_NATURAL_EXPONENT = 130e18; int256 constant MIN_NATURAL_EXPONENT = -41e18; // Bounds for ln_36's argument. Both ln(0.9) and ln(1.1) can be represented with 36 decimal places in a fixed point // 256 bit integer. int256 constant LN_36_LOWER_BOUND = ONE_18 - 1e17; int256 constant LN_36_UPPER_BOUND = ONE_18 + 1e17; uint256 constant MILD_EXPONENT_BOUND = 2**254 / uint256(ONE_20); // 18 decimal constants int256 constant x0 = 128000000000000000000; // 2ˆ7 int256 constant a0 = 38877084059945950922200000000000000000000000000000000000; // eˆ(x0) (no decimals) int256 constant x1 = 64000000000000000000; // 2ˆ6 int256 constant a1 = 6235149080811616882910000000; // eˆ(x1) (no decimals) // 20 decimal constants int256 constant x2 = 3200000000000000000000; // 2ˆ5 int256 constant a2 = 7896296018268069516100000000000000; // eˆ(x2) int256 constant x3 = 1600000000000000000000; // 2ˆ4 int256 constant a3 = 888611052050787263676000000; // eˆ(x3) int256 constant x4 = 800000000000000000000; // 2ˆ3 int256 constant a4 = 298095798704172827474000; // eˆ(x4) int256 constant x5 = 400000000000000000000; // 2ˆ2 int256 constant a5 = 5459815003314423907810; // eˆ(x5) int256 constant x6 = 200000000000000000000; // 2ˆ1 int256 constant a6 = 738905609893065022723; // eˆ(x6) int256 constant x7 = 100000000000000000000; // 2ˆ0 int256 constant a7 = 271828182845904523536; // eˆ(x7) int256 constant x8 = 50000000000000000000; // 2ˆ-1 int256 constant a8 = 164872127070012814685; // eˆ(x8) int256 constant x9 = 25000000000000000000; // 2ˆ-2 int256 constant a9 = 128402541668774148407; // eˆ(x9) int256 constant x10 = 12500000000000000000; // 2ˆ-3 int256 constant a10 = 113314845306682631683; // eˆ(x10) int256 constant x11 = 6250000000000000000; // 2ˆ-4 int256 constant a11 = 106449445891785942956; // eˆ(x11) /** * @dev Exponentiation (x^y) with unsigned 18 decimal fixed point base and exponent. * * Reverts if ln(x) * y is smaller than `MIN_NATURAL_EXPONENT`, or larger than `MAX_NATURAL_EXPONENT`. */ function pow(uint256 x, uint256 y) internal pure returns (uint256) { if (y == 0) { // We solve the 0^0 indetermination by making it equal one. return uint256(ONE_18); } if (x == 0) { return 0; } // Instead of computing x^y directly, we instead rely on the properties of logarithms and exponentiation to // arrive at that result. In particular, exp(ln(x)) = x, and ln(x^y) = y * ln(x). This means // x^y = exp(y * ln(x)). // The ln function takes a signed value, so we need to make sure x fits in the signed 256 bit range. _require(x < 2**255, Errors.X_OUT_OF_BOUNDS); int256 x_int256 = int256(x); // We will compute y * ln(x) in a single step. Depending on the value of x, we can either use ln or ln_36. In // both cases, we leave the division by ONE_18 (due to fixed point multiplication) to the end. // This prevents y * ln(x) from overflowing, and at the same time guarantees y fits in the signed 256 bit range. _require(y < MILD_EXPONENT_BOUND, Errors.Y_OUT_OF_BOUNDS); int256 y_int256 = int256(y); int256 logx_times_y; if (LN_36_LOWER_BOUND < x_int256 && x_int256 < LN_36_UPPER_BOUND) { int256 ln_36_x = _ln_36(x_int256); // ln_36_x has 36 decimal places, so multiplying by y_int256 isn't as straightforward, since we can't just // bring y_int256 to 36 decimal places, as it might overflow. Instead, we perform two 18 decimal // multiplications and add the results: one with the first 18 decimals of ln_36_x, and one with the // (downscaled) last 18 decimals. logx_times_y = ((ln_36_x / ONE_18) * y_int256 + ((ln_36_x % ONE_18) * y_int256) / ONE_18); } else { logx_times_y = _ln(x_int256) * y_int256; } logx_times_y /= ONE_18; // Finally, we compute exp(y * ln(x)) to arrive at x^y _require( MIN_NATURAL_EXPONENT <= logx_times_y && logx_times_y <= MAX_NATURAL_EXPONENT, Errors.PRODUCT_OUT_OF_BOUNDS ); return uint256(exp(logx_times_y)); } /** * @dev Natural exponentiation (e^x) with signed 18 decimal fixed point exponent. * * Reverts if `x` is smaller than MIN_NATURAL_EXPONENT, or larger than `MAX_NATURAL_EXPONENT`. */ function exp(int256 x) internal pure returns (int256) { _require(x >= MIN_NATURAL_EXPONENT && x <= MAX_NATURAL_EXPONENT, Errors.INVALID_EXPONENT); if (x < 0) { // We only handle positive exponents: e^(-x) is computed as 1 / e^x. We can safely make x positive since it // fits in the signed 256 bit range (as it is larger than MIN_NATURAL_EXPONENT). // Fixed point division requires multiplying by ONE_18. return ((ONE_18 * ONE_18) / exp(-x)); } // First, we use the fact that e^(x+y) = e^x * e^y to decompose x into a sum of powers of two, which we call x_n, // where x_n == 2^(7 - n), and e^x_n = a_n has been precomputed. We choose the first x_n, x0, to equal 2^7 // because all larger powers are larger than MAX_NATURAL_EXPONENT, and therefore not present in the // decomposition. // At the end of this process we will have the product of all e^x_n = a_n that apply, and the remainder of this // decomposition, which will be lower than the smallest x_n. // exp(x) = k_0 * a_0 * k_1 * a_1 * ... + k_n * a_n * exp(remainder), where each k_n equals either 0 or 1. // We mutate x by subtracting x_n, making it the remainder of the decomposition. // The first two a_n (e^(2^7) and e^(2^6)) are too large if stored as 18 decimal numbers, and could cause // intermediate overflows. Instead we store them as plain integers, with 0 decimals. // Additionally, x0 + x1 is larger than MAX_NATURAL_EXPONENT, which means they will not both be present in the // decomposition. // For each x_n, we test if that term is present in the decomposition (if x is larger than it), and if so deduct // it and compute the accumulated product. int256 firstAN; if (x >= x0) { x -= x0; firstAN = a0; } else if (x >= x1) { x -= x1; firstAN = a1; } else { firstAN = 1; // One with no decimal places } // We now transform x into a 20 decimal fixed point number, to have enhanced precision when computing the // smaller terms. x *= 100; // `product` is the accumulated product of all a_n (except a0 and a1), which starts at 20 decimal fixed point // one. Recall that fixed point multiplication requires dividing by ONE_20. int256 product = ONE_20; if (x >= x2) { x -= x2; product = (product * a2) / ONE_20; } if (x >= x3) { x -= x3; product = (product * a3) / ONE_20; } if (x >= x4) { x -= x4; product = (product * a4) / ONE_20; } if (x >= x5) { x -= x5; product = (product * a5) / ONE_20; } if (x >= x6) { x -= x6; product = (product * a6) / ONE_20; } if (x >= x7) { x -= x7; product = (product * a7) / ONE_20; } if (x >= x8) { x -= x8; product = (product * a8) / ONE_20; } if (x >= x9) { x -= x9; product = (product * a9) / ONE_20; } // x10 and x11 are unnecessary here since we have high enough precision already. // Now we need to compute e^x, where x is small (in particular, it is smaller than x9). We use the Taylor series // expansion for e^x: 1 + x + (x^2 / 2!) + (x^3 / 3!) + ... + (x^n / n!). int256 seriesSum = ONE_20; // The initial one in the sum, with 20 decimal places. int256 term; // Each term in the sum, where the nth term is (x^n / n!). // The first term is simply x. term = x; seriesSum += term; // Each term (x^n / n!) equals the previous one times x, divided by n. Since x is a fixed point number, // multiplying by it requires dividing by ONE_20, but dividing by the non-fixed point n values does not. term = ((term * x) / ONE_20) / 2; seriesSum += term; term = ((term * x) / ONE_20) / 3; seriesSum += term; term = ((term * x) / ONE_20) / 4; seriesSum += term; term = ((term * x) / ONE_20) / 5; seriesSum += term; term = ((term * x) / ONE_20) / 6; seriesSum += term; term = ((term * x) / ONE_20) / 7; seriesSum += term; term = ((term * x) / ONE_20) / 8; seriesSum += term; term = ((term * x) / ONE_20) / 9; seriesSum += term; term = ((term * x) / ONE_20) / 10; seriesSum += term; term = ((term * x) / ONE_20) / 11; seriesSum += term; term = ((term * x) / ONE_20) / 12; seriesSum += term; // 12 Taylor terms are sufficient for 18 decimal precision. // We now have the first a_n (with no decimals), and the product of all other a_n present, and the Taylor // approximation of the exponentiation of the remainder (both with 20 decimals). All that remains is to multiply // all three (one 20 decimal fixed point multiplication, dividing by ONE_20, and one integer multiplication), // and then drop two digits to return an 18 decimal value. return (((product * seriesSum) / ONE_20) * firstAN) / 100; } /** * @dev Logarithm (log(arg, base), with signed 18 decimal fixed point base and argument. */ function log(int256 arg, int256 base) internal pure returns (int256) { // This performs a simple base change: log(arg, base) = ln(arg) / ln(base). // Both logBase and logArg are computed as 36 decimal fixed point numbers, either by using ln_36, or by // upscaling. int256 logBase; if (LN_36_LOWER_BOUND < base && base < LN_36_UPPER_BOUND) { logBase = _ln_36(base); } else { logBase = _ln(base) * ONE_18; } int256 logArg; if (LN_36_LOWER_BOUND < arg && arg < LN_36_UPPER_BOUND) { logArg = _ln_36(arg); } else { logArg = _ln(arg) * ONE_18; } // When dividing, we multiply by ONE_18 to arrive at a result with 18 decimal places return (logArg * ONE_18) / logBase; } /** * @dev Natural logarithm (ln(a)) with signed 18 decimal fixed point argument. */ function ln(int256 a) internal pure returns (int256) { // The real natural logarithm is not defined for negative numbers or zero. _require(a > 0, Errors.OUT_OF_BOUNDS); if (LN_36_LOWER_BOUND < a && a < LN_36_UPPER_BOUND) { return _ln_36(a) / ONE_18; } else { return _ln(a); } } /** * @dev Internal natural logarithm (ln(a)) with signed 18 decimal fixed point argument. */ function _ln(int256 a) private pure returns (int256) { if (a < ONE_18) { // Since ln(a^k) = k * ln(a), we can compute ln(a) as ln(a) = ln((1/a)^(-1)) = - ln((1/a)). If a is less // than one, 1/a will be greater than one, and this if statement will not be entered in the recursive call. // Fixed point division requires multiplying by ONE_18. return (-_ln((ONE_18 * ONE_18) / a)); } // First, we use the fact that ln^(a * b) = ln(a) + ln(b) to decompose ln(a) into a sum of powers of two, which // we call x_n, where x_n == 2^(7 - n), which are the natural logarithm of precomputed quantities a_n (that is, // ln(a_n) = x_n). We choose the first x_n, x0, to equal 2^7 because the exponential of all larger powers cannot // be represented as 18 fixed point decimal numbers in 256 bits, and are therefore larger than a. // At the end of this process we will have the sum of all x_n = ln(a_n) that apply, and the remainder of this // decomposition, which will be lower than the smallest a_n. // ln(a) = k_0 * x_0 + k_1 * x_1 + ... + k_n * x_n + ln(remainder), where each k_n equals either 0 or 1. // We mutate a by subtracting a_n, making it the remainder of the decomposition. // For reasons related to how `exp` works, the first two a_n (e^(2^7) and e^(2^6)) are not stored as fixed point // numbers with 18 decimals, but instead as plain integers with 0 decimals, so we need to multiply them by // ONE_18 to convert them to fixed point. // For each a_n, we test if that term is present in the decomposition (if a is larger than it), and if so divide // by it and compute the accumulated sum. int256 sum = 0; if (a >= a0 * ONE_18) { a /= a0; // Integer, not fixed point division sum += x0; } if (a >= a1 * ONE_18) { a /= a1; // Integer, not fixed point division sum += x1; } // All other a_n and x_n are stored as 20 digit fixed point numbers, so we convert the sum and a to this format. sum *= 100; a *= 100; // Because further a_n are 20 digit fixed point numbers, we multiply by ONE_20 when dividing by them. if (a >= a2) { a = (a * ONE_20) / a2; sum += x2; } if (a >= a3) { a = (a * ONE_20) / a3; sum += x3; } if (a >= a4) { a = (a * ONE_20) / a4; sum += x4; } if (a >= a5) { a = (a * ONE_20) / a5; sum += x5; } if (a >= a6) { a = (a * ONE_20) / a6; sum += x6; } if (a >= a7) { a = (a * ONE_20) / a7; sum += x7; } if (a >= a8) { a = (a * ONE_20) / a8; sum += x8; } if (a >= a9) { a = (a * ONE_20) / a9; sum += x9; } if (a >= a10) { a = (a * ONE_20) / a10; sum += x10; } if (a >= a11) { a = (a * ONE_20) / a11; sum += x11; } // a is now a small number (smaller than a_11, which roughly equals 1.06). This means we can use a Taylor series // that converges rapidly for values of `a` close to one - the same one used in ln_36. // Let z = (a - 1) / (a + 1). // ln(a) = 2 * (z + z^3 / 3 + z^5 / 5 + z^7 / 7 + ... + z^(2 * n + 1) / (2 * n + 1)) // Recall that 20 digit fixed point division requires multiplying by ONE_20, and multiplication requires // division by ONE_20. int256 z = ((a - ONE_20) * ONE_20) / (a + ONE_20); int256 z_squared = (z * z) / ONE_20; // num is the numerator of the series: the z^(2 * n + 1) term int256 num = z; // seriesSum holds the accumulated sum of each term in the series, starting with the initial z int256 seriesSum = num; // In each step, the numerator is multiplied by z^2 num = (num * z_squared) / ONE_20; seriesSum += num / 3; num = (num * z_squared) / ONE_20; seriesSum += num / 5; num = (num * z_squared) / ONE_20; seriesSum += num / 7; num = (num * z_squared) / ONE_20; seriesSum += num / 9; num = (num * z_squared) / ONE_20; seriesSum += num / 11; // 6 Taylor terms are sufficient for 36 decimal precision. // Finally, we multiply by 2 (non fixed point) to compute ln(remainder) seriesSum *= 2; // We now have the sum of all x_n present, and the Taylor approximation of the logarithm of the remainder (both // with 20 decimals). All that remains is to sum these two, and then drop two digits to return a 18 decimal // value. return (sum + seriesSum) / 100; } /** * @dev Intrnal high precision (36 decimal places) natural logarithm (ln(x)) with signed 18 decimal fixed point argument, * for x close to one. * * Should only be used if x is between LN_36_LOWER_BOUND and LN_36_UPPER_BOUND. */ function _ln_36(int256 x) private pure returns (int256) { // Since ln(1) = 0, a value of x close to one will yield a very small result, which makes using 36 digits // worthwhile. // First, we transform x to a 36 digit fixed point value. x *= ONE_18; // We will use the following Taylor expansion, which converges very rapidly. Let z = (x - 1) / (x + 1). // ln(x) = 2 * (z + z^3 / 3 + z^5 / 5 + z^7 / 7 + ... + z^(2 * n + 1) / (2 * n + 1)) // Recall that 36 digit fixed point division requires multiplying by ONE_36, and multiplication requires // division by ONE_36. int256 z = ((x - ONE_36) * ONE_36) / (x + ONE_36); int256 z_squared = (z * z) / ONE_36; // num is the numerator of the series: the z^(2 * n + 1) term int256 num = z; // seriesSum holds the accumulated sum of each term in the series, starting with the initial z int256 seriesSum = num; // In each step, the numerator is multiplied by z^2 num = (num * z_squared) / ONE_36; seriesSum += num / 3; num = (num * z_squared) / ONE_36; seriesSum += num / 5; num = (num * z_squared) / ONE_36; seriesSum += num / 7; num = (num * z_squared) / ONE_36; seriesSum += num / 9; num = (num * z_squared) / ONE_36; seriesSum += num / 11; num = (num * z_squared) / ONE_36; seriesSum += num / 13; num = (num * z_squared) / ONE_36; seriesSum += num / 15; // 8 Taylor terms are sufficient for 36 decimal precision. // All that remains is multiplying by 2 (non fixed point). return seriesSum * 2; } } /* solhint-disable private-vars-leading-underscore */ library FixedPoint { uint256 internal constant ONE = 1e18; // 18 decimal places uint256 internal constant MAX_POW_RELATIVE_ERROR = 10000; // 10^(-14) // Minimum base for the power function when the exponent is 'free' (larger than ONE). uint256 internal constant MIN_POW_BASE_FREE_EXPONENT = 0.7e18; function add(uint256 a, uint256 b) internal pure returns (uint256) { // Fixed Point addition is the same as regular checked addition uint256 c = a + b; _require(c >= a, Errors.ADD_OVERFLOW); return c; } function sub(uint256 a, uint256 b) internal pure returns (uint256) { // Fixed Point addition is the same as regular checked addition _require(b <= a, Errors.SUB_OVERFLOW); uint256 c = a - b; return c; } function mulDown(uint256 a, uint256 b) internal pure returns (uint256) { uint256 product = a * b; _require(a == 0 || product / a == b, Errors.MUL_OVERFLOW); return product / ONE; } function mulUp(uint256 a, uint256 b) internal pure returns (uint256) { uint256 product = a * b; _require(a == 0 || product / a == b, Errors.MUL_OVERFLOW); if (product == 0) { return 0; } else { // The traditional divUp formula is: // divUp(x, y) := (x + y - 1) / y // To avoid intermediate overflow in the addition, we distribute the division and get: // divUp(x, y) := (x - 1) / y + 1 // Note that this requires x != 0, which we already tested for. return ((product - 1) / ONE) + 1; } } function divDown(uint256 a, uint256 b) internal pure returns (uint256) { _require(b != 0, Errors.ZERO_DIVISION); if (a == 0) { return 0; } else { uint256 aInflated = a * ONE; _require(aInflated / a == ONE, Errors.DIV_INTERNAL); // mul overflow return aInflated / b; } } function divUp(uint256 a, uint256 b) internal pure returns (uint256) { _require(b != 0, Errors.ZERO_DIVISION); if (a == 0) { return 0; } else { uint256 aInflated = a * ONE; _require(aInflated / a == ONE, Errors.DIV_INTERNAL); // mul overflow // The traditional divUp formula is: // divUp(x, y) := (x + y - 1) / y // To avoid intermediate overflow in the addition, we distribute the division and get: // divUp(x, y) := (x - 1) / y + 1 // Note that this requires x != 0, which we already tested for. return ((aInflated - 1) / b) + 1; } } /** * @dev Returns x^y, assuming both are fixed point numbers, rounding down. The result is guaranteed to not be above * the true value (that is, the error function expected - actual is always positive). */ function powDown(uint256 x, uint256 y) internal pure returns (uint256) { uint256 raw = LogExpMath.pow(x, y); uint256 maxError = add(mulUp(raw, MAX_POW_RELATIVE_ERROR), 1); if (raw < maxError) { return 0; } else { return sub(raw, maxError); } } /** * @dev Returns x^y, assuming both are fixed point numbers, rounding up. The result is guaranteed to not be below * the true value (that is, the error function expected - actual is always negative). */ function powUp(uint256 x, uint256 y) internal pure returns (uint256) { uint256 raw = LogExpMath.pow(x, y); uint256 maxError = add(mulUp(raw, MAX_POW_RELATIVE_ERROR), 1); return add(raw, maxError); } /** * @dev Returns the complement of a value (1 - x), capped to 0 if x is larger than 1. * * Useful when computing the complement for values with some level of relative error, as it strips this error and * prevents intermediate negative values. */ function complement(uint256 x) internal pure returns (uint256) { return (x < ONE) ? (ONE - x) : 0; } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. library InputHelpers { function ensureInputLengthMatch(uint256 a, uint256 b) internal pure { _require(a == b, Errors.INPUT_LENGTH_MISMATCH); } function ensureInputLengthMatch( uint256 a, uint256 b, uint256 c ) internal pure { _require(a == b && b == c, Errors.INPUT_LENGTH_MISMATCH); } function ensureArrayIsSorted(IERC20[] memory array) internal pure { address[] memory addressArray; // solhint-disable-next-line no-inline-assembly assembly { addressArray := array } ensureArrayIsSorted(addressArray); } function ensureArrayIsSorted(address[] memory array) internal pure { if (array.length < 2) { return; } address previous = array[0]; for (uint256 i = 1; i < array.length; ++i) { address current = array[i]; _require(previous < current, Errors.UNSORTED_ARRAY); previous = current; } } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev IPools with the General specialization setting should implement this interface. * * This is called by the Vault when a user calls `IVault.swap` or `IVault.batchSwap` to swap with this Pool. * Returns the number of tokens the Pool will grant to the user in a 'given in' swap, or that the user will * grant to the pool in a 'given out' swap. * * This can often be implemented by a `view` function, since many pricing algorithms don't need to track state * changes in swaps. However, contracts implementing this in non-view functions should check that the caller is * indeed the Vault. */ interface IGeneralPool is IBasePool { function onSwap( SwapRequest memory swapRequest, uint256[] memory balances, uint256 indexIn, uint256 indexOut ) external returns (uint256 amount); } /** * @dev Extension of `BasePool`, adding a handler for `IGeneralPool.onSwap`. * * Derived contracts must call `BasePool`'s constructor, and implement `_onSwapGivenIn` and `_onSwapGivenOut` along with * `BasePool`'s virtual functions. Inheriting from this contract lets derived contracts choose the General * specialization setting. */ abstract contract BaseGeneralPool is IGeneralPool, BasePool { // Swap Hooks function onSwap( SwapRequest memory swapRequest, uint256[] memory balances, uint256 indexIn, uint256 indexOut ) public virtual override onlyVault(swapRequest.poolId) returns (uint256) { _validateIndexes(indexIn, indexOut, _getTotalTokens()); uint256[] memory scalingFactors = _scalingFactors(); return swapRequest.kind == IVault.SwapKind.GIVEN_IN ? _swapGivenIn(swapRequest, balances, indexIn, indexOut, scalingFactors) : _swapGivenOut(swapRequest, balances, indexIn, indexOut, scalingFactors); } function _swapGivenIn( SwapRequest memory swapRequest, uint256[] memory balances, uint256 indexIn, uint256 indexOut, uint256[] memory scalingFactors ) internal returns (uint256) { // Fees are subtracted before scaling, to reduce the complexity of the rounding direction analysis. swapRequest.amount = _subtractSwapFeeAmount(swapRequest.amount); _upscaleArray(balances, scalingFactors); swapRequest.amount = _upscale(swapRequest.amount, scalingFactors[indexIn]); uint256 amountOut = _onSwapGivenIn(swapRequest, balances, indexIn, indexOut); // amountOut tokens are exiting the Pool, so we round down. return _downscaleDown(amountOut, scalingFactors[indexOut]); } function _swapGivenOut( SwapRequest memory swapRequest, uint256[] memory balances, uint256 indexIn, uint256 indexOut, uint256[] memory scalingFactors ) internal returns (uint256) { _upscaleArray(balances, scalingFactors); swapRequest.amount = _upscale(swapRequest.amount, scalingFactors[indexOut]); uint256 amountIn = _onSwapGivenOut(swapRequest, balances, indexIn, indexOut); // amountIn tokens are entering the Pool, so we round up. amountIn = _downscaleUp(amountIn, scalingFactors[indexIn]); // Fees are added after scaling happens, to reduce the complexity of the rounding direction analysis. return _addSwapFeeAmount(amountIn); } /* * @dev Called when a swap with the Pool occurs, where the amount of tokens entering the Pool is known. * * Returns the amount of tokens that will be taken from the Pool in return. * * All amounts inside `swapRequest` and `balances` are upscaled. The swap fee has already been deducted from * `swapRequest.amount`. * * The return value is also considered upscaled, and will be downscaled (rounding down) before returning it to the * Vault. */ function _onSwapGivenIn( SwapRequest memory swapRequest, uint256[] memory balances, uint256 indexIn, uint256 indexOut ) internal virtual returns (uint256); /* * @dev Called when a swap with the Pool occurs, where the amount of tokens exiting the Pool is known. * * Returns the amount of tokens that will be granted to the Pool in return. * * All amounts inside `swapRequest` and `balances` are upscaled. * * The return value is also considered upscaled, and will be downscaled (rounding up) before applying the swap fee * and returning it to the Vault. */ function _onSwapGivenOut( SwapRequest memory swapRequest, uint256[] memory balances, uint256 indexIn, uint256 indexOut ) internal virtual returns (uint256); function _validateIndexes( uint256 indexIn, uint256 indexOut, uint256 limit ) private pure { _require(indexIn < limit && indexOut < limit, Errors.OUT_OF_BOUNDS); } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. /** * @dev Pool contracts with the MinimalSwapInfo or TwoToken specialization settings should implement this interface. * * This is called by the Vault when a user calls `IVault.swap` or `IVault.batchSwap` to swap with this Pool. * Returns the number of tokens the Pool will grant to the user in a 'given in' swap, or that the user will grant * to the pool in a 'given out' swap. * * This can often be implemented by a `view` function, since many pricing algorithms don't need to track state * changes in swaps. However, contracts implementing this in non-view functions should check that the caller is * indeed the Vault. */ interface IMinimalSwapInfoPool is IBasePool { function onSwap( SwapRequest memory swapRequest, uint256 currentBalanceTokenIn, uint256 currentBalanceTokenOut ) external returns (uint256 amount); } /** * @dev Extension of `BasePool`, adding a handler for `IMinimalSwapInfoPool.onSwap`. * * Derived contracts must call `BasePool`'s constructor, and implement `_onSwapGivenIn` and `_onSwapGivenOut` along with * `BasePool`'s virtual functions. Inheriting from this contract lets derived contracts choose the Two Token or Minimal * Swap Info specialization settings. */ abstract contract BaseMinimalSwapInfoPool is IMinimalSwapInfoPool, BasePool { // Swap Hooks function onSwap( SwapRequest memory request, uint256 balanceTokenIn, uint256 balanceTokenOut ) public virtual override onlyVault(request.poolId) returns (uint256) { uint256 scalingFactorTokenIn = _scalingFactor(request.tokenIn); uint256 scalingFactorTokenOut = _scalingFactor(request.tokenOut); if (request.kind == IVault.SwapKind.GIVEN_IN) { // Fees are subtracted before scaling, to reduce the complexity of the rounding direction analysis. uint256 amountInMinusSwapFees = _subtractSwapFeeAmount(request.amount); // Process the (upscaled!) swap fee. uint256 swapFee = request.amount - amountInMinusSwapFees; _processSwapFeeAmount(request.tokenIn, _upscale(swapFee, scalingFactorTokenIn)); request.amount = amountInMinusSwapFees; // All token amounts are upscaled. balanceTokenIn = _upscale(balanceTokenIn, scalingFactorTokenIn); balanceTokenOut = _upscale(balanceTokenOut, scalingFactorTokenOut); request.amount = _upscale(request.amount, scalingFactorTokenIn); uint256 amountOut = _onSwapGivenIn(request, balanceTokenIn, balanceTokenOut); // amountOut tokens are exiting the Pool, so we round down. return _downscaleDown(amountOut, scalingFactorTokenOut); } else { // All token amounts are upscaled. balanceTokenIn = _upscale(balanceTokenIn, scalingFactorTokenIn); balanceTokenOut = _upscale(balanceTokenOut, scalingFactorTokenOut); request.amount = _upscale(request.amount, scalingFactorTokenOut); uint256 amountIn = _onSwapGivenOut(request, balanceTokenIn, balanceTokenOut); // amountIn tokens are entering the Pool, so we round up. amountIn = _downscaleUp(amountIn, scalingFactorTokenIn); // Fees are added after scaling happens, to reduce the complexity of the rounding direction analysis. uint256 amountInPlusSwapFees = _addSwapFeeAmount(amountIn); // Process the (upscaled!) swap fee. uint256 swapFee = amountInPlusSwapFees - amountIn; _processSwapFeeAmount(request.tokenIn, _upscale(swapFee, scalingFactorTokenIn)); return amountInPlusSwapFees; } } /* * @dev Called when a swap with the Pool occurs, where the amount of tokens entering the Pool is known. * * Returns the amount of tokens that will be taken from the Pool in return. * * All amounts inside `swapRequest`, `balanceTokenIn` and `balanceTokenOut` are upscaled. The swap fee has already * been deducted from `swapRequest.amount`. * * The return value is also considered upscaled, and will be downscaled (rounding down) before returning it to the * Vault. */ function _onSwapGivenIn( SwapRequest memory swapRequest, uint256 balanceTokenIn, uint256 balanceTokenOut ) internal virtual returns (uint256); /* * @dev Called when a swap with the Pool occurs, where the amount of tokens exiting the Pool is known. * * Returns the amount of tokens that will be granted to the Pool in return. * * All amounts inside `swapRequest`, `balanceTokenIn` and `balanceTokenOut` are upscaled. * * The return value is also considered upscaled, and will be downscaled (rounding up) before applying the swap fee * and returning it to the Vault. */ function _onSwapGivenOut( SwapRequest memory swapRequest, uint256 balanceTokenIn, uint256 balanceTokenOut ) internal virtual returns (uint256); /** * @dev Called whenever a swap fee is charged. Implementations should call their parents via super, to ensure all * implementations in the inheritance tree are called. * * Callers must call one of the three `_processSwapFeeAmount` functions when swap fees are computed, * and upscale `amount`. */ function _processSwapFeeAmount( uint256, /*index*/ uint256 /*amount*/ ) internal virtual { // solhint-disable-previous-line no-empty-blocks } function _processSwapFeeAmount(IERC20 token, uint256 amount) internal { _processSwapFeeAmount(_tokenAddressToIndex(token), amount); } function _processSwapFeeAmounts(uint256[] memory amounts) internal { InputHelpers.ensureInputLengthMatch(amounts.length, _getTotalTokens()); for (uint256 i = 0; i < _getTotalTokens(); ++i) { _processSwapFeeAmount(i, amounts[i]); } } /** * @dev Returns the index of `token` in the Pool's token array (i.e. the one `vault.getPoolTokens()` would return). * * A trivial (and incorrect!) implementation is already provided for Pools that don't override * `_processSwapFeeAmount` and skip the entire feature. However, Pools that do override `_processSwapFeeAmount` * *must* override this function with a meaningful implementation. */ function _tokenAddressToIndex( IERC20 /*token*/ ) internal view virtual returns (uint256) { return 0; } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. interface IRateProvider { /** * @dev Returns an 18 decimal fixed point number that is the exchange rate of the token to some other underlying * token. The meaning of this rate depends on the context. */ function getRate() external view returns (uint256); } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. // These functions start with an underscore, as if they were part of a contract and not a library. At some point this // should be fixed. Additionally, some variables have non mixed case names (e.g. P_D) that relate to the mathematical // derivations. // solhint-disable private-vars-leading-underscore, var-name-mixedcase library StableMath { using FixedPoint for uint256; uint256 internal constant _MIN_AMP = 1; uint256 internal constant _MAX_AMP = 5000; uint256 internal constant _AMP_PRECISION = 1e3; uint256 internal constant _MAX_STABLE_TOKENS = 5; // Note on unchecked arithmetic: // This contract performs a large number of additions, subtractions, multiplications and divisions, often inside // loops. Since many of these operations are gas-sensitive (as they happen e.g. during a swap), it is important to // not make any unnecessary checks. We rely on a set of invariants to avoid having to use checked arithmetic (the // Math library), including: // - the number of tokens is bounded by _MAX_STABLE_TOKENS // - the amplification parameter is bounded by _MAX_AMP * _AMP_PRECISION, which fits in 23 bits // - the token balances are bounded by 2^112 (guaranteed by the Vault) times 1e18 (the maximum scaling factor), // which fits in 172 bits // // This means e.g. we can safely multiply a balance by the amplification parameter without worrying about overflow. // About swap fees on joins and exits: // Any join or exit that is not perfectly balanced (e.g. all single token joins or exits) is mathematically // equivalent to a perfectly balanced join or exit followed by a series of swaps. Since these swaps would charge // swap fees, it follows that (some) joins and exits should as well. // On these operations, we split the token amounts in 'taxable' and 'non-taxable' portions, where the 'taxable' part // is the one to which swap fees are applied. // Computes the invariant given the current balances, using the Newton-Raphson approximation. // The amplification parameter equals: A n^(n-1) function _calculateInvariant( uint256 amplificationParameter, uint256[] memory balances, bool roundUp ) internal pure returns (uint256) { /********************************************************************************************** // invariant // // D = invariant D^(n+1) // // A = amplification coefficient A n^n S + D = A D n^n + ----------- // // S = sum of balances n^n P // // P = product of balances // // n = number of tokens // **********************************************************************************************/ // We support rounding up or down. uint256 sum = 0; uint256 numTokens = balances.length; for (uint256 i = 0; i < numTokens; i++) { sum = sum.add(balances[i]); } if (sum == 0) { return 0; } uint256 prevInvariant = 0; uint256 invariant = sum; uint256 ampTimesTotal = amplificationParameter * numTokens; for (uint256 i = 0; i < 255; i++) { uint256 P_D = balances[0] * numTokens; for (uint256 j = 1; j < numTokens; j++) { P_D = Math.div(Math.mul(Math.mul(P_D, balances[j]), numTokens), invariant, roundUp); } prevInvariant = invariant; invariant = Math.div( Math.mul(Math.mul(numTokens, invariant), invariant).add( Math.div(Math.mul(Math.mul(ampTimesTotal, sum), P_D), _AMP_PRECISION, roundUp) ), Math.mul(numTokens + 1, invariant).add( // No need to use checked arithmetic for the amp precision, the amp is guaranteed to be at least 1 Math.div(Math.mul(ampTimesTotal - _AMP_PRECISION, P_D), _AMP_PRECISION, !roundUp) ), roundUp ); if (invariant > prevInvariant) { if (invariant - prevInvariant <= 1) { return invariant; } } else if (prevInvariant - invariant <= 1) { return invariant; } } _revert(Errors.STABLE_INVARIANT_DIDNT_CONVERGE); } // Computes how many tokens can be taken out of a pool if `tokenAmountIn` are sent, given the current balances. // The amplification parameter equals: A n^(n-1) // The invariant should be rounded up. function _calcOutGivenIn( uint256 amplificationParameter, uint256[] memory balances, uint256 tokenIndexIn, uint256 tokenIndexOut, uint256 tokenAmountIn, uint256 invariant ) internal pure returns (uint256) { /************************************************************************************************************** // outGivenIn token x for y - polynomial equation to solve // // ay = amount out to calculate // // by = balance token out // // y = by - ay (finalBalanceOut) // // D = invariant D D^(n+1) // // A = amplification coefficient y^2 + ( S - ---------- - D) * y - ------------- = 0 // // n = number of tokens (A * n^n) A * n^2n * P // // S = sum of final balances but y // // P = product of final balances but y // **************************************************************************************************************/ // Amount out, so we round down overall. balances[tokenIndexIn] = balances[tokenIndexIn].add(tokenAmountIn); uint256 finalBalanceOut = _getTokenBalanceGivenInvariantAndAllOtherBalances( amplificationParameter, balances, invariant, tokenIndexOut ); // No need to use checked arithmetic since `tokenAmountIn` was actually added to the same balance right before // calling `_getTokenBalanceGivenInvariantAndAllOtherBalances` which doesn't alter the balances array. balances[tokenIndexIn] = balances[tokenIndexIn] - tokenAmountIn; return balances[tokenIndexOut].sub(finalBalanceOut).sub(1); } // Computes how many tokens must be sent to a pool if `tokenAmountOut` are sent given the // current balances, using the Newton-Raphson approximation. // The amplification parameter equals: A n^(n-1) // The invariant should be rounded up. function _calcInGivenOut( uint256 amplificationParameter, uint256[] memory balances, uint256 tokenIndexIn, uint256 tokenIndexOut, uint256 tokenAmountOut, uint256 invariant ) internal pure returns (uint256) { /************************************************************************************************************** // inGivenOut token x for y - polynomial equation to solve // // ax = amount in to calculate // // bx = balance token in // // x = bx + ax (finalBalanceIn) // // D = invariant D D^(n+1) // // A = amplification coefficient x^2 + ( S - ---------- - D) * x - ------------- = 0 // // n = number of tokens (A * n^n) A * n^2n * P // // S = sum of final balances but x // // P = product of final balances but x // **************************************************************************************************************/ // Amount in, so we round up overall. balances[tokenIndexOut] = balances[tokenIndexOut].sub(tokenAmountOut); uint256 finalBalanceIn = _getTokenBalanceGivenInvariantAndAllOtherBalances( amplificationParameter, balances, invariant, tokenIndexIn ); // No need to use checked arithmetic since `tokenAmountOut` was actually subtracted from the same balance right // before calling `_getTokenBalanceGivenInvariantAndAllOtherBalances` which doesn't alter the balances array. balances[tokenIndexOut] = balances[tokenIndexOut] + tokenAmountOut; return finalBalanceIn.sub(balances[tokenIndexIn]).add(1); } function _calcBptOutGivenExactTokensIn( uint256 amp, uint256[] memory balances, uint256[] memory amountsIn, uint256 bptTotalSupply, uint256 swapFeePercentage ) internal pure returns (uint256) { // BPT out, so we round down overall. // First loop calculates the sum of all token balances, which will be used to calculate // the current weights of each token, relative to this sum uint256 sumBalances = 0; for (uint256 i = 0; i < balances.length; i++) { sumBalances = sumBalances.add(balances[i]); } // Calculate the weighted balance ratio without considering fees uint256[] memory balanceRatiosWithFee = new uint256[](amountsIn.length); // The weighted sum of token balance ratios with fee uint256 invariantRatioWithFees = 0; for (uint256 i = 0; i < balances.length; i++) { uint256 currentWeight = balances[i].divDown(sumBalances); balanceRatiosWithFee[i] = balances[i].add(amountsIn[i]).divDown(balances[i]); invariantRatioWithFees = invariantRatioWithFees.add(balanceRatiosWithFee[i].mulDown(currentWeight)); } // Second loop calculates new amounts in, taking into account the fee on the percentage excess uint256[] memory newBalances = new uint256[](balances.length); for (uint256 i = 0; i < balances.length; i++) { uint256 amountInWithoutFee; // Check if the balance ratio is greater than the ideal ratio to charge fees or not if (balanceRatiosWithFee[i] > invariantRatioWithFees) { uint256 nonTaxableAmount = balances[i].mulDown(invariantRatioWithFees.sub(FixedPoint.ONE)); uint256 taxableAmount = amountsIn[i].sub(nonTaxableAmount); // No need to use checked arithmetic for the swap fee, it is guaranteed to be lower than 50% amountInWithoutFee = nonTaxableAmount.add(taxableAmount.mulDown(FixedPoint.ONE - swapFeePercentage)); } else { amountInWithoutFee = amountsIn[i]; } newBalances[i] = balances[i].add(amountInWithoutFee); } // Get current and new invariants, taking swap fees into account uint256 currentInvariant = _calculateInvariant(amp, balances, true); uint256 newInvariant = _calculateInvariant(amp, newBalances, false); uint256 invariantRatio = newInvariant.divDown(currentInvariant); // If the invariant didn't increase for any reason, we simply don't mint BPT if (invariantRatio > FixedPoint.ONE) { return bptTotalSupply.mulDown(invariantRatio - FixedPoint.ONE); } else { return 0; } } function _calcTokenInGivenExactBptOut( uint256 amp, uint256[] memory balances, uint256 tokenIndex, uint256 bptAmountOut, uint256 bptTotalSupply, uint256 swapFeePercentage ) internal pure returns (uint256) { // Token in, so we round up overall. // Get the current invariant uint256 currentInvariant = _calculateInvariant(amp, balances, true); // Calculate new invariant uint256 newInvariant = bptTotalSupply.add(bptAmountOut).divUp(bptTotalSupply).mulUp(currentInvariant); // Calculate amount in without fee. uint256 newBalanceTokenIndex = _getTokenBalanceGivenInvariantAndAllOtherBalances( amp, balances, newInvariant, tokenIndex ); uint256 amountInWithoutFee = newBalanceTokenIndex.sub(balances[tokenIndex]); // First calculate the sum of all token balances, which will be used to calculate // the current weight of each token uint256 sumBalances = 0; for (uint256 i = 0; i < balances.length; i++) { sumBalances = sumBalances.add(balances[i]); } // We can now compute how much extra balance is being deposited and used in virtual swaps, and charge swap fees // accordingly. uint256 currentWeight = balances[tokenIndex].divDown(sumBalances); uint256 taxablePercentage = currentWeight.complement(); uint256 taxableAmount = amountInWithoutFee.mulUp(taxablePercentage); uint256 nonTaxableAmount = amountInWithoutFee.sub(taxableAmount); // No need to use checked arithmetic for the swap fee, it is guaranteed to be lower than 50% return nonTaxableAmount.add(taxableAmount.divUp(FixedPoint.ONE - swapFeePercentage)); } /* Flow of calculations: amountsTokenOut -> amountsOutProportional -> amountOutPercentageExcess -> amountOutBeforeFee -> newInvariant -> amountBPTIn */ function _calcBptInGivenExactTokensOut( uint256 amp, uint256[] memory balances, uint256[] memory amountsOut, uint256 bptTotalSupply, uint256 swapFeePercentage ) internal pure returns (uint256) { // BPT in, so we round up overall. // First loop calculates the sum of all token balances, which will be used to calculate // the current weights of each token relative to this sum uint256 sumBalances = 0; for (uint256 i = 0; i < balances.length; i++) { sumBalances = sumBalances.add(balances[i]); } // Calculate the weighted balance ratio without considering fees uint256[] memory balanceRatiosWithoutFee = new uint256[](amountsOut.length); uint256 invariantRatioWithoutFees = 0; for (uint256 i = 0; i < balances.length; i++) { uint256 currentWeight = balances[i].divUp(sumBalances); balanceRatiosWithoutFee[i] = balances[i].sub(amountsOut[i]).divUp(balances[i]); invariantRatioWithoutFees = invariantRatioWithoutFees.add(balanceRatiosWithoutFee[i].mulUp(currentWeight)); } // Second loop calculates new amounts in, taking into account the fee on the percentage excess uint256[] memory newBalances = new uint256[](balances.length); for (uint256 i = 0; i < balances.length; i++) { // Swap fees are typically charged on 'token in', but there is no 'token in' here, so we apply it to // 'token out'. This results in slightly larger price impact. uint256 amountOutWithFee; if (invariantRatioWithoutFees > balanceRatiosWithoutFee[i]) { uint256 nonTaxableAmount = balances[i].mulDown(invariantRatioWithoutFees.complement()); uint256 taxableAmount = amountsOut[i].sub(nonTaxableAmount); // No need to use checked arithmetic for the swap fee, it is guaranteed to be lower than 50% amountOutWithFee = nonTaxableAmount.add(taxableAmount.divUp(FixedPoint.ONE - swapFeePercentage)); } else { amountOutWithFee = amountsOut[i]; } newBalances[i] = balances[i].sub(amountOutWithFee); } // Get current and new invariants, taking into account swap fees uint256 currentInvariant = _calculateInvariant(amp, balances, true); uint256 newInvariant = _calculateInvariant(amp, newBalances, false); uint256 invariantRatio = newInvariant.divDown(currentInvariant); // return amountBPTIn return bptTotalSupply.mulUp(invariantRatio.complement()); } function _calcTokenOutGivenExactBptIn( uint256 amp, uint256[] memory balances, uint256 tokenIndex, uint256 bptAmountIn, uint256 bptTotalSupply, uint256 swapFeePercentage ) internal pure returns (uint256) { // Token out, so we round down overall. // Get the current and new invariants. Since we need a bigger new invariant, we round the current one up. uint256 currentInvariant = _calculateInvariant(amp, balances, true); uint256 newInvariant = bptTotalSupply.sub(bptAmountIn).divUp(bptTotalSupply).mulUp(currentInvariant); // Calculate amount out without fee uint256 newBalanceTokenIndex = _getTokenBalanceGivenInvariantAndAllOtherBalances( amp, balances, newInvariant, tokenIndex ); uint256 amountOutWithoutFee = balances[tokenIndex].sub(newBalanceTokenIndex); // First calculate the sum of all token balances, which will be used to calculate // the current weight of each token uint256 sumBalances = 0; for (uint256 i = 0; i < balances.length; i++) { sumBalances = sumBalances.add(balances[i]); } // We can now compute how much excess balance is being withdrawn as a result of the virtual swaps, which result // in swap fees. uint256 currentWeight = balances[tokenIndex].divDown(sumBalances); uint256 taxablePercentage = currentWeight.complement(); // Swap fees are typically charged on 'token in', but there is no 'token in' here, so we apply it // to 'token out'. This results in slightly larger price impact. Fees are rounded up. uint256 taxableAmount = amountOutWithoutFee.mulUp(taxablePercentage); uint256 nonTaxableAmount = amountOutWithoutFee.sub(taxableAmount); // No need to use checked arithmetic for the swap fee, it is guaranteed to be lower than 50% return nonTaxableAmount.add(taxableAmount.mulDown(FixedPoint.ONE - swapFeePercentage)); } function _calcTokensOutGivenExactBptIn( uint256[] memory balances, uint256 bptAmountIn, uint256 bptTotalSupply ) internal pure returns (uint256[] memory) { /********************************************************************************************** // exactBPTInForTokensOut // // (per token) // // aO = tokenAmountOut / bptIn \ // // b = tokenBalance a0 = b * | --------------------- | // // bptIn = bptAmountIn \ bptTotalSupply / // // bpt = bptTotalSupply // **********************************************************************************************/ // Since we're computing an amount out, we round down overall. This means rounding down on both the // multiplication and division. uint256 bptRatio = bptAmountIn.divDown(bptTotalSupply); uint256[] memory amountsOut = new uint256[](balances.length); for (uint256 i = 0; i < balances.length; i++) { amountsOut[i] = balances[i].mulDown(bptRatio); } return amountsOut; } // The amplification parameter equals: A n^(n-1) function _calcDueTokenProtocolSwapFeeAmount( uint256 amplificationParameter, uint256[] memory balances, uint256 lastInvariant, uint256 tokenIndex, uint256 protocolSwapFeePercentage ) internal pure returns (uint256) { /************************************************************************************************************** // oneTokenSwapFee - polynomial equation to solve // // af = fee amount to calculate in one token // // bf = balance of fee token // // f = bf - af (finalBalanceFeeToken) // // D = old invariant D D^(n+1) // // A = amplification coefficient f^2 + ( S - ---------- - D) * f - ------------- = 0 // // n = number of tokens (A * n^n) A * n^2n * P // // S = sum of final balances but f // // P = product of final balances but f // **************************************************************************************************************/ // Protocol swap fee amount, so we round down overall. uint256 finalBalanceFeeToken = _getTokenBalanceGivenInvariantAndAllOtherBalances( amplificationParameter, balances, lastInvariant, tokenIndex ); if (balances[tokenIndex] <= finalBalanceFeeToken) { // This shouldn't happen outside of rounding errors, but have this safeguard nonetheless to prevent the Pool // from entering a locked state in which joins and exits revert while computing accumulated swap fees. return 0; } // Result is rounded down uint256 accumulatedTokenSwapFees = balances[tokenIndex] - finalBalanceFeeToken; return accumulatedTokenSwapFees.mulDown(protocolSwapFeePercentage); } // This function calculates the balance of a given token (tokenIndex) // given all the other balances and the invariant function _getTokenBalanceGivenInvariantAndAllOtherBalances( uint256 amplificationParameter, uint256[] memory balances, uint256 invariant, uint256 tokenIndex ) internal pure returns (uint256) { // Rounds result up overall uint256 ampTimesTotal = amplificationParameter * balances.length; uint256 sum = balances[0]; uint256 P_D = balances[0] * balances.length; for (uint256 j = 1; j < balances.length; j++) { P_D = Math.divDown(Math.mul(Math.mul(P_D, balances[j]), balances.length), invariant); sum = sum.add(balances[j]); } // No need to use safe math, based on the loop above `sum` is greater than or equal to `balances[tokenIndex]` sum = sum - balances[tokenIndex]; uint256 inv2 = Math.mul(invariant, invariant); // We remove the balance from c by multiplying it uint256 c = Math.mul( Math.mul(Math.divUp(inv2, Math.mul(ampTimesTotal, P_D)), _AMP_PRECISION), balances[tokenIndex] ); uint256 b = sum.add(Math.mul(Math.divDown(invariant, ampTimesTotal), _AMP_PRECISION)); // We iterate to find the balance uint256 prevTokenBalance = 0; // We multiply the first iteration outside the loop with the invariant to set the value of the // initial approximation. uint256 tokenBalance = Math.divUp(inv2.add(c), invariant.add(b)); for (uint256 i = 0; i < 255; i++) { prevTokenBalance = tokenBalance; tokenBalance = Math.divUp( Math.mul(tokenBalance, tokenBalance).add(c), Math.mul(tokenBalance, 2).add(b).sub(invariant) ); if (tokenBalance > prevTokenBalance) { if (tokenBalance - prevTokenBalance <= 1) { return tokenBalance; } } else if (prevTokenBalance - tokenBalance <= 1) { return tokenBalance; } } _revert(Errors.STABLE_GET_BALANCE_DIDNT_CONVERGE); } function _getRate( uint256[] memory balances, uint256 amp, uint256 supply ) internal pure returns (uint256) { // When calculating the current BPT rate, we may not have paid the protocol fees, therefore // the invariant should be smaller than its current value. Then, we round down overall. uint256 invariant = _calculateInvariant(amp, balances, false); return invariant.divDown(supply); } } // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. library StablePoolUserData { // In order to preserve backwards compatibility, make sure new join and exit kinds are added at the end of the enum. enum JoinKind { INIT, EXACT_TOKENS_IN_FOR_BPT_OUT, TOKEN_IN_FOR_EXACT_BPT_OUT } enum ExitKind { EXACT_BPT_IN_FOR_ONE_TOKEN_OUT, EXACT_BPT_IN_FOR_TOKENS_OUT, BPT_IN_FOR_EXACT_TOKENS_OUT } function joinKind(bytes memory self) internal pure returns (JoinKind) { return abi.decode(self, (JoinKind)); } function exitKind(bytes memory self) internal pure returns (ExitKind) { return abi.decode(self, (ExitKind)); } // Joins function initialAmountsIn(bytes memory self) internal pure returns (uint256[] memory amountsIn) { (, amountsIn) = abi.decode(self, (JoinKind, uint256[])); } function exactTokensInForBptOut(bytes memory self) internal pure returns (uint256[] memory amountsIn, uint256 minBPTAmountOut) { (, amountsIn, minBPTAmountOut) = abi.decode(self, (JoinKind, uint256[], uint256)); } function tokenInForExactBptOut(bytes memory self) internal pure returns (uint256 bptAmountOut, uint256 tokenIndex) { (, bptAmountOut, tokenIndex) = abi.decode(self, (JoinKind, uint256, uint256)); } // Exits function exactBptInForTokenOut(bytes memory self) internal pure returns (uint256 bptAmountIn, uint256 tokenIndex) { (, bptAmountIn, tokenIndex) = abi.decode(self, (ExitKind, uint256, uint256)); } function exactBptInForTokensOut(bytes memory self) internal pure returns (uint256 bptAmountIn) { (, bptAmountIn) = abi.decode(self, (ExitKind, uint256)); } function bptInForExactTokensOut(bytes memory self) internal pure returns (uint256[] memory amountsOut, uint256 maxBPTAmountIn) { (, amountsOut, maxBPTAmountIn) = abi.decode(self, (ExitKind, uint256[], uint256)); } } contract StablePool is BaseGeneralPool, BaseMinimalSwapInfoPool, IRateProvider { using WordCodec for bytes32; using FixedPoint for uint256; using StablePoolUserData for bytes; // This contract uses timestamps to slowly update its Amplification parameter over time. These changes must occur // over a minimum time period much larger than the blocktime, making timestamp manipulation a non-issue. // solhint-disable not-rely-on-time // Amplification factor changes must happen over a minimum period of one day, and can at most divide or multiply the // current value by 2 every day. // WARNING: this only limits *a single* amplification change to have a maximum rate of change of twice the original // value daily. It is possible to perform multiple amplification changes in sequence to increase this value more // rapidly: for example, by doubling the value every day it can increase by a factor of 8 over three days (2^3). uint256 private constant _MIN_UPDATE_TIME = 1 days; uint256 private constant _MAX_AMP_UPDATE_DAILY_RATE = 2; bytes32 private _packedAmplificationData; event AmpUpdateStarted(uint256 startValue, uint256 endValue, uint256 startTime, uint256 endTime); event AmpUpdateStopped(uint256 currentValue); uint256 private immutable _totalTokens; IERC20 internal immutable _token0; IERC20 internal immutable _token1; IERC20 internal immutable _token2; IERC20 internal immutable _token3; IERC20 internal immutable _token4; // All token balances are normalized to behave as if the token had 18 decimals. We assume a token's decimals will // not change throughout its lifetime, and store the corresponding scaling factor for each at construction time. // These factors are always greater than or equal to one: tokens with more than 18 decimals are not supported. uint256 internal immutable _scalingFactor0; uint256 internal immutable _scalingFactor1; uint256 internal immutable _scalingFactor2; uint256 internal immutable _scalingFactor3; uint256 internal immutable _scalingFactor4; // To track how many tokens are owed to the Vault as protocol fees, we measure and store the value of the invariant // after every join and exit. All invariant growth that happens between join and exit events is due to swap fees. uint256 internal _lastInvariant; // Because the invariant depends on the amplification parameter, and this value may change over time, we should only // compare invariants that were computed using the same value. We therefore store it whenever we store // _lastInvariant. uint256 internal _lastInvariantAmp; constructor( IVault vault, string memory name, string memory symbol, IERC20[] memory tokens, uint256 amplificationParameter, uint256 swapFeePercentage, uint256 pauseWindowDuration, uint256 bufferPeriodDuration, address owner ) BasePool( vault, // Because we're inheriting from both BaseGeneralPool and BaseMinimalSwapInfoPool we can choose any // specialization setting. Since this Pool never registers or deregisters any tokens after construction, // picking Two Token when the Pool only has two tokens is free gas savings. tokens.length == 2 ? IVault.PoolSpecialization.TWO_TOKEN : IVault.PoolSpecialization.GENERAL, name, symbol, tokens, new address[](tokens.length), swapFeePercentage, pauseWindowDuration, bufferPeriodDuration, owner ) { _require(amplificationParameter >= StableMath._MIN_AMP, Errors.MIN_AMP); _require(amplificationParameter <= StableMath._MAX_AMP, Errors.MAX_AMP); uint256 totalTokens = tokens.length; _totalTokens = totalTokens; // Immutable variables cannot be initialized inside an if statement, so we must do conditional assignments _token0 = tokens[0]; _token1 = tokens[1]; _token2 = totalTokens > 2 ? tokens[2] : IERC20(0); _token3 = totalTokens > 3 ? tokens[3] : IERC20(0); _token4 = totalTokens > 4 ? tokens[4] : IERC20(0); _scalingFactor0 = _computeScalingFactor(tokens[0]); _scalingFactor1 = _computeScalingFactor(tokens[1]); _scalingFactor2 = totalTokens > 2 ? _computeScalingFactor(tokens[2]) : 0; _scalingFactor3 = totalTokens > 3 ? _computeScalingFactor(tokens[3]) : 0; _scalingFactor4 = totalTokens > 4 ? _computeScalingFactor(tokens[4]) : 0; uint256 initialAmp = Math.mul(amplificationParameter, StableMath._AMP_PRECISION); _setAmplificationData(initialAmp); } function getLastInvariant() external view returns (uint256 lastInvariant, uint256 lastInvariantAmp) { lastInvariant = _lastInvariant; lastInvariantAmp = _lastInvariantAmp; } // Base Pool handlers // Swap - General Pool specialization (from BaseGeneralPool) function _onSwapGivenIn( SwapRequest memory swapRequest, uint256[] memory balances, uint256 indexIn, uint256 indexOut ) internal virtual override whenNotPaused returns (uint256) { (uint256 currentAmp, ) = _getAmplificationParameter(); uint256 invariant = StableMath._calculateInvariant(currentAmp, balances, true); uint256 amountOut = StableMath._calcOutGivenIn( currentAmp, balances, indexIn, indexOut, swapRequest.amount, invariant ); return amountOut; } function _onSwapGivenOut( SwapRequest memory swapRequest, uint256[] memory balances, uint256 indexIn, uint256 indexOut ) internal virtual override whenNotPaused returns (uint256) { (uint256 currentAmp, ) = _getAmplificationParameter(); uint256 invariant = StableMath._calculateInvariant(currentAmp, balances, true); uint256 amountIn = StableMath._calcInGivenOut( currentAmp, balances, indexIn, indexOut, swapRequest.amount, invariant ); return amountIn; } // Swap - Two Token Pool specialization (from BaseMinimalSwapInfoPool) function _onSwapGivenIn( SwapRequest memory swapRequest, uint256 balanceTokenIn, uint256 balanceTokenOut ) internal virtual override returns (uint256) { _require(_getTotalTokens() == 2, Errors.NOT_TWO_TOKENS); (uint256[] memory balances, uint256 indexIn, uint256 indexOut) = _getSwapBalanceArrays( swapRequest, balanceTokenIn, balanceTokenOut ); return _onSwapGivenIn(swapRequest, balances, indexIn, indexOut); } function _onSwapGivenOut( SwapRequest memory swapRequest, uint256 balanceTokenIn, uint256 balanceTokenOut ) internal virtual override returns (uint256) { _require(_getTotalTokens() == 2, Errors.NOT_TWO_TOKENS); (uint256[] memory balances, uint256 indexIn, uint256 indexOut) = _getSwapBalanceArrays( swapRequest, balanceTokenIn, balanceTokenOut ); return _onSwapGivenOut(swapRequest, balances, indexIn, indexOut); } function _getSwapBalanceArrays( SwapRequest memory swapRequest, uint256 balanceTokenIn, uint256 balanceTokenOut ) private view returns ( uint256[] memory balances, uint256 indexIn, uint256 indexOut ) { balances = new uint256[](2); if (_isToken0(swapRequest.tokenIn)) { indexIn = 0; indexOut = 1; balances[0] = balanceTokenIn; balances[1] = balanceTokenOut; } else { // _token0 == swapRequest.tokenOut indexOut = 0; indexIn = 1; balances[0] = balanceTokenOut; balances[1] = balanceTokenIn; } } // Initialize function _onInitializePool( bytes32, address, address, uint256[] memory scalingFactors, bytes memory userData ) internal virtual override whenNotPaused returns (uint256, uint256[] memory) { // It would be strange for the Pool to be paused before it is initialized, but for consistency we prevent // initialization in this case. StablePoolUserData.JoinKind kind = userData.joinKind(); _require(kind == StablePoolUserData.JoinKind.INIT, Errors.UNINITIALIZED); uint256[] memory amountsIn = userData.initialAmountsIn(); InputHelpers.ensureInputLengthMatch(amountsIn.length, _getTotalTokens()); _upscaleArray(amountsIn, scalingFactors); (uint256 currentAmp, ) = _getAmplificationParameter(); uint256 invariantAfterJoin = StableMath._calculateInvariant(currentAmp, amountsIn, true); // Set the initial BPT to the value of the invariant. uint256 bptAmountOut = invariantAfterJoin; _updateLastInvariant(invariantAfterJoin, currentAmp); return (bptAmountOut, amountsIn); } // Join function _onJoinPool( bytes32, address, address, uint256[] memory balances, uint256, uint256 protocolSwapFeePercentage, uint256[] memory scalingFactors, bytes memory userData ) internal virtual override whenNotPaused returns ( uint256, uint256[] memory, uint256[] memory ) { // Due protocol swap fee amounts are computed by measuring the growth of the invariant between the previous join // or exit event and now - the invariant's growth is due exclusively to swap fees. This avoids spending gas to // calculate the fee amounts during each individual swap. uint256[] memory dueProtocolFeeAmounts = _getDueProtocolFeeAmounts(balances, protocolSwapFeePercentage); // Update current balances by subtracting the protocol fee amounts _mutateAmounts(balances, dueProtocolFeeAmounts, FixedPoint.sub); (uint256 bptAmountOut, uint256[] memory amountsIn) = _doJoin(balances, scalingFactors, userData); // Update the invariant with the balances the Pool will have after the join, in order to compute the // protocol swap fee amounts due in future joins and exits. _updateInvariantAfterJoin(balances, amountsIn); return (bptAmountOut, amountsIn, dueProtocolFeeAmounts); } function _doJoin( uint256[] memory balances, uint256[] memory scalingFactors, bytes memory userData ) private view returns (uint256, uint256[] memory) { StablePoolUserData.JoinKind kind = userData.joinKind(); if (kind == StablePoolUserData.JoinKind.EXACT_TOKENS_IN_FOR_BPT_OUT) { return _joinExactTokensInForBPTOut(balances, scalingFactors, userData); } else if (kind == StablePoolUserData.JoinKind.TOKEN_IN_FOR_EXACT_BPT_OUT) { return _joinTokenInForExactBPTOut(balances, userData); } else { _revert(Errors.UNHANDLED_JOIN_KIND); } } function _joinExactTokensInForBPTOut( uint256[] memory balances, uint256[] memory scalingFactors, bytes memory userData ) private view returns (uint256, uint256[] memory) { (uint256[] memory amountsIn, uint256 minBPTAmountOut) = userData.exactTokensInForBptOut(); InputHelpers.ensureInputLengthMatch(_getTotalTokens(), amountsIn.length); _upscaleArray(amountsIn, scalingFactors); (uint256 currentAmp, ) = _getAmplificationParameter(); uint256 bptAmountOut = StableMath._calcBptOutGivenExactTokensIn( currentAmp, balances, amountsIn, totalSupply(), getSwapFeePercentage() ); _require(bptAmountOut >= minBPTAmountOut, Errors.BPT_OUT_MIN_AMOUNT); return (bptAmountOut, amountsIn); } function _joinTokenInForExactBPTOut(uint256[] memory balances, bytes memory userData) private view returns (uint256, uint256[] memory) { (uint256 bptAmountOut, uint256 tokenIndex) = userData.tokenInForExactBptOut(); // Note that there is no maximum amountIn parameter: this is handled by `IVault.joinPool`. _require(tokenIndex < _getTotalTokens(), Errors.OUT_OF_BOUNDS); uint256[] memory amountsIn = new uint256[](_getTotalTokens()); (uint256 currentAmp, ) = _getAmplificationParameter(); amountsIn[tokenIndex] = StableMath._calcTokenInGivenExactBptOut( currentAmp, balances, tokenIndex, bptAmountOut, totalSupply(), getSwapFeePercentage() ); return (bptAmountOut, amountsIn); } // Exit function _onExitPool( bytes32, address, address, uint256[] memory balances, uint256, uint256 protocolSwapFeePercentage, uint256[] memory scalingFactors, bytes memory userData ) internal virtual override returns ( uint256 bptAmountIn, uint256[] memory amountsOut, uint256[] memory dueProtocolFeeAmounts ) { // Exits are not completely disabled while the contract is paused: proportional exits (exact BPT in for tokens // out) remain functional. if (_isNotPaused()) { // Due protocol swap fee amounts are computed by measuring the growth of the invariant between the previous // join or exit event and now - the invariant's growth is due exclusively to swap fees. This avoids // spending gas calculating fee amounts during each individual swap dueProtocolFeeAmounts = _getDueProtocolFeeAmounts(balances, protocolSwapFeePercentage); // Update current balances by subtracting the protocol fee amounts _mutateAmounts(balances, dueProtocolFeeAmounts, FixedPoint.sub); } else { // If the contract is paused, swap protocol fee amounts are not charged to avoid extra calculations and // reduce the potential for errors. dueProtocolFeeAmounts = new uint256[](_getTotalTokens()); } (bptAmountIn, amountsOut) = _doExit(balances, scalingFactors, userData); // Update the invariant with the balances the Pool will have after the exit, in order to compute the // protocol swap fee amounts due in future joins and exits. _updateInvariantAfterExit(balances, amountsOut); return (bptAmountIn, amountsOut, dueProtocolFeeAmounts); } function _doExit( uint256[] memory balances, uint256[] memory scalingFactors, bytes memory userData ) private view returns (uint256, uint256[] memory) { StablePoolUserData.ExitKind kind = userData.exitKind(); if (kind == StablePoolUserData.ExitKind.EXACT_BPT_IN_FOR_ONE_TOKEN_OUT) { return _exitExactBPTInForTokenOut(balances, userData); } else if (kind == StablePoolUserData.ExitKind.EXACT_BPT_IN_FOR_TOKENS_OUT) { return _exitExactBPTInForTokensOut(balances, userData); } else if (kind == StablePoolUserData.ExitKind.BPT_IN_FOR_EXACT_TOKENS_OUT) { return _exitBPTInForExactTokensOut(balances, scalingFactors, userData); } else { _revert(Errors.UNHANDLED_EXIT_KIND); } } function _exitExactBPTInForTokenOut(uint256[] memory balances, bytes memory userData) private view whenNotPaused returns (uint256, uint256[] memory) { // This exit function is disabled if the contract is paused. (uint256 bptAmountIn, uint256 tokenIndex) = userData.exactBptInForTokenOut(); // Note that there is no minimum amountOut parameter: this is handled by `IVault.exitPool`. _require(tokenIndex < _getTotalTokens(), Errors.OUT_OF_BOUNDS); // We exit in a single token, so initialize amountsOut with zeros uint256[] memory amountsOut = new uint256[](_getTotalTokens()); // And then assign the result to the selected token (uint256 currentAmp, ) = _getAmplificationParameter(); amountsOut[tokenIndex] = StableMath._calcTokenOutGivenExactBptIn( currentAmp, balances, tokenIndex, bptAmountIn, totalSupply(), getSwapFeePercentage() ); return (bptAmountIn, amountsOut); } function _exitExactBPTInForTokensOut(uint256[] memory balances, bytes memory userData) private view returns (uint256, uint256[] memory) { // This exit function is the only one that is not disabled if the contract is paused: it remains unrestricted // in an attempt to provide users with a mechanism to retrieve their tokens in case of an emergency. // This particular exit function is the only one that remains available because it is the simplest one, and // therefore the one with the lowest likelihood of errors. uint256 bptAmountIn = userData.exactBptInForTokensOut(); // Note that there is no minimum amountOut parameter: this is handled by `IVault.exitPool`. uint256[] memory amountsOut = StableMath._calcTokensOutGivenExactBptIn(balances, bptAmountIn, totalSupply()); return (bptAmountIn, amountsOut); } function _exitBPTInForExactTokensOut( uint256[] memory balances, uint256[] memory scalingFactors, bytes memory userData ) private view whenNotPaused returns (uint256, uint256[] memory) { // This exit function is disabled if the contract is paused. (uint256[] memory amountsOut, uint256 maxBPTAmountIn) = userData.bptInForExactTokensOut(); InputHelpers.ensureInputLengthMatch(amountsOut.length, _getTotalTokens()); _upscaleArray(amountsOut, scalingFactors); (uint256 currentAmp, ) = _getAmplificationParameter(); uint256 bptAmountIn = StableMath._calcBptInGivenExactTokensOut( currentAmp, balances, amountsOut, totalSupply(), getSwapFeePercentage() ); _require(bptAmountIn <= maxBPTAmountIn, Errors.BPT_IN_MAX_AMOUNT); return (bptAmountIn, amountsOut); } // Helpers /** * @dev Stores the last measured invariant, and the amplification parameter used to compute it. */ function _updateLastInvariant(uint256 invariant, uint256 amplificationParameter) internal { _lastInvariant = invariant; _lastInvariantAmp = amplificationParameter; } /** * @dev Returns the amount of protocol fees to pay, given the value of the last stored invariant and the current * balances. */ function _getDueProtocolFeeAmounts(uint256[] memory balances, uint256 protocolSwapFeePercentage) private view returns (uint256[] memory) { // Initialize with zeros uint256[] memory dueProtocolFeeAmounts = new uint256[](_getTotalTokens()); // Early return if the protocol swap fee percentage is zero, saving gas. if (protocolSwapFeePercentage == 0) { return dueProtocolFeeAmounts; } // Instead of paying the protocol swap fee in all tokens proportionally, we will pay it in a single one. This // will reduce gas costs for single asset joins and exits, as at most only two Pool balances will change (the // token joined/exited, and the token in which fees will be paid). // The protocol fee is charged using the token with the highest balance in the pool. uint256 chosenTokenIndex = 0; uint256 maxBalance = balances[0]; for (uint256 i = 1; i < _getTotalTokens(); ++i) { uint256 currentBalance = balances[i]; if (currentBalance > maxBalance) { chosenTokenIndex = i; maxBalance = currentBalance; } } // Set the fee amount to pay in the selected token dueProtocolFeeAmounts[chosenTokenIndex] = StableMath._calcDueTokenProtocolSwapFeeAmount( _lastInvariantAmp, balances, _lastInvariant, chosenTokenIndex, protocolSwapFeePercentage ); return dueProtocolFeeAmounts; } /** * @dev Computes and stores the value of the invariant after a join, which is required to compute due protocol fees * in the future. */ function _updateInvariantAfterJoin(uint256[] memory balances, uint256[] memory amountsIn) private { _mutateAmounts(balances, amountsIn, FixedPoint.add); (uint256 currentAmp, ) = _getAmplificationParameter(); // This invariant is used only to compute the final balance when calculating the protocol fees. These are // rounded down, so we round the invariant up. _updateLastInvariant(StableMath._calculateInvariant(currentAmp, balances, true), currentAmp); } /** * @dev Computes and stores the value of the invariant after an exit, which is required to compute due protocol fees * in the future. */ function _updateInvariantAfterExit(uint256[] memory balances, uint256[] memory amountsOut) private { _mutateAmounts(balances, amountsOut, FixedPoint.sub); (uint256 currentAmp, ) = _getAmplificationParameter(); // This invariant is used only to compute the final balance when calculating the protocol fees. These are // rounded down, so we round the invariant up. _updateLastInvariant(StableMath._calculateInvariant(currentAmp, balances, true), currentAmp); } /** * @dev Mutates `amounts` by applying `mutation` with each entry in `arguments`. * * Equivalent to `amounts = amounts.map(mutation)`. */ function _mutateAmounts( uint256[] memory toMutate, uint256[] memory arguments, function(uint256, uint256) pure returns (uint256) mutation ) private view { for (uint256 i = 0; i < _getTotalTokens(); ++i) { toMutate[i] = mutation(toMutate[i], arguments[i]); } } /** * @dev This function returns the appreciation of one BPT relative to the * underlying tokens. This starts at 1 when the pool is created and grows over time */ function getRate() public view virtual override returns (uint256) { (, uint256[] memory balances, ) = getVault().getPoolTokens(getPoolId()); _upscaleArray(balances, _scalingFactors()); (uint256 currentAmp, ) = _getAmplificationParameter(); return StableMath._getRate(balances, currentAmp, totalSupply()); } // Amplification /** * @dev Begins changing the amplification parameter to `rawEndValue` over time. The value will change linearly until * `endTime` is reached, when it will be `rawEndValue`. * * NOTE: Internally, the amplification parameter is represented using higher precision. The values returned by * `getAmplificationParameter` have to be corrected to account for this when comparing to `rawEndValue`. */ function startAmplificationParameterUpdate(uint256 rawEndValue, uint256 endTime) external authenticate { _require(rawEndValue >= StableMath._MIN_AMP, Errors.MIN_AMP); _require(rawEndValue <= StableMath._MAX_AMP, Errors.MAX_AMP); uint256 duration = Math.sub(endTime, block.timestamp); _require(duration >= _MIN_UPDATE_TIME, Errors.AMP_END_TIME_TOO_CLOSE); (uint256 currentValue, bool isUpdating) = _getAmplificationParameter(); _require(!isUpdating, Errors.AMP_ONGOING_UPDATE); uint256 endValue = Math.mul(rawEndValue, StableMath._AMP_PRECISION); // daily rate = (endValue / currentValue) / duration * 1 day // We perform all multiplications first to not reduce precision, and round the division up as we want to avoid // large rates. Note that these are regular integer multiplications and divisions, not fixed point. uint256 dailyRate = endValue > currentValue ? Math.divUp(Math.mul(1 days, endValue), Math.mul(currentValue, duration)) : Math.divUp(Math.mul(1 days, currentValue), Math.mul(endValue, duration)); _require(dailyRate <= _MAX_AMP_UPDATE_DAILY_RATE, Errors.AMP_RATE_TOO_HIGH); _setAmplificationData(currentValue, endValue, block.timestamp, endTime); } /** * @dev Stops the amplification parameter change process, keeping the current value. */ function stopAmplificationParameterUpdate() external authenticate { (uint256 currentValue, bool isUpdating) = _getAmplificationParameter(); _require(isUpdating, Errors.AMP_NO_ONGOING_UPDATE); _setAmplificationData(currentValue); } function _isOwnerOnlyAction(bytes32 actionId) internal view virtual override returns (bool) { return (actionId == getActionId(StablePool.startAmplificationParameterUpdate.selector)) || (actionId == getActionId(StablePool.stopAmplificationParameterUpdate.selector)) || super._isOwnerOnlyAction(actionId); } function getAmplificationParameter() external view returns ( uint256 value, bool isUpdating, uint256 precision ) { (value, isUpdating) = _getAmplificationParameter(); precision = StableMath._AMP_PRECISION; } function _getAmplificationParameter() internal view returns (uint256 value, bool isUpdating) { (uint256 startValue, uint256 endValue, uint256 startTime, uint256 endTime) = _getAmplificationData(); // Note that block.timestamp >= startTime, since startTime is set to the current time when an update starts if (block.timestamp < endTime) { isUpdating = true; // We can skip checked arithmetic as: // - block.timestamp is always larger or equal to startTime // - endTime is always larger than startTime // - the value delta is bounded by the largest amplification parameter, which never causes the // multiplication to overflow. // This also means that the following computation will never revert nor yield invalid results. if (endValue > startValue) { value = startValue + ((endValue - startValue) * (block.timestamp - startTime)) / (endTime - startTime); } else { value = startValue - ((startValue - endValue) * (block.timestamp - startTime)) / (endTime - startTime); } } else { isUpdating = false; value = endValue; } } function _getMaxTokens() internal pure override returns (uint256) { return StableMath._MAX_STABLE_TOKENS; } function _getTotalTokens() internal view virtual override returns (uint256) { return _totalTokens; } function _scalingFactor(IERC20 token) internal view virtual override returns (uint256) { // prettier-ignore if (_isToken0(token)) { return _getScalingFactor0(); } else if (_isToken1(token)) { return _getScalingFactor1(); } else if (token == _token2) { return _getScalingFactor2(); } else if (token == _token3) { return _getScalingFactor3(); } else if (token == _token4) { return _getScalingFactor4(); } else { _revert(Errors.INVALID_TOKEN); } } function _scalingFactors() internal view virtual override returns (uint256[] memory) { uint256 totalTokens = _getTotalTokens(); uint256[] memory scalingFactors = new uint256[](totalTokens); // prettier-ignore { scalingFactors[0] = _getScalingFactor0(); scalingFactors[1] = _getScalingFactor1(); if (totalTokens > 2) { scalingFactors[2] = _getScalingFactor2(); } else { return scalingFactors; } if (totalTokens > 3) { scalingFactors[3] = _getScalingFactor3(); } else { return scalingFactors; } if (totalTokens > 4) { scalingFactors[4] = _getScalingFactor4(); } else { return scalingFactors; } } return scalingFactors; } function _setAmplificationData(uint256 value) private { _storeAmplificationData(value, value, block.timestamp, block.timestamp); emit AmpUpdateStopped(value); } function _setAmplificationData( uint256 startValue, uint256 endValue, uint256 startTime, uint256 endTime ) private { _storeAmplificationData(startValue, endValue, startTime, endTime); emit AmpUpdateStarted(startValue, endValue, startTime, endTime); } function _storeAmplificationData( uint256 startValue, uint256 endValue, uint256 startTime, uint256 endTime ) private { _packedAmplificationData = WordCodec.encodeUint(uint64(startValue), 0) | WordCodec.encodeUint(uint64(endValue), 64) | WordCodec.encodeUint(uint64(startTime), 64 * 2) | WordCodec.encodeUint(uint64(endTime), 64 * 3); } function _getAmplificationData() private view returns ( uint256 startValue, uint256 endValue, uint256 startTime, uint256 endTime ) { startValue = _packedAmplificationData.decodeUint64(0); endValue = _packedAmplificationData.decodeUint64(64); startTime = _packedAmplificationData.decodeUint64(64 * 2); endTime = _packedAmplificationData.decodeUint64(64 * 3); } function _isToken0(IERC20 token) internal view returns (bool) { return token == _token0; } function _isToken1(IERC20 token) internal view returns (bool) { return token == _token1; } function _getScalingFactor0() internal view returns (uint256) { return _scalingFactor0; } function _getScalingFactor1() internal view returns (uint256) { return _scalingFactor1; } function _getScalingFactor2() internal view returns (uint256) { return _scalingFactor2; } function _getScalingFactor3() internal view returns (uint256) { return _scalingFactor3; } function _getScalingFactor4() internal view returns (uint256) { return _scalingFactor4; } } contract StablePoolFactory is BasePoolFactory, FactoryWidePauseWindow { constructor(IVault vault) BasePoolFactory(vault) { // solhint-disable-previous-line no-empty-blocks } /** * @dev Deploys a new `StablePool`. */ function create( string memory name, string memory symbol, IERC20[] memory tokens, uint256 amplificationParameter, uint256 swapFeePercentage, address owner ) external returns (address) { (uint256 pauseWindowDuration, uint256 bufferPeriodDuration) = getPauseConfiguration(); address pool = address( new StablePool( getVault(), name, symbol, tokens, amplificationParameter, swapFeePercentage, pauseWindowDuration, bufferPeriodDuration, owner ) ); _register(pool); return pool; } }
Contract ABI
[{"type":"constructor","stateMutability":"nonpayable","inputs":[{"type":"address","name":"vault","internalType":"contract IVault"}]},{"type":"event","name":"PoolCreated","inputs":[{"type":"address","name":"pool","internalType":"address","indexed":true}],"anonymous":false},{"type":"function","stateMutability":"nonpayable","outputs":[{"type":"address","name":"","internalType":"address"}],"name":"create","inputs":[{"type":"string","name":"name","internalType":"string"},{"type":"string","name":"symbol","internalType":"string"},{"type":"address[]","name":"tokens","internalType":"contract IERC20[]"},{"type":"uint256","name":"amplificationParameter","internalType":"uint256"},{"type":"uint256","name":"swapFeePercentage","internalType":"uint256"},{"type":"address","name":"owner","internalType":"address"}]},{"type":"function","stateMutability":"view","outputs":[{"type":"uint256","name":"pauseWindowDuration","internalType":"uint256"},{"type":"uint256","name":"bufferPeriodDuration","internalType":"uint256"}],"name":"getPauseConfiguration","inputs":[]},{"type":"function","stateMutability":"view","outputs":[{"type":"address","name":"","internalType":"contract IVault"}],"name":"getVault","inputs":[]},{"type":"function","stateMutability":"view","outputs":[{"type":"bool","name":"","internalType":"bool"}],"name":"isPoolFromFactory","inputs":[{"type":"address","name":"pool","internalType":"address"}]}]
Contract Creation Code
0x60c060405234801561001057600080fd5b5060405161588f38038061588f83398101604081905261002f9161004d565b60601b6001600160601b0319166080526276a700420160a05261007b565b60006020828403121561005e578081fd5b81516001600160a01b0381168114610074578182fd5b9392505050565b60805160601c60a0516157ea6100a56000398060d652806101005250806101e152506157ea6000f3fe60806040523480156200001157600080fd5b5060043610620000525760003560e01c80632da47c4014620000575780636634b753146200007a5780637932c7f314620000a05780638d928af814620000c6575b600080fd5b62000061620000d0565b604051620000719291906200054e565b60405180910390f35b620000916200008b366004620002d6565b6200013c565b6040516200007191906200048c565b620000b7620000b1366004620002fc565b6200015e565b60405162000071919062000478565b620000b7620001df565b600080427f00000000000000000000000000000000000000000000000000000000000000008110156200012e57807f000000000000000000000000000000000000000000000000000000000000000003925062278d00915062000137565b60009250600091505b509091565b6001600160a01b03811660009081526020819052604090205460ff165b919050565b60008060006200016d620000d0565b9150915060006200017d620001df565b8a8a8a8a8a88888c60405162000193906200024f565b620001a79998979695949392919062000497565b604051809103906000f080158015620001c4573d6000803e3d6000fd5b509050620001d28162000203565b9998505050505050505050565b7f000000000000000000000000000000000000000000000000000000000000000090565b6001600160a01b038116600081815260208190526040808220805460ff19166001179055517f83a48fbcfc991335314e74d0496aab6a1987e992ddc85dddbcc4d6dd6ef2e9fc9190a250565b61521a806200059b83390190565b8035620001598162000581565b600082601f8301126200027b578081fd5b813567ffffffffffffffff8111156200029057fe5b620002a5601f8201601f19166020016200055c565b9150808252836020828501011115620002bd57600080fd5b8060208401602084013760009082016020015292915050565b600060208284031215620002e8578081fd5b8135620002f58162000581565b9392505050565b60008060008060008060c0878903121562000315578182fd5b863567ffffffffffffffff808211156200032d578384fd5b6200033b8a838b016200026a565b975060209150818901358181111562000352578485fd5b620003608b828c016200026a565b97505060408901358181111562000375578485fd5b8901601f81018b1362000386578485fd5b8035828111156200039357fe5b8381029250620003a58484016200055c565b8181528481019083860185850187018f1015620003c0578889fd5b8895505b83861015620003ed57620003d8816200025d565b835260019590950194918601918601620003c4565b509850505050606089013594505050608087013591506200041160a088016200025d565b90509295509295509295565b6001600160a01b03169052565b60008151808452815b81811015620004515760208185018101518683018201520162000433565b81811115620004635782602083870101525b50601f01601f19169290920160200192915050565b6001600160a01b0391909116815260200190565b901515815260200190565b6001600160a01b038a81168252610120602080840182905260009290620004c18584018e6200042a565b92508483036040860152620004d7838d6200042a565b85810360608701528b51808252828d01945090820190855b818110156200050f578551851683529483019491830191600101620004ef565b5050809450505050508660808301528560a08301528460c08301528360e0830152620005406101008301846200041d565b9a9950505050505050505050565b918252602082015260400190565b60405181810167ffffffffffffffff811182821017156200057957fe5b604052919050565b6001600160a01b03811681146200059757600080fd5b5056fe6103206040527f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9610120523480156200003757600080fd5b506040516200521a3803806200521a8339810160408190526200005a9162000adc565b8886516002146200006d57600062000070565b60025b8989898a516001600160401b03811180156200008b57600080fd5b50604051908082528060200260200182016040528015620000b6578160200160208202803683370190505b5089898989828289898d8280604051806040016040528060018152602001603160f81b81525085858a336001600160a01b031660001b806080818152505050806001600160a01b031660a0816001600160a01b031660601b815250505081600390805190602001906200012b929190620008fe565b50805162000141906004906020840190620008fe565b505060058054601260ff1990911617905550815160209283012060c052805191012060e052507f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f6101005260601b6001600160601b0319166101405250620001b490506276a70083111561019462000569565b620001c862278d0082111561019562000569565b4290910161016081905201610180528551620001ea906002111560c862000569565b62000204620001f86200057e565b8751111560c962000569565b6200021a866200058360201b620010061760201c565b62000225846200058f565b6040516309b2760f60e01b81526000906001600160a01b038c16906309b2760f9062000256908d9060040162000c74565b602060405180830381600087803b1580156200027157600080fd5b505af115801562000286573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620002ac919062000ac3565b604051633354e3e960e11b81529091506001600160a01b038c16906366a9c7d290620002e19084908b908b9060040162000bda565b600060405180830381600087803b158015620002fc57600080fd5b505af115801562000311573d6000803e3d6000fd5b5050506101a091909152506200033c9950505060018d1015965061012c955050620005699350505050565b6200034f61138886111561012d62000569565b85516101c0819052865187906000906200036557fe5b60200260200101516001600160a01b03166101e0816001600160a01b031660601b81525050866001815181106200039857fe5b60200260200101516001600160a01b0316610200816001600160a01b031660601b8152505060028111620003ce576000620003e5565b86600281518110620003dc57fe5b60200260200101515b60601b6001600160601b0319166102205260038111620004075760006200041e565b866003815181106200041557fe5b60200260200101515b60601b6001600160601b03191661024052600481116200044057600062000457565b866004815181106200044e57fe5b60200260200101515b6001600160a01b0316610260816001600160a01b031660601b815250506200049a876000815181106200048657fe5b60200260200101516200061b60201b60201c565b610280528651620004b390889060019081106200048657fe5b6102a05260028111620004c8576000620004da565b620004da876002815181106200048657fe5b6102c05260038111620004ef57600062000501565b62000501876003815181106200048657fe5b6102e052600481116200051657600062000528565b62000528876004815181106200048657fe5b610300818152505060006200054b876103e8620006ef60201b620010101760201c565b905062000558816200071e565b505050505050505050505062000ccc565b816200057a576200057a816200075d565b5050565b600590565b806200057a81620007b0565b620005a464e8d4a5100082101560cb62000569565b620005bc67016345785d8a000082111560ca62000569565b620005db8160c06008546200083d60201b62001034179092919060201c565b6008556040517fa9ba3ffe0b6c366b81232caab38605a0699ad5398d6cce76f91ee809e322dafc906200061090839062000c89565b60405180910390a150565b60006001600160a01b0382163014156200063f5750670de0b6b3a7640000620006ea565b6000826001600160a01b031663313ce5676040518163ffffffff1660e01b815260040160206040518083038186803b1580156200067b57600080fd5b505afa15801562000690573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620006b6919062000bb7565b60ff1690506000620006d56012836200085260201b620010491760201c565b905080600a0a670de0b6b3a764000002925050505b919050565b6000828202620007178415806200070f5750838583816200070c57fe5b04145b600362000569565b9392505050565b6200072c818042806200086a565b7fa0d01593e47e69d07e0ccd87bece09411e07dd1ed40ca8f2e7af2976542a02338160405162000610919062000c89565b62461bcd60e51b6000908152602060045260076024526642414c23000030600a808404818106603090810160081b95839006959095019082900491820690940160101b939093010160c81b604452606490fd5b600281511015620007c1576200083a565b600081600081518110620007d157fe5b602002602001015190506000600190505b825181101562000837576000838281518110620007fb57fe5b602002602001015190506200082c816001600160a01b0316846001600160a01b03161060656200056960201b60201c565b9150600101620007e2565b50505b50565b6001600160401b03811b1992909216911b1790565b60006200086483831115600162000569565b50900390565b6200088b816001600160401b031660c0620008fa60201b6200105f1760201c565b620008ac836001600160401b03166080620008fa60201b6200105f1760201c565b620008cd856001600160401b03166040620008fa60201b6200105f1760201c565b620008ee876001600160401b03166000620008fa60201b6200105f1760201c565b17171760095550505050565b1b90565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106200094157805160ff191683800117855562000971565b8280016001018555821562000971579182015b828111156200097157825182559160200191906001019062000954565b506200097f92915062000983565b5090565b5b808211156200097f576000815560010162000984565b8051620006ea8162000cb6565b600082601f830112620009b8578081fd5b81516001600160401b03811115620009cc57fe5b6020808202620009de82820162000c92565b83815293508184018583018287018401881015620009fb57600080fd5b600092505b8483101562000a2b57805162000a168162000cb6565b82526001929092019190830190830162000a00565b505050505092915050565b600082601f83011262000a47578081fd5b81516001600160401b0381111562000a5b57fe5b602062000a71601f8301601f1916820162000c92565b9250818352848183860101111562000a8857600080fd5b60005b8281101562000aa857848101820151848201830152810162000a8b565b8281111562000aba5760008284860101525b50505092915050565b60006020828403121562000ad5578081fd5b5051919050565b60008060008060008060008060006101208a8c03121562000afb578485fd5b62000b068a6200099a565b60208b01519099506001600160401b038082111562000b23578687fd5b62000b318d838e0162000a36565b995060408c015191508082111562000b47578687fd5b62000b558d838e0162000a36565b985060608c015191508082111562000b6b578687fd5b5062000b7a8c828d01620009a7565b96505060808a0151945060a08a0151935060c08a0151925060e08a0151915062000ba86101008b016200099a565b90509295985092959850929598565b60006020828403121562000bc9578081fd5b815160ff8116811462000717578182fd5b60006060820185835260206060818501528186518084526080860191508288019350845b8181101562000c255784516001600160a01b03168352938301939183019160010162000bfe565b505084810360408601528551808252908201925081860190845b8181101562000c665782516001600160a01b03168552938301939183019160010162000c3f565b509298975050505050505050565b602081016003831062000c8357fe5b91905290565b90815260200190565b6040518181016001600160401b038111828210171562000cae57fe5b604052919050565b6001600160a01b03811681146200083a57600080fd5b60805160a05160601c60c05160e05161010051610120516101405160601c61016051610180516101a0516101c0516101e05160601c6102005160601c6102205160601c6102405160601c6102605160601c610280516102a0516102c0516102e0516103005161445962000dc16000398061209752508061207352508061204f52508061202b525080612007525080611c6d525080611c2b525080611be95250806128c152508061288f5250806110735250806107e352508061140b5250806113e7525080610ae4525080610d59525080611607525080611649525080611628525080610ac0525080610a4a52506144596000f3fe608060405234801561001057600080fd5b506004361061021c5760003560e01c80636daccffa116101255780639b02cdde116100ad578063aaabadc51161007c578063aaabadc514610475578063d505accf1461047d578063d5c096c414610490578063dd62ed3e146104a3578063eb0f24d6146104b65761021c565b80639b02cdde146104265780639d2c110c1461043c578063a457c2d71461044f578063a9059cbb146104625761021c565b8063851c1bb3116100f4578063851c1bb3146103db57806387ec6817146103ee578063893d20e8146104015780638d928af81461041657806395d89b411461041e5761021c565b80636daccffa1461037d57806370a082311461039457806374f3b009146103a75780637ecebe00146103c85761021c565b8063313ce567116101a85780633950935111610177578063395093511461032657806350dd6ed91461033957806355c676281461034c5780636028bfd414610354578063679aefce146103755761021c565b8063313ce567146102ee5780633644e5151461030357806338e9922e1461030b57806338fff2d01461031e5761021c565b806318160ddd116101ef57806318160ddd146102945780631c0de0511461029c5780631dd746ea146102b357806323b872dd146102c85780632f1a0bc9146102db5761021c565b806301ec954a1461022157806306fdde031461024a578063095ea7b31461025f57806316c38b3c1461027f575b600080fd5b61023461022f366004613ff9565b6104be565b6040516102419190614264565b60405180910390f35b61025261055c565b604051610241919061433a565b61027261026d366004613c8f565b6105f3565b6040516102419190614241565b61029261028d366004613d85565b61060a565b005b61023461061e565b6102a4610624565b6040516102419392919061424c565b6102bb61064d565b6040516102419190614209565b6102726102d6366004613bda565b61065c565b6102926102e93660046140cc565b6106d2565b6102f66107b5565b60405161024191906143a5565b6102346107be565b6102926103193660046140b4565b6107c8565b6102346107e1565b610272610334366004613c8f565b610805565b610292610347366004613ea3565b610840565b61023461085e565b610367610362366004613dbd565b61086f565b60405161024192919061434d565b6102346108a6565b610385610973565b60405161024193929190614366565b6102346103a2366004613b86565b61098e565b6103ba6103b5366004613dbd565b6109ad565b60405161024192919061421c565b6102346103d6366004613b86565b610a2b565b6102346103e9366004613e5f565b610a46565b6103676103fc366004613dbd565b610a98565b610409610abe565b60405161024191906141f5565b610409610ae2565b610252610b06565b61042e610b67565b60405161024192919061437c565b61023461044a366004614069565b610b71565b61027261045d366004613c8f565b610ccf565b610272610470366004613c8f565b610d0d565b610409610d1a565b61029261048b366004613c1a565b610d24565b6103ba61049e366004613dbd565b610e6d565b6102346104b1366004613ba2565b610f9d565b610292610fda565b600084608001516104eb6104d0610ae2565b6001600160a01b0316336001600160a01b03161460cd611063565b6105006104f66107e1565b82146101f4611063565b610512848461050d611071565b611095565b606061051c6110b2565b905060008751600181111561052d57fe5b146105445761053f87878787856111d9565b610551565b6105518787878785611250565b979650505050505050565b60038054604080516020601f60026000196101006001881615020190951694909404938401819004810282018101909252828152606093909290918301828280156105e85780601f106105bd576101008083540402835291602001916105e8565b820191906000526020600020905b8154815290600101906020018083116105cb57829003601f168201915b505050505090505b90565b60006106003384846112b4565b5060015b92915050565b61061261131c565b61061b8161134a565b50565b60025490565b60008060006106316113c8565b15925061063c6113e5565b9150610646611409565b9050909192565b60606106576110b2565b905090565b6000806106698533610f9d565b905061068d336001600160a01b03871614806106855750838210155b61019e611063565b61069885858561142d565b336001600160a01b038616148015906106b357506000198114155b156106c5576106c585338584036112b4565b60019150505b9392505050565b6106da61131c565b6106ea600183101561012c611063565b6106fb61138883111561012d611063565b60006107078242611049565b905061071b6201518082101561013d611063565b60008061072661150d565b91509150610737811561013e611063565b6000610745866103e8611010565b905060008382116107745761076f6107606201518086611010565b61076a8488611010565b611581565b61078e565b61078e6107846201518084611010565b61076a8688611010565b90506107a0600282111561013f611063565b6107ac848342896115b4565b50505050505050565b60055460ff1690565b6000610657611603565b6107d061131c565b6107d86116a0565b61061b816116b5565b7f000000000000000000000000000000000000000000000000000000000000000090565b3360008181526001602090815260408083206001600160a01b0387168452909152812054909161060091859061083b9086611720565b6112b4565b61084861131c565b6108506116a0565b61085a8282611732565b5050565b6008546000906106579060c0611831565b600060606108858651610880611071565b61183e565b61089a8989898989898961184b6118ee61194f565b97509795505050505050565b600060606108b2610ae2565b6001600160a01b031663f94d46686108c86107e1565b6040518263ffffffff1660e01b81526004016108e49190614264565b60006040518083038186803b1580156108fc57600080fd5b505afa158015610910573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526109389190810190613cba565b5091505061094d816109486110b2565b611a72565b600061095761150d565b50905061096c828261096761061e565b611ad3565b9250505090565b600080600061098061150d565b90949093506103e892509050565b6001600160a01b0381166000908152602081905260409020545b919050565b606080886109bc6104d0610ae2565b6109c76104f66107e1565b60606109d16110b2565b90506109dd8882611a72565b60006060806109f28e8e8e8e8e8e8a8f61184b565b925092509250610a028d84611aee565b610a0c82856118ee565b610a1681856118ee565b909550935050505b5097509795505050505050565b6001600160a01b031660009081526006602052604090205490565b60007f000000000000000000000000000000000000000000000000000000000000000082604051602001610a7b9291906141b2565b604051602081830303815290604052805190602001209050919050565b60006060610aa98651610880611071565b61089a89898989898989611af8611b5161194f565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b60048054604080516020601f60026000196101006001881615020190951694909404938401819004810282018101909252828152606093909290918301828280156105e85780601f106105bd576101008083540402835291602001916105e8565b600a54600b549091565b60008360800151610b836104d0610ae2565b610b8e6104f66107e1565b6000610b9d8660200151611bb2565b90506000610bae8760400151611bb2565b9050600087516001811115610bbf57fe5b1415610c4f576000610bd48860600151611cb8565b90506000818960600151039050610bf88960200151610bf38387611cd9565b611ce5565b60608901829052610c098885611cd9565b9750610c158784611cd9565b9650610c25896060015185611cd9565b60608a01526000610c378a8a8a611cf7565b9050610c438185611d30565b96505050505050610cc7565b610c598683611cd9565b9550610c658582611cd9565b9450610c75876060015182611cd9565b60608801526000610c87888888611d3c565b9050610c938184611d6b565b90506000610ca082611d77565b905060008282039050610cbb8a60200151610bf38388611cd9565b509450610cc792505050565b509392505050565b600080610cdc3385610f9d565b9050808310610cf657610cf1338560006112b4565b610d03565b610d0333858584036112b4565b5060019392505050565b600061060033848461142d565b6000610657611d9d565b610d328442111560d1611063565b6001600160a01b0387166000908152600660209081526040808320549051909291610d89917f0000000000000000000000000000000000000000000000000000000000000000918c918c918c9188918d910161428c565b6040516020818303038152906040528051906020012090506000610dac82611e17565b9050600060018288888860405160008152602001604052604051610dd3949392919061431c565b6020604051602081039080840390855afa158015610df5573d6000803e3d6000fd5b5050604051601f1901519150610e3790506001600160a01b03821615801590610e2f57508b6001600160a01b0316826001600160a01b0316145b6101f8611063565b6001600160a01b038b166000908152600660205260409020600185019055610e608b8b8b6112b4565b5050505050505050505050565b60608088610e7c6104d0610ae2565b610e876104f66107e1565b6060610e916110b2565b9050610e9b61061e565b610f4d5760006060610eb08d8d8d868b611e33565b91509150610ec9610ebf611ec2565b83101560cc611063565b610edb6000610ed6611ec2565b611ec9565b610eee8b610ee7611ec2565b8403611ec9565b610ef88184611b51565b80610f01611071565b6001600160401b0381118015610f1657600080fd5b50604051908082528060200260200182016040528015610f40578160200160208202803683370190505b5095509550505050610a1e565b610f578882611a72565b6000606080610f6c8e8e8e8e8e8e8a8f611af8565b925092509250610f7c8c84611ec9565b610f868285611b51565b610f9081856118ee565b9095509350610a1e915050565b6000610fa7610ae2565b6001600160a01b0316826001600160a01b03161415610fc95750600019610604565b610fd38383611ed3565b9050610604565b610fe261131c565b600080610fed61150d565b91509150610ffd81610140611063565b61085a82611efe565b8061085a81611f39565b60008282026106cb84158061102d57508385838161102a57fe5b04145b6003611063565b6001600160401b03811b1992909216911b1790565b6000611059838311156001611063565b50900390565b1b90565b8161085a5761085a81611fb2565b7f000000000000000000000000000000000000000000000000000000000000000090565b6110ad81841080156110a657508183105b6064611063565b505050565b606060006110be611071565b90506060816001600160401b03811180156110d857600080fd5b50604051908082528060200260200182016040528015611102578160200160208202803683370190505b50905061110d612005565b8160008151811061111a57fe5b60200260200101818152505061112e612029565b8160018151811061113b57fe5b60200260200101818152505060028211156111765761115861204d565b8160028151811061116557fe5b60200260200101818152505061117f565b91506105f09050565b600382111561117657611190612071565b8160038151811061119d57fe5b6020026020010181815250506004821115611176576111ba612095565b816004815181106111c757fe5b60200260200101818152505091505090565b60006111e58583611a72565b61120686606001518385815181106111f957fe5b6020026020010151611cd9565b60608701526000611219878787876120b9565b90506112388184878151811061122b57fe5b6020026020010151611d6b565b905061124381611d77565b9150505b95945050505050565b600061125f8660600151611cb8565b606087015261126e8583611a72565b61128286606001518386815181106111f957fe5b6060870152600061129587878787612102565b9050611243818486815181106112a757fe5b6020026020010151611d30565b6001600160a01b0380841660008181526001602090815260408083209487168084529490915290819020849055517f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9259061130f908590614264565b60405180910390a3505050565b60006113336000356001600160e01b031916610a46565b905061061b611342823361213d565b610191611063565b801561136a5761136561135b6113e5565b4210610193611063565b61137f565b61137f611375611409565b42106101a9611063565b6007805460ff19168215151790556040517f9e3a5e37224532dea67b89face185703738a228a6e8a23dee546960180d3be64906113bd908390614241565b60405180910390a150565b60006113d2611409565b42118061065757505060075460ff161590565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b6114446001600160a01b0384161515610198611063565b61145b6001600160a01b0383161515610199611063565b6114668383836110ad565b6001600160a01b03831660009081526020819052604090205461148c90826101a0612226565b6001600160a01b0380851660009081526020819052604080822093909355908416815220546114bb9082611720565b6001600160a01b0380841660008181526020819052604090819020939093559151908516907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9061130f908590614264565b60008060008060008061151e61223c565b93509350935093508042101561157157600194508383111561155557818103824203858503028161154b57fe5b048401955061156c565b818103824203848603028161156657fe5b04840395505b611579565b600094508295505b505050509091565b60006115908215156004611063565b8261159d57506000610604565b8160018403816115a957fe5b046001019050610604565b6115c084848484612293565b7f1835882ee7a34ac194f717a35e09bb1d24c82a3b9d854ab6c9749525b714cdf2848484846040516115f5949392919061438a565b60405180910390a150505050565b60007f00000000000000000000000000000000000000000000000000000000000000007f00000000000000000000000000000000000000000000000000000000000000007f00000000000000000000000000000000000000000000000000000000000000006116706122ef565b306040516020016116859594939291906142c0565b60405160208183030381529060405280519060200120905090565b6116b36116ab6113c8565b610192611063565b565b6116c864e8d4a5100082101560cb611063565b6116de67016345785d8a000082111560ca611063565b6008546116ed908260c0611034565b6008556040517fa9ba3ffe0b6c366b81232caab38605a0699ad5398d6cce76f91ee809e322dafc906113bd908390614264565b60008282016106cb8482101583611063565b600061173c6107e1565b90506000611748610ae2565b6001600160a01b031663b05f8e4883866040518363ffffffff1660e01b8152600401611775929190614305565b60806040518083038186803b15801561178d57600080fd5b505afa1580156117a1573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906117c591906140ed565b604051630639cdb560e21b81529094506001600160a01b03851693506318e736d492506117f99150859087906004016142ec565b600060405180830381600087803b15801561181357600080fd5b505af1158015611827573d6000803e3d6000fd5b5050505050505050565b1c6001600160401b031690565b61085a8183146067611063565b60006060806118586113c8565b1561187b5761186788876122f3565b905061187688826110496123df565b6118c6565b611883611071565b6001600160401b038111801561189857600080fd5b506040519080825280602002602001820160405280156118c2578160200160208202803683370190505b5090505b6118d188868661244a565b90935091506118e088836124d5565b985098509895505050505050565b60005b6118f9611071565b8110156110ad5761193083828151811061190f57fe5b602002602001015183838151811061192357fe5b6020026020010151612504565b83828151811061193c57fe5b60209081029190910101526001016118f1565b333014611a0d576000306001600160a01b03166000366040516119739291906141ca565b6000604051808303816000865af19150503d80600081146119b0576040519150601f19603f3d011682016040523d82523d6000602084013e6119b5565b606091505b5050905080600081146119c457fe5b60046000803e6000516001600160e01b0319166343adbafb60e01b81146119ef573d6000803e3d6000fd5b506020600460003e604060205260243d03602460403e601c3d016000f35b6060611a176110b2565b9050611a238782611a72565b60006060611a3b8c8c8c8c8c8c898d8d63ffffffff16565b5091509150611a4e81848663ffffffff16565b8051601f1982018390526343adbafb603f1983015260200260231982016044820181fd5b60005b611a7d611071565b8110156110ad57611ab4838281518110611a9357fe5b6020026020010151838381518110611aa757fe5b6020026020010151612555565b838281518110611ac057fe5b6020908102919091010152600101611a75565b600080611ae284866000612581565b90506112478184612504565b61085a828261271d565b6000606080611b056116a0565b6060611b1189886122f3565b9050611b2089826110496123df565b60006060611b2f8b89896127d9565b91509150611b3d8b82612832565b909d909c50909a5098505050505050505050565b60005b611b5c611071565b8110156110ad57611b93838281518110611b7257fe5b6020026020010151838381518110611b8657fe5b602002602001015161283f565b838281518110611b9f57fe5b6020908102919091010152600101611b54565b6000611bbd8261288d565b15611bd157611bca612005565b90506109a8565b611bda826128bf565b15611be757611bca612029565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316826001600160a01b03161415611c2957611bca61204d565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316826001600160a01b03161415611c6b57611bca612071565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316826001600160a01b03161415611cad57611bca612095565b6109a8610135611fb2565b600080611ccd611cc661085e565b84906128f1565b90506106cb8382611049565b60006106cb8383612555565b61085a611cf18361292d565b8261085a565b6000611d0e611d04611071565b60021460d2611063565b6060600080611d1e878787612933565b92509250925061055187848484612102565b60006106cb8383612504565b6000611d49611d04611071565b6060600080611d59878787612933565b925092509250610551878484846120b9565b60006106cb838361283f565b6000610604611d96611d8761085e565b670de0b6b3a764000090611049565b839061283f565b6000611da7610ae2565b6001600160a01b031663aaabadc56040518163ffffffff1660e01b815260040160206040518083038186803b158015611ddf57600080fd5b505afa158015611df3573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106579190613e87565b6000611e21611603565b82604051602001610a7b9291906141da565b60006060611e3f6116a0565b6000611e4a846129f4565b9050611e656000826002811115611e5d57fe5b1460ce611063565b6060611e7085612a0a565b9050611e7f8151610880611071565b611e898187611a72565b6000611e9361150d565b5090506000611ea482846001612581565b905080611eb18184612a20565b9b929a509198505050505050505050565b620f424090565b61085a8282612a2b565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b611f0a81824242612293565b7fa0d01593e47e69d07e0ccd87bece09411e07dd1ed40ca8f2e7af2976542a0233816040516113bd9190614264565b600281511015611f485761061b565b600081600081518110611f5757fe5b602002602001015190506000600190505b82518110156110ad576000838281518110611f7f57fe5b60200260200101519050611fa8816001600160a01b0316846001600160a01b0316106065611063565b9150600101611f68565b62461bcd60e51b6000908152602060045260076024526642414c23000030600a808404818106603090810160081b95839006959095019082900491820690940160101b939093010160c81b604452606490fd5b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b60006120c36116a0565b60006120cd61150d565b50905060006120de82876001612581565b905060006120f4838888888c6060015187612ab9565b93505050505b949350505050565b600061210c6116a0565b600061211661150d565b509050600061212782876001612581565b905060006120f4838888888c6060015187612b6e565b600073ba1ba1ba1ba1ba1ba1ba1ba1ba1ba1ba1ba1ba1b61215c610abe565b6001600160a01b031614158015612177575061217783612c07565b1561219f57612184610abe565b6001600160a01b0316336001600160a01b0316149050610604565b6121a7611d9d565b6001600160a01b0316639be2a8848484306040518463ffffffff1660e01b81526004016121d69392919061426d565b60206040518083038186803b1580156121ee57600080fd5b505afa158015612202573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610fd39190613da1565b60006122358484111583611063565b5050900390565b600080600080612258600060095461183190919063ffffffff16565b600954909450612269906040611831565b60095490935061227a906080611831565b60095490925061228b9060c0611831565b905090919293565b6122a7816001600160401b031660c061105f565b6122bb836001600160401b0316608061105f565b6122cf856001600160401b0316604061105f565b6122e3876001600160401b0316600061105f565b17171760095550505050565b4690565b6060806122fe611071565b6001600160401b038111801561231357600080fd5b5060405190808252806020026020018201604052801561233d578160200160208202803683370190505b5090508261234c579050610604565b6000808560008151811061235c57fe5b602002602001015190506000600190505b612375611071565b8110156123ac57600087828151811061238a57fe5b60200260200101519050828111156123a3578193508092505b5060010161236d565b506123be600b5487600a548589612c43565b8383815181106123ca57fe5b60209081029190910101525090949350505050565b60005b6123ea611071565b8110156124445761242584828151811061240057fe5b602002602001015184838151811061241457fe5b60200260200101518463ffffffff16565b84828151811061243157fe5b60209081029190910101526001016123e2565b50505050565b600060606000612459846129f4565b9050600081600281111561246957fe5b1415612483576124798685612ca5565b92509250506124cd565b600181600281111561249157fe5b14156124a1576124798685612d6f565b60028160028111156124af57fe5b14156124c057612479868686612da1565b6124cb610150611fb2565b505b935093915050565b6124e282826110496123df565b60006124ec61150d565b5090506110ad6124fe82856001612581565b82612a20565b60006125138215156004611063565b8261252057506000610604565b670de0b6b3a7640000838102906125439085838161253a57fe5b04146005611063565b82818161254c57fe5b04915050610604565b600082820261256f84158061102d57508385838161102a57fe5b670de0b6b3a764000090049392505050565b81516000908190815b818110156125c2576125b88682815181106125a157fe5b60200260200101518461172090919063ffffffff16565b925060010161258a565b50816125d3576000925050506106cb565b600082878302825b60ff811015612705576000858a6000815181106125f457fe5b60200260200101510290506000600190505b868110156126485761263e612637612631848e858151811061262457fe5b6020026020010151611010565b89611010565b868c612e1d565b9150600101612606565b508394506126bb61268a612671612668612662878c611010565b85611010565b6103e88d612e1d565b61268461267e8a89611010565b88611010565b90611720565b6126b56126a861269e6103e8880386611010565b6103e88e15612e1d565b6126848a60010189611010565b8b612e1d565b9350848411156126e3576001858503116126de57839750505050505050506106cb565b6126fc565b6001848603116126fc57839750505050505050506106cb565b506001016125db565b50612711610141611fb2565b50505050509392505050565b6127346001600160a01b038316151561019b611063565b612740826000836110ad565b6001600160a01b03821660009081526020819052604090205461276690826101a1612226565b6001600160a01b03831660009081526020819052604090205560025461278c9082612e3d565b6002556040516000906001600160a01b038416907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef906127cd908590614264565b60405180910390a35050565b6000606060006127e8846129f4565b905060018160028111156127f857fe5b141561280957612479868686612e4b565b600281600281111561281757fe5b1415612827576124798685612eb5565b6124cb610136611fb2565b6124e282826117206123df565b600061284e8215156004611063565b8261285b57506000610604565b670de0b6b3a7640000838102906128759085838161253a57fe5b82600182038161288157fe5b04600101915050610604565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0390811691161490565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0390811691161490565b600082820261290b84158061102d57508385838161102a57fe5b8061291a576000915050610604565b670de0b6b3a76400006000198201612881565b50600090565b60408051600280825260608281019093526000918291816020016020820280368337019050509250612968866020015161288d565b156129ae576000915060019050848360008151811061298357fe5b602002602001018181525050838360018151811061299d57fe5b6020026020010181815250506129eb565b600090506001915083836000815181106129c457fe5b60200260200101818152505084836001815181106129de57fe5b6020026020010181815250505b93509350939050565b6000818060200190518101906106049190613ef0565b6060818060200190518101906106cb9190613fb5565b600a91909155600b55565b612a37600083836110ad565b600254612a449082611720565b6002556001600160a01b038216600090815260208190526040902054612a6a9082611720565b6001600160a01b0383166000818152602081905260408082209390935591519091907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef906127cd908590614264565b6000612ae183878681518110612acb57fe5b602002602001015161104990919063ffffffff16565b868581518110612aed57fe5b6020026020010181815250506000612b0788888589612f49565b905083878681518110612b1657fe5b602002602001015101878681518110612b2b57fe5b602002602001018181525050612b626001612684898981518110612b4b57fe5b60200260200101518461104990919063ffffffff16565b98975050505050505050565b6000612b9683878781518110612b8057fe5b602002602001015161172090919063ffffffff16565b868681518110612ba257fe5b6020026020010181815250506000612bbc88888588612f49565b905083878781518110612bcb57fe5b602002602001015103878781518110612be057fe5b602002602001018181525050612b626001612c01838a8981518110612acb57fe5b90611049565b6000612c19632f1a0bc960e01b610a46565b821480612c345750612c31637587926b60e11b610a46565b82145b806106045750610604826130f9565b600080612c5287878787612f49565b905080868581518110612c6157fe5b602002602001015111612c78576000915050611247565b600081878681518110612c8757fe5b6020026020010151039050612b62848261255590919063ffffffff16565b60006060612cb16116a0565b600080612cbd8561312b565b91509150612cd5612ccc611071565b82106064611063565b6060612cdf611071565b6001600160401b0381118015612cf457600080fd5b50604051908082528060200260200182016040528015612d1e578160200160208202803683370190505b5090506000612d2b61150d565b509050612d4a81898587612d3d61061e565b612d4561085e565b61314d565b828481518110612d5657fe5b6020908102919091010152509196919550909350505050565b600060606000612d7e84613269565b90506060612d948683612d8f61061e565b61327f565b9196919550909350505050565b60006060612dad6116a0565b60606000612dba85613330565b91509150612dcb8251610880611071565b612dd58287611a72565b6000612ddf61150d565b5090506000612dff828a86612df261061e565b612dfa61085e565b613348565b9050612e0f8382111560cf611063565b989297509195505050505050565b600081612e3357612e2e84846135dc565b6120fa565b6120fa8484611581565b60006106cb83836001612226565b60006060806000612e5b85613330565b91509150612e71612e6a611071565b835161183e565b612e7b8287611a72565b6000612e8561150d565b5090506000612ea5828a86612e9861061e565b612ea061085e565b6135fc565b9050612e0f8382101560d0611063565b60006060600080612ec58561312b565b91509150612ed4612ccc611071565b6060612ede611071565b6001600160401b0381118015612ef357600080fd5b50604051908082528060200260200182016040528015612f1d578160200160208202803683370190505b5090506000612f2a61150d565b509050612d4a81898587612f3c61061e565b612f4461085e565b613878565b600080845186029050600085600081518110612f6157fe5b602002602001015190506000865187600081518110612f7c57fe5b60200260200101510290506000600190505b8751811015612fd557612fba612fb4612fad848b858151811061262457fe5b8a51611010565b886135dc565b9150612fcb8882815181106125a157fe5b9250600101612f8e565b50868581518110612fe257fe5b6020026020010151820391506000612ffa8788611010565b9050600061302661301a6130128461076a8988611010565b6103e8611010565b8a898151811061262457fe5b9050600061304161303a6130128b896135dc565b8690611720565b905060008061305d6130538686611720565b61076a8d86611720565b905060005b60ff8110156130dd5781925061309261307f866126848586611010565b61076a8e612c0188612684886002611010565b9150828211156130bb576001838303116130b6575097506120fa9650505050505050565b6130d5565b6001828403116130d5575097506120fa9650505050505050565b600101613062565b506130e9610142611fb2565b5050505050505050949350505050565b600061310b631c74c91760e11b610a46565b82148061060457506131236350dd6ed960e01b610a46565b909114919050565b600080828060200190518101906131429190613f7f565b909590945092505050565b60008061315c88886001612581565b9050600061317e8261317887613172818b611049565b9061283f565b906128f1565b9050600061318e8a8a848b612f49565b905060006131a2828b8b81518110612acb57fe5b90506000805b8b518110156131e1576131d78c82815181106131c057fe5b60200260200101518361172090919063ffffffff16565b91506001016131a8565b50600061320a828d8d815181106131f457fe5b602002602001015161250490919063ffffffff16565b9050600061321782613955565b9050600061322585836128f1565b905060006132338683611049565b905061325461324d83670de0b6b3a76400008e9003612555565b8290611720565b99505050505050505050509695505050505050565b6000818060200190518101906106cb9190613f52565b6060600061328d8484612504565b9050606085516001600160401b03811180156132a857600080fd5b506040519080825280602002602001820160405280156132d2578160200160208202803683370190505b50905060005b865181101561332657613307838883815181106132f157fe5b602002602001015161255590919063ffffffff16565b82828151811061331357fe5b60209081029190910101526001016132d8565b5095945050505050565b60606000828060200190518101906131429190613f0c565b600080805b865181101561336f576133658782815181106131c057fe5b915060010161334d565b50606085516001600160401b038111801561338957600080fd5b506040519080825280602002602001820160405280156133b3578160200160208202803683370190505b5090506000805b885181101561347a5760006133eb858b84815181106133d557fe5b602002602001015161283f90919063ffffffff16565b90506134278a83815181106133fc57fe5b60200260200101516131728b858151811061341357fe5b60200260200101518d8681518110612acb57fe5b84838151811061343357fe5b60200260200101818152505061346f6134688286858151811061345257fe5b60200260200101516128f190919063ffffffff16565b8490611720565b9250506001016133ba565b50606088516001600160401b038111801561349457600080fd5b506040519080825280602002602001820160405280156134be578160200160208202803683370190505b50905060005b89518110156135895760008482815181106134db57fe5b60200260200101518411156135425760006135046134f886613955565b8d85815181106132f157fe5b90506000613518828d8681518110612acb57fe5b905061353961353282670de0b6b3a76400008d900361283f565b8390611720565b92505050613559565b89828151811061354e57fe5b602002602001015190505b613569818c8481518110612acb57fe5b83838151811061357557fe5b6020908102919091010152506001016134c4565b5060006135988b8b6001612581565b905060006135a88c846000612581565b905060006135b68284612504565b90506135cb6135c482613955565b8b906128f1565b9d9c50505050505050505050505050565b60006135eb8215156004611063565b8183816135f457fe5b049392505050565b600080805b8651811015613623576136198782815181106131c057fe5b9150600101613601565b50606085516001600160401b038111801561363d57600080fd5b50604051908082528060200260200182016040528015613667578160200160208202803683370190505b5090506000805b8851811015613701576000613689858b84815181106131f457fe5b90506136cb8a838151811061369a57fe5b60200260200101516136c58b85815181106136b157fe5b60200260200101518d8681518110612b8057fe5b90612504565b8483815181106136d757fe5b6020026020010181815250506136f6613468828685815181106132f157fe5b92505060010161366e565b50606088516001600160401b038111801561371b57600080fd5b50604051908082528060200260200182016040528015613745578160200160208202803683370190505b50905060005b89518110156138065760008385838151811061376357fe5b602002602001015111156137bf5760006137886134f886670de0b6b3a7640000611049565b9050600061379c828d8681518110612acb57fe5b90506137b661353282670de0b6b3a76400008d9003612555565b925050506137d6565b8982815181106137cb57fe5b602002602001015190505b6137e6818c8481518110612b8057fe5b8383815181106137f257fe5b60209081029190910101525060010161374b565b5060006138158b8b6001612581565b905060006138258c846000612581565b905060006138338284612504565b9050670de0b6b3a76400008111156138685761385a8a670de0b6b3a763ffff198301612555565b975050505050505050611247565b6000975050505050505050611247565b60008061388788886001612581565b9050600061389d8261317887613172818b611720565b905060006138ad8a8a848b612f49565b905060006138d78a8a815181106138c057fe5b60200260200101518361104990919063ffffffff16565b90506000805b8b518110156138ff576138f58c82815181106131c057fe5b91506001016138dd565b506000613912828d8d815181106131f457fe5b9050600061391f82613955565b9050600061392d85836128f1565b9050600061393b8683611049565b905061325461324d83670de0b6b3a76400008e900361283f565b6000670de0b6b3a7640000821061396d576000610604565b50670de0b6b3a76400000390565b80356109a8816143f3565b600082601f830112613996578081fd5b81356139a96139a4826143d6565b6143b3565b8181529150602080830190848101818402860182018710156139ca57600080fd5b60005b848110156139e9578135845292820192908201906001016139cd565b505050505092915050565b600082601f830112613a04578081fd5b8151613a126139a4826143d6565b818152915060208083019084810181840286018201871015613a3357600080fd5b60005b848110156139e957815184529282019290820190600101613a36565b600082601f830112613a62578081fd5b81356001600160401b03811115613a7557fe5b613a88601f8201601f19166020016143b3565b9150808252836020828501011115613a9f57600080fd5b8060208401602084013760009082016020015292915050565b8035600281106109a857600080fd5b6000610120808385031215613ada578182fd5b613ae3816143b3565b915050613aef82613ab8565b8152613afd6020830161397b565b6020820152613b0e6040830161397b565b6040820152606082013560608201526080820135608082015260a082013560a0820152613b3d60c0830161397b565b60c0820152613b4e60e0830161397b565b60e0820152610100808301356001600160401b03811115613b6e57600080fd5b613b7a85828601613a52565b82840152505092915050565b600060208284031215613b97578081fd5b81356106cb816143f3565b60008060408385031215613bb4578081fd5b8235613bbf816143f3565b91506020830135613bcf816143f3565b809150509250929050565b600080600060608486031215613bee578081fd5b8335613bf9816143f3565b92506020840135613c09816143f3565b929592945050506040919091013590565b600080600080600080600060e0888a031215613c34578283fd5b8735613c3f816143f3565b96506020880135613c4f816143f3565b95506040880135945060608801359350608088013560ff81168114613c72578384fd5b9699959850939692959460a0840135945060c09093013592915050565b60008060408385031215613ca1578182fd5b8235613cac816143f3565b946020939093013593505050565b600080600060608486031215613cce578081fd5b83516001600160401b0380821115613ce4578283fd5b818601915086601f830112613cf7578283fd5b8151613d056139a4826143d6565b80828252602080830192508086018b828387028901011115613d25578788fd5b8796505b84871015613d50578051613d3c816143f3565b845260019690960195928101928101613d29565b508901519097509350505080821115613d67578283fd5b50613d74868287016139f4565b925050604084015190509250925092565b600060208284031215613d96578081fd5b81356106cb81614408565b600060208284031215613db2578081fd5b81516106cb81614408565b600080600080600080600060e0888a031215613dd7578081fd5b873596506020880135613de9816143f3565b95506040880135613df9816143f3565b945060608801356001600160401b0380821115613e14578283fd5b613e208b838c01613986565b955060808a0135945060a08a0135935060c08a0135915080821115613e43578283fd5b50613e508a828b01613a52565b91505092959891949750929550565b600060208284031215613e70578081fd5b81356001600160e01b0319811681146106cb578182fd5b600060208284031215613e98578081fd5b81516106cb816143f3565b60008060408385031215613eb5578182fd5b8235613ec0816143f3565b915060208301356001600160401b03811115613eda578182fd5b613ee685828601613a52565b9150509250929050565b600060208284031215613f01578081fd5b81516106cb81614416565b600080600060608486031215613f20578081fd5b8351613f2b81614416565b60208501519093506001600160401b03811115613f46578182fd5b613d74868287016139f4565b60008060408385031215613f64578182fd5b8251613f6f81614416565b6020939093015192949293505050565b600080600060608486031215613f93578081fd5b8351613f9e81614416565b602085015160409095015190969495509392505050565b60008060408385031215613fc7578182fd5b8251613fd281614416565b60208401519092506001600160401b03811115613fed578182fd5b613ee6858286016139f4565b6000806000806080858703121561400e578182fd5b84356001600160401b0380821115614024578384fd5b61403088838901613ac7565b95506020870135915080821115614045578384fd5b5061405287828801613986565b949794965050505060408301359260600135919050565b60008060006060848603121561407d578081fd5b83356001600160401b03811115614092578182fd5b61409e86828701613ac7565b9660208601359650604090950135949350505050565b6000602082840312156140c5578081fd5b5035919050565b600080604083850312156140de578182fd5b50508035926020909101359150565b60008060008060808587031215614102578182fd5b8451935060208501519250604085015191506060850151614122816143f3565b939692955090935050565b6000815180845260208085019450808401835b8381101561415c57815187529582019590820190600101614140565b509495945050505050565b60008151808452815b8181101561418c57602081850181015186830182015201614170565b8181111561419d5782602083870101525b50601f01601f19169290920160200192915050565b9182526001600160e01b031916602082015260240190565b6000828483379101908152919050565b61190160f01b81526002810192909252602282015260420190565b6001600160a01b0391909116815260200190565b6000602082526106cb602083018461412d565b60006040825261422f604083018561412d565b8281036020840152611247818561412d565b901515815260200190565b92151583526020830191909152604082015260600190565b90815260200190565b9283526001600160a01b03918216602084015216604082015260600190565b9586526001600160a01b0394851660208701529290931660408501526060840152608083019190915260a082015260c00190565b9485526020850193909352604084019190915260608301526001600160a01b0316608082015260a00190565b6000838252604060208301526120fa6040830184614167565b9182526001600160a01b0316602082015260400190565b93845260ff9290921660208401526040830152606082015260800190565b6000602082526106cb6020830184614167565b6000838252604060208301526120fa604083018461412d565b9283529015156020830152604082015260600190565b918252602082015260400190565b93845260208401929092526040830152606082015260800190565b60ff91909116815260200190565b6040518181016001600160401b03811182821017156143ce57fe5b604052919050565b60006001600160401b038211156143e957fe5b5060209081020190565b6001600160a01b038116811461061b57600080fd5b801515811461061b57600080fd5b6003811061061b57600080fdfea264697066735822122058c6c5a8359fccab1e3c84b413ff9b890a33a2d4a47d61df7247e9e6a16025a564736f6c63430007030033a2646970667358221220603c754d10ed8e2fe9a549070ca2ec78e8263dd6e2f1b80669354d68adf8a04e64736f6c63430007030033000000000000000000000000a18808989e7eb0fcf0932fd00d007f3c118b78e7
Deployed ByteCode
0x60806040523480156200001157600080fd5b5060043610620000525760003560e01c80632da47c4014620000575780636634b753146200007a5780637932c7f314620000a05780638d928af814620000c6575b600080fd5b62000061620000d0565b604051620000719291906200054e565b60405180910390f35b620000916200008b366004620002d6565b6200013c565b6040516200007191906200048c565b620000b7620000b1366004620002fc565b6200015e565b60405162000071919062000478565b620000b7620001df565b600080427f00000000000000000000000000000000000000000000000000000000633ad2b68110156200012e57807f00000000000000000000000000000000000000000000000000000000633ad2b603925062278d00915062000137565b60009250600091505b509091565b6001600160a01b03811660009081526020819052604090205460ff165b919050565b60008060006200016d620000d0565b9150915060006200017d620001df565b8a8a8a8a8a88888c60405162000193906200024f565b620001a79998979695949392919062000497565b604051809103906000f080158015620001c4573d6000803e3d6000fd5b509050620001d28162000203565b9998505050505050505050565b7f000000000000000000000000a18808989e7eb0fcf0932fd00d007f3c118b78e790565b6001600160a01b038116600081815260208190526040808220805460ff19166001179055517f83a48fbcfc991335314e74d0496aab6a1987e992ddc85dddbcc4d6dd6ef2e9fc9190a250565b61521a806200059b83390190565b8035620001598162000581565b600082601f8301126200027b578081fd5b813567ffffffffffffffff8111156200029057fe5b620002a5601f8201601f19166020016200055c565b9150808252836020828501011115620002bd57600080fd5b8060208401602084013760009082016020015292915050565b600060208284031215620002e8578081fd5b8135620002f58162000581565b9392505050565b60008060008060008060c0878903121562000315578182fd5b863567ffffffffffffffff808211156200032d578384fd5b6200033b8a838b016200026a565b975060209150818901358181111562000352578485fd5b620003608b828c016200026a565b97505060408901358181111562000375578485fd5b8901601f81018b1362000386578485fd5b8035828111156200039357fe5b8381029250620003a58484016200055c565b8181528481019083860185850187018f1015620003c0578889fd5b8895505b83861015620003ed57620003d8816200025d565b835260019590950194918601918601620003c4565b509850505050606089013594505050608087013591506200041160a088016200025d565b90509295509295509295565b6001600160a01b03169052565b60008151808452815b81811015620004515760208185018101518683018201520162000433565b81811115620004635782602083870101525b50601f01601f19169290920160200192915050565b6001600160a01b0391909116815260200190565b901515815260200190565b6001600160a01b038a81168252610120602080840182905260009290620004c18584018e6200042a565b92508483036040860152620004d7838d6200042a565b85810360608701528b51808252828d01945090820190855b818110156200050f578551851683529483019491830191600101620004ef565b5050809450505050508660808301528560a08301528460c08301528360e0830152620005406101008301846200041d565b9a9950505050505050505050565b918252602082015260400190565b60405181810167ffffffffffffffff811182821017156200057957fe5b604052919050565b6001600160a01b03811681146200059757600080fd5b5056fe6103206040527f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9610120523480156200003757600080fd5b506040516200521a3803806200521a8339810160408190526200005a9162000adc565b8886516002146200006d57600062000070565b60025b8989898a516001600160401b03811180156200008b57600080fd5b50604051908082528060200260200182016040528015620000b6578160200160208202803683370190505b5089898989828289898d8280604051806040016040528060018152602001603160f81b81525085858a336001600160a01b031660001b806080818152505050806001600160a01b031660a0816001600160a01b031660601b815250505081600390805190602001906200012b929190620008fe565b50805162000141906004906020840190620008fe565b505060058054601260ff1990911617905550815160209283012060c052805191012060e052507f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f6101005260601b6001600160601b0319166101405250620001b490506276a70083111561019462000569565b620001c862278d0082111561019562000569565b4290910161016081905201610180528551620001ea906002111560c862000569565b62000204620001f86200057e565b8751111560c962000569565b6200021a866200058360201b620010061760201c565b62000225846200058f565b6040516309b2760f60e01b81526000906001600160a01b038c16906309b2760f9062000256908d9060040162000c74565b602060405180830381600087803b1580156200027157600080fd5b505af115801562000286573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620002ac919062000ac3565b604051633354e3e960e11b81529091506001600160a01b038c16906366a9c7d290620002e19084908b908b9060040162000bda565b600060405180830381600087803b158015620002fc57600080fd5b505af115801562000311573d6000803e3d6000fd5b5050506101a091909152506200033c9950505060018d1015965061012c955050620005699350505050565b6200034f61138886111561012d62000569565b85516101c0819052865187906000906200036557fe5b60200260200101516001600160a01b03166101e0816001600160a01b031660601b81525050866001815181106200039857fe5b60200260200101516001600160a01b0316610200816001600160a01b031660601b8152505060028111620003ce576000620003e5565b86600281518110620003dc57fe5b60200260200101515b60601b6001600160601b0319166102205260038111620004075760006200041e565b866003815181106200041557fe5b60200260200101515b60601b6001600160601b03191661024052600481116200044057600062000457565b866004815181106200044e57fe5b60200260200101515b6001600160a01b0316610260816001600160a01b031660601b815250506200049a876000815181106200048657fe5b60200260200101516200061b60201b60201c565b610280528651620004b390889060019081106200048657fe5b6102a05260028111620004c8576000620004da565b620004da876002815181106200048657fe5b6102c05260038111620004ef57600062000501565b62000501876003815181106200048657fe5b6102e052600481116200051657600062000528565b62000528876004815181106200048657fe5b610300818152505060006200054b876103e8620006ef60201b620010101760201c565b905062000558816200071e565b505050505050505050505062000ccc565b816200057a576200057a816200075d565b5050565b600590565b806200057a81620007b0565b620005a464e8d4a5100082101560cb62000569565b620005bc67016345785d8a000082111560ca62000569565b620005db8160c06008546200083d60201b62001034179092919060201c565b6008556040517fa9ba3ffe0b6c366b81232caab38605a0699ad5398d6cce76f91ee809e322dafc906200061090839062000c89565b60405180910390a150565b60006001600160a01b0382163014156200063f5750670de0b6b3a7640000620006ea565b6000826001600160a01b031663313ce5676040518163ffffffff1660e01b815260040160206040518083038186803b1580156200067b57600080fd5b505afa15801562000690573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620006b6919062000bb7565b60ff1690506000620006d56012836200085260201b620010491760201c565b905080600a0a670de0b6b3a764000002925050505b919050565b6000828202620007178415806200070f5750838583816200070c57fe5b04145b600362000569565b9392505050565b6200072c818042806200086a565b7fa0d01593e47e69d07e0ccd87bece09411e07dd1ed40ca8f2e7af2976542a02338160405162000610919062000c89565b62461bcd60e51b6000908152602060045260076024526642414c23000030600a808404818106603090810160081b95839006959095019082900491820690940160101b939093010160c81b604452606490fd5b600281511015620007c1576200083a565b600081600081518110620007d157fe5b602002602001015190506000600190505b825181101562000837576000838281518110620007fb57fe5b602002602001015190506200082c816001600160a01b0316846001600160a01b03161060656200056960201b60201c565b9150600101620007e2565b50505b50565b6001600160401b03811b1992909216911b1790565b60006200086483831115600162000569565b50900390565b6200088b816001600160401b031660c0620008fa60201b6200105f1760201c565b620008ac836001600160401b03166080620008fa60201b6200105f1760201c565b620008cd856001600160401b03166040620008fa60201b6200105f1760201c565b620008ee876001600160401b03166000620008fa60201b6200105f1760201c565b17171760095550505050565b1b90565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106200094157805160ff191683800117855562000971565b8280016001018555821562000971579182015b828111156200097157825182559160200191906001019062000954565b506200097f92915062000983565b5090565b5b808211156200097f576000815560010162000984565b8051620006ea8162000cb6565b600082601f830112620009b8578081fd5b81516001600160401b03811115620009cc57fe5b6020808202620009de82820162000c92565b83815293508184018583018287018401881015620009fb57600080fd5b600092505b8483101562000a2b57805162000a168162000cb6565b82526001929092019190830190830162000a00565b505050505092915050565b600082601f83011262000a47578081fd5b81516001600160401b0381111562000a5b57fe5b602062000a71601f8301601f1916820162000c92565b9250818352848183860101111562000a8857600080fd5b60005b8281101562000aa857848101820151848201830152810162000a8b565b8281111562000aba5760008284860101525b50505092915050565b60006020828403121562000ad5578081fd5b5051919050565b60008060008060008060008060006101208a8c03121562000afb578485fd5b62000b068a6200099a565b60208b01519099506001600160401b038082111562000b23578687fd5b62000b318d838e0162000a36565b995060408c015191508082111562000b47578687fd5b62000b558d838e0162000a36565b985060608c015191508082111562000b6b578687fd5b5062000b7a8c828d01620009a7565b96505060808a0151945060a08a0151935060c08a0151925060e08a0151915062000ba86101008b016200099a565b90509295985092959850929598565b60006020828403121562000bc9578081fd5b815160ff8116811462000717578182fd5b60006060820185835260206060818501528186518084526080860191508288019350845b8181101562000c255784516001600160a01b03168352938301939183019160010162000bfe565b505084810360408601528551808252908201925081860190845b8181101562000c665782516001600160a01b03168552938301939183019160010162000c3f565b509298975050505050505050565b602081016003831062000c8357fe5b91905290565b90815260200190565b6040518181016001600160401b038111828210171562000cae57fe5b604052919050565b6001600160a01b03811681146200083a57600080fd5b60805160a05160601c60c05160e05161010051610120516101405160601c61016051610180516101a0516101c0516101e05160601c6102005160601c6102205160601c6102405160601c6102605160601c610280516102a0516102c0516102e0516103005161445962000dc16000398061209752508061207352508061204f52508061202b525080612007525080611c6d525080611c2b525080611be95250806128c152508061288f5250806110735250806107e352508061140b5250806113e7525080610ae4525080610d59525080611607525080611649525080611628525080610ac0525080610a4a52506144596000f3fe608060405234801561001057600080fd5b506004361061021c5760003560e01c80636daccffa116101255780639b02cdde116100ad578063aaabadc51161007c578063aaabadc514610475578063d505accf1461047d578063d5c096c414610490578063dd62ed3e146104a3578063eb0f24d6146104b65761021c565b80639b02cdde146104265780639d2c110c1461043c578063a457c2d71461044f578063a9059cbb146104625761021c565b8063851c1bb3116100f4578063851c1bb3146103db57806387ec6817146103ee578063893d20e8146104015780638d928af81461041657806395d89b411461041e5761021c565b80636daccffa1461037d57806370a082311461039457806374f3b009146103a75780637ecebe00146103c85761021c565b8063313ce567116101a85780633950935111610177578063395093511461032657806350dd6ed91461033957806355c676281461034c5780636028bfd414610354578063679aefce146103755761021c565b8063313ce567146102ee5780633644e5151461030357806338e9922e1461030b57806338fff2d01461031e5761021c565b806318160ddd116101ef57806318160ddd146102945780631c0de0511461029c5780631dd746ea146102b357806323b872dd146102c85780632f1a0bc9146102db5761021c565b806301ec954a1461022157806306fdde031461024a578063095ea7b31461025f57806316c38b3c1461027f575b600080fd5b61023461022f366004613ff9565b6104be565b6040516102419190614264565b60405180910390f35b61025261055c565b604051610241919061433a565b61027261026d366004613c8f565b6105f3565b6040516102419190614241565b61029261028d366004613d85565b61060a565b005b61023461061e565b6102a4610624565b6040516102419392919061424c565b6102bb61064d565b6040516102419190614209565b6102726102d6366004613bda565b61065c565b6102926102e93660046140cc565b6106d2565b6102f66107b5565b60405161024191906143a5565b6102346107be565b6102926103193660046140b4565b6107c8565b6102346107e1565b610272610334366004613c8f565b610805565b610292610347366004613ea3565b610840565b61023461085e565b610367610362366004613dbd565b61086f565b60405161024192919061434d565b6102346108a6565b610385610973565b60405161024193929190614366565b6102346103a2366004613b86565b61098e565b6103ba6103b5366004613dbd565b6109ad565b60405161024192919061421c565b6102346103d6366004613b86565b610a2b565b6102346103e9366004613e5f565b610a46565b6103676103fc366004613dbd565b610a98565b610409610abe565b60405161024191906141f5565b610409610ae2565b610252610b06565b61042e610b67565b60405161024192919061437c565b61023461044a366004614069565b610b71565b61027261045d366004613c8f565b610ccf565b610272610470366004613c8f565b610d0d565b610409610d1a565b61029261048b366004613c1a565b610d24565b6103ba61049e366004613dbd565b610e6d565b6102346104b1366004613ba2565b610f9d565b610292610fda565b600084608001516104eb6104d0610ae2565b6001600160a01b0316336001600160a01b03161460cd611063565b6105006104f66107e1565b82146101f4611063565b610512848461050d611071565b611095565b606061051c6110b2565b905060008751600181111561052d57fe5b146105445761053f87878787856111d9565b610551565b6105518787878785611250565b979650505050505050565b60038054604080516020601f60026000196101006001881615020190951694909404938401819004810282018101909252828152606093909290918301828280156105e85780601f106105bd576101008083540402835291602001916105e8565b820191906000526020600020905b8154815290600101906020018083116105cb57829003601f168201915b505050505090505b90565b60006106003384846112b4565b5060015b92915050565b61061261131c565b61061b8161134a565b50565b60025490565b60008060006106316113c8565b15925061063c6113e5565b9150610646611409565b9050909192565b60606106576110b2565b905090565b6000806106698533610f9d565b905061068d336001600160a01b03871614806106855750838210155b61019e611063565b61069885858561142d565b336001600160a01b038616148015906106b357506000198114155b156106c5576106c585338584036112b4565b60019150505b9392505050565b6106da61131c565b6106ea600183101561012c611063565b6106fb61138883111561012d611063565b60006107078242611049565b905061071b6201518082101561013d611063565b60008061072661150d565b91509150610737811561013e611063565b6000610745866103e8611010565b905060008382116107745761076f6107606201518086611010565b61076a8488611010565b611581565b61078e565b61078e6107846201518084611010565b61076a8688611010565b90506107a0600282111561013f611063565b6107ac848342896115b4565b50505050505050565b60055460ff1690565b6000610657611603565b6107d061131c565b6107d86116a0565b61061b816116b5565b7f000000000000000000000000000000000000000000000000000000000000000090565b3360008181526001602090815260408083206001600160a01b0387168452909152812054909161060091859061083b9086611720565b6112b4565b61084861131c565b6108506116a0565b61085a8282611732565b5050565b6008546000906106579060c0611831565b600060606108858651610880611071565b61183e565b61089a8989898989898961184b6118ee61194f565b97509795505050505050565b600060606108b2610ae2565b6001600160a01b031663f94d46686108c86107e1565b6040518263ffffffff1660e01b81526004016108e49190614264565b60006040518083038186803b1580156108fc57600080fd5b505afa158015610910573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526109389190810190613cba565b5091505061094d816109486110b2565b611a72565b600061095761150d565b50905061096c828261096761061e565b611ad3565b9250505090565b600080600061098061150d565b90949093506103e892509050565b6001600160a01b0381166000908152602081905260409020545b919050565b606080886109bc6104d0610ae2565b6109c76104f66107e1565b60606109d16110b2565b90506109dd8882611a72565b60006060806109f28e8e8e8e8e8e8a8f61184b565b925092509250610a028d84611aee565b610a0c82856118ee565b610a1681856118ee565b909550935050505b5097509795505050505050565b6001600160a01b031660009081526006602052604090205490565b60007f000000000000000000000000000000000000000000000000000000000000000082604051602001610a7b9291906141b2565b604051602081830303815290604052805190602001209050919050565b60006060610aa98651610880611071565b61089a89898989898989611af8611b5161194f565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b60048054604080516020601f60026000196101006001881615020190951694909404938401819004810282018101909252828152606093909290918301828280156105e85780601f106105bd576101008083540402835291602001916105e8565b600a54600b549091565b60008360800151610b836104d0610ae2565b610b8e6104f66107e1565b6000610b9d8660200151611bb2565b90506000610bae8760400151611bb2565b9050600087516001811115610bbf57fe5b1415610c4f576000610bd48860600151611cb8565b90506000818960600151039050610bf88960200151610bf38387611cd9565b611ce5565b60608901829052610c098885611cd9565b9750610c158784611cd9565b9650610c25896060015185611cd9565b60608a01526000610c378a8a8a611cf7565b9050610c438185611d30565b96505050505050610cc7565b610c598683611cd9565b9550610c658582611cd9565b9450610c75876060015182611cd9565b60608801526000610c87888888611d3c565b9050610c938184611d6b565b90506000610ca082611d77565b905060008282039050610cbb8a60200151610bf38388611cd9565b509450610cc792505050565b509392505050565b600080610cdc3385610f9d565b9050808310610cf657610cf1338560006112b4565b610d03565b610d0333858584036112b4565b5060019392505050565b600061060033848461142d565b6000610657611d9d565b610d328442111560d1611063565b6001600160a01b0387166000908152600660209081526040808320549051909291610d89917f0000000000000000000000000000000000000000000000000000000000000000918c918c918c9188918d910161428c565b6040516020818303038152906040528051906020012090506000610dac82611e17565b9050600060018288888860405160008152602001604052604051610dd3949392919061431c565b6020604051602081039080840390855afa158015610df5573d6000803e3d6000fd5b5050604051601f1901519150610e3790506001600160a01b03821615801590610e2f57508b6001600160a01b0316826001600160a01b0316145b6101f8611063565b6001600160a01b038b166000908152600660205260409020600185019055610e608b8b8b6112b4565b5050505050505050505050565b60608088610e7c6104d0610ae2565b610e876104f66107e1565b6060610e916110b2565b9050610e9b61061e565b610f4d5760006060610eb08d8d8d868b611e33565b91509150610ec9610ebf611ec2565b83101560cc611063565b610edb6000610ed6611ec2565b611ec9565b610eee8b610ee7611ec2565b8403611ec9565b610ef88184611b51565b80610f01611071565b6001600160401b0381118015610f1657600080fd5b50604051908082528060200260200182016040528015610f40578160200160208202803683370190505b5095509550505050610a1e565b610f578882611a72565b6000606080610f6c8e8e8e8e8e8e8a8f611af8565b925092509250610f7c8c84611ec9565b610f868285611b51565b610f9081856118ee565b9095509350610a1e915050565b6000610fa7610ae2565b6001600160a01b0316826001600160a01b03161415610fc95750600019610604565b610fd38383611ed3565b9050610604565b610fe261131c565b600080610fed61150d565b91509150610ffd81610140611063565b61085a82611efe565b8061085a81611f39565b60008282026106cb84158061102d57508385838161102a57fe5b04145b6003611063565b6001600160401b03811b1992909216911b1790565b6000611059838311156001611063565b50900390565b1b90565b8161085a5761085a81611fb2565b7f000000000000000000000000000000000000000000000000000000000000000090565b6110ad81841080156110a657508183105b6064611063565b505050565b606060006110be611071565b90506060816001600160401b03811180156110d857600080fd5b50604051908082528060200260200182016040528015611102578160200160208202803683370190505b50905061110d612005565b8160008151811061111a57fe5b60200260200101818152505061112e612029565b8160018151811061113b57fe5b60200260200101818152505060028211156111765761115861204d565b8160028151811061116557fe5b60200260200101818152505061117f565b91506105f09050565b600382111561117657611190612071565b8160038151811061119d57fe5b6020026020010181815250506004821115611176576111ba612095565b816004815181106111c757fe5b60200260200101818152505091505090565b60006111e58583611a72565b61120686606001518385815181106111f957fe5b6020026020010151611cd9565b60608701526000611219878787876120b9565b90506112388184878151811061122b57fe5b6020026020010151611d6b565b905061124381611d77565b9150505b95945050505050565b600061125f8660600151611cb8565b606087015261126e8583611a72565b61128286606001518386815181106111f957fe5b6060870152600061129587878787612102565b9050611243818486815181106112a757fe5b6020026020010151611d30565b6001600160a01b0380841660008181526001602090815260408083209487168084529490915290819020849055517f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b9259061130f908590614264565b60405180910390a3505050565b60006113336000356001600160e01b031916610a46565b905061061b611342823361213d565b610191611063565b801561136a5761136561135b6113e5565b4210610193611063565b61137f565b61137f611375611409565b42106101a9611063565b6007805460ff19168215151790556040517f9e3a5e37224532dea67b89face185703738a228a6e8a23dee546960180d3be64906113bd908390614241565b60405180910390a150565b60006113d2611409565b42118061065757505060075460ff161590565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b6114446001600160a01b0384161515610198611063565b61145b6001600160a01b0383161515610199611063565b6114668383836110ad565b6001600160a01b03831660009081526020819052604090205461148c90826101a0612226565b6001600160a01b0380851660009081526020819052604080822093909355908416815220546114bb9082611720565b6001600160a01b0380841660008181526020819052604090819020939093559151908516907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef9061130f908590614264565b60008060008060008061151e61223c565b93509350935093508042101561157157600194508383111561155557818103824203858503028161154b57fe5b048401955061156c565b818103824203848603028161156657fe5b04840395505b611579565b600094508295505b505050509091565b60006115908215156004611063565b8261159d57506000610604565b8160018403816115a957fe5b046001019050610604565b6115c084848484612293565b7f1835882ee7a34ac194f717a35e09bb1d24c82a3b9d854ab6c9749525b714cdf2848484846040516115f5949392919061438a565b60405180910390a150505050565b60007f00000000000000000000000000000000000000000000000000000000000000007f00000000000000000000000000000000000000000000000000000000000000007f00000000000000000000000000000000000000000000000000000000000000006116706122ef565b306040516020016116859594939291906142c0565b60405160208183030381529060405280519060200120905090565b6116b36116ab6113c8565b610192611063565b565b6116c864e8d4a5100082101560cb611063565b6116de67016345785d8a000082111560ca611063565b6008546116ed908260c0611034565b6008556040517fa9ba3ffe0b6c366b81232caab38605a0699ad5398d6cce76f91ee809e322dafc906113bd908390614264565b60008282016106cb8482101583611063565b600061173c6107e1565b90506000611748610ae2565b6001600160a01b031663b05f8e4883866040518363ffffffff1660e01b8152600401611775929190614305565b60806040518083038186803b15801561178d57600080fd5b505afa1580156117a1573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906117c591906140ed565b604051630639cdb560e21b81529094506001600160a01b03851693506318e736d492506117f99150859087906004016142ec565b600060405180830381600087803b15801561181357600080fd5b505af1158015611827573d6000803e3d6000fd5b5050505050505050565b1c6001600160401b031690565b61085a8183146067611063565b60006060806118586113c8565b1561187b5761186788876122f3565b905061187688826110496123df565b6118c6565b611883611071565b6001600160401b038111801561189857600080fd5b506040519080825280602002602001820160405280156118c2578160200160208202803683370190505b5090505b6118d188868661244a565b90935091506118e088836124d5565b985098509895505050505050565b60005b6118f9611071565b8110156110ad5761193083828151811061190f57fe5b602002602001015183838151811061192357fe5b6020026020010151612504565b83828151811061193c57fe5b60209081029190910101526001016118f1565b333014611a0d576000306001600160a01b03166000366040516119739291906141ca565b6000604051808303816000865af19150503d80600081146119b0576040519150601f19603f3d011682016040523d82523d6000602084013e6119b5565b606091505b5050905080600081146119c457fe5b60046000803e6000516001600160e01b0319166343adbafb60e01b81146119ef573d6000803e3d6000fd5b506020600460003e604060205260243d03602460403e601c3d016000f35b6060611a176110b2565b9050611a238782611a72565b60006060611a3b8c8c8c8c8c8c898d8d63ffffffff16565b5091509150611a4e81848663ffffffff16565b8051601f1982018390526343adbafb603f1983015260200260231982016044820181fd5b60005b611a7d611071565b8110156110ad57611ab4838281518110611a9357fe5b6020026020010151838381518110611aa757fe5b6020026020010151612555565b838281518110611ac057fe5b6020908102919091010152600101611a75565b600080611ae284866000612581565b90506112478184612504565b61085a828261271d565b6000606080611b056116a0565b6060611b1189886122f3565b9050611b2089826110496123df565b60006060611b2f8b89896127d9565b91509150611b3d8b82612832565b909d909c50909a5098505050505050505050565b60005b611b5c611071565b8110156110ad57611b93838281518110611b7257fe5b6020026020010151838381518110611b8657fe5b602002602001015161283f565b838281518110611b9f57fe5b6020908102919091010152600101611b54565b6000611bbd8261288d565b15611bd157611bca612005565b90506109a8565b611bda826128bf565b15611be757611bca612029565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316826001600160a01b03161415611c2957611bca61204d565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316826001600160a01b03161415611c6b57611bca612071565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316826001600160a01b03161415611cad57611bca612095565b6109a8610135611fb2565b600080611ccd611cc661085e565b84906128f1565b90506106cb8382611049565b60006106cb8383612555565b61085a611cf18361292d565b8261085a565b6000611d0e611d04611071565b60021460d2611063565b6060600080611d1e878787612933565b92509250925061055187848484612102565b60006106cb8383612504565b6000611d49611d04611071565b6060600080611d59878787612933565b925092509250610551878484846120b9565b60006106cb838361283f565b6000610604611d96611d8761085e565b670de0b6b3a764000090611049565b839061283f565b6000611da7610ae2565b6001600160a01b031663aaabadc56040518163ffffffff1660e01b815260040160206040518083038186803b158015611ddf57600080fd5b505afa158015611df3573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106579190613e87565b6000611e21611603565b82604051602001610a7b9291906141da565b60006060611e3f6116a0565b6000611e4a846129f4565b9050611e656000826002811115611e5d57fe5b1460ce611063565b6060611e7085612a0a565b9050611e7f8151610880611071565b611e898187611a72565b6000611e9361150d565b5090506000611ea482846001612581565b905080611eb18184612a20565b9b929a509198505050505050505050565b620f424090565b61085a8282612a2b565b6001600160a01b03918216600090815260016020908152604080832093909416825291909152205490565b611f0a81824242612293565b7fa0d01593e47e69d07e0ccd87bece09411e07dd1ed40ca8f2e7af2976542a0233816040516113bd9190614264565b600281511015611f485761061b565b600081600081518110611f5757fe5b602002602001015190506000600190505b82518110156110ad576000838281518110611f7f57fe5b60200260200101519050611fa8816001600160a01b0316846001600160a01b0316106065611063565b9150600101611f68565b62461bcd60e51b6000908152602060045260076024526642414c23000030600a808404818106603090810160081b95839006959095019082900491820690940160101b939093010160c81b604452606490fd5b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b7f000000000000000000000000000000000000000000000000000000000000000090565b60006120c36116a0565b60006120cd61150d565b50905060006120de82876001612581565b905060006120f4838888888c6060015187612ab9565b93505050505b949350505050565b600061210c6116a0565b600061211661150d565b509050600061212782876001612581565b905060006120f4838888888c6060015187612b6e565b600073ba1ba1ba1ba1ba1ba1ba1ba1ba1ba1ba1ba1ba1b61215c610abe565b6001600160a01b031614158015612177575061217783612c07565b1561219f57612184610abe565b6001600160a01b0316336001600160a01b0316149050610604565b6121a7611d9d565b6001600160a01b0316639be2a8848484306040518463ffffffff1660e01b81526004016121d69392919061426d565b60206040518083038186803b1580156121ee57600080fd5b505afa158015612202573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610fd39190613da1565b60006122358484111583611063565b5050900390565b600080600080612258600060095461183190919063ffffffff16565b600954909450612269906040611831565b60095490935061227a906080611831565b60095490925061228b9060c0611831565b905090919293565b6122a7816001600160401b031660c061105f565b6122bb836001600160401b0316608061105f565b6122cf856001600160401b0316604061105f565b6122e3876001600160401b0316600061105f565b17171760095550505050565b4690565b6060806122fe611071565b6001600160401b038111801561231357600080fd5b5060405190808252806020026020018201604052801561233d578160200160208202803683370190505b5090508261234c579050610604565b6000808560008151811061235c57fe5b602002602001015190506000600190505b612375611071565b8110156123ac57600087828151811061238a57fe5b60200260200101519050828111156123a3578193508092505b5060010161236d565b506123be600b5487600a548589612c43565b8383815181106123ca57fe5b60209081029190910101525090949350505050565b60005b6123ea611071565b8110156124445761242584828151811061240057fe5b602002602001015184838151811061241457fe5b60200260200101518463ffffffff16565b84828151811061243157fe5b60209081029190910101526001016123e2565b50505050565b600060606000612459846129f4565b9050600081600281111561246957fe5b1415612483576124798685612ca5565b92509250506124cd565b600181600281111561249157fe5b14156124a1576124798685612d6f565b60028160028111156124af57fe5b14156124c057612479868686612da1565b6124cb610150611fb2565b505b935093915050565b6124e282826110496123df565b60006124ec61150d565b5090506110ad6124fe82856001612581565b82612a20565b60006125138215156004611063565b8261252057506000610604565b670de0b6b3a7640000838102906125439085838161253a57fe5b04146005611063565b82818161254c57fe5b04915050610604565b600082820261256f84158061102d57508385838161102a57fe5b670de0b6b3a764000090049392505050565b81516000908190815b818110156125c2576125b88682815181106125a157fe5b60200260200101518461172090919063ffffffff16565b925060010161258a565b50816125d3576000925050506106cb565b600082878302825b60ff811015612705576000858a6000815181106125f457fe5b60200260200101510290506000600190505b868110156126485761263e612637612631848e858151811061262457fe5b6020026020010151611010565b89611010565b868c612e1d565b9150600101612606565b508394506126bb61268a612671612668612662878c611010565b85611010565b6103e88d612e1d565b61268461267e8a89611010565b88611010565b90611720565b6126b56126a861269e6103e8880386611010565b6103e88e15612e1d565b6126848a60010189611010565b8b612e1d565b9350848411156126e3576001858503116126de57839750505050505050506106cb565b6126fc565b6001848603116126fc57839750505050505050506106cb565b506001016125db565b50612711610141611fb2565b50505050509392505050565b6127346001600160a01b038316151561019b611063565b612740826000836110ad565b6001600160a01b03821660009081526020819052604090205461276690826101a1612226565b6001600160a01b03831660009081526020819052604090205560025461278c9082612e3d565b6002556040516000906001600160a01b038416907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef906127cd908590614264565b60405180910390a35050565b6000606060006127e8846129f4565b905060018160028111156127f857fe5b141561280957612479868686612e4b565b600281600281111561281757fe5b1415612827576124798685612eb5565b6124cb610136611fb2565b6124e282826117206123df565b600061284e8215156004611063565b8261285b57506000610604565b670de0b6b3a7640000838102906128759085838161253a57fe5b82600182038161288157fe5b04600101915050610604565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0390811691161490565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0390811691161490565b600082820261290b84158061102d57508385838161102a57fe5b8061291a576000915050610604565b670de0b6b3a76400006000198201612881565b50600090565b60408051600280825260608281019093526000918291816020016020820280368337019050509250612968866020015161288d565b156129ae576000915060019050848360008151811061298357fe5b602002602001018181525050838360018151811061299d57fe5b6020026020010181815250506129eb565b600090506001915083836000815181106129c457fe5b60200260200101818152505084836001815181106129de57fe5b6020026020010181815250505b93509350939050565b6000818060200190518101906106049190613ef0565b6060818060200190518101906106cb9190613fb5565b600a91909155600b55565b612a37600083836110ad565b600254612a449082611720565b6002556001600160a01b038216600090815260208190526040902054612a6a9082611720565b6001600160a01b0383166000818152602081905260408082209390935591519091907fddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef906127cd908590614264565b6000612ae183878681518110612acb57fe5b602002602001015161104990919063ffffffff16565b868581518110612aed57fe5b6020026020010181815250506000612b0788888589612f49565b905083878681518110612b1657fe5b602002602001015101878681518110612b2b57fe5b602002602001018181525050612b626001612684898981518110612b4b57fe5b60200260200101518461104990919063ffffffff16565b98975050505050505050565b6000612b9683878781518110612b8057fe5b602002602001015161172090919063ffffffff16565b868681518110612ba257fe5b6020026020010181815250506000612bbc88888588612f49565b905083878781518110612bcb57fe5b602002602001015103878781518110612be057fe5b602002602001018181525050612b626001612c01838a8981518110612acb57fe5b90611049565b6000612c19632f1a0bc960e01b610a46565b821480612c345750612c31637587926b60e11b610a46565b82145b806106045750610604826130f9565b600080612c5287878787612f49565b905080868581518110612c6157fe5b602002602001015111612c78576000915050611247565b600081878681518110612c8757fe5b6020026020010151039050612b62848261255590919063ffffffff16565b60006060612cb16116a0565b600080612cbd8561312b565b91509150612cd5612ccc611071565b82106064611063565b6060612cdf611071565b6001600160401b0381118015612cf457600080fd5b50604051908082528060200260200182016040528015612d1e578160200160208202803683370190505b5090506000612d2b61150d565b509050612d4a81898587612d3d61061e565b612d4561085e565b61314d565b828481518110612d5657fe5b6020908102919091010152509196919550909350505050565b600060606000612d7e84613269565b90506060612d948683612d8f61061e565b61327f565b9196919550909350505050565b60006060612dad6116a0565b60606000612dba85613330565b91509150612dcb8251610880611071565b612dd58287611a72565b6000612ddf61150d565b5090506000612dff828a86612df261061e565b612dfa61085e565b613348565b9050612e0f8382111560cf611063565b989297509195505050505050565b600081612e3357612e2e84846135dc565b6120fa565b6120fa8484611581565b60006106cb83836001612226565b60006060806000612e5b85613330565b91509150612e71612e6a611071565b835161183e565b612e7b8287611a72565b6000612e8561150d565b5090506000612ea5828a86612e9861061e565b612ea061085e565b6135fc565b9050612e0f8382101560d0611063565b60006060600080612ec58561312b565b91509150612ed4612ccc611071565b6060612ede611071565b6001600160401b0381118015612ef357600080fd5b50604051908082528060200260200182016040528015612f1d578160200160208202803683370190505b5090506000612f2a61150d565b509050612d4a81898587612f3c61061e565b612f4461085e565b613878565b600080845186029050600085600081518110612f6157fe5b602002602001015190506000865187600081518110612f7c57fe5b60200260200101510290506000600190505b8751811015612fd557612fba612fb4612fad848b858151811061262457fe5b8a51611010565b886135dc565b9150612fcb8882815181106125a157fe5b9250600101612f8e565b50868581518110612fe257fe5b6020026020010151820391506000612ffa8788611010565b9050600061302661301a6130128461076a8988611010565b6103e8611010565b8a898151811061262457fe5b9050600061304161303a6130128b896135dc565b8690611720565b905060008061305d6130538686611720565b61076a8d86611720565b905060005b60ff8110156130dd5781925061309261307f866126848586611010565b61076a8e612c0188612684886002611010565b9150828211156130bb576001838303116130b6575097506120fa9650505050505050565b6130d5565b6001828403116130d5575097506120fa9650505050505050565b600101613062565b506130e9610142611fb2565b5050505050505050949350505050565b600061310b631c74c91760e11b610a46565b82148061060457506131236350dd6ed960e01b610a46565b909114919050565b600080828060200190518101906131429190613f7f565b909590945092505050565b60008061315c88886001612581565b9050600061317e8261317887613172818b611049565b9061283f565b906128f1565b9050600061318e8a8a848b612f49565b905060006131a2828b8b81518110612acb57fe5b90506000805b8b518110156131e1576131d78c82815181106131c057fe5b60200260200101518361172090919063ffffffff16565b91506001016131a8565b50600061320a828d8d815181106131f457fe5b602002602001015161250490919063ffffffff16565b9050600061321782613955565b9050600061322585836128f1565b905060006132338683611049565b905061325461324d83670de0b6b3a76400008e9003612555565b8290611720565b99505050505050505050509695505050505050565b6000818060200190518101906106cb9190613f52565b6060600061328d8484612504565b9050606085516001600160401b03811180156132a857600080fd5b506040519080825280602002602001820160405280156132d2578160200160208202803683370190505b50905060005b865181101561332657613307838883815181106132f157fe5b602002602001015161255590919063ffffffff16565b82828151811061331357fe5b60209081029190910101526001016132d8565b5095945050505050565b60606000828060200190518101906131429190613f0c565b600080805b865181101561336f576133658782815181106131c057fe5b915060010161334d565b50606085516001600160401b038111801561338957600080fd5b506040519080825280602002602001820160405280156133b3578160200160208202803683370190505b5090506000805b885181101561347a5760006133eb858b84815181106133d557fe5b602002602001015161283f90919063ffffffff16565b90506134278a83815181106133fc57fe5b60200260200101516131728b858151811061341357fe5b60200260200101518d8681518110612acb57fe5b84838151811061343357fe5b60200260200101818152505061346f6134688286858151811061345257fe5b60200260200101516128f190919063ffffffff16565b8490611720565b9250506001016133ba565b50606088516001600160401b038111801561349457600080fd5b506040519080825280602002602001820160405280156134be578160200160208202803683370190505b50905060005b89518110156135895760008482815181106134db57fe5b60200260200101518411156135425760006135046134f886613955565b8d85815181106132f157fe5b90506000613518828d8681518110612acb57fe5b905061353961353282670de0b6b3a76400008d900361283f565b8390611720565b92505050613559565b89828151811061354e57fe5b602002602001015190505b613569818c8481518110612acb57fe5b83838151811061357557fe5b6020908102919091010152506001016134c4565b5060006135988b8b6001612581565b905060006135a88c846000612581565b905060006135b68284612504565b90506135cb6135c482613955565b8b906128f1565b9d9c50505050505050505050505050565b60006135eb8215156004611063565b8183816135f457fe5b049392505050565b600080805b8651811015613623576136198782815181106131c057fe5b9150600101613601565b50606085516001600160401b038111801561363d57600080fd5b50604051908082528060200260200182016040528015613667578160200160208202803683370190505b5090506000805b8851811015613701576000613689858b84815181106131f457fe5b90506136cb8a838151811061369a57fe5b60200260200101516136c58b85815181106136b157fe5b60200260200101518d8681518110612b8057fe5b90612504565b8483815181106136d757fe5b6020026020010181815250506136f6613468828685815181106132f157fe5b92505060010161366e565b50606088516001600160401b038111801561371b57600080fd5b50604051908082528060200260200182016040528015613745578160200160208202803683370190505b50905060005b89518110156138065760008385838151811061376357fe5b602002602001015111156137bf5760006137886134f886670de0b6b3a7640000611049565b9050600061379c828d8681518110612acb57fe5b90506137b661353282670de0b6b3a76400008d9003612555565b925050506137d6565b8982815181106137cb57fe5b602002602001015190505b6137e6818c8481518110612b8057fe5b8383815181106137f257fe5b60209081029190910101525060010161374b565b5060006138158b8b6001612581565b905060006138258c846000612581565b905060006138338284612504565b9050670de0b6b3a76400008111156138685761385a8a670de0b6b3a763ffff198301612555565b975050505050505050611247565b6000975050505050505050611247565b60008061388788886001612581565b9050600061389d8261317887613172818b611720565b905060006138ad8a8a848b612f49565b905060006138d78a8a815181106138c057fe5b60200260200101518361104990919063ffffffff16565b90506000805b8b518110156138ff576138f58c82815181106131c057fe5b91506001016138dd565b506000613912828d8d815181106131f457fe5b9050600061391f82613955565b9050600061392d85836128f1565b9050600061393b8683611049565b905061325461324d83670de0b6b3a76400008e900361283f565b6000670de0b6b3a7640000821061396d576000610604565b50670de0b6b3a76400000390565b80356109a8816143f3565b600082601f830112613996578081fd5b81356139a96139a4826143d6565b6143b3565b8181529150602080830190848101818402860182018710156139ca57600080fd5b60005b848110156139e9578135845292820192908201906001016139cd565b505050505092915050565b600082601f830112613a04578081fd5b8151613a126139a4826143d6565b818152915060208083019084810181840286018201871015613a3357600080fd5b60005b848110156139e957815184529282019290820190600101613a36565b600082601f830112613a62578081fd5b81356001600160401b03811115613a7557fe5b613a88601f8201601f19166020016143b3565b9150808252836020828501011115613a9f57600080fd5b8060208401602084013760009082016020015292915050565b8035600281106109a857600080fd5b6000610120808385031215613ada578182fd5b613ae3816143b3565b915050613aef82613ab8565b8152613afd6020830161397b565b6020820152613b0e6040830161397b565b6040820152606082013560608201526080820135608082015260a082013560a0820152613b3d60c0830161397b565b60c0820152613b4e60e0830161397b565b60e0820152610100808301356001600160401b03811115613b6e57600080fd5b613b7a85828601613a52565b82840152505092915050565b600060208284031215613b97578081fd5b81356106cb816143f3565b60008060408385031215613bb4578081fd5b8235613bbf816143f3565b91506020830135613bcf816143f3565b809150509250929050565b600080600060608486031215613bee578081fd5b8335613bf9816143f3565b92506020840135613c09816143f3565b929592945050506040919091013590565b600080600080600080600060e0888a031215613c34578283fd5b8735613c3f816143f3565b96506020880135613c4f816143f3565b95506040880135945060608801359350608088013560ff81168114613c72578384fd5b9699959850939692959460a0840135945060c09093013592915050565b60008060408385031215613ca1578182fd5b8235613cac816143f3565b946020939093013593505050565b600080600060608486031215613cce578081fd5b83516001600160401b0380821115613ce4578283fd5b818601915086601f830112613cf7578283fd5b8151613d056139a4826143d6565b80828252602080830192508086018b828387028901011115613d25578788fd5b8796505b84871015613d50578051613d3c816143f3565b845260019690960195928101928101613d29565b508901519097509350505080821115613d67578283fd5b50613d74868287016139f4565b925050604084015190509250925092565b600060208284031215613d96578081fd5b81356106cb81614408565b600060208284031215613db2578081fd5b81516106cb81614408565b600080600080600080600060e0888a031215613dd7578081fd5b873596506020880135613de9816143f3565b95506040880135613df9816143f3565b945060608801356001600160401b0380821115613e14578283fd5b613e208b838c01613986565b955060808a0135945060a08a0135935060c08a0135915080821115613e43578283fd5b50613e508a828b01613a52565b91505092959891949750929550565b600060208284031215613e70578081fd5b81356001600160e01b0319811681146106cb578182fd5b600060208284031215613e98578081fd5b81516106cb816143f3565b60008060408385031215613eb5578182fd5b8235613ec0816143f3565b915060208301356001600160401b03811115613eda578182fd5b613ee685828601613a52565b9150509250929050565b600060208284031215613f01578081fd5b81516106cb81614416565b600080600060608486031215613f20578081fd5b8351613f2b81614416565b60208501519093506001600160401b03811115613f46578182fd5b613d74868287016139f4565b60008060408385031215613f64578182fd5b8251613f6f81614416565b6020939093015192949293505050565b600080600060608486031215613f93578081fd5b8351613f9e81614416565b602085015160409095015190969495509392505050565b60008060408385031215613fc7578182fd5b8251613fd281614416565b60208401519092506001600160401b03811115613fed578182fd5b613ee6858286016139f4565b6000806000806080858703121561400e578182fd5b84356001600160401b0380821115614024578384fd5b61403088838901613ac7565b95506020870135915080821115614045578384fd5b5061405287828801613986565b949794965050505060408301359260600135919050565b60008060006060848603121561407d578081fd5b83356001600160401b03811115614092578182fd5b61409e86828701613ac7565b9660208601359650604090950135949350505050565b6000602082840312156140c5578081fd5b5035919050565b600080604083850312156140de578182fd5b50508035926020909101359150565b60008060008060808587031215614102578182fd5b8451935060208501519250604085015191506060850151614122816143f3565b939692955090935050565b6000815180845260208085019450808401835b8381101561415c57815187529582019590820190600101614140565b509495945050505050565b60008151808452815b8181101561418c57602081850181015186830182015201614170565b8181111561419d5782602083870101525b50601f01601f19169290920160200192915050565b9182526001600160e01b031916602082015260240190565b6000828483379101908152919050565b61190160f01b81526002810192909252602282015260420190565b6001600160a01b0391909116815260200190565b6000602082526106cb602083018461412d565b60006040825261422f604083018561412d565b8281036020840152611247818561412d565b901515815260200190565b92151583526020830191909152604082015260600190565b90815260200190565b9283526001600160a01b03918216602084015216604082015260600190565b9586526001600160a01b0394851660208701529290931660408501526060840152608083019190915260a082015260c00190565b9485526020850193909352604084019190915260608301526001600160a01b0316608082015260a00190565b6000838252604060208301526120fa6040830184614167565b9182526001600160a01b0316602082015260400190565b93845260ff9290921660208401526040830152606082015260800190565b6000602082526106cb6020830184614167565b6000838252604060208301526120fa604083018461412d565b9283529015156020830152604082015260600190565b918252602082015260400190565b93845260208401929092526040830152606082015260800190565b60ff91909116815260200190565b6040518181016001600160401b03811182821017156143ce57fe5b604052919050565b60006001600160401b038211156143e957fe5b5060209081020190565b6001600160a01b038116811461061b57600080fd5b801515811461061b57600080fd5b6003811061061b57600080fdfea264697066735822122058c6c5a8359fccab1e3c84b413ff9b890a33a2d4a47d61df7247e9e6a16025a564736f6c63430007030033a2646970667358221220603c754d10ed8e2fe9a549070ca2ec78e8263dd6e2f1b80669354d68adf8a04e64736f6c63430007030033