Transaction Hash:
Block:
21502708 at Dec-28-2024 06:18:59 PM +UTC
Transaction Fee:
0.000436759755028774 ETH
$1.10
Gas Used:
73,006 Gas / 5.982518629 Gwei
Emitted Events:
296 |
WETH9.Transfer( src=[Sender] 0x0117ce17bc661d9bc331a328dc57c05d99b087d3, dst=0xB28Ca7e465C452cE4252598e0Bc96Aeba553CF82, wad=22159738095239290946 )
|
297 |
WETH9.Withdrawal( src=0xB28Ca7e465C452cE4252598e0Bc96Aeba553CF82, wad=22159738095239290946 )
|
298 |
OdosRouterV2.Swap( sender=[Sender] 0x0117ce17bc661d9bc331a328dc57c05d99b087d3, inputAmount=22159738095239290946, inputToken=WETH9, amountOut=22159738095239290880, outputToken=0x00000000...000000000, slippage=66, referralCode=1 )
|
Account State Difference:
Address | Before | After | State Difference | ||
---|---|---|---|---|---|
0x0117Ce17...d99B087D3 |
0.029770948016443327 Eth
Nonce: 200
|
22.189072283500705433 Eth
Nonce: 201
| 22.159301335484262106 | ||
0x95222290...5CC4BAfe5
Miner
| (beaverbuild) | 13.497436554469816397 Eth | 13.497440204769816397 Eth | 0.0000036503 | |
0xC02aaA39...83C756Cc2 | 2,888,754.079603357962055565 Eth | 2,888,731.919865262722764619 Eth | 22.159738095239290946 | ||
0xCf5540fF...7b0772559 | (Odos: Router V2) | 52.603905711613934835 Eth | 52.603905711613934901 Eth | 0.000000000000000066 |
Execution Trace
OdosRouterV2.swapCompact( ) => ( 22159738095239290880 )
-
WETH9.transferFrom( src=0x0117Ce17Bc661d9bc331A328DC57C05d99B087D3, dst=0xB28Ca7e465C452cE4252598e0Bc96Aeba553CF82, wad=22159738095239290946 ) => ( True )
0xb28ca7e465c452ce4252598e0bc96aeba553cf82.cb70e273( )
WETH9.withdraw( wad=22159738095239290946 )
- ETH 22.159738095239290946
0xb28ca7e465c452ce4252598e0bc96aeba553cf82.CALL( )
- ETH 22.159738095239290946
- ETH 22.159738095239290946
OdosRouterV2.CALL( )
- ETH 22.15973809523929088
0x0117ce17bc661d9bc331a328dc57c05d99b087d3.CALL( )
File 1 of 2: OdosRouterV2
File 2 of 2: WETH9
// SPDX-License-Identifier: MIT pragma solidity 0.8.8; // OpenZeppelin Contracts v4.4.1 (utils/Context.sol) /** * @dev Provides information about the current execution context, including the * sender of the transaction and its data. While these are generally available * via msg.sender and msg.data, they should not be accessed in such a direct * manner, since when dealing with meta-transactions the account sending and * paying for execution may not be the actual sender (as far as an application * is concerned). * * This contract is only required for intermediate, library-like contracts. */ abstract contract Context { function _msgSender() internal view virtual returns (address) { return msg.sender; } function _msgData() internal view virtual returns (bytes calldata) { return msg.data; } } // OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol) /** * @dev Contract module which provides a basic access control mechanism, where * there is an account (an owner) that can be granted exclusive access to * specific functions. * * By default, the owner account will be the one that deploys the contract. This * can later be changed with {transferOwnership}. * * This module is used through inheritance. It will make available the modifier * `onlyOwner`, which can be applied to your functions to restrict their use to * the owner. */ abstract contract Ownable is Context { address private _owner; event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); /** * @dev Initializes the contract setting the deployer as the initial owner. */ constructor() { _transferOwnership(_msgSender()); } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { _checkOwner(); _; } /** * @dev Returns the address of the current owner. */ function owner() public view virtual returns (address) { return _owner; } /** * @dev Throws if the sender is not the owner. */ function _checkOwner() internal view virtual { require(owner() == _msgSender(), "Ownable: caller is not the owner"); } /** * @dev Leaves the contract without owner. It will not be possible to call * `onlyOwner` functions anymore. Can only be called by the current owner. * * NOTE: Renouncing ownership will leave the contract without an owner, * thereby removing any functionality that is only available to the owner. */ function renounceOwnership() public virtual onlyOwner { _transferOwnership(address(0)); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Can only be called by the current owner. */ function transferOwnership(address newOwner) public virtual onlyOwner { require(newOwner != address(0), "Ownable: new owner is the zero address"); _transferOwnership(newOwner); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Internal function without access restriction. */ function _transferOwnership(address newOwner) internal virtual { address oldOwner = _owner; _owner = newOwner; emit OwnershipTransferred(oldOwner, newOwner); } } // OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol) /** * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't * need to send a transaction, and thus is not required to hold Ether at all. */ interface IERC20Permit { /** * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens, * given ``owner``'s signed approval. * * IMPORTANT: The same issues {IERC20-approve} has related to transaction * ordering also apply here. * * Emits an {Approval} event. * * Requirements: * * - `spender` cannot be the zero address. * - `deadline` must be a timestamp in the future. * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner` * over the EIP712-formatted function arguments. * - the signature must use ``owner``'s current nonce (see {nonces}). * * For more information on the signature format, see the * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP * section]. */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external; /** * @dev Returns the current nonce for `owner`. This value must be * included whenever a signature is generated for {permit}. * * Every successful call to {permit} increases ``owner``'s nonce by one. This * prevents a signature from being used multiple times. */ function nonces(address owner) external view returns (uint256); /** * @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}. */ // solhint-disable-next-line func-name-mixedcase function DOMAIN_SEPARATOR() external view returns (bytes32); } // OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol) /** * @dev Collection of functions related to the address type */ library Address { /** * @dev Returns true if `account` is a contract. * * [IMPORTANT] * ==== * It is unsafe to assume that an address for which this function returns * false is an externally-owned account (EOA) and not a contract. * * Among others, `isContract` will return false for the following * types of addresses: * * - an externally-owned account * - a contract in construction * - an address where a contract will be created * - an address where a contract lived, but was destroyed * ==== * * [IMPORTANT] * ==== * You shouldn't rely on `isContract` to protect against flash loan attacks! * * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract * constructor. * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize/address.code.length, which returns 0 // for contracts in construction, since the code is only stored at the end // of the constructor execution. return account.code.length > 0; } /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { require(address(this).balance >= amount, "Address: insufficient balance"); (bool success, ) = recipient.call{value: amount}(""); require(success, "Address: unable to send value, recipient may have reverted"); } /** * @dev Performs a Solidity function call using a low level `call`. A * plain `call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason, it is bubbled up by this * function (like regular Solidity function calls). * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, "Address: low-level call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value ) internal returns (bytes memory) { return functionCallWithValue(target, data, value, "Address: low-level call with value failed"); } /** * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value, string memory errorMessage ) internal returns (bytes memory) { require(address(this).balance >= value, "Address: insufficient balance for call"); (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResultFromTarget(target, success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { return functionStaticCall(target, data, "Address: low-level static call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall( address target, bytes memory data, string memory errorMessage ) internal view returns (bytes memory) { (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResultFromTarget(target, success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResultFromTarget(target, success, returndata, errorMessage); } /** * @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling * the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract. * * _Available since v4.8._ */ function verifyCallResultFromTarget( address target, bool success, bytes memory returndata, string memory errorMessage ) internal view returns (bytes memory) { if (success) { if (returndata.length == 0) { // only check isContract if the call was successful and the return data is empty // otherwise we already know that it was a contract require(isContract(target), "Address: call to non-contract"); } return returndata; } else { _revert(returndata, errorMessage); } } /** * @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the * revert reason or using the provided one. * * _Available since v4.3._ */ function verifyCallResult( bool success, bytes memory returndata, string memory errorMessage ) internal pure returns (bytes memory) { if (success) { return returndata; } else { _revert(returndata, errorMessage); } } function _revert(bytes memory returndata, string memory errorMessage) private pure { // Look for revert reason and bubble it up if present if (returndata.length > 0) { // The easiest way to bubble the revert reason is using memory via assembly /// @solidity memory-safe-assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert(errorMessage); } } } // OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol) /** * @title SafeERC20 * @dev Wrappers around ERC20 operations that throw on failure (when the token * contract returns false). Tokens that return no value (and instead revert or * throw on failure) are also supported, non-reverting calls are assumed to be * successful. * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract, * which allows you to call the safe operations as `token.safeTransfer(...)`, etc. */ library SafeERC20 { using Address for address; function safeTransfer( IERC20 token, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value)); } function safeTransferFrom( IERC20 token, address from, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value)); } /** * @dev Deprecated. This function has issues similar to the ones found in * {IERC20-approve}, and its usage is discouraged. * * Whenever possible, use {safeIncreaseAllowance} and * {safeDecreaseAllowance} instead. */ function safeApprove( IERC20 token, address spender, uint256 value ) internal { // safeApprove should only be called when setting an initial allowance, // or when resetting it to zero. To increase and decrease it, use // 'safeIncreaseAllowance' and 'safeDecreaseAllowance' require( (value == 0) || (token.allowance(address(this), spender) == 0), "SafeERC20: approve from non-zero to non-zero allowance" ); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value)); } function safeIncreaseAllowance( IERC20 token, address spender, uint256 value ) internal { uint256 newAllowance = token.allowance(address(this), spender) + value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } function safeDecreaseAllowance( IERC20 token, address spender, uint256 value ) internal { unchecked { uint256 oldAllowance = token.allowance(address(this), spender); require(oldAllowance >= value, "SafeERC20: decreased allowance below zero"); uint256 newAllowance = oldAllowance - value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } } function safePermit( IERC20Permit token, address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) internal { uint256 nonceBefore = token.nonces(owner); token.permit(owner, spender, value, deadline, v, r, s); uint256 nonceAfter = token.nonces(owner); require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed"); } /** * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement * on the return value: the return value is optional (but if data is returned, it must not be false). * @param token The token targeted by the call. * @param data The call data (encoded using abi.encode or one of its variants). */ function _callOptionalReturn(IERC20 token, bytes memory data) private { // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since // we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that // the target address contains contract code and also asserts for success in the low-level call. bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed"); if (returndata.length > 0) { // Return data is optional require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed"); } } } // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol) /** * @dev Interface of the ERC20 standard as defined in the EIP. */ interface IERC20 { /** * @dev Emitted when `value` tokens are moved from one account (`from`) to * another (`to`). * * Note that `value` may be zero. */ event Transfer(address indexed from, address indexed to, uint256 value); /** * @dev Emitted when the allowance of a `spender` for an `owner` is set by * a call to {approve}. `value` is the new allowance. */ event Approval(address indexed owner, address indexed spender, uint256 value); /** * @dev Returns the amount of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the amount of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves `amount` tokens from the caller's account to `to`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address to, uint256 amount) external returns (bool); /** * @dev Returns the remaining number of tokens that `spender` will be * allowed to spend on behalf of `owner` through {transferFrom}. This is * zero by default. * * This value changes when {approve} or {transferFrom} are called. */ function allowance(address owner, address spender) external view returns (uint256); /** * @dev Sets `amount` as the allowance of `spender` over the caller's tokens. * * Returns a boolean value indicating whether the operation succeeded. * * IMPORTANT: Beware that changing an allowance with this method brings the risk * that someone may use both the old and the new allowance by unfortunate * transaction ordering. One possible solution to mitigate this race * condition is to first reduce the spender's allowance to 0 and set the * desired value afterwards: * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 * * Emits an {Approval} event. */ function approve(address spender, uint256 amount) external returns (bool); /** * @dev Moves `amount` tokens from `from` to `to` using the * allowance mechanism. `amount` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom( address from, address to, uint256 amount ) external returns (bool); } // https://github.com/Uniswap/permit2 /// @title SignatureTransfer /// @notice Handles ERC20 token transfers through signature based actions /// @dev Requires user's token approval on the Permit2 contract interface ISignatureTransfer { /// @notice The token and amount details for a transfer signed in the permit transfer signature struct TokenPermissions { // ERC20 token address address token; // the maximum amount that can be spent uint256 amount; } /// @notice The signed permit message for a single token transfer struct PermitTransferFrom { TokenPermissions permitted; // a unique value for every token owner's signature to prevent signature replays uint256 nonce; // deadline on the permit signature uint256 deadline; } /// @notice Specifies the recipient address and amount for batched transfers. /// @dev Recipients and amounts correspond to the index of the signed token permissions array. /// @dev Reverts if the requested amount is greater than the permitted signed amount. struct SignatureTransferDetails { // recipient address address to; // spender requested amount uint256 requestedAmount; } /// @notice Used to reconstruct the signed permit message for multiple token transfers /// @dev Do not need to pass in spender address as it is required that it is msg.sender /// @dev Note that a user still signs over a spender address struct PermitBatchTransferFrom { // the tokens and corresponding amounts permitted for a transfer TokenPermissions[] permitted; // a unique value for every token owner's signature to prevent signature replays uint256 nonce; // deadline on the permit signature uint256 deadline; } /// @notice Transfers a token using a signed permit message /// @dev Reverts if the requested amount is greater than the permitted signed amount /// @param permit The permit data signed over by the owner /// @param owner The owner of the tokens to transfer /// @param transferDetails The spender's requested transfer details for the permitted token /// @param signature The signature to verify function permitTransferFrom( PermitTransferFrom memory permit, SignatureTransferDetails calldata transferDetails, address owner, bytes calldata signature ) external; /// @notice Transfers multiple tokens using a signed permit message /// @param permit The permit data signed over by the owner /// @param owner The owner of the tokens to transfer /// @param transferDetails Specifies the recipient and requested amount for the token transfer /// @param signature The signature to verify function permitTransferFrom( PermitBatchTransferFrom memory permit, SignatureTransferDetails[] calldata transferDetails, address owner, bytes calldata signature ) external; } // @dev interface for interacting with an Odos executor interface IOdosExecutor { function executePath ( bytes calldata bytecode, uint256[] memory inputAmount, address msgSender ) external payable; } /// @title Routing contract for Odos SOR /// @author Semiotic AI /// @notice Wrapper with security gaurentees around execution of arbitrary operations on user tokens contract OdosRouterV2 is Ownable { using SafeERC20 for IERC20; /// @dev The zero address is uniquely used to represent eth since it is already /// recognized as an invalid ERC20, and due to its gas efficiency address constant _ETH = address(0); /// @dev Address list where addresses can be cached for use when reading from storage is cheaper // than reading from calldata. addressListStart is the storage slot of the first dynamic array element uint256 private constant addressListStart = 80084422859880547211683076133703299733277748156566366325829078699459944778998; address[] public addressList; // @dev constants for managing referrals and fees uint256 public constant REFERRAL_WITH_FEE_THRESHOLD = 1 << 31; uint256 public constant FEE_DENOM = 1e18; // @dev fee taken on multi-input and multi-output swaps instead of positive slippage uint256 public swapMultiFee; /// @dev Contains all information needed to describe the input and output for a swap struct permit2Info { address contractAddress; uint256 nonce; uint256 deadline; bytes signature; } /// @dev Contains all information needed to describe the input and output for a swap struct swapTokenInfo { address inputToken; uint256 inputAmount; address inputReceiver; address outputToken; uint256 outputQuote; uint256 outputMin; address outputReceiver; } /// @dev Contains all information needed to describe an intput token for swapMulti struct inputTokenInfo { address tokenAddress; uint256 amountIn; address receiver; } /// @dev Contains all information needed to describe an output token for swapMulti struct outputTokenInfo { address tokenAddress; uint256 relativeValue; address receiver; } // @dev event for swapping one token for another event Swap( address sender, uint256 inputAmount, address inputToken, uint256 amountOut, address outputToken, int256 slippage, uint32 referralCode ); /// @dev event for swapping multiple input and/or output tokens event SwapMulti( address sender, uint256[] amountsIn, address[] tokensIn, uint256[] amountsOut, address[] tokensOut, uint32 referralCode ); /// @dev Holds all information for a given referral struct referralInfo { uint64 referralFee; address beneficiary; bool registered; } /// @dev Register referral fee and information mapping(uint32 => referralInfo) public referralLookup; /// @dev Set the null referralCode as "Unregistered" with no additional fee constructor() { referralLookup[0].referralFee = 0; referralLookup[0].beneficiary = address(0); referralLookup[0].registered = true; swapMultiFee = 5e14; } /// @dev Must exist in order for contract to receive eth receive() external payable { } /// @notice Custom decoder to swap with compact calldata for efficient execution on L2s function swapCompact() external payable returns (uint256) { swapTokenInfo memory tokenInfo; address executor; uint32 referralCode; bytes calldata pathDefinition; { address msgSender = msg.sender; assembly { // Define function to load in token address, either from calldata or from storage function getAddress(currPos) -> result, newPos { let inputPos := shr(240, calldataload(currPos)) switch inputPos // Reserve the null address as a special case that can be specified with 2 null bytes case 0x0000 { newPos := add(currPos, 2) } // This case means that the address is encoded in the calldata directly following the code case 0x0001 { result := and(shr(80, calldataload(currPos)), 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF) newPos := add(currPos, 22) } // Otherwise we use the case to load in from the cached address list default { result := sload(add(addressListStart, sub(inputPos, 2))) newPos := add(currPos, 2) } } let result := 0 let pos := 4 // Load in the input and output token addresses result, pos := getAddress(pos) mstore(tokenInfo, result) result, pos := getAddress(pos) mstore(add(tokenInfo, 0x60), result) // Load in the input amount - a 0 byte means the full balance is to be used let inputAmountLength := shr(248, calldataload(pos)) pos := add(pos, 1) if inputAmountLength { mstore(add(tokenInfo, 0x20), shr(mul(sub(32, inputAmountLength), 8), calldataload(pos))) pos := add(pos, inputAmountLength) } // Load in the quoted output amount let quoteAmountLength := shr(248, calldataload(pos)) pos := add(pos, 1) let outputQuote := shr(mul(sub(32, quoteAmountLength), 8), calldataload(pos)) mstore(add(tokenInfo, 0x80), outputQuote) pos := add(pos, quoteAmountLength) // Load the slippage tolerance and use to get the minimum output amount { let slippageTolerance := shr(232, calldataload(pos)) mstore(add(tokenInfo, 0xA0), div(mul(outputQuote, sub(0xFFFFFF, slippageTolerance)), 0xFFFFFF)) } pos := add(pos, 3) // Load in the executor address executor, pos := getAddress(pos) // Load in the destination to send the input to - Zero denotes the executor result, pos := getAddress(pos) if eq(result, 0) { result := executor } mstore(add(tokenInfo, 0x40), result) // Load in the destination to send the output to - Zero denotes msg.sender result, pos := getAddress(pos) if eq(result, 0) { result := msgSender } mstore(add(tokenInfo, 0xC0), result) // Load in the referralCode referralCode := shr(224, calldataload(pos)) pos := add(pos, 4) // Set the offset and size for the pathDefinition portion of the msg.data pathDefinition.length := mul(shr(248, calldataload(pos)), 32) pathDefinition.offset := add(pos, 1) } } return _swapApproval( tokenInfo, pathDefinition, executor, referralCode ); } /// @notice Externally facing interface for swapping two tokens /// @param tokenInfo All information about the tokens being swapped /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path /// @param referralCode referral code to specify the source of the swap function swap( swapTokenInfo memory tokenInfo, bytes calldata pathDefinition, address executor, uint32 referralCode ) external payable returns (uint256 amountOut) { return _swapApproval( tokenInfo, pathDefinition, executor, referralCode ); } /// @notice Internal function for initiating approval transfers /// @param tokenInfo All information about the tokens being swapped /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path /// @param referralCode referral code to specify the source of the swap function _swapApproval( swapTokenInfo memory tokenInfo, bytes calldata pathDefinition, address executor, uint32 referralCode ) internal returns (uint256 amountOut) { if (tokenInfo.inputToken == _ETH) { // Support rebasing tokens by allowing the user to trade the entire balance if (tokenInfo.inputAmount == 0) { tokenInfo.inputAmount = msg.value; } else { require(msg.value == tokenInfo.inputAmount, "Wrong msg.value"); } } else { // Support rebasing tokens by allowing the user to trade the entire balance if (tokenInfo.inputAmount == 0) { tokenInfo.inputAmount = IERC20(tokenInfo.inputToken).balanceOf(msg.sender); } IERC20(tokenInfo.inputToken).safeTransferFrom( msg.sender, tokenInfo.inputReceiver, tokenInfo.inputAmount ); } return _swap( tokenInfo, pathDefinition, executor, referralCode ); } /// @notice Externally facing interface for swapping two tokens /// @param permit2 All additional info for Permit2 transfers /// @param tokenInfo All information about the tokens being swapped /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path /// @param referralCode referral code to specify the source of the swap function swapPermit2( permit2Info memory permit2, swapTokenInfo memory tokenInfo, bytes calldata pathDefinition, address executor, uint32 referralCode ) external returns (uint256 amountOut) { ISignatureTransfer(permit2.contractAddress).permitTransferFrom( ISignatureTransfer.PermitTransferFrom( ISignatureTransfer.TokenPermissions( tokenInfo.inputToken, tokenInfo.inputAmount ), permit2.nonce, permit2.deadline ), ISignatureTransfer.SignatureTransferDetails( tokenInfo.inputReceiver, tokenInfo.inputAmount ), msg.sender, permit2.signature ); return _swap( tokenInfo, pathDefinition, executor, referralCode ); } /// @notice contains the main logic for swapping one token for another /// Assumes input tokens have already been sent to their destinations and /// that msg.value is set to expected ETH input value, or 0 for ERC20 input /// @param tokenInfo All information about the tokens being swapped /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path /// @param referralCode referral code to specify the source of the swap function _swap( swapTokenInfo memory tokenInfo, bytes calldata pathDefinition, address executor, uint32 referralCode ) internal returns (uint256 amountOut) { // Check for valid output specifications require(tokenInfo.outputMin <= tokenInfo.outputQuote, "Minimum greater than quote"); require(tokenInfo.outputMin > 0, "Slippage limit too low"); require(tokenInfo.inputToken != tokenInfo.outputToken, "Arbitrage not supported"); uint256 balanceBefore = _universalBalance(tokenInfo.outputToken); // Delegate the execution of the path to the specified Odos Executor uint256[] memory amountsIn = new uint256[](1); amountsIn[0] = tokenInfo.inputAmount; IOdosExecutor(executor).executePath{value: msg.value}(pathDefinition, amountsIn, msg.sender); amountOut = _universalBalance(tokenInfo.outputToken) - balanceBefore; if (referralCode > REFERRAL_WITH_FEE_THRESHOLD) { referralInfo memory thisReferralInfo = referralLookup[referralCode]; _universalTransfer( tokenInfo.outputToken, thisReferralInfo.beneficiary, amountOut * thisReferralInfo.referralFee * 8 / (FEE_DENOM * 10) ); amountOut = amountOut * (FEE_DENOM - thisReferralInfo.referralFee) / FEE_DENOM; } int256 slippage = int256(amountOut) - int256(tokenInfo.outputQuote); if (slippage > 0) { amountOut = tokenInfo.outputQuote; } require(amountOut >= tokenInfo.outputMin, "Slippage Limit Exceeded"); // Transfer out the final output to the end user _universalTransfer(tokenInfo.outputToken, tokenInfo.outputReceiver, amountOut); emit Swap( msg.sender, tokenInfo.inputAmount, tokenInfo.inputToken, amountOut, tokenInfo.outputToken, slippage, referralCode ); } /// @notice Custom decoder to swapMulti with compact calldata for efficient execution on L2s function swapMultiCompact() external payable returns (uint256[] memory amountsOut) { address executor; uint256 valueOutMin; inputTokenInfo[] memory inputs; outputTokenInfo[] memory outputs; uint256 pos = 6; { address msgSender = msg.sender; uint256 numInputs; uint256 numOutputs; assembly { numInputs := shr(248, calldataload(4)) numOutputs := shr(248, calldataload(5)) } inputs = new inputTokenInfo[](numInputs); outputs = new outputTokenInfo[](numOutputs); assembly { // Define function to load in token address, either from calldata or from storage function getAddress(currPos) -> result, newPos { let inputPos := shr(240, calldataload(currPos)) switch inputPos // Reserve the null address as a special case that can be specified with 2 null bytes case 0x0000 { newPos := add(currPos, 2) } // This case means that the address is encoded in the calldata directly following the code case 0x0001 { result := and(shr(80, calldataload(currPos)), 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF) newPos := add(currPos, 22) } // Otherwise we use the case to load in from the cached address list default { result := sload(add(addressListStart, sub(inputPos, 2))) newPos := add(currPos, 2) } } executor, pos := getAddress(pos) // Load in the quoted output amount let outputMinAmountLength := shr(248, calldataload(pos)) pos := add(pos, 1) valueOutMin := shr(mul(sub(32, outputMinAmountLength), 8), calldataload(pos)) pos := add(pos, outputMinAmountLength) let result := 0 let memPos := 0 for { let element := 0 } lt(element, numInputs) { element := add(element, 1) } { memPos := mload(add(inputs, add(mul(element, 0x20), 0x20))) // Load in the token address result, pos := getAddress(pos) mstore(memPos, result) // Load in the input amount - a 0 byte means the full balance is to be used let inputAmountLength := shr(248, calldataload(pos)) pos := add(pos, 1) if inputAmountLength { mstore(add(memPos, 0x20), shr(mul(sub(32, inputAmountLength), 8), calldataload(pos))) pos := add(pos, inputAmountLength) } result, pos := getAddress(pos) if eq(result, 0) { result := executor } mstore(add(memPos, 0x40), result) } for { let element := 0 } lt(element, numOutputs) { element := add(element, 1) } { memPos := mload(add(outputs, add(mul(element, 0x20), 0x20))) // Load in the token address result, pos := getAddress(pos) mstore(memPos, result) // Load in the quoted output amount let outputAmountLength := shr(248, calldataload(pos)) pos := add(pos, 1) mstore(add(memPos, 0x20), shr(mul(sub(32, outputAmountLength), 8), calldataload(pos))) pos := add(pos, outputAmountLength) result, pos := getAddress(pos) if eq(result, 0) { result := msgSender } mstore(add(memPos, 0x40), result) } } } uint32 referralCode; bytes calldata pathDefinition; assembly { // Load in the referralCode referralCode := shr(224, calldataload(pos)) pos := add(pos, 4) // Set the offset and size for the pathDefinition portion of the msg.data pathDefinition.length := mul(shr(248, calldataload(pos)), 32) pathDefinition.offset := add(pos, 1) } return _swapMultiApproval( inputs, outputs, valueOutMin, pathDefinition, executor, referralCode ); } /// @notice Externally facing interface for swapping between two sets of tokens /// @param inputs list of input token structs for the path being executed /// @param outputs list of output token structs for the path being executed /// @param valueOutMin minimum amount of value out the user will accept /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path /// @param referralCode referral code to specify the source of the swap function swapMulti( inputTokenInfo[] memory inputs, outputTokenInfo[] memory outputs, uint256 valueOutMin, bytes calldata pathDefinition, address executor, uint32 referralCode ) external payable returns (uint256[] memory amountsOut) { return _swapMultiApproval( inputs, outputs, valueOutMin, pathDefinition, executor, referralCode ); } /// @notice Internal logic for swapping between two sets of tokens with approvals /// @param inputs list of input token structs for the path being executed /// @param outputs list of output token structs for the path being executed /// @param valueOutMin minimum amount of value out the user will accept /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path /// @param referralCode referral code to specify the source of the swap function _swapMultiApproval( inputTokenInfo[] memory inputs, outputTokenInfo[] memory outputs, uint256 valueOutMin, bytes calldata pathDefinition, address executor, uint32 referralCode ) internal returns (uint256[] memory amountsOut) { // If input amount is still 0 then that means the maximum possible input is to be used uint256 expected_msg_value = 0; for (uint256 i = 0; i < inputs.length; i++) { if (inputs[i].tokenAddress == _ETH) { if (inputs[i].amountIn == 0) { inputs[i].amountIn = msg.value; } expected_msg_value = inputs[i].amountIn; } else { if (inputs[i].amountIn == 0) { inputs[i].amountIn = IERC20(inputs[i].tokenAddress).balanceOf(msg.sender); } IERC20(inputs[i].tokenAddress).safeTransferFrom( msg.sender, inputs[i].receiver, inputs[i].amountIn ); } } require(msg.value == expected_msg_value, "Wrong msg.value"); return _swapMulti( inputs, outputs, valueOutMin, pathDefinition, executor, referralCode ); } /// @notice Externally facing interface for swapping between two sets of tokens with Permit2 /// @param permit2 All additional info for Permit2 transfers /// @param inputs list of input token structs for the path being executed /// @param outputs list of output token structs for the path being executed /// @param valueOutMin minimum amount of value out the user will accept /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path /// @param referralCode referral code to specify the source of the swap function swapMultiPermit2( permit2Info memory permit2, inputTokenInfo[] memory inputs, outputTokenInfo[] memory outputs, uint256 valueOutMin, bytes calldata pathDefinition, address executor, uint32 referralCode ) external payable returns (uint256[] memory amountsOut) { ISignatureTransfer.PermitBatchTransferFrom memory permit; ISignatureTransfer.SignatureTransferDetails[] memory transferDetails; { uint256 permit_length = msg.value > 0 ? inputs.length - 1 : inputs.length; permit = ISignatureTransfer.PermitBatchTransferFrom( new ISignatureTransfer.TokenPermissions[](permit_length), permit2.nonce, permit2.deadline ); transferDetails = new ISignatureTransfer.SignatureTransferDetails[](permit_length); } { uint256 expected_msg_value = 0; for (uint256 i = 0; i < inputs.length; i++) { if (inputs[i].tokenAddress == _ETH) { if (inputs[i].amountIn == 0) { inputs[i].amountIn = msg.value; } expected_msg_value = inputs[i].amountIn; } else { if (inputs[i].amountIn == 0) { inputs[i].amountIn = IERC20(inputs[i].tokenAddress).balanceOf(msg.sender); } uint256 permit_index = expected_msg_value == 0 ? i : i - 1; permit.permitted[permit_index].token = inputs[i].tokenAddress; permit.permitted[permit_index].amount = inputs[i].amountIn; transferDetails[permit_index].to = inputs[i].receiver; transferDetails[permit_index].requestedAmount = inputs[i].amountIn; } } require(msg.value == expected_msg_value, "Wrong msg.value"); } ISignatureTransfer(permit2.contractAddress).permitTransferFrom( permit, transferDetails, msg.sender, permit2.signature ); return _swapMulti( inputs, outputs, valueOutMin, pathDefinition, executor, referralCode ); } /// @notice contains the main logic for swapping between two sets of tokens /// assumes that inputs have already been sent to the right location and msg.value /// is set correctly to be 0 for no native input and match native inpuit otherwise /// @param inputs list of input token structs for the path being executed /// @param outputs list of output token structs for the path being executed /// @param valueOutMin minimum amount of value out the user will accept /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path /// @param referralCode referral code to specify the source of the swap function _swapMulti( inputTokenInfo[] memory inputs, outputTokenInfo[] memory outputs, uint256 valueOutMin, bytes calldata pathDefinition, address executor, uint32 referralCode ) internal returns (uint256[] memory amountsOut) { // Check for valid output specifications require(valueOutMin > 0, "Slippage limit too low"); // Extract arrays of input amount values and tokens from the inputs struct list uint256[] memory amountsIn = new uint256[](inputs.length); address[] memory tokensIn = new address[](inputs.length); // Check input specification validity and transfer input tokens to executor { for (uint256 i = 0; i < inputs.length; i++) { amountsIn[i] = inputs[i].amountIn; tokensIn[i] = inputs[i].tokenAddress; for (uint256 j = 0; j < i; j++) { require( inputs[i].tokenAddress != inputs[j].tokenAddress, "Duplicate source tokens" ); } for (uint256 j = 0; j < outputs.length; j++) { require( inputs[i].tokenAddress != outputs[j].tokenAddress, "Arbitrage not supported" ); } } } // Check outputs for duplicates and record balances before swap uint256[] memory balancesBefore = new uint256[](outputs.length); for (uint256 i = 0; i < outputs.length; i++) { for (uint256 j = 0; j < i; j++) { require( outputs[i].tokenAddress != outputs[j].tokenAddress, "Duplicate destination tokens" ); } balancesBefore[i] = _universalBalance(outputs[i].tokenAddress); } // Delegate the execution of the path to the specified Odos Executor IOdosExecutor(executor).executePath{value: msg.value}(pathDefinition, amountsIn, msg.sender); referralInfo memory thisReferralInfo; if (referralCode > REFERRAL_WITH_FEE_THRESHOLD) { thisReferralInfo = referralLookup[referralCode]; } { uint256 valueOut; uint256 _swapMultiFee = swapMultiFee; amountsOut = new uint256[](outputs.length); for (uint256 i = 0; i < outputs.length; i++) { // Record the destination token balance before the path is executed amountsOut[i] = _universalBalance(outputs[i].tokenAddress) - balancesBefore[i]; // Remove the swapMulti Fee (taken instead of positive slippage) amountsOut[i] = amountsOut[i] * (FEE_DENOM - _swapMultiFee) / FEE_DENOM; if (referralCode > REFERRAL_WITH_FEE_THRESHOLD) { _universalTransfer( outputs[i].tokenAddress, thisReferralInfo.beneficiary, amountsOut[i] * thisReferralInfo.referralFee * 8 / (FEE_DENOM * 10) ); amountsOut[i] = amountsOut[i] * (FEE_DENOM - thisReferralInfo.referralFee) / FEE_DENOM; } _universalTransfer( outputs[i].tokenAddress, outputs[i].receiver, amountsOut[i] ); // Add the amount out sent to the user to the total value of output valueOut += amountsOut[i] * outputs[i].relativeValue; } require(valueOut >= valueOutMin, "Slippage Limit Exceeded"); } address[] memory tokensOut = new address[](outputs.length); for (uint256 i = 0; i < outputs.length; i++) { tokensOut[i] = outputs[i].tokenAddress; } emit SwapMulti( msg.sender, amountsIn, tokensIn, amountsOut, tokensOut, referralCode ); } /// @notice Register a new referrer, optionally with an additional swap fee /// @param _referralCode the referral code to use for the new referral /// @param _referralFee the additional fee to add to each swap using this code /// @param _beneficiary the address to send the referral's share of fees to function registerReferralCode( uint32 _referralCode, uint64 _referralFee, address _beneficiary ) external { // Do not allow for any overwriting of referral codes require(!referralLookup[_referralCode].registered, "Code in use"); // Maximum additional fee a referral can set is 2% require(_referralFee <= FEE_DENOM / 50, "Fee too high"); // Reserve the lower half of referral codes to be informative only if (_referralCode <= REFERRAL_WITH_FEE_THRESHOLD) { require(_referralFee == 0, "Invalid fee for code"); } else { require(_referralFee > 0, "Invalid fee for code"); // Make sure the beneficiary is not the null address if there is a fee require(_beneficiary != address(0), "Null beneficiary"); } referralLookup[_referralCode].referralFee = _referralFee; referralLookup[_referralCode].beneficiary = _beneficiary; referralLookup[_referralCode].registered = true; } /// @notice Set the fee used for swapMulti /// @param _swapMultiFee the new fee for swapMulti function setSwapMultiFee( uint256 _swapMultiFee ) external onlyOwner { // Maximum swapMultiFee that can be set is 0.5% require(_swapMultiFee <= FEE_DENOM / 200, "Fee too high"); swapMultiFee = _swapMultiFee; } /// @notice Push new addresses to the cached address list for when storage is cheaper than calldata /// @param addresses list of addresses to be added to the cached address list function writeAddressList( address[] calldata addresses ) external onlyOwner { for (uint256 i = 0; i < addresses.length; i++) { addressList.push(addresses[i]); } } /// @notice Allows the owner to transfer funds held by the router contract /// @param tokens List of token address to be transferred /// @param amounts List of amounts of each token to be transferred /// @param dest Address to which the funds should be sent function transferRouterFunds( address[] calldata tokens, uint256[] calldata amounts, address dest ) external onlyOwner { require(tokens.length == amounts.length, "Invalid funds transfer"); for (uint256 i = 0; i < tokens.length; i++) { _universalTransfer( tokens[i], dest, amounts[i] == 0 ? _universalBalance(tokens[i]) : amounts[i] ); } } /// @notice Directly swap funds held in router /// @param inputs list of input token structs for the path being executed /// @param outputs list of output token structs for the path being executed /// @param valueOutMin minimum amount of value out the user will accept /// @param pathDefinition Encoded path definition for executor /// @param executor Address of contract that will execute the path function swapRouterFunds( inputTokenInfo[] memory inputs, outputTokenInfo[] memory outputs, uint256 valueOutMin, bytes calldata pathDefinition, address executor ) external onlyOwner returns (uint256[] memory amountsOut) { uint256[] memory amountsIn = new uint256[](inputs.length); address[] memory tokensIn = new address[](inputs.length); for (uint256 i = 0; i < inputs.length; i++) { tokensIn[i] = inputs[i].tokenAddress; amountsIn[i] = inputs[i].amountIn == 0 ? _universalBalance(tokensIn[i]) : inputs[i].amountIn; _universalTransfer( tokensIn[i], inputs[i].receiver, amountsIn[i] ); } // Check outputs for duplicates and record balances before swap uint256[] memory balancesBefore = new uint256[](outputs.length); address[] memory tokensOut = new address[](outputs.length); for (uint256 i = 0; i < outputs.length; i++) { tokensOut[i] = outputs[i].tokenAddress; balancesBefore[i] = _universalBalance(tokensOut[i]); } // Delegate the execution of the path to the specified Odos Executor IOdosExecutor(executor).executePath{value: 0}(pathDefinition, amountsIn, msg.sender); uint256 valueOut; amountsOut = new uint256[](outputs.length); for (uint256 i = 0; i < outputs.length; i++) { // Record the destination token balance before the path is executed amountsOut[i] = _universalBalance(tokensOut[i]) - balancesBefore[i]; _universalTransfer( outputs[i].tokenAddress, outputs[i].receiver, amountsOut[i] ); // Add the amount out sent to the user to the total value of output valueOut += amountsOut[i] * outputs[i].relativeValue; } require(valueOut >= valueOutMin, "Slippage Limit Exceeded"); emit SwapMulti( msg.sender, amountsIn, tokensIn, amountsOut, tokensOut, 0 ); } /// @notice helper function to get balance of ERC20 or native coin for this contract /// @param token address of the token to check, null for native coin /// @return balance of specified coin or token function _universalBalance(address token) private view returns(uint256) { if (token == _ETH) { return address(this).balance; } else { return IERC20(token).balanceOf(address(this)); } } /// @notice helper function to transfer ERC20 or native coin /// @param token address of the token being transferred, null for native coin /// @param to address to transfer to /// @param amount to transfer function _universalTransfer(address token, address to, uint256 amount) private { if (token == _ETH) { (bool success,) = payable(to).call{value: amount}(""); require(success, "ETH transfer failed"); } else { IERC20(token).safeTransfer(to, amount); } } }
File 2 of 2: WETH9
// Copyright (C) 2015, 2016, 2017 Dapphub // 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.4.18; contract WETH9 { string public name = "Wrapped Ether"; string public symbol = "WETH"; uint8 public decimals = 18; event Approval(address indexed src, address indexed guy, uint wad); event Transfer(address indexed src, address indexed dst, uint wad); event Deposit(address indexed dst, uint wad); event Withdrawal(address indexed src, uint wad); mapping (address => uint) public balanceOf; mapping (address => mapping (address => uint)) public allowance; function() public payable { deposit(); } function deposit() public payable { balanceOf[msg.sender] += msg.value; Deposit(msg.sender, msg.value); } function withdraw(uint wad) public { require(balanceOf[msg.sender] >= wad); balanceOf[msg.sender] -= wad; msg.sender.transfer(wad); Withdrawal(msg.sender, wad); } function totalSupply() public view returns (uint) { return this.balance; } function approve(address guy, uint wad) public returns (bool) { allowance[msg.sender][guy] = wad; Approval(msg.sender, guy, wad); return true; } function transfer(address dst, uint wad) public returns (bool) { return transferFrom(msg.sender, dst, wad); } function transferFrom(address src, address dst, uint wad) public returns (bool) { require(balanceOf[src] >= wad); if (src != msg.sender && allowance[src][msg.sender] != uint(-1)) { require(allowance[src][msg.sender] >= wad); allowance[src][msg.sender] -= wad; } balanceOf[src] -= wad; balanceOf[dst] += wad; Transfer(src, dst, wad); return true; } } /* GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> 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/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>. */