Overview
POL Balance
0 POL
POL Value
$0.00Token Holdings
More Info
Private Name Tags
ContractCreator
Latest 25 from a total of 1,118 transactions
Transaction Hash |
Method
|
Block
|
From
|
To
|
|||||
---|---|---|---|---|---|---|---|---|---|
Unwrap | 56991171 | 202 days ago | IN | 0 POL | 0.00515049 | ||||
Unwrap | 51149352 | 355 days ago | IN | 0 POL | 0.01440639 | ||||
Unwrap | 50569296 | 369 days ago | IN | 0 POL | 0.15137811 | ||||
Unwrap | 50569109 | 369 days ago | IN | 0 POL | 0.13722228 | ||||
Unwrap | 50502954 | 371 days ago | IN | 0 POL | 0.01526419 | ||||
Unwrap | 50502909 | 371 days ago | IN | 0 POL | 0.0152972 | ||||
Unwrap | 50496002 | 371 days ago | IN | 0 POL | 0.0178542 | ||||
Unwrap | 50467378 | 372 days ago | IN | 0 POL | 0.0050884 | ||||
Unwrap | 50461825 | 372 days ago | IN | 0 POL | 0.00695414 | ||||
Unwrap | 50447831 | 372 days ago | IN | 0 POL | 0.01224288 | ||||
Unwrap | 50445342 | 372 days ago | IN | 0 POL | 0.01147554 | ||||
Unwrap | 50430370 | 373 days ago | IN | 0 POL | 0.0089271 | ||||
Wrap | 50429670 | 373 days ago | IN | 0 POL | 0.00843955 | ||||
Unwrap | 50429433 | 373 days ago | IN | 0 POL | 0.00898208 | ||||
Wrap | 50429307 | 373 days ago | IN | 0 POL | 0.00487911 | ||||
Wrap | 50429072 | 373 days ago | IN | 0 POL | 0.00461538 | ||||
Wrap | 50428938 | 373 days ago | IN | 0 POL | 0.00464671 | ||||
Wrap | 50428816 | 373 days ago | IN | 0 POL | 0.00448351 | ||||
Wrap | 50428756 | 373 days ago | IN | 0 POL | 0.00461538 | ||||
Wrap | 50428699 | 373 days ago | IN | 0 POL | 0.00487911 | ||||
Wrap | 50428445 | 373 days ago | IN | 0 POL | 0.00448351 | ||||
Wrap | 50428251 | 373 days ago | IN | 0 POL | 0.00501098 | ||||
Wrap | 50425304 | 373 days ago | IN | 0 POL | 0.01081317 | ||||
Unwrap | 50418328 | 373 days ago | IN | 0 POL | 0.02714936 | ||||
Wrap | 50406436 | 373 days ago | IN | 0 POL | 0.0049198 |
Latest 1 internal transaction
Parent Transaction Hash | Block | From | To | |||
---|---|---|---|---|---|---|
29903097 | 894 days ago | Contract Creation | 0 POL |
Loading...
Loading
Contract Name:
SynthereumFixedRateWrapper
Compiler Version
v0.8.4+commit.c7e474f2
Optimization Enabled:
Yes with 200 runs
Other Settings:
default evmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {IStandardERC20} from '../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; import {ISynthereumFixedRateWrapper} from './interfaces/IFixedRateWrapper.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; import {ERC2771Context} from '../../common/ERC2771Context.sol'; import { AccessControlEnumerable, Context } from '../../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; contract SynthereumFixedRateWrapper is ISynthereumFixedRateWrapper, AccessControlEnumerable, ERC2771Context, ReentrancyGuard { struct ConstructorParams { // Synthereum finder ISynthereumFinder finder; // Synthereum fixed rate version uint8 version; // ERC20 collateral token IStandardERC20 pegCollateralToken; // ERC20 synthetic token IMintableBurnableERC20 fixedRateToken; // The addresses of admin, maintainer Roles roles; // Conversion rate uint256 rate; } //---------------------------------------- // Constants //---------------------------------------- string public constant override typology = 'FIXED_RATE'; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); // Precision for math operations uint256 public constant PRECISION = 1e18; // Current rate set for the wrapper uint256 private immutable rate; // The fixedRate synthetic token associated with the wrapper IMintableBurnableERC20 private immutable fixedRateToken; // The peg collateral token associated with the wrapper IStandardERC20 private immutable pegCollateralToken; // Version of the fixed rate wrapper uint8 private immutable fixedRateVersion; //---------------------------------------- // Storage //---------------------------------------- // Storage from interface ISynthereumFinder private finder; // Total amount of peg collateral tokens deposited uint256 private totalDeposited; // Total amount of synthetic tokens minted uint256 private totalSyntheticTokens; // When contract is paused minting is revoked bool private paused; //---------------------------------------- // Modifiers //---------------------------------------- modifier isActive() { require(!paused, 'Contract has been paused'); _; } modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, _msgSender()), 'Sender must be the maintainer' ); _; } //---------------------------------------- // Events //---------------------------------------- event Wrap(uint256 amountTokens, address recipient); event Unwrap(uint256 amountCollateral, address recipient); event ContractPaused(); event ContractResumed(); //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the fixed rate wrapper contract * @param params The parameters passed from deployer to construct the fixed rate wrapper contract */ constructor(ConstructorParams memory params) nonReentrant { require( params.pegCollateralToken.decimals() <= 18, 'Collateral has more than 18 decimals' ); require( params.fixedRateToken.decimals() == 18, 'FixedRate token has more or less than 18 decimals' ); rate = params.rate; pegCollateralToken = params.pegCollateralToken; fixedRateToken = params.fixedRateToken; fixedRateVersion = params.version; finder = params.finder; _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, params.roles.admin); _setupRole(MAINTAINER_ROLE, params.roles.maintainer); } //---------------------------------------- // External //---------------------------------------- /** * @notice Receives an amount of peg collateral tokens and mints new synthetic tokens based on the rate * @param _collateral The amount of peg collateral tokens to be wrapped * @param _recipient Address of the recipient to receive the newly minted fixed rate synthetic tokens * @return amountTokens The amount of newly minted fixed rate synthetic tokens */ function wrap(uint256 _collateral, address _recipient) external override nonReentrant isActive returns (uint256 amountTokens) { pegCollateralToken.transferFrom(_msgSender(), address(this), _collateral); amountTokens = (_collateral * (10**(18 - pegCollateralToken.decimals())) * rate) / PRECISION; totalDeposited = totalDeposited + _collateral; totalSyntheticTokens += amountTokens; fixedRateToken.mint(_recipient, amountTokens); emit Wrap(amountTokens, _recipient); } /** * @notice Burns an amount of fixed rate synthetic tokens and releases peg collateral tokens based on the conversion rate * @param _tokenAmount The amount of fixed rate synthetic tokens to be burned * @param _recipient Address of the recipient to receive the peg collateral tokens * @return amountCollateral The amount of peg collateral tokens received */ function unwrap(uint256 _tokenAmount, address _recipient) external override nonReentrant returns (uint256 amountCollateral) { require( fixedRateToken.balanceOf(_msgSender()) >= _tokenAmount, 'Not enought tokens to unwrap' ); fixedRateToken.transferFrom(_msgSender(), address(this), _tokenAmount); amountCollateral = (totalDeposited * ((_tokenAmount * PRECISION) / totalSyntheticTokens)) / PRECISION; fixedRateToken.burn(_tokenAmount); totalDeposited = totalDeposited - amountCollateral; totalSyntheticTokens -= _tokenAmount; pegCollateralToken.transfer(_recipient, amountCollateral); emit Unwrap(amountCollateral, _recipient); } /** @notice Allows the maintainer to pause the contract in case of emergency * which blocks minting of new fixed rate synthetic tokens */ function pauseContract() external override onlyMaintainer { paused = true; emit ContractPaused(); } /** @notice Allows the maintainer to resume the contract functionalities * unblocking the minting of new fixed rate synthetic tokens */ function resumeContract() external override onlyMaintainer { paused = false; emit ContractResumed(); } /** @notice Checks the address of the peg collateral token registered in the wrapper * @return collateralCurrency The address of the peg collateral token registered */ function collateralToken() external view override returns (IERC20 collateralCurrency) { collateralCurrency = pegCollateralToken; } /** @notice Checks the symbol of the fixed rate synthetic token registered in the wrapper * @return The symbol of the fixed rate synthetic token associated with the wrapper */ function syntheticTokenSymbol() external view override returns (string memory) { return IStandardERC20(address(fixedRateToken)).symbol(); } /** @notice Checks the address of the fixed rate synthetic token registered in the wrapper * @return The address of the fixed rate synthetic token associated with the wrapper */ function syntheticToken() external view override returns (IERC20) { return fixedRateToken; } /** @notice Checks the version of the fixed rate wrapper contract * @return The version of the fixed rate wrapper contract */ function version() external view override returns (uint8) { return fixedRateVersion; } /** @notice Checks the SynthereumFinder associated with the fixed rate wrapper contract * @return The address of the SynthereumFinder */ function synthereumFinder() external view override returns (ISynthereumFinder) { return finder; } /** @notice Check the conversion rate between peg-collateral and fixed-rate synthetic token * @return Coversion rate */ function conversionRate() external view override returns (uint256) { return rate; } /** @notice Amount of peg collateral stored in the contract * @return totalDeposited peg collateral deposited */ function totalPegCollateral() external view override returns (uint256) { return totalDeposited; } /** @notice Amount of synthetic tokens minted through the contract * @return totalSyntheticTokens synthetic tokens minted */ function totalSyntheticTokensMinted() external view override returns (uint256) { return totalSyntheticTokens; } /** @notice Check if wrap can be performed or not * @return True if minting is paused, otherwise false */ function isPaused() external view override returns (bool) { return paused; } /** * @notice Check if an address is the trusted forwarder * @param forwarder Address to check * @return True is the input address is the trusted forwarder, otherwise false */ function isTrustedForwarder(address forwarder) public view override returns (bool) { try finder.getImplementationAddress(SynthereumInterfaces.TrustedForwarder) returns (address trustedForwarder) { if (forwarder == trustedForwarder) { return true; } else { return false; } } catch { return false; } } function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) { return ERC2771Context._msgSender(); } function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata) { return ERC2771Context._msgData(); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; interface AggregatorV3Interface { function decimals() external view returns ( uint8 ); function description() external view returns ( string memory ); function version() external view returns ( uint256 ); // getRoundData and latestRoundData should both raise "No data present" // if they do not have data to report, instead of returning unset values // which could be misinterpreted as actual reported values. function getRoundData( uint80 _roundId ) external view returns ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ); function latestRoundData() external view returns ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { AggregatorV3Interface } from '../../../../@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol'; import {ISynthereumPriceFeed} from '../../common/interfaces/IPriceFeed.sol'; interface ISynthereumChainlinkPriceFeed is ISynthereumPriceFeed { struct OracleData { uint80 roundId; uint256 answer; uint256 startedAt; uint256 updatedAt; uint80 answeredInRound; uint8 decimals; } enum Type {STANDARD, INVERSE, COMPUTED} /** * @notice Set a pair object associated to a price identifier * @param priceIdentifier Price feed identifier of the pair * @param aggregator Address of chainlink proxy aggregator * @param intermediatePairs Price feed identifier of the pairs to use for computed price * @param kind Dictates what kind of price identifier is being registered */ function setPair( Type kind, bytes32 priceIdentifier, address aggregator, bytes32[] memory intermediatePairs ) external; /** * @notice Delete the Pair object associated to a price identifier * @param priceIdentifier Price feed identifier */ function removePair(bytes32 priceIdentifier) external; /** * @notice Get last chainlink oracle price of a set of price identifiers * @param priceIdentifiers Array of Price feed identifier * @return prices Oracle prices for the ids */ function getLatestPrices(bytes32[] calldata priceIdentifiers) external returns (uint256[] memory prices); /** * @notice Returns the address of aggregator if exists, otherwise it reverts * @param priceIdentifier Price feed identifier * @return aggregator Aggregator associated with price identifier */ function getAggregator(bytes32 priceIdentifier) external view returns (AggregatorV3Interface aggregator); /** * @notice Get chainlink oracle price in a given round for a given price identifier * @param priceIdentifier Price feed identifier * @param _roundId Round Id * @return price Oracle price */ function getRoundPrice(bytes32 priceIdentifier, uint80 _roundId) external view returns (uint256 price); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; interface ISynthereumPriceFeed { /** * @notice Get last chainlink oracle price for a given price identifier * @param priceIdentifier Price feed identifier * @return price Oracle price */ function getLatestPrice(bytes32 priceIdentifier) external view returns (uint256 price); /** * @notice Return if price identifier is supported * @param priceIdentifier Price feed identifier * @return isSupported True if price is supported otherwise false */ function isPriceSupported(bytes32 priceIdentifier) external view returns (bool isSupported); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { ISynthereumChainlinkPriceFeed } from '../oracle/chainlink/interfaces/IChainlinkPriceFeed.sol'; contract WrongTypology { string public constant typology = 'WRONG'; ISynthereumChainlinkPriceFeed public priceFeed; constructor(address _priceFeed) { priceFeed = ISynthereumChainlinkPriceFeed(_priceFeed); } function getPrice(bytes32 identifier) external view returns (uint256 price) { price = priceFeed.getLatestPrice(identifier); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import '../base/interfaces/IStandardERC20.sol'; import '../base/utils/StringUtils.sol'; import '../common/interfaces/IEmergencyShutdown.sol'; import '../common/interfaces/IDeployment.sol'; import '../common/FactoryConditions.sol'; import '../common/ERC2771Context.sol'; import '../test/MockAggregator.sol'; import '../test/MockRandomAggregator.sol'; import '../test/TestnetERC20.sol'; import '../test/TestnetSelfMintingERC20.sol'; import '../test/SelfMintingControllerMock.sol'; import '../test/CreditLineControllerMock.sol'; import '../test/MockOnChainOracle.sol'; import '../test/PriceFeedGetter.sol'; import '../test/UtilsMock.sol'; import '../test/DerivativeMock.sol'; import '../test/PoolMock.sol'; import '../test/WrongTypology.sol'; import '../test/PoolRegistryMock.sol'; import '../test/MockContext.sol'; import '../test/MockCreditLineContext.sol'; import '../oracle/common/interfaces/IPriceFeed.sol'; import '../oracle/chainlink/interfaces/IChainlinkPriceFeed.sol'; import '../oracle/chainlink/ChainlinkPriceFeed.sol'; import '../synthereum-pool/v4/interfaces/IPoolOnChainPriceFeed.sol'; import '../synthereum-pool/v5/interfaces/ILiquidityPoolGeneral.sol'; import '../synthereum-pool/v5/interfaces/ILiquidityPoolInteraction.sol'; import '../synthereum-pool/v5/interfaces/ILiquidityPool.sol'; import '../synthereum-pool/v5/interfaces/ILiquidityPoolStorage.sol'; import '../synthereum-pool/v5/LiquidityPool.sol'; import '../synthereum-pool/v5/LiquidityPoolLib.sol'; import '../synthereum-pool/v5/LiquidityPoolCreator.sol'; import '../synthereum-pool/v5/LiquidityPoolFactory.sol'; import '../core/Manager.sol'; import '../core/FactoryVersioning.sol'; import '../core/Finder.sol'; import '../core/interfaces/IFinder.sol'; import '../core/interfaces/IManager.sol'; import '../core/interfaces/IFactoryVersioning.sol'; import '../core/interfaces/IDeploymentSignature.sol'; import '../core/interfaces/IDeployer.sol'; import '../core/interfaces/IJarvisBrrrrr.sol'; import '../core/Constants.sol'; import '../core/Deployer.sol'; import '../core/JarvisBrrrrr.sol'; import '../core/CollateralWhitelist.sol'; import '../core/IdentifierWhitelist.sol'; import '../core/TrustedForwarder.sol'; import '../core/interfaces/ICollateralWhitelist.sol'; import '../core/interfaces/IIdentifierWhitelist.sol'; import '../core/registries/SelfMintingRegistry.sol'; import '../core/registries/interfaces/IRegistry.sol'; import '../core/registries/Registry.sol'; import '../core/registries/PoolRegistry.sol'; import '../self-minting/v1/interfaces/ISelfMintingMultiParty.sol'; import '../self-minting/v2/CreditLineCreator.sol'; import '../self-minting/v2/CreditLineFactory.sol'; import '../self-minting/v2/CreditLineController.sol'; import '../self-minting/v2/interfaces/ICreditLine.sol'; import '../self-minting/v2/interfaces/ICreditLineController.sol'; import '../tokens/MintableBurnableSyntheticToken.sol'; import '../tokens/MintableBurnableSyntheticTokenPermit.sol'; import '../tokens/interfaces/BaseControlledMintableBurnableERC20.sol'; import '../tokens/interfaces/IMintableBurnableERC20.sol'; import '../tokens/factories/interfaces/IMintableBurnableTokenFactory.sol'; import '../tokens/MintableBurnableERC20.sol'; import '../tokens/factories/MintableBurnableTokenFactory.sol'; import '../tokens/factories/SyntheticTokenFactory.sol'; import '../tokens/factories/SyntheticTokenPermitFactory.sol'; import '../core/registries/FixedRateRegistry.sol'; import '../fixed-rate/v1/FixedRateCreator.sol'; import '../fixed-rate/v1/FixedRateFactory.sol'; import '../fixed-rate/v1/FixedRateWrapper.sol'; import '../fixed-rate/v1/interfaces/IFixedRateWrapper.sol';
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; interface IStandardERC20 is IERC20 { /** * @dev Returns the name of the token. */ function name() external view returns (string memory); /** * @dev Returns the symbol of the token, usually a shorter version of the * name. */ function symbol() external view returns (string memory); /** * @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() external view returns (uint8); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; /** * @title Library for strings */ library StringUtils { /** * @notice Convert string in 32bytes * @param _string string to convert * @return result string converted in 32bytes */ function stringToBytes32(string memory _string) internal pure returns (bytes32 result) { bytes memory source = bytes(_string); if (source.length == 0) { return 0x0; } else if (source.length > 32) { revert('Bytes length bigger than 32'); } else { assembly { result := mload(add(source, 32)) } } } /** * @notice Conevert bytes32 in string * @param _bytes32 32bytes to convert * @return 32bytes converted in string */ function bytes32ToString(bytes32 _bytes32) internal pure returns (string memory) { uint8 i = 0; while (i < 32 && _bytes32[i] != 0) { i++; } bytes memory bytesArray = new bytes(i); for (i = 0; i < 32 && _bytes32[i] != 0; i++) { bytesArray[i] = _bytes32[i]; } return string(bytesArray); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; interface IEmergencyShutdown { /** * @notice Shutdown the pool or self-minting-derivative in case of emergency * @notice Only Synthereum manager contract can call this function * @return timestamp Timestamp of emergency shutdown transaction * @return price Price of the pair at the moment of shutdown execution */ function emergencyShutdown() external returns (uint256 timestamp, uint256 price); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; /** * @title Interface that a pool MUST have in order to be included in the deployer */ interface ISynthereumDeployment { /** * @notice Get Synthereum finder of the pool/self-minting derivative * @return finder Returns finder contract */ function synthereumFinder() external view returns (ISynthereumFinder finder); /** * @notice Get Synthereum version * @return contractVersion Returns the version of this pool/self-minting derivative */ function version() external view returns (uint8 contractVersion); /** * @notice Get the collateral token of this pool/self-minting derivative * @return collateralCurrency The ERC20 collateral token */ function collateralToken() external view returns (IERC20 collateralCurrency); /** * @notice Get the synthetic token associated to this pool/self-minting derivative * @return syntheticCurrency The ERC20 synthetic token */ function syntheticToken() external view returns (IERC20 syntheticCurrency); /** * @notice Get the synthetic token symbol associated to this pool/self-minting derivative * @return symbol The ERC20 synthetic token symbol */ function syntheticTokenSymbol() external view returns (string memory symbol); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IStandardERC20} from '../base/interfaces/IStandardERC20.sol'; import {ISynthereumFinder} from '../core/interfaces/IFinder.sol'; import { ISynthereumCollateralWhitelist } from '../core/interfaces/ICollateralWhitelist.sol'; import { ISynthereumIdentifierWhitelist } from '../core/interfaces/IIdentifierWhitelist.sol'; import {SynthereumInterfaces} from '../core/Constants.sol'; /** @title Contract factory of self-minting derivatives */ contract FactoryConditions { /** * @notice Check if the sender is the deployer and if identifier and collateral are supported * @param synthereumFinder Synthereum finder * @param collateralToken Collateral token to check if it's in the whithelist * @param priceFeedIdentifier Identifier to check if it's in the whithelist */ function checkDeploymentConditions( ISynthereumFinder synthereumFinder, IStandardERC20 collateralToken, bytes32 priceFeedIdentifier ) internal view { address deployer = synthereumFinder.getImplementationAddress(SynthereumInterfaces.Deployer); require(msg.sender == deployer, 'Sender must be Synthereum deployer'); ISynthereumCollateralWhitelist collateralWhitelist = ISynthereumCollateralWhitelist( synthereumFinder.getImplementationAddress( SynthereumInterfaces.CollateralWhitelist ) ); require( collateralWhitelist.isOnWhitelist(address(collateralToken)), 'Collateral not supported' ); ISynthereumIdentifierWhitelist identifierWhitelist = ISynthereumIdentifierWhitelist( synthereumFinder.getImplementationAddress( SynthereumInterfaces.IdentifierWhitelist ) ); require( identifierWhitelist.isOnWhitelist(priceFeedIdentifier), 'Identifier not supported' ); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.3.2 (metatx/ERC2771Context.sol) pragma solidity ^0.8.0; import {Context} from '../../@openzeppelin/contracts/utils/Context.sol'; /** * @dev Context variant with ERC2771 support. */ abstract contract ERC2771Context is Context { function isTrustedForwarder(address forwarder) public view virtual returns (bool); function _msgSender() internal view virtual override returns (address sender) { if (isTrustedForwarder(msg.sender)) { // The assembly code is more direct than the Solidity version using `abi.decode`. assembly { sender := shr(96, calldataload(sub(calldatasize(), 20))) } } else { return super._msgSender(); } } function _msgData() internal view virtual override returns (bytes calldata) { if (isTrustedForwarder(msg.sender)) { return msg.data[0:msg.data.length - 20]; } else { return super._msgData(); } } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; contract MockAggregator { uint256 public constant version = 0; uint8 public decimals; int256 public latestAnswer; uint256 public latestTimestamp; uint256 public latestRound; mapping(uint256 => int256) public getAnswer; mapping(uint256 => uint256) public getTimestamp; mapping(uint256 => uint256) private getStartedAt; constructor(uint8 _decimals, int256 _initialAnswer) { decimals = _decimals; updateAnswer(_initialAnswer); } function updateAnswer(int256 _answer) public virtual { latestAnswer = _answer; latestTimestamp = block.timestamp; latestRound++; getAnswer[latestRound] = _answer; getTimestamp[latestRound] = block.timestamp; getStartedAt[latestRound] = block.timestamp; } function updateRoundData( uint80 _roundId, int256 _answer, uint256 _timestamp, uint256 _startedAt ) public virtual { latestRound = _roundId; latestAnswer = _answer; latestTimestamp = _timestamp; getAnswer[latestRound] = _answer; getTimestamp[latestRound] = _timestamp; getStartedAt[latestRound] = _startedAt; } function getRoundData(uint80 _roundId) public view returns ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ) { return ( _roundId, getAnswer[_roundId], getStartedAt[_roundId], getTimestamp[_roundId], _roundId ); } function latestRoundData() public view virtual returns ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ) { return ( uint80(latestRound), getAnswer[latestRound], getStartedAt[latestRound], getTimestamp[latestRound], uint80(latestRound) ); } function description() external pure returns (string memory) { return 'MockAggregator.sol'; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {SafeMath} from '../../@openzeppelin/contracts/utils/math/SafeMath.sol'; import { SignedSafeMath } from '../../@openzeppelin/contracts/utils/math/SignedSafeMath.sol'; import {Ownable} from '../../@openzeppelin/contracts/access/Ownable.sol'; import {MockAggregator} from './MockAggregator.sol'; contract MockRandomAggregator is Ownable, MockAggregator { using SafeMath for uint256; using SignedSafeMath for int256; uint256 public maxSpreadForSecond; constructor(int256 _initialAnswer, uint256 _maxSpreadForSecond) MockAggregator(18, _initialAnswer) { maxSpreadForSecond = _maxSpreadForSecond; } function latestRoundData() public view override returns ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ) { uint256 randomNumber = getRandomNumber(); answer = calculateNewPrice(randomNumber); (roundId, , startedAt, updatedAt, answeredInRound) = super .latestRoundData(); } function updateAnswer(int256 _answer) public override onlyOwner { super.updateAnswer(_answer); } function updateRoundData( uint80 _roundId, int256 _answer, uint256 _timestamp, uint256 _startedAt ) public override onlyOwner { super.updateRoundData(_roundId, _answer, _timestamp, _startedAt); } function calculateNewPrice(uint256 randomNumber) internal view returns (int256 newPrice) { int256 lastPrice = latestAnswer; int256 difference = lastPrice .mul(int256(block.timestamp.sub(latestTimestamp))) .mul(int256(maxSpreadForSecond)) .div(10**18) .mul(int256(randomNumber)) .div(10**18); newPrice = (randomNumber.mod(2) == 0) ? latestAnswer.sub(difference) : latestAnswer.add(difference); } function getRandomNumber() internal view returns (uint256) { return uint256(blockhash(block.number - 1)).mod(10**18); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.0; import '../../@openzeppelin/contracts/token/ERC20/ERC20.sol'; /** * @title An implementation of ERC20 with the same interface as the Compound project's testnet tokens (mainly DAI) * @dev This contract can be deployed or the interface can be used to communicate with Compound's ERC20 tokens. Note: * this token should never be used to store real value since it allows permissionless minting. */ contract TestnetERC20 is ERC20 { uint8 _decimals; /** * @notice Constructs the TestnetERC20. * @param _name The name which describes the new token. * @param _symbol The ticker abbreviation of the name. Ideally < 5 chars. * @param _tokenDecimals The number of decimals to define token precision. */ constructor( string memory _name, string memory _symbol, uint8 _tokenDecimals ) ERC20(_name, _symbol) { _decimals = _tokenDecimals; } function decimals() public view virtual override(ERC20) returns (uint8) { return _decimals; } // Sample token information. /** * @notice Mints value tokens to the owner address. * @param ownerAddress the address to mint to. * @param value the amount of tokens to mint. */ function allocateTo(address ownerAddress, uint256 value) external { _mint(ownerAddress, value); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {TestnetERC20} from './TestnetERC20.sol'; contract TestnetSelfMintingERC20 is TestnetERC20 { constructor( string memory _name, string memory _symbol, uint8 _decimals ) TestnetERC20(_name, _symbol, _decimals) {} }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; contract SelfMintingControllerMock { struct DaoFee { uint256 feePercentage; address feeRecipient; } mapping(address => uint256) private capMint; mapping(address => uint256) private capDeposit; mapping(address => DaoFee) private fee; function setCapMintAmount( address selfMintingDerivative, uint256 capMintAmount ) external { _setCapMintAmount(selfMintingDerivative, capMintAmount); } function setCapDepositRatio( address selfMintingDerivative, uint256 capDepositRatio ) external { _setCapDepositRatio(selfMintingDerivative, capDepositRatio); } function setDaoFee(address selfMintingDerivative, DaoFee calldata daoFee) external { _setDaoFee(selfMintingDerivative, daoFee); } function getCapMintAmount(address selfMintingDerivative) external view returns (uint256 capMintAmount) { capMintAmount = capMint[selfMintingDerivative]; } function getCapDepositRatio(address selfMintingDerivative) external view returns (uint256 capDepositRatio) { capDepositRatio = capDeposit[selfMintingDerivative]; } function getDaoFee(address selfMintingDerivative) external view returns (DaoFee memory daoFee) { daoFee = fee[selfMintingDerivative]; } function getDaoFeePercentage(address selfMintingDerivative) external view returns (uint256 daoFeePercentage) { daoFeePercentage = fee[selfMintingDerivative].feePercentage; } function getDaoFeeRecipient(address selfMintingDerivative) external view returns (address recipient) { recipient = fee[selfMintingDerivative].feeRecipient; } function _setCapMintAmount( address selfMintingDerivative, uint256 capMintAmount ) internal { require( capMint[selfMintingDerivative] != capMintAmount, 'Cap mint amount is the same' ); capMint[selfMintingDerivative] = capMintAmount; } function _setCapDepositRatio( address selfMintingDerivative, uint256 capDepositRatio ) internal { require( capDeposit[selfMintingDerivative] != capDepositRatio, 'Cap deposit ratio is the same' ); capDeposit[selfMintingDerivative] = capDepositRatio; } function _setDaoFee(address selfMintingDerivative, DaoFee calldata daoFee) internal { require( fee[selfMintingDerivative].feePercentage != daoFee.feePercentage || fee[selfMintingDerivative].feeRecipient != daoFee.feeRecipient, 'Dao fee is the same' ); fee[selfMintingDerivative] = DaoFee( daoFee.feePercentage, daoFee.feeRecipient ); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../core/interfaces/IFinder.sol'; import { ICreditLineStorage } from '../self-minting/v2/interfaces/ICreditLineStorage.sol'; import { FixedPoint } from '../../@uma/core/contracts/common/implementation/FixedPoint.sol'; /** * @title SelfMintingController * Set capMintAmount, and fee recipient, proportions and percentage of each self-minting derivative */ contract CreditLineControllerMock { using FixedPoint for FixedPoint.Unsigned; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //Describe role structure struct Roles { address admin; address[] maintainers; } //---------------------------------------- // Storage //---------------------------------------- ISynthereumFinder public synthereumFinder; mapping(address => uint256) private capMint; mapping(address => FixedPoint.Unsigned) private liquidationReward; mapping(address => FixedPoint.Unsigned) private overCollateralizationPercentage; mapping(address => ICreditLineStorage.Fee) private fee; //---------------------------------------- // Constructor //---------------------------------------- //---------------------------------------- // External functions //---------------------------------------- function setCollateralRequirement( address[] calldata selfMintingDerivatives, uint256[] calldata overcollateralPct ) external { require( selfMintingDerivatives.length > 0, 'No self-minting derivatives passed' ); require( selfMintingDerivatives.length == overcollateralPct.length, 'Number of derivatives and overcollaterals must be the same' ); for (uint256 j; j < selfMintingDerivatives.length; j++) { _setCollateralRequirement( selfMintingDerivatives[j], overcollateralPct[j] ); } } function setCapMintAmount( address[] calldata selfMintingDerivatives, uint256[] calldata capMintAmounts ) external { require( selfMintingDerivatives.length > 0, 'No self-minting derivatives passed' ); require( selfMintingDerivatives.length == capMintAmounts.length, 'Number of derivatives and mint cap amounts must be the same' ); for (uint256 j; j < selfMintingDerivatives.length; j++) { _setCapMintAmount(selfMintingDerivatives[j], capMintAmounts[j]); } } function setFeePercentage( address[] calldata selfMintingDerivatives, uint256[] calldata feePercentages ) external { uint256 selfMintingDerCount = selfMintingDerivatives.length; require(selfMintingDerCount > 0, 'No self-minting derivatives passed'); require( selfMintingDerCount == feePercentages.length, 'Number of derivatives and fee percentages must be the same' ); for (uint256 j; j < selfMintingDerCount; j++) { _setFeePercentage(selfMintingDerivatives[j], feePercentages[j]); } } function setFeeRecipients( address[] calldata selfMintingDerivatives, address[][] calldata feeRecipients, uint32[][] calldata feeProportions ) external { require( selfMintingDerivatives.length == feeRecipients.length, 'Mismatch between derivatives to update and fee recipients' ); require( selfMintingDerivatives.length == feeProportions.length, 'Mismatch between derivatives to update and fee proportions' ); // update each derivative fee parameters for (uint256 j; j < selfMintingDerivatives.length; j++) { _setFeeRecipients( selfMintingDerivatives[j], feeRecipients[j], feeProportions[j] ); } } function setLiquidationRewardPercentage( address[] calldata selfMintingDerivatives, FixedPoint.Unsigned[] calldata _liquidationRewards ) external { for (uint256 j = 0; j < selfMintingDerivatives.length; j++) { require( _liquidationRewards[j].isGreaterThan(0) && _liquidationRewards[j].isLessThanOrEqual( FixedPoint.fromUnscaledUint(1) ), 'Liquidation reward must be between 0 and 1 (100%)' ); liquidationReward[selfMintingDerivatives[j]] = _liquidationRewards[j]; } } function getCollateralRequirement(address selfMintingDerivative) external view returns (uint256) { return overCollateralizationPercentage[selfMintingDerivative].rawValue; } function getLiquidationRewardPercentage(address selfMintingDerivative) external view returns (uint256) { return liquidationReward[selfMintingDerivative].rawValue; } function getFeeInfo(address selfMintingDerivative) external view returns (ICreditLineStorage.Fee memory) { return fee[selfMintingDerivative]; } function getCapMintAmount(address selfMintingDerivative) external view returns (uint256 capMintAmount) { return capMint[selfMintingDerivative]; } //---------------------------------------- // Internal functions //---------------------------------------- function _setCollateralRequirement( address selfMintingDerivative, uint256 percentage ) internal { overCollateralizationPercentage[selfMintingDerivative] = FixedPoint .Unsigned(percentage); } function _setFeeRecipients( address selfMintingDerivative, address[] calldata feeRecipients, uint32[] calldata feeProportions ) internal { uint256 totalActualFeeProportions = 0; // Store the sum of all proportions for (uint256 i = 0; i < feeProportions.length; i++) { totalActualFeeProportions += feeProportions[i]; fee[selfMintingDerivative].feeRecipients = feeRecipients; fee[selfMintingDerivative].feeProportions = feeProportions; fee[selfMintingDerivative] .totalFeeProportions = totalActualFeeProportions; } } function _setFeePercentage( address selfMintingDerivative, uint256 feePercentage ) internal { require( fee[selfMintingDerivative].feePercentage != feePercentage, ' fee percentage is the same' ); fee[selfMintingDerivative].feePercentage = feePercentage; } function _setCapMintAmount( address selfMintingDerivative, uint256 capMintAmount ) internal { require( capMint[selfMintingDerivative] != capMintAmount, 'Cap mint amount is the same' ); capMint[selfMintingDerivative] = capMintAmount; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; contract MockOnChainOracle { mapping(bytes32 => uint256) idToPrice; uint8 decimals; constructor(uint8 _decimals) { decimals = _decimals; } function getLatestPrice(bytes32 identifier) external view returns (uint256 price) { price = idToPrice[identifier]; price = price * (10**(18 - decimals)); } function setPrice(bytes32 identifier, uint256 price) external { idToPrice[identifier] = price; } function isPriceSupported(bytes32 identifier) external view returns (bool) { return idToPrice[identifier] > 0; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { ISynthereumChainlinkPriceFeed } from '../oracle/chainlink/interfaces/IChainlinkPriceFeed.sol'; import {IERC20} from '../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; contract PriceFeedGetter { string public constant typology = 'POOL'; ISynthereumChainlinkPriceFeed public priceFeed; string private symbol; IERC20 private token; uint8 private poolVersion; constructor( address _priceFeed, string memory _symbol, IERC20 _token, uint8 _poolVersion ) { priceFeed = ISynthereumChainlinkPriceFeed(_priceFeed); symbol = _symbol; token = _token; poolVersion = _poolVersion; } function getPrice(bytes32 identifier) external view returns (uint256 price) { price = priceFeed.getLatestPrice(identifier); } function syntheticTokenSymbol() external view returns (string memory) { return symbol; } function collateralToken() external view returns (IERC20) { return token; } function version() external view returns (uint8) { return poolVersion; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {StringUtils} from '../base/utils/StringUtils.sol'; contract UtilsMock { using StringUtils for string; using StringUtils for bytes32; function stringToBytes32(string memory _string) external pure returns (bytes32 result) { result = _string.stringToBytes32(); } function bytes32ToString(bytes32 _bytes32) external pure returns (string memory) { return _bytes32.bytes32ToString(); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {ISynthereumFinder} from '../core/interfaces/IFinder.sol'; import { FixedPoint } from '../../@uma/core/contracts/common/implementation/FixedPoint.sol'; contract DerivativeMock { IERC20 private collateral; IERC20 private token; bytes32 private priceFeedIdentifier; constructor( IERC20 _collateral, IERC20 _token, bytes32 _priceFeedIdentifier ) { collateral = _collateral; token = _token; priceFeedIdentifier = _priceFeedIdentifier; } function collateralCurrency() external view returns (IERC20) { return collateral; } function tokenCurrency() external view returns (IERC20 syntheticCurrency) { return token; } function priceIdentifier() external view returns (bytes32 priceId) { priceId = priceFeedIdentifier; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import { ISynthereumChainlinkPriceFeed } from '../oracle/chainlink/interfaces/IChainlinkPriceFeed.sol'; contract PoolMock { uint8 private poolVersion; IERC20 private collateralCurrency; string private tokenSymbol; IERC20 private token; constructor( uint8 _version, IERC20 _collateralToken, string memory _syntheticTokenSymbol, IERC20 _syntheticToken ) { poolVersion = _version; collateralCurrency = _collateralToken; tokenSymbol = _syntheticTokenSymbol; token = _syntheticToken; } function version() external view returns (uint8) { return poolVersion; } function collateralToken() external view returns (IERC20) { return collateralCurrency; } function syntheticTokenSymbol() external view returns (string memory) { return tokenSymbol; } function syntheticToken() external view returns (IERC20) { return token; } function getRate(address priceFeed, bytes32 identifier) external view returns (uint256) { return ISynthereumChainlinkPriceFeed(priceFeed).getLatestPrice(identifier); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import { EnumerableSet } from '../../@openzeppelin/contracts/utils/structs/EnumerableSet.sol'; /** * @title Register and track all the pools deployed */ contract PoolRegistryMock { using EnumerableSet for EnumerableSet.AddressSet; //---------------------------------------- // Storage //---------------------------------------- mapping(string => mapping(IERC20 => mapping(uint8 => EnumerableSet.AddressSet))) private symbolToElements; //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Allow the deployer to register an element * @param syntheticTokenSymbol Symbol of the syntheticToken * @param collateralToken Collateral ERC20 token of the element deployed * @param version Version of the element deployed * @param element Address of the element deployed */ function register( string calldata syntheticTokenSymbol, IERC20 collateralToken, uint8 version, address element ) external { symbolToElements[syntheticTokenSymbol][collateralToken][version].add( element ); } /** * @notice Returns if a particular element exists or not * @param syntheticTokenSymbol Synthetic token symbol of the element * @param collateralToken ERC20 contract of collateral currency * @param version Version of the element * @param element Contract of the element to check * @return isElementDeployed Returns true if a particular element exists, otherwise false */ function isDeployed( string calldata syntheticTokenSymbol, IERC20 collateralToken, uint8 version, address element ) external view returns (bool isElementDeployed) { isElementDeployed = symbolToElements[syntheticTokenSymbol][collateralToken][ version ] .contains(element); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.3.2 (metatx/ERC2771Context.sol) pragma solidity ^0.8.0; import {SynthereumLiquidityPool} from '../synthereum-pool/v5/LiquidityPool.sol'; contract MockContext is SynthereumLiquidityPool { constructor(SynthereumLiquidityPool.ConstructorParams memory params) SynthereumLiquidityPool(params) {} function test() public view returns (address, bytes memory) { return (_msgSender(), _msgData()); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.3.2 (metatx/ERC2771Context.sol) pragma solidity ^0.8.0; import {CreditLine} from '../self-minting/v2/CreditLine.sol'; contract MockCreditLineContext is CreditLine { constructor(CreditLine.PositionManagerParams memory params) CreditLine(params) {} function test() public view returns (address, bytes memory) { return (_msgSender(), _msgData()); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { ISynthereumRegistry } from '../../core/registries/interfaces/IRegistry.sol'; import {ISynthereumDeployment} from '../../common/interfaces/IDeployment.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import { ISynthereumChainlinkPriceFeed } from './interfaces/IChainlinkPriceFeed.sol'; import {ITypology} from '../../common/interfaces/ITypology.sol'; import { AggregatorV3Interface } from '../../../@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol'; import { AccessControlEnumerable } from '../../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; import '../../../hardhat/console.sol'; contract SynthereumChainlinkPriceFeed is ISynthereumChainlinkPriceFeed, AccessControlEnumerable { bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //Describe role structure struct Roles { address admin; address maintainer; } struct Pair { bool isSupported; Type priceType; AggregatorV3Interface aggregator; bytes32[] intermediatePairs; } //---------------------------------------- // Storage //---------------------------------------- ISynthereumFinder public immutable synthereumFinder; mapping(bytes32 => Pair) public pairs; //---------------------------------------- // Events //---------------------------------------- event SetPair( bytes32 indexed priceIdentifier, Type kind, address aggregator, bytes32[] intermediatePairs ); event RemovePair(bytes32 indexed priceIdentifier); //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the SynthereumChainlinkPriceFeed contract * @param _synthereumFinder Synthereum finder contract * @param roles Admin and Mainteiner roles */ constructor(ISynthereumFinder _synthereumFinder, Roles memory roles) { synthereumFinder = _synthereumFinder; _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, roles.admin); _setupRole(MAINTAINER_ROLE, roles.maintainer); } //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, msg.sender), 'Sender must be the maintainer' ); _; } modifier onlyPoolsOrSelfMinting() { if (msg.sender != tx.origin) { ISynthereumRegistry registry; try ITypology(msg.sender).typology() returns ( string memory typologyString ) { bytes32 typology = keccak256(abi.encodePacked(typologyString)); if (typology == keccak256(abi.encodePacked('POOL'))) { registry = ISynthereumRegistry( synthereumFinder.getImplementationAddress( SynthereumInterfaces.PoolRegistry ) ); } else if (typology == keccak256(abi.encodePacked('SELF-MINTING'))) { registry = ISynthereumRegistry( synthereumFinder.getImplementationAddress( SynthereumInterfaces.SelfMintingRegistry ) ); } else { revert('Typology not supported'); } } catch { registry = ISynthereumRegistry( synthereumFinder.getImplementationAddress( SynthereumInterfaces.PoolRegistry ) ); } ISynthereumDeployment callingContract = ISynthereumDeployment(msg.sender); require( registry.isDeployed( callingContract.syntheticTokenSymbol(), callingContract.collateralToken(), callingContract.version(), msg.sender ), 'Calling contract not registered' ); } _; } //---------------------------------------- // External functions //---------------------------------------- function setPair( Type kind, bytes32 priceIdentifier, address aggregator, bytes32[] memory intermediatePairs ) external override onlyMaintainer { if (kind == Type.INVERSE || kind == Type.STANDARD) { require(aggregator != address(0), 'No aggregator set'); require( intermediatePairs.length == 0, 'No intermediate pairs should be specified' ); } else { require(aggregator == address(0), 'Aggregator should not be set'); require(intermediatePairs.length > 0, 'No intermediate pairs set'); } pairs[priceIdentifier] = Pair( true, kind, AggregatorV3Interface(aggregator), intermediatePairs ); emit SetPair(priceIdentifier, kind, aggregator, intermediatePairs); } function removePair(bytes32 priceIdentifier) external override onlyMaintainer { require( pairs[priceIdentifier].isSupported, 'Price identifier does not exist' ); delete pairs[priceIdentifier]; emit RemovePair(priceIdentifier); } /** * @notice Get last chainlink oracle price for a given price identifier * @param priceIdentifier Price feed identifier * @return price Oracle price */ function getLatestPrice(bytes32 priceIdentifier) external view override onlyPoolsOrSelfMinting returns (uint256 price) { price = _getLatestPrice(priceIdentifier); } /** * @notice Get chainlink oracle price in a given round for a given price identifier * @param priceIdentifier Price feed identifier * @param _roundId Round Id * @return price Oracle price */ function getRoundPrice(bytes32 priceIdentifier, uint80 _roundId) external view override onlyPoolsOrSelfMinting returns (uint256 price) { Type priceType = pairs[priceIdentifier].priceType; require(priceType != Type.COMPUTED, 'Computed price not supported'); OracleData memory oracleData = _getOracleRoundData(priceIdentifier, _roundId); price = _getScaledValue(oracleData.answer, oracleData.decimals); if (priceType == Type.INVERSE) { price = 10**36 / price; } } //---------------------------------------- // Public view functions //---------------------------------------- /** * @notice Get last chainlink oracle price of a set of price identifiers * @param priceIdentifiers Array of Price feed identifier * @return prices Oracle prices for the ids */ function getLatestPrices(bytes32[] calldata priceIdentifiers) public view override onlyPoolsOrSelfMinting returns (uint256[] memory prices) { prices = new uint256[](priceIdentifiers.length); for (uint256 i = 0; i < priceIdentifiers.length; i++) { prices[i] = _getLatestPrice(priceIdentifiers[i]); } } /** * @notice Returns the address of aggregator if exists, otherwise it reverts * @param priceIdentifier Price feed identifier * @return aggregator Aggregator associated with price identifier */ function getAggregator(bytes32 priceIdentifier) public view override returns (AggregatorV3Interface aggregator) { require( pairs[priceIdentifier].isSupported, 'Price identifier does not exist' ); aggregator = pairs[priceIdentifier].aggregator; } /** * @notice Return if price identifier is supported * @param priceIdentifier Price feed identifier * @return isSupported True if price is supported otherwise false */ function isPriceSupported(bytes32 priceIdentifier) external view override returns (bool isSupported) { isSupported = pairs[priceIdentifier].isSupported; } //---------------------------------------- // Internal view functions //---------------------------------------- /** * @notice Calculate a computed price of a specific pair * @notice A computed price is obtained by combining prices from separate aggregators * @param pair Struct identifying the pair of assets * @return price 18 decimals scaled price of the pair */ function _getComputedPrice(Pair memory pair) internal view returns (uint256 price) { bytes32[] memory intermediatePairs = pair.intermediatePairs; price = 10**18; for (uint8 i = 0; i < intermediatePairs.length; i++) { uint256 intermediatePrice = _getLatestPrice(intermediatePairs[i]); price = (price * intermediatePrice) / 10**18; } } /** * @notice Calculate the inverse price of a given pair * @param priceId Price feed identifier * @return price 18 decimals scaled price of the pair */ function _getInversePrice(bytes32 priceId) internal view returns (uint256 price) { OracleData memory oracleData = _getOracleLatestRoundData(priceId); price = 10**36 / _getScaledValue(oracleData.answer, oracleData.decimals); } /** * @notice Retrieve from aggregator the price of a given pair * @param priceId Price feed identifier * @return price 18 decimals scaled price of the pair */ function _getStandardPrice(bytes32 priceId) internal view returns (uint256 price) { OracleData memory oracleData = _getOracleLatestRoundData(priceId); price = _getScaledValue(oracleData.answer, oracleData.decimals); } /** * @notice Get last chainlink oracle data for a given price identifier * @param priceIdentifier Price feed identifier * @return oracleData Oracle data */ function _getOracleLatestRoundData(bytes32 priceIdentifier) internal view returns (OracleData memory oracleData) { AggregatorV3Interface aggregator = getAggregator(priceIdentifier); ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ) = aggregator.latestRoundData(); uint8 decimals = aggregator.decimals(); oracleData = OracleData( roundId, _convertPrice(answer), startedAt, updatedAt, answeredInRound, decimals ); } /** * @notice Get chainlink oracle data in a given round for a given price identifier * @param priceIdentifier Price feed identifier * @param _roundId Round Id * @return oracleData Oracle data */ function _getOracleRoundData(bytes32 priceIdentifier, uint80 _roundId) internal view returns (OracleData memory oracleData) { AggregatorV3Interface aggregator = getAggregator(priceIdentifier); ( uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound ) = aggregator.getRoundData(_roundId); uint8 decimals = aggregator.decimals(); oracleData = OracleData( roundId, _convertPrice(answer), startedAt, updatedAt, answeredInRound, decimals ); } //---------------------------------------- // Internal pure functions //---------------------------------------- function _getLatestPrice(bytes32 priceIdentifier) internal view returns (uint256 price) { Pair memory pair = pairs[priceIdentifier]; if (pair.priceType == Type.STANDARD) { price = _getStandardPrice(priceIdentifier); } else if (pair.priceType == Type.INVERSE) { price = _getInversePrice(priceIdentifier); } else { price = _getComputedPrice(pair); } } /** * @notice Covert the price from int to uint and it reverts if negative * @param uncovertedPrice Price before conversion * @return price Price after conversion */ function _convertPrice(int256 uncovertedPrice) internal pure returns (uint256 price) { require(uncovertedPrice >= 0, 'Negative value'); price = uint256(uncovertedPrice); } /** * @notice Covert the price to a integer with 18 decimals * @param unscaledPrice Price before conversion * @param decimals Number of decimals of unconverted price * @return price Price after conversion */ function _getScaledValue(uint256 unscaledPrice, uint8 decimals) internal pure returns (uint256 price) { price = unscaledPrice * (10**(18 - decimals)); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { FixedPoint } from '../../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; import {IERC20} from '../../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {ISynthereumFinder} from '../../../core/interfaces/IFinder.sol'; /** * @title Token Issuer Contract Interface */ interface ISynthereumPoolOnChainPriceFeed { event Mint( address indexed account, address indexed pool, uint256 collateralSent, uint256 numTokensReceived, uint256 feePaid, address recipient ); event Redeem( address indexed account, address indexed pool, uint256 numTokensSent, uint256 collateralReceived, uint256 feePaid, address recipient ); event Exchange( address indexed account, address indexed sourcePool, address indexed destPool, uint256 numTokensSent, uint256 destNumTokensReceived, uint256 feePaid, address recipient ); event Settlement( address indexed account, address indexed pool, uint256 numTokens, uint256 collateralSettled ); event SetFeePercentage(uint256 feePercentage); event SetFeeRecipients(address[] feeRecipients, uint32[] feeProportions); // We may omit the pool from event since we can recover it from the address of smart contract emitting event, but for query convenience we include it in the event event AddDerivative(address indexed pool, address indexed derivative); event RemoveDerivative(address indexed pool, address indexed derivative); // Describe fee structure struct Fee { // Fees charged when a user mints, redeem and exchanges tokens FixedPoint.Unsigned feePercentage; address[] feeRecipients; uint32[] feeProportions; } // Describe role structure struct Roles { address admin; address maintainer; address liquidityProvider; } struct MintParams { // Derivative to use address derivative; // Minimum amount of synthetic tokens that a user wants to mint using collateral (anti-slippage) uint256 minNumTokens; // Amount of collateral that a user wants to spend for minting uint256 collateralAmount; // Maximum amount of fees in percentage that user is willing to pay uint256 feePercentage; // Expiration time of the transaction uint256 expiration; // Address to which send synthetic tokens minted address recipient; } struct RedeemParams { // Derivative to use address derivative; // Amount of synthetic tokens that user wants to use for redeeming uint256 numTokens; // Minimium amount of collateral that user wants to redeem (anti-slippage) uint256 minCollateral; // Maximum amount of fees in percentage that user is willing to pay uint256 feePercentage; // Expiration time of the transaction uint256 expiration; // Address to which send collateral tokens redeemed address recipient; } struct ExchangeParams { // Derivative of source pool address derivative; // Destination pool ISynthereumPoolOnChainPriceFeed destPool; // Derivative of destination pool address destDerivative; // Amount of source synthetic tokens that user wants to use for exchanging uint256 numTokens; // Minimum Amount of destination synthetic tokens that user wants to receive (anti-slippage) uint256 minDestNumTokens; // Maximum amount of fees in percentage that user is willing to pay uint256 feePercentage; // Expiration time of the transaction uint256 expiration; // Address to which send synthetic tokens exchanged address recipient; } /** * @notice Add a derivate to be controlled by this pool * @param derivative A perpetual derivative */ function addDerivative(address derivative) external; /** * @notice Remove a derivative controlled by this pool * @param derivative A perpetual derivative */ function removeDerivative(address derivative) external; /** * @notice Mint synthetic tokens using fixed amount of collateral * @notice This calculate the price using on chain price feed * @notice User must approve collateral transfer for the mint request to succeed * @param mintParams Input parameters for minting (see MintParams struct) * @return syntheticTokensMinted Amount of synthetic tokens minted by a user * @return feePaid Amount of collateral paid by the minter as fee */ function mint(MintParams memory mintParams) external returns (uint256 syntheticTokensMinted, uint256 feePaid); /** * @notice Redeem amount of collateral using fixed number of synthetic token * @notice This calculate the price using on chain price feed * @notice User must approve synthetic token transfer for the redeem request to succeed * @param redeemParams Input parameters for redeeming (see RedeemParams struct) * @return collateralRedeemed Amount of collateral redeeem by user * @return feePaid Amount of collateral paid by user as fee */ function redeem(RedeemParams memory redeemParams) external returns (uint256 collateralRedeemed, uint256 feePaid); /** * @notice Exchange a fixed amount of synthetic token of this pool, with an amount of synthetic tokens of an another pool * @notice This calculate the price using on chain price feed * @notice User must approve synthetic token transfer for the redeem request to succeed * @param exchangeParams Input parameters for exchanging (see ExchangeParams struct) * @return destNumTokensMinted Amount of collateral redeeem by user * @return feePaid Amount of collateral paid by user as fee */ function exchange(ExchangeParams memory exchangeParams) external returns (uint256 destNumTokensMinted, uint256 feePaid); /** * @notice Liquidity provider withdraw margin from the pool * @param collateralAmount The amount of margin to withdraw */ function withdrawFromPool(uint256 collateralAmount) external; /** * @notice Move collateral from Pool to its derivative in order to increase GCR * @param derivative Derivative on which to deposit collateral * @param collateralAmount The amount of collateral to move into derivative */ function depositIntoDerivative(address derivative, uint256 collateralAmount) external; /** * @notice Start a slow withdrawal request * @notice Collateral can be withdrawn once the liveness period has elapsed * @param derivative Derivative from which collateral withdrawal is requested * @param collateralAmount The amount of excess collateral to withdraw */ function slowWithdrawRequest(address derivative, uint256 collateralAmount) external; /** * @notice Withdraw collateral after a withdraw request has passed it's liveness period * @param derivative Derivative from which collateral withdrawal is requested * @return amountWithdrawn Amount of collateral withdrawn by slow withdrawal */ function slowWithdrawPassedRequest(address derivative) external returns (uint256 amountWithdrawn); /** * @notice Withdraw collateral immediately if the remaining collateral is above GCR * @param derivative Derivative from which fast withdrawal is requested * @param collateralAmount The amount of excess collateral to withdraw * @return amountWithdrawn Amount of collateral withdrawn by fast withdrawal */ function fastWithdraw(address derivative, uint256 collateralAmount) external returns (uint256 amountWithdrawn); /** * @notice Redeem tokens after contract emergency shutdown * @param derivative Derivative for which settlement is requested * @return amountSettled Amount of collateral withdrawn after emergency shutdown */ function settleEmergencyShutdown(address derivative) external returns (uint256 amountSettled); /** * @notice Update the fee percentage, recipients and recipient proportions * @param _fee Fee struct containing percentage, recipients and proportions */ function setFee(Fee memory _fee) external; /** * @notice Update the fee percentage * @param _feePercentage The new fee percentage */ function setFeePercentage(uint256 _feePercentage) external; /** * @notice Update the addresses of recipients for generated fees and proportions of fees each address will receive * @param _feeRecipients An array of the addresses of recipients that will receive generated fees * @param _feeProportions An array of the proportions of fees generated each recipient will receive */ function setFeeRecipients( address[] memory _feeRecipients, uint32[] memory _feeProportions ) external; /** * @notice Reset the starting collateral ratio - for example when you add a new derivative without collateral * @param startingCollateralRatio Initial ratio between collateral amount and synth tokens */ function setStartingCollateralization(uint256 startingCollateralRatio) external; /** * @notice Get all the derivatives associated to this pool * @return Return list of all derivatives */ function getAllDerivatives() external view returns (address[] memory); /** * @notice Get the starting collateral ratio of the pool * @return startingCollateralRatio Initial ratio between collateral amount and synth tokens */ function getStartingCollateralization() external view returns (uint256 startingCollateralRatio); /** * @notice Returns infos about fee set * @return fee Percentage and recipients of fee */ function getFeeInfo() external view returns (Fee memory fee); /** * @notice Calculate the fees a user will have to pay to mint tokens with their collateral * @param collateralAmount Amount of collateral on which fees are calculated * @return fee Amount of fee that must be paid by the user */ function calculateFee(uint256 collateralAmount) external view returns (uint256 fee); /** * @notice Called by a source Pool's `exchange` function to mint destination tokens * @notice This functon can be called only by a pool registered in the PoolRegister contract * @param srcDerivative Derivative used by the source pool * @param derivative The derivative of the destination pool to use for mint * @param collateralAmount The amount of collateral to use from the source Pool * @param numTokens The number of new tokens to mint */ function exchangeMint( address srcDerivative, address derivative, uint256 collateralAmount, uint256 numTokens ) external; /** * @notice Returns price identifier of the pool * @return identifier Price identifier */ function getPriceFeedIdentifier() external view returns (bytes32 identifier); /** * @notice Check that a derivative is admitted in the pool * @param derivative Address of the derivative to be checked * @return isAdmitted true if derivative is admitted otherwise false */ function isDerivativeAdmitted(address derivative) external view returns (bool isAdmitted); /** * @notice Get Synthereum finder of the pool * @return finder Returns finder contract */ function synthereumFinder() external view returns (ISynthereumFinder finder); /** * @notice Get Synthereum version * @return poolVersion Returns the version of this Synthereum pool */ function version() external view returns (uint8 poolVersion); /** * @notice Get the collateral token * @return collateralCurrency The ERC20 collateral token */ function collateralToken() external view returns (IERC20 collateralCurrency); /** * @notice Get the synthetic token associated to this pool * @return syntheticCurrency The ERC20 synthetic token */ function syntheticToken() external view returns (IERC20 syntheticCurrency); /** * @notice Get the synthetic token symbol associated to this pool * @return symbol The ERC20 synthetic token symbol */ function syntheticTokenSymbol() external view returns (string memory symbol); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { ISynthereumLiquidityPoolInteraction } from './ILiquidityPoolInteraction.sol'; import { ISynthereumDeployment } from '../../../common/interfaces/IDeployment.sol'; interface ISynthereumLiquidityPoolGeneral is ISynthereumDeployment, ISynthereumLiquidityPoolInteraction {}
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; interface ISynthereumLiquidityPoolInteraction { /** * @notice Called by a source Pool's `exchange` function to mint destination tokens * @notice This functon can be called only by a pool registered in the PoolRegister contract * @param collateralAmount The amount of collateral to use from the source Pool * @param numTokens The number of new tokens to mint * @param recipient Recipient to which send synthetic token minted */ function exchangeMint( uint256 collateralAmount, uint256 numTokens, address recipient ) external; /** * @notice Returns price identifier of the pool * @return identifier Price identifier */ function getPriceFeedIdentifier() external view returns (bytes32 identifier); /** * @notice Return overcollateralization percentage from the storage * @return Overcollateralization percentage */ function overCollateralization() external view returns (uint256); /** * @notice Returns the total amount of liquidity deposited in the pool, but nut used as collateral * @return Total available liquidity */ function totalAvailableLiquidity() external view returns (uint256); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { IEmergencyShutdown } from '../../../common/interfaces/IEmergencyShutdown.sol'; import {ISynthereumLiquidityPoolGeneral} from './ILiquidityPoolGeneral.sol'; import {ISynthereumLiquidityPoolStorage} from './ILiquidityPoolStorage.sol'; import {ITypology} from '../../../common/interfaces/ITypology.sol'; /** * @title Token Issuer Contract Interface */ interface ISynthereumLiquidityPool is ITypology, IEmergencyShutdown, ISynthereumLiquidityPoolGeneral { struct MintParams { // Minimum amount of synthetic tokens that a user wants to mint using collateral (anti-slippage) uint256 minNumTokens; // Amount of collateral that a user wants to spend for minting uint256 collateralAmount; // Expiration time of the transaction uint256 expiration; // Address to which send synthetic tokens minted address recipient; } struct RedeemParams { // Amount of synthetic tokens that user wants to use for redeeming uint256 numTokens; // Minimium amount of collateral that user wants to redeem (anti-slippage) uint256 minCollateral; // Expiration time of the transaction uint256 expiration; // Address to which send collateral tokens redeemed address recipient; } struct ExchangeParams { // Destination pool ISynthereumLiquidityPoolGeneral destPool; // Amount of source synthetic tokens that user wants to use for exchanging uint256 numTokens; // Minimum Amount of destination synthetic tokens that user wants to receive (anti-slippage) uint256 minDestNumTokens; // Expiration time of the transaction uint256 expiration; // Address to which send synthetic tokens exchanged address recipient; } /** * @notice Mint synthetic tokens using fixed amount of collateral * @notice This calculate the price using on chain price feed * @notice User must approve collateral transfer for the mint request to succeed * @param mintParams Input parameters for minting (see MintParams struct) * @return syntheticTokensMinted Amount of synthetic tokens minted by a user * @return feePaid Amount of collateral paid by the user as fee */ function mint(MintParams calldata mintParams) external returns (uint256 syntheticTokensMinted, uint256 feePaid); /** * @notice Redeem amount of collateral using fixed number of synthetic token * @notice This calculate the price using on chain price feed * @notice User must approve synthetic token transfer for the redeem request to succeed * @param redeemParams Input parameters for redeeming (see RedeemParams struct) * @return collateralRedeemed Amount of collateral redeem by user * @return feePaid Amount of collateral paid by user as fee */ function redeem(RedeemParams calldata redeemParams) external returns (uint256 collateralRedeemed, uint256 feePaid); /** * @notice Exchange a fixed amount of synthetic token of this pool, with an amount of synthetic tokens of an another pool * @notice This calculate the price using on chain price feed * @notice User must approve synthetic token transfer for the redeem request to succeed * @param exchangeParams Input parameters for exchanging (see ExchangeParams struct) * @return destNumTokensMinted Amount of collateral redeem by user * @return feePaid Amount of collateral paid by user as fee */ function exchange(ExchangeParams calldata exchangeParams) external returns (uint256 destNumTokensMinted, uint256 feePaid); /** * @notice Withdraw unused deposited collateral by the LP * @notice Only a sender with LP role can call this function * @param collateralAmount Collateral to be withdrawn * @return remainingLiquidity Remaining unused collateral in the pool */ function withdrawLiquidity(uint256 collateralAmount) external returns (uint256 remainingLiquidity); /** * @notice Increase collaterallization of Lp position * @notice Only a sender with LP role can call this function * @param collateralToTransfer Collateral to be transferred before increase collateral in the position * @param collateralToIncrease Collateral to be added to the position * @return newTotalCollateral New total collateral amount */ function increaseCollateral( uint256 collateralToTransfer, uint256 collateralToIncrease ) external returns (uint256 newTotalCollateral); /** * @notice Decrease collaterallization of Lp position * @notice Check that final poosition is not undercollateralized * @notice Only a sender with LP role can call this function * @param collateralToDecrease Collateral to decreased from the position * @param collateralToWithdraw Collateral to be transferred to the LP * @return newTotalCollateral New total collateral amount */ function decreaseCollateral( uint256 collateralToDecrease, uint256 collateralToWithdraw ) external returns (uint256 newTotalCollateral); /** * @notice Withdraw fees gained by the sender * @return feeClaimed Amount of fee claimed */ function claimFee() external returns (uint256 feeClaimed); /** * @notice Liquidate Lp position for an amount of synthetic tokens undercollateralized * @notice Revert if position is not undercollateralized * @param numSynthTokens Number of synthetic tokens that user wants to liquidate * @return synthTokensLiquidated Amount of synthetic tokens liquidated * @return collateralReceived Amount of received collateral equal to the value of tokens liquidated * @return rewardAmount Amount of received collateral as reward for the liquidation */ function liquidate(uint256 numSynthTokens) external returns ( uint256 synthTokensLiquidated, uint256 collateralReceived, uint256 rewardAmount ); /** * @notice Redeem tokens after emergency shutdown * @return synthTokensSettled Amount of synthetic tokens liquidated * @return collateralSettled Amount of collateral withdrawn after emergency shutdown */ function settleEmergencyShutdown() external returns (uint256 synthTokensSettled, uint256 collateralSettled); /** * @notice Update the fee percentage, recipients and recipient proportions * @notice Only the maintainer can call this function * @param _feeData Fee info (percentage + recipients + weigths) */ function setFee(ISynthereumLiquidityPoolStorage.FeeData calldata _feeData) external; /** * @notice Update the fee percentage * @notice Only the maintainer can call this function * @param _feePercentage The new fee percentage */ function setFeePercentage(uint256 _feePercentage) external; /** * @notice Update the addresses of recipients for generated fees and proportions of fees each address will receive * @notice Only the maintainer can call this function * @param feeRecipients An array of the addresses of recipients that will receive generated fees * @param feeProportions An array of the proportions of fees generated each recipient will receive */ function setFeeRecipients( address[] calldata feeRecipients, uint32[] calldata feeProportions ) external; /** * @notice Update the overcollateralization percentage * @notice Only the maintainer can call this function * @param _overCollateralization Overcollateralization percentage */ function setOverCollateralization(uint256 _overCollateralization) external; /** * @notice Update the liquidation reward percentage * @notice Only the maintainer can call this function * @param _liquidationReward Percentage of reward for correct liquidation by a liquidator */ function setLiquidationReward(uint256 _liquidationReward) external; /** * @notice Returns fee percentage set by the maintainer * @return Fee percentage */ function feePercentage() external view returns (uint256); /** * @notice Returns fee recipients info * @return Addresses, weigths and total of weigths */ function feeRecipientsInfo() external view returns ( address[] memory, uint32[] memory, uint256 ); /** * @notice Returns total number of synthetic tokens generated by this pool * @return Number of synthetic tokens */ function totalSyntheticTokens() external view returns (uint256); /** * @notice Returns the total amount of collateral used for collateralizing tokens (users + LP) * @return Total collateral amount */ function totalCollateralAmount() external view returns (uint256); /** * @notice Returns the total amount of fees to be withdrawn * @return Total fee amount */ function totalFeeAmount() external view returns (uint256); /** * @notice Returns the user's fee to be withdrawn * @param user User's address * @return User's fee */ function userFee(address user) external view returns (uint256); /** * @notice Returns the percentage of overcollateralization to which a liquidation can triggered * @return Percentage of overcollateralization */ function collateralRequirement() external view returns (uint256); /** * @notice Returns the percentage of reward for correct liquidation by a liquidator * @return Percentage of reward */ function liquidationReward() external view returns (uint256); /** * @notice Returns the price of the pair at the moment of the shutdown * @return Price of the pair */ function emergencyShutdownPrice() external view returns (uint256); /** * @notice Returns the timestamp (unix time) at the moment of the shutdown * @return Timestamp */ function emergencyShutdownTimestamp() external view returns (uint256); /** * @notice Returns if position is overcollateralized and thepercentage of coverage of the collateral according to the last price * @return True if position is overcollaterlized, otherwise false + percentage of coverage (totalCollateralAmount / (price * tokensCollateralized)) */ function collateralCoverage() external returns (bool, uint256); /** * @notice Returns the synthetic tokens will be received and fees will be paid in exchange for an input collateral amount * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param inputCollateral Input collateral amount to be exchanged * @return synthTokensReceived Synthetic tokens will be minted * @return feePaid Collateral fee will be paid */ function getMintTradeInfo(uint256 inputCollateral) external view returns (uint256 synthTokensReceived, uint256 feePaid); /** * @notice Returns the collateral amount will be received and fees will be paid in exchange for an input amount of synthetic tokens * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param syntheticTokens Amount of synthetic tokens to be exchanged * @return collateralAmountReceived Collateral amount will be received by the user * @return feePaid Collateral fee will be paid */ function getRedeemTradeInfo(uint256 syntheticTokens) external view returns (uint256 collateralAmountReceived, uint256 feePaid); /** * @notice Returns the destination synthetic tokens amount will be received and fees will be paid in exchange for an input amount of synthetic tokens * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param syntheticTokens Amount of synthetic tokens to be exchanged * @param destinationPool Pool in which mint the destination synthetic token * @return destSyntheticTokensReceived Synthetic tokens will be received from destination pool * @return feePaid Collateral fee will be paid */ function getExchangeTradeInfo( uint256 syntheticTokens, ISynthereumLiquidityPoolGeneral destinationPool ) external view returns (uint256 destSyntheticTokensReceived, uint256 feePaid); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IStandardERC20} from '../../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableERC20 } from '../../../tokens/interfaces/IMintableBurnableERC20.sol'; import {ISynthereumFinder} from '../../../core/interfaces/IFinder.sol'; import { FixedPoint } from '../../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; interface ISynthereumLiquidityPoolStorage { // Describe role structure struct Roles { address admin; address maintainer; address liquidityProvider; } // Describe fee data structure struct FeeData { // Fees charged when a user mints, redeem and exchanges tokens FixedPoint.Unsigned feePercentage; // Recipient receiving fees address[] feeRecipients; // Proportion for each recipient uint32[] feeProportions; } // Describe fee structure struct Fee { // Fee data structure FeeData feeData; // Used with individual proportions to scale values uint256 totalFeeProportions; } struct Storage { // Synthereum finder ISynthereumFinder finder; // Synthereum version uint8 version; // Collateral token IStandardERC20 collateralToken; // Synthetic token IMintableBurnableERC20 syntheticToken; // Overcollateralization percentage FixedPoint.Unsigned overCollateralization; // Fees Fee fee; // Price identifier bytes32 priceIdentifier; } struct LPPosition { // Collateral used for collateralize tokens FixedPoint.Unsigned totalCollateralAmount; // Number of tokens collateralized FixedPoint.Unsigned tokensCollateralized; } struct Liquidation { // Percentage of overcollateralization to which a liquidation can triggered FixedPoint.Unsigned collateralRequirement; // Percentage of reward for correct liquidation by a liquidator FixedPoint.Unsigned liquidationReward; } struct FeeStatus { // Track the fee gained to be withdrawn by an address mapping(address => FixedPoint.Unsigned) feeGained; // Total amount of fees to be withdrawn FixedPoint.Unsigned totalFeeAmount; } struct Shutdown { // Timestamp of execution of shutdown uint256 timestamp; // Price of the pair at the moment of the shutdown FixedPoint.Unsigned price; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {IStandardERC20} from '../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; import {ISynthereumLiquidityPool} from './interfaces/ILiquidityPool.sol'; import { ISynthereumLiquidityPoolStorage } from './interfaces/ILiquidityPoolStorage.sol'; import { ISynthereumLiquidityPoolGeneral } from './interfaces/ILiquidityPoolGeneral.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import { FixedPoint } from '../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; import {SynthereumLiquidityPoolLib} from './LiquidityPoolLib.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; import {ERC2771Context} from '../../common/ERC2771Context.sol'; import { AccessControlEnumerable, Context } from '../../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; /** * @title Token Issuer Contract * @notice Collects collateral and issues synthetic assets */ contract SynthereumLiquidityPool is ISynthereumLiquidityPoolStorage, ISynthereumLiquidityPool, AccessControlEnumerable, ERC2771Context, ReentrancyGuard { using SynthereumLiquidityPoolLib for Storage; using SynthereumLiquidityPoolLib for Liquidation; struct ConstructorParams { // Synthereum finder ISynthereumFinder finder; // Synthereum pool version uint8 version; // ERC20 collateral token IStandardERC20 collateralToken; // ERC20 synthetic token IMintableBurnableERC20 syntheticToken; // The addresses of admin, maintainer, liquidity provider Roles roles; // Overcollateralization percentage uint256 overCollateralization; // The feeData structure FeeData feeData; // Identifier of price to be used in the price feed bytes32 priceIdentifier; // Percentage of overcollateralization to which a liquidation can triggered uint256 collateralRequirement; // Percentage of reward for correct liquidation by a liquidator uint256 liquidationReward; } //---------------------------------------- // Constants //---------------------------------------- string public constant override typology = 'POOL'; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); bytes32 public constant LIQUIDITY_PROVIDER_ROLE = keccak256('Liquidity Provider'); //---------------------------------------- // Storage //---------------------------------------- Storage private poolStorage; LPPosition private lpPosition; Liquidation private liquidationData; FeeStatus private feeStatus; Shutdown private emergencyShutdownData; //---------------------------------------- // Events //---------------------------------------- event Mint( address indexed account, uint256 collateralSent, uint256 numTokensReceived, uint256 feePaid, address recipient ); event Redeem( address indexed account, uint256 numTokensSent, uint256 collateralReceived, uint256 feePaid, address recipient ); event Exchange( address indexed account, address indexed destPool, uint256 numTokensSent, uint256 destNumTokensReceived, uint256 feePaid, address recipient ); event WithdrawLiquidity( address indexed lp, uint256 liquidityWithdrawn, uint256 remainingLiquidity ); event IncreaseCollateral( address indexed lp, uint256 collateralAdded, uint256 newTotalCollateral ); event DecreaseCollateral( address indexed lp, uint256 collateralRemoved, uint256 newTotalCollateral ); event ClaimFee( address indexed claimer, uint256 feeAmount, uint256 totalRemainingFees ); event Liquidate( address indexed liquidator, uint256 tokensLiquidated, uint256 price, uint256 collateralExpected, uint256 collateralReceived, uint256 rewardReceived ); event EmergencyShutdown( uint256 timestamp, uint256 price, uint256 finalCollateral ); event Settle( address indexed account, uint256 numTokensSettled, uint256 collateralExpected, uint256 collateralSettled ); event SetFeePercentage(uint256 feePercentage); event SetFeeRecipients(address[] feeRecipients, uint32[] feeProportions); event SetOverCollateralization(uint256 overCollateralization); event SetLiquidationReward(uint256 liquidationReward); //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, _msgSender()), 'Sender must be the maintainer' ); _; } modifier onlyLiquidityProvider() { require( hasRole(LIQUIDITY_PROVIDER_ROLE, _msgSender()), 'Sender must be the liquidity provider' ); _; } modifier notEmergencyShutdown() { require(emergencyShutdownData.timestamp == 0, 'Pool emergency shutdown'); _; } modifier isEmergencyShutdown() { require( emergencyShutdownData.timestamp != 0, 'Pool not emergency shutdown' ); _; } //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructor of liquidity pool */ constructor(ConstructorParams memory params) nonReentrant { poolStorage.initialize( liquidationData, params.finder, params.version, params.collateralToken, params.syntheticToken, FixedPoint.Unsigned(params.overCollateralization), params.priceIdentifier, FixedPoint.Unsigned(params.collateralRequirement), FixedPoint.Unsigned(params.liquidationReward) ); poolStorage.setFeePercentage(params.feeData.feePercentage); poolStorage.setFeeRecipients( params.feeData.feeRecipients, params.feeData.feeProportions ); _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(LIQUIDITY_PROVIDER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, params.roles.admin); _setupRole(MAINTAINER_ROLE, params.roles.maintainer); _setupRole(LIQUIDITY_PROVIDER_ROLE, params.roles.liquidityProvider); } //---------------------------------------- // External functions //---------------------------------------- /** * @notice Mint synthetic tokens using fixed amount of collateral * @notice This calculate the price using on chain price feed * @notice User must approve collateral transfer for the mint request to succeed * @param mintParams Input parameters for minting (see MintParams struct) * @return syntheticTokensMinted Amount of synthetic tokens minted by a user * @return feePaid Amount of collateral paid by the user as fee */ function mint(MintParams calldata mintParams) external override notEmergencyShutdown nonReentrant returns (uint256 syntheticTokensMinted, uint256 feePaid) { (syntheticTokensMinted, feePaid) = poolStorage.mint( lpPosition, feeStatus, mintParams, _msgSender() ); } /** * @notice Redeem amount of collateral using fixed number of synthetic token * @notice This calculate the price using on chain price feed * @notice User must approve synthetic token transfer for the redeem request to succeed * @param redeemParams Input parameters for redeeming (see RedeemParams struct) * @return collateralRedeemed Amount of collateral redeem by user * @return feePaid Amount of collateral paid by user as fee */ function redeem(RedeemParams calldata redeemParams) external override notEmergencyShutdown nonReentrant returns (uint256 collateralRedeemed, uint256 feePaid) { (collateralRedeemed, feePaid) = poolStorage.redeem( lpPosition, feeStatus, redeemParams, _msgSender() ); } /** * @notice Exchange a fixed amount of synthetic token of this pool, with an amount of synthetic tokens of an another pool * @notice This calculate the price using on chain price feed * @notice User must approve synthetic token transfer for the redeem request to succeed * @param exchangeParams Input parameters for exchanging (see ExchangeParams struct) * @return destNumTokensMinted Amount of collateral redeem by user * @return feePaid Amount of collateral paid by user as fee */ function exchange(ExchangeParams calldata exchangeParams) external override notEmergencyShutdown nonReentrant returns (uint256 destNumTokensMinted, uint256 feePaid) { (destNumTokensMinted, feePaid) = poolStorage.exchange( lpPosition, feeStatus, exchangeParams, _msgSender() ); } /** * @notice Called by a source Pool's `exchange` function to mint destination tokens * @notice This functon can be called only by a pool registered in the PoolRegister contract * @param collateralAmount The amount of collateral to use from the source Pool * @param numTokens The number of new tokens to mint * @param recipient Recipient to which send synthetic token minted */ function exchangeMint( uint256 collateralAmount, uint256 numTokens, address recipient ) external override notEmergencyShutdown nonReentrant { poolStorage.exchangeMint( lpPosition, feeStatus, FixedPoint.Unsigned(collateralAmount), FixedPoint.Unsigned(numTokens), recipient ); } /** * @notice Withdraw unused deposited collateral by the LP * @notice Only a sender with LP role can call this function * @param collateralAmount Collateral to be withdrawn * @return remainingLiquidity Remaining unused collateral in the pool */ function withdrawLiquidity(uint256 collateralAmount) external override onlyLiquidityProvider notEmergencyShutdown nonReentrant returns (uint256 remainingLiquidity) { remainingLiquidity = poolStorage.withdrawLiquidity( lpPosition, feeStatus, FixedPoint.Unsigned(collateralAmount), _msgSender() ); } /** * @notice Increase collaterallization of Lp position * @notice Only a sender with LP role can call this function * @param collateralToTransfer Collateral to be transferred before increase collateral in the position * @param collateralToIncrease Collateral to be added to the position * @return newTotalCollateral New total collateral amount */ function increaseCollateral( uint256 collateralToTransfer, uint256 collateralToIncrease ) external override onlyLiquidityProvider nonReentrant returns (uint256 newTotalCollateral) { newTotalCollateral = poolStorage.increaseCollateral( lpPosition, feeStatus, FixedPoint.Unsigned(collateralToTransfer), FixedPoint.Unsigned(collateralToIncrease), _msgSender() ); } /** * @notice Decrease collaterallization of Lp position * @notice Check that final poosition is not undercollateralized * @notice Only a sender with LP role can call this function * @param collateralToDecrease Collateral to decreased from the position * @param collateralToWithdraw Collateral to be transferred to the LP * @return newTotalCollateral New total collateral amount */ function decreaseCollateral( uint256 collateralToDecrease, uint256 collateralToWithdraw ) external override onlyLiquidityProvider notEmergencyShutdown nonReentrant returns (uint256 newTotalCollateral) { newTotalCollateral = poolStorage.decreaseCollateral( lpPosition, liquidationData, feeStatus, FixedPoint.Unsigned(collateralToDecrease), FixedPoint.Unsigned(collateralToWithdraw), _msgSender() ); } /** * @notice Withdraw fees gained by the sender * @return feeClaimed Amount of fee claimed */ function claimFee() external override nonReentrant returns (uint256 feeClaimed) { feeClaimed = poolStorage.claimFee(feeStatus, _msgSender()); } /** * @notice Liquidate Lp position for an amount of synthetic tokens undercollateralized * @notice Revert if position is not undercollateralized * @param numSynthTokens Number of synthetic tokens that user wants to liquidate * @return synthTokensLiquidated Amount of synthetic tokens liquidated * @return collateralReceived Amount of received collateral equal to the value of tokens liquidated * @return rewardAmount Amount of received collateral as reward for the liquidation */ function liquidate(uint256 numSynthTokens) external override notEmergencyShutdown nonReentrant returns ( uint256 synthTokensLiquidated, uint256 collateralReceived, uint256 rewardAmount ) { (synthTokensLiquidated, collateralReceived, rewardAmount) = poolStorage .liquidate( lpPosition, liquidationData, feeStatus, FixedPoint.Unsigned(numSynthTokens), _msgSender() ); } /** * @notice Shutdown the pool in case of emergency * @notice Only Synthereum manager contract can call this function * @return timestamp Timestamp of emergency shutdown transaction * @return price Price of the pair at the moment of shutdown execution */ function emergencyShutdown() external override notEmergencyShutdown nonReentrant returns (uint256 timestamp, uint256 price) { (timestamp, price) = poolStorage.emergencyShutdown( lpPosition, feeStatus, emergencyShutdownData ); } /** * @notice Redeem tokens after emergency shutdown * @return synthTokensSettled Amount of synthetic tokens liquidated * @return collateralSettled Amount of collateral withdrawn after emergency shutdown */ function settleEmergencyShutdown() external override isEmergencyShutdown nonReentrant returns (uint256 synthTokensSettled, uint256 collateralSettled) { address msgSender = _msgSender(); bool isLiquidityProvider = hasRole(LIQUIDITY_PROVIDER_ROLE, msgSender); (synthTokensSettled, collateralSettled) = poolStorage .settleEmergencyShutdown( lpPosition, feeStatus, emergencyShutdownData, isLiquidityProvider, msgSender ); } /** * @notice Update the fee percentage, recipients and recipient proportions * @notice Only the maintainer can call this function * @param _feeData Fee info (percentage + recipients + weigths) */ function setFee(ISynthereumLiquidityPoolStorage.FeeData calldata _feeData) external override onlyMaintainer nonReentrant { poolStorage.setFeePercentage(_feeData.feePercentage); poolStorage.setFeeRecipients( _feeData.feeRecipients, _feeData.feeProportions ); } /** * @notice Update the fee percentage * @notice Only the maintainer can call this function * @param _feePercentage The new fee percentage */ function setFeePercentage(uint256 _feePercentage) external override onlyMaintainer nonReentrant { poolStorage.setFeePercentage(FixedPoint.Unsigned(_feePercentage)); } /** * @notice Update the addresses of recipients for generated fees and proportions of fees each address will receive * @notice Only the maintainer can call this function * @param feeRecipients An array of the addresses of recipients that will receive generated fees * @param feeProportions An array of the proportions of fees generated each recipient will receive */ function setFeeRecipients( address[] calldata feeRecipients, uint32[] calldata feeProportions ) external override onlyMaintainer nonReentrant { poolStorage.setFeeRecipients(feeRecipients, feeProportions); } /** * @notice Update the overcollateralization percentage * @notice Only the maintainer can call this function * @param _overCollateralization Overcollateralization percentage */ function setOverCollateralization(uint256 _overCollateralization) external override onlyMaintainer nonReentrant { poolStorage.setOverCollateralization( liquidationData, FixedPoint.Unsigned(_overCollateralization) ); } /** * @notice Update the liquidation reward percentage * @notice Only the maintainer can call this function * @param _liquidationReward Percentage of reward for correct liquidation by a liquidator */ function setLiquidationReward(uint256 _liquidationReward) external override onlyMaintainer nonReentrant { liquidationData.setLiquidationReward( FixedPoint.Unsigned(_liquidationReward) ); } //---------------------------------------- // External view functions //---------------------------------------- /** * @notice Get Synthereum finder of the pool * @return finder Returns finder contract */ function synthereumFinder() external view override returns (ISynthereumFinder finder) { finder = poolStorage.finder; } /** * @notice Get Synthereum version * @return poolVersion Returns the version of the Synthereum pool */ function version() external view override returns (uint8 poolVersion) { poolVersion = poolStorage.version; } /** * @notice Get the collateral token * @return collateralCurrency The ERC20 collateral token */ function collateralToken() external view override returns (IERC20 collateralCurrency) { collateralCurrency = poolStorage.collateralToken; } /** * @notice Get the synthetic token associated to this pool * @return syntheticCurrency The ERC20 synthetic token */ function syntheticToken() external view override returns (IERC20 syntheticCurrency) { syntheticCurrency = poolStorage.syntheticToken; } /** * @notice Get the synthetic token symbol associated to this pool * @return symbol The ERC20 synthetic token symbol */ function syntheticTokenSymbol() external view override returns (string memory symbol) { symbol = IStandardERC20(address(poolStorage.syntheticToken)).symbol(); } /** * @notice Returns price identifier of the pool * @return identifier Price identifier */ function getPriceFeedIdentifier() external view override returns (bytes32 identifier) { identifier = poolStorage.priceIdentifier; } /** * @notice Return overcollateralization percentage from the storage * @return Overcollateralization percentage */ function overCollateralization() external view override returns (uint256) { return poolStorage.overCollateralization.rawValue; } /** * @notice Returns fee percentage set by the maintainer * @return Fee percentage */ function feePercentage() external view override returns (uint256) { return poolStorage.fee.feeData.feePercentage.rawValue; } /** * @notice Returns fee recipients info * @return Addresses, weigths and total of weigths */ function feeRecipientsInfo() external view override returns ( address[] memory, uint32[] memory, uint256 ) { FeeData storage _feeData = poolStorage.fee.feeData; return ( _feeData.feeRecipients, _feeData.feeProportions, poolStorage.fee.totalFeeProportions ); } /** * @notice Returns total number of synthetic tokens generated by this pool * @return Number of synthetic tokens */ function totalSyntheticTokens() external view override returns (uint256) { return lpPosition.tokensCollateralized.rawValue; } /** * @notice Returns the total amount of collateral used for collateralizing tokens (users + LP) * @return Total collateral amount */ function totalCollateralAmount() external view override returns (uint256) { return lpPosition.totalCollateralAmount.rawValue; } /** * @notice Returns the total amount of liquidity deposited in the pool, but nut used as collateral * @return Total available liquidity */ function totalAvailableLiquidity() external view override returns (uint256) { return poolStorage.totalAvailableLiquidity(lpPosition, feeStatus); } /** * @notice Returns the total amount of fees to be withdrawn * @return Total fee amount */ function totalFeeAmount() external view override returns (uint256) { return feeStatus.totalFeeAmount.rawValue; } /** * @notice Returns the user's fee to be withdrawn * @param user User's address * @return User's fee */ function userFee(address user) external view override returns (uint256) { return feeStatus.feeGained[user].rawValue; } /** * @notice Returns the percentage of overcollateralization to which a liquidation can triggered * @return Percentage of overcollateralization */ function collateralRequirement() external view override returns (uint256) { return liquidationData.collateralRequirement.rawValue; } /** * @notice Returns the percentage of reward for correct liquidation by a liquidator * @return Percentage of reward */ function liquidationReward() external view override returns (uint256) { return liquidationData.liquidationReward.rawValue; } /** * @notice Returns the price of the pair at the moment of the shutdown * @return Price of the pair */ function emergencyShutdownPrice() external view override returns (uint256) { return emergencyShutdownData.price.rawValue; } /** * @notice Returns the timestamp (unix time) at the moment of the shutdown * @return Timestamp */ function emergencyShutdownTimestamp() external view override returns (uint256) { return emergencyShutdownData.timestamp; } /** * @notice Returns if position is overcollateralized and thepercentage of coverage of the collateral according to the last price * @return True if position is overcollaterlized, otherwise false + percentage of coverage (totalCollateralAmount / (price * tokensCollateralized)) */ function collateralCoverage() external view override returns (bool, uint256) { return poolStorage.collateralCoverage(lpPosition, liquidationData); } /** * @notice Returns the synthetic tokens will be received and fees will be paid in exchange for an input collateral amount * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param inputCollateral Input collateral amount to be exchanged * @return synthTokensReceived Synthetic tokens will be minted * @return feePaid Collateral fee will be paid */ function getMintTradeInfo(uint256 inputCollateral) external view override returns (uint256 synthTokensReceived, uint256 feePaid) { (synthTokensReceived, feePaid) = poolStorage.getMintTradeInfo( lpPosition, feeStatus, FixedPoint.Unsigned(inputCollateral) ); } /** * @notice Returns the collateral amount will be received and fees will be paid in exchange for an input amount of synthetic tokens * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param syntheticTokens Amount of synthetic tokens to be exchanged * @return collateralAmountReceived Collateral amount will be received by the user * @return feePaid Collateral fee will be paid */ function getRedeemTradeInfo(uint256 syntheticTokens) external view override returns (uint256 collateralAmountReceived, uint256 feePaid) { (collateralAmountReceived, feePaid) = poolStorage.getRedeemTradeInfo( lpPosition, FixedPoint.Unsigned(syntheticTokens) ); } /** * @notice Returns the destination synthetic tokens amount will be received and fees will be paid in exchange for an input amount of synthetic tokens * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param syntheticTokens Amount of synthetic tokens to be exchanged * @param destinationPool Pool in which mint the destination synthetic token * @return destSyntheticTokensReceived Synthetic tokens will be received from destination pool * @return feePaid Collateral fee will be paid */ function getExchangeTradeInfo( uint256 syntheticTokens, ISynthereumLiquidityPoolGeneral destinationPool ) external view override returns (uint256 destSyntheticTokensReceived, uint256 feePaid) { (destSyntheticTokensReceived, feePaid) = poolStorage.getExchangeTradeInfo( lpPosition, FixedPoint.Unsigned(syntheticTokens), destinationPool ); } /** * @notice Check if an address is the trusted forwarder * @param forwarder Address to check * @return True is the input address is the trusted forwarder, otherwise false */ function isTrustedForwarder(address forwarder) public view override returns (bool) { try poolStorage.finder.getImplementationAddress( SynthereumInterfaces.TrustedForwarder ) returns (address trustedForwarder) { if (forwarder == trustedForwarder) { return true; } else { return false; } } catch { return false; } } function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) { return ERC2771Context._msgSender(); } function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata) { return ERC2771Context._msgData(); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { ISynthereumLiquidityPoolStorage } from './interfaces/ILiquidityPoolStorage.sol'; import {ISynthereumLiquidityPool} from './interfaces/ILiquidityPool.sol'; import { FixedPoint } from '../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; import {IStandardERC20} from '../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { ISynthereumRegistry } from '../../core/registries/interfaces/IRegistry.sol'; import { ISynthereumPriceFeed } from '../../oracle/common/interfaces/IPriceFeed.sol'; import { ISynthereumLiquidityPoolGeneral } from './interfaces/ILiquidityPoolGeneral.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import { SafeERC20 } from '../../../@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol'; /** * @notice Pool implementation is stored here to reduce deployment costs */ library SynthereumLiquidityPoolLib { using FixedPoint for FixedPoint.Unsigned; using FixedPoint for uint256; using SafeERC20 for IStandardERC20; using SafeERC20 for IMintableBurnableERC20; using SynthereumLiquidityPoolLib for ISynthereumLiquidityPoolStorage.Storage; using SynthereumLiquidityPoolLib for ISynthereumLiquidityPoolStorage.LPPosition; using SynthereumLiquidityPoolLib for ISynthereumLiquidityPoolStorage.FeeStatus; struct ExecuteMintParams { // Amount of synth tokens to mint FixedPoint.Unsigned numTokens; // Amount of collateral (excluding fees) needed for mint FixedPoint.Unsigned collateralAmount; // Amount of fees of collateral user must pay FixedPoint.Unsigned feeAmount; // Amount of collateral equal to collateral minted + fees FixedPoint.Unsigned totCollateralAmount; // Recipient address that will receive synthetic tokens address recipient; // Sender of the mint transaction address sender; } struct ExecuteRedeemParams { //Amount of synth tokens needed for redeem FixedPoint.Unsigned numTokens; // Amount of collateral that user will receive FixedPoint.Unsigned collateralAmount; // Amount of fees of collateral user must pay FixedPoint.Unsigned feeAmount; // Amount of collateral equal to collateral redeemed + fees FixedPoint.Unsigned totCollateralAmount; // Recipient address that will receive synthetic tokens address recipient; // Sender of the redeem transaction address sender; } struct ExecuteExchangeParams { // Destination pool in which mint new tokens ISynthereumLiquidityPoolGeneral destPool; // Amount of tokens to send FixedPoint.Unsigned numTokens; // Amount of collateral (excluding fees) equivalent to synthetic token (exluding fees) to send FixedPoint.Unsigned collateralAmount; // Amount of fees of collateral user must pay FixedPoint.Unsigned feeAmount; // Amount of collateral equal to collateral redemeed + fees FixedPoint.Unsigned totCollateralAmount; // Amount of synthetic token to receive FixedPoint.Unsigned destNumTokens; // Recipient address that will receive synthetic tokens address recipient; // Sender of the exchange transaction address sender; } struct ExecuteSettlement { // Price of emergency shutdown FixedPoint.Unsigned emergencyPrice; // Amount of synthtic tokens to be liquidated FixedPoint.Unsigned userNumTokens; // Total amount of collateral (excluding unused and fees) deposited FixedPoint.Unsigned totalCollateralAmount; // Total amount of synthetic tokens FixedPoint.Unsigned tokensCollaterlized; // Total actual amount of fees to be withdrawn FixedPoint.Unsigned totalFeeAmount; // Overcollateral to be withdrawn by Lp (0 if standard user) FixedPoint.Unsigned overCollateral; // Amount of collateral which value is equal to the synthetic tokens value according to the emergency price FixedPoint.Unsigned totalRedeemableCollateral; // Exepected amount of collateral FixedPoint.Unsigned redeemableCollateral; // Collateral deposited but not used to collateralize FixedPoint.Unsigned unusedCollateral; // Amount of collateral settled to the sender FixedPoint.Unsigned transferableCollateral; } struct ExecuteLiquidation { // Total amount of collateral in the Lp position FixedPoint.Unsigned totalCollateralAmount; // Total number of tokens collateralized in the Lp position FixedPoint.Unsigned tokensCollateralized; // Total number of tokens in liquidation FixedPoint.Unsigned tokensInLiquidation; // Amount of collateral used to collateralize user's tokens FixedPoint.Unsigned userCollateralization; // Available liquidity in the pool FixedPoint.Unsigned unusedCollateral; // Expected collateral received by the user according to the actual price FixedPoint.Unsigned expectedCollateral; // Collateral amount receieved by the user FixedPoint.Unsigned settledCollateral; // Reward amount received by the user FixedPoint.Unsigned rewardAmount; // Price rate at the moment of the liquidation FixedPoint.Unsigned priceRate; } //---------------------------------------- // Events //---------------------------------------- event Mint( address indexed account, uint256 collateralSent, uint256 numTokensReceived, uint256 feePaid, address recipient ); event Redeem( address indexed account, uint256 numTokensSent, uint256 collateralReceived, uint256 feePaid, address recipient ); event Exchange( address indexed account, address indexed destPool, uint256 numTokensSent, uint256 destNumTokensReceived, uint256 feePaid, address recipient ); event WithdrawLiquidity( address indexed lp, uint256 liquidityWithdrawn, uint256 remainingLiquidity ); event IncreaseCollateral( address indexed lp, uint256 collateralAdded, uint256 newTotalCollateral ); event DecreaseCollateral( address indexed lp, uint256 collateralRemoved, uint256 newTotalCollateral ); event ClaimFee( address indexed claimer, uint256 feeAmount, uint256 totalRemainingFees ); event Liquidate( address indexed liquidator, uint256 tokensLiquidated, uint256 price, uint256 collateralExpected, uint256 collateralReceived, uint256 rewardReceived ); event EmergencyShutdown( uint256 timestamp, uint256 price, uint256 finalCollateral ); event Settle( address indexed account, uint256 numTokensSettled, uint256 collateralExpected, uint256 collateralSettled ); event SetFeePercentage(uint256 feePercentage); event SetFeeRecipients(address[] feeRecipients, uint32[] feeProportions); event SetOverCollateralization(uint256 overCollateralization); event SetLiquidationReward(uint256 liquidationReward); //---------------------------------------- // External functions //---------------------------------------- /** * @notice Initializes a liquidity pool * @param self Data type the library is attached to * @param liquidationData Liquidation info (see LiquidationData struct) * @param _finder The Synthereum finder * @param _version Synthereum version * @param _collateralToken ERC20 collateral token * @param _syntheticToken ERC20 synthetic token * @param _overCollateralization Over-collateralization ratio * @param _priceIdentifier Identifier of price to be used in the price feed * @param _collateralRequirement Percentage of overcollateralization to which a liquidation can triggered * @param _liquidationReward Percentage of reward for correct liquidation by a liquidator */ function initialize( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.Liquidation storage liquidationData, ISynthereumFinder _finder, uint8 _version, IStandardERC20 _collateralToken, IMintableBurnableERC20 _syntheticToken, FixedPoint.Unsigned calldata _overCollateralization, bytes32 _priceIdentifier, FixedPoint.Unsigned calldata _collateralRequirement, FixedPoint.Unsigned calldata _liquidationReward ) external { require( _collateralRequirement.isGreaterThan(1), 'Collateral requirement must be bigger than 100%' ); require( _overCollateralization.isGreaterThan(_collateralRequirement.sub(1)), 'Overcollateralization must be bigger than the Lp part of the collateral requirement' ); require( _liquidationReward.rawValue > 0 && _liquidationReward.isLessThanOrEqual(1), 'Liquidation reward must be between 0 and 100%' ); require( _collateralToken.decimals() <= 18, 'Collateral has more than 18 decimals' ); require( _syntheticToken.decimals() == 18, 'Synthetic token has more or less than 18 decimals' ); ISynthereumPriceFeed priceFeed = ISynthereumPriceFeed( _finder.getImplementationAddress(SynthereumInterfaces.PriceFeed) ); require( priceFeed.isPriceSupported(_priceIdentifier), 'Price identifier not supported' ); self.finder = _finder; self.version = _version; self.collateralToken = _collateralToken; self.syntheticToken = _syntheticToken; self.overCollateralization = _overCollateralization; self.priceIdentifier = _priceIdentifier; liquidationData.collateralRequirement = _collateralRequirement; liquidationData.liquidationReward = _liquidationReward; } /** * @notice Mint synthetic tokens using fixed amount of collateral * @notice This calculate the price using on chain price feed * @notice User must approve collateral transfer for the mint request to succeed * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param mintParams Input parameters for minting (see MintParams struct) * @param sender Sender of the mint transaction * @return syntheticTokensMinted Amount of synthetic tokens minted by a user * @return feePaid Amount of collateral paid by the user as fee */ function mint( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ISynthereumLiquidityPool.MintParams calldata mintParams, address sender ) external returns (uint256 syntheticTokensMinted, uint256 feePaid) { FixedPoint.Unsigned memory totCollateralAmount = FixedPoint.Unsigned(mintParams.collateralAmount); ( FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory feeAmount, FixedPoint.Unsigned memory numTokens ) = self.mintCalculation(totCollateralAmount); require( numTokens.rawValue >= mintParams.minNumTokens, 'Number of tokens less than minimum limit' ); checkExpiration(mintParams.expiration); self.executeMint( lpPosition, feeStatus, ExecuteMintParams( numTokens, collateralAmount, feeAmount, totCollateralAmount, mintParams.recipient, sender ) ); syntheticTokensMinted = numTokens.rawValue; feePaid = feeAmount.rawValue; } /** * @notice Redeem amount of collateral using fixed number of synthetic token * @notice This calculate the price using on chain price feed * @notice User must approve synthetic token transfer for the redeem request to succeed * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param redeemParams Input parameters for redeeming (see RedeemParams struct) * @param sender Sender of the redeem transaction * @return collateralRedeemed Amount of collateral redeem by user * @return feePaid Amount of collateral paid by user as fee */ function redeem( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ISynthereumLiquidityPool.RedeemParams calldata redeemParams, address sender ) external returns (uint256 collateralRedeemed, uint256 feePaid) { FixedPoint.Unsigned memory numTokens = FixedPoint.Unsigned(redeemParams.numTokens); ( FixedPoint.Unsigned memory totCollateralAmount, FixedPoint.Unsigned memory feeAmount, FixedPoint.Unsigned memory collateralAmount ) = self.redeemCalculation(numTokens); require( collateralAmount.rawValue >= redeemParams.minCollateral, 'Collateral amount less than minimum limit' ); checkExpiration(redeemParams.expiration); self.executeRedeem( lpPosition, feeStatus, ExecuteRedeemParams( numTokens, collateralAmount, feeAmount, totCollateralAmount, redeemParams.recipient, sender ) ); feePaid = feeAmount.rawValue; collateralRedeemed = collateralAmount.rawValue; } /** * @notice Exchange a fixed amount of synthetic token of this pool, with an amount of synthetic tokens of an another pool * @notice This calculate the price using on chain price feed * @notice User must approve synthetic token transfer for the redeem request to succeed * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param exchangeParams Input parameters for exchanging (see ExchangeParams struct) * @param sender Sender of the exchange transaction * @return destNumTokensMinted Amount of synthetic token minted in the destination pool * @return feePaid Amount of collateral paid by user as fee */ function exchange( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ISynthereumLiquidityPool.ExchangeParams calldata exchangeParams, address sender ) external returns (uint256 destNumTokensMinted, uint256 feePaid) { FixedPoint.Unsigned memory numTokens = FixedPoint.Unsigned(exchangeParams.numTokens); ( FixedPoint.Unsigned memory totCollateralAmount, FixedPoint.Unsigned memory feeAmount, FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory destNumTokens ) = self.exchangeCalculation(numTokens, exchangeParams.destPool); require( destNumTokens.rawValue >= exchangeParams.minDestNumTokens, 'Number of destination tokens less than minimum limit' ); checkExpiration(exchangeParams.expiration); self.executeExchange( lpPosition, feeStatus, ExecuteExchangeParams( exchangeParams.destPool, numTokens, collateralAmount, feeAmount, totCollateralAmount, destNumTokens, exchangeParams.recipient, sender ) ); destNumTokensMinted = destNumTokens.rawValue; feePaid = feeAmount.rawValue; } /** * @notice Called by a source Pool's `exchange` function to mint destination tokens * @notice This functon can be called only by a pool registered in the deployer * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param collateralAmount The amount of collateral to use from the source Pool * @param numTokens The number of new tokens to mint * @param recipient Recipient to which send synthetic token minted */ function exchangeMint( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, FixedPoint.Unsigned calldata collateralAmount, FixedPoint.Unsigned calldata numTokens, address recipient ) external { self.checkPool(ISynthereumLiquidityPoolGeneral(msg.sender)); // Sending amount must be different from 0 require( collateralAmount.rawValue > 0, 'Sending collateral amount is equal to 0' ); // Collateral available FixedPoint.Unsigned memory unusedCollateral = self.calculateUnusedCollateral( lpPosition.totalCollateralAmount, feeStatus.totalFeeAmount, collateralAmount ); // Update LP's collateralization status FixedPoint.Unsigned memory overCollateral = lpPosition.updateLpPositionInMint( self.overCollateralization, collateralAmount, numTokens ); //Check there is enough liquidity in the pool for overcollateralization require( unusedCollateral.isGreaterThanOrEqual(overCollateral), 'No enough liquidity for cover mint operation' ); // Mint synthetic asset and transfer to the recipient self.syntheticToken.mint(recipient, numTokens.rawValue); } /** * @notice Withdraw unused deposited collateral by the LP * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param collateralAmount Collateral to be withdrawn * @param sender Sender of the withdrawLiquidity transaction * @return remainingLiquidity Remaining unused collateral in the pool */ function withdrawLiquidity( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, FixedPoint.Unsigned calldata collateralAmount, address sender ) external returns (uint256 remainingLiquidity) { remainingLiquidity = self._withdrawLiquidity( lpPosition, feeStatus, collateralAmount, sender ); } /** * @notice Increase collaterallization of Lp position * @notice Only a sender with LP role can call this function * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param collateralToTransfer Collateral to be transferred before increase collateral in the position * @param collateralToIncrease Collateral to be added to the position * @param sender Sender of the increaseCollateral transaction * @return newTotalCollateral New total collateral amount */ function increaseCollateral( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, FixedPoint.Unsigned calldata collateralToTransfer, FixedPoint.Unsigned calldata collateralToIncrease, address sender ) external returns (uint256 newTotalCollateral) { // Check the collateral to be increased is not 0 require(collateralToIncrease.rawValue > 0, 'No collateral to be increased'); // Deposit collateral in the pool if (collateralToTransfer.rawValue > 0) { self.pullCollateral(sender, collateralToTransfer); } // Collateral available FixedPoint.Unsigned memory unusedCollateral = self.calculateUnusedCollateral( lpPosition.totalCollateralAmount, feeStatus.totalFeeAmount, FixedPoint.Unsigned(0) ); // Check that there is enoush availabe collateral deposited in the pool require( unusedCollateral.isGreaterThanOrEqual(collateralToIncrease), 'No enough liquidity for increasing collateral' ); // Update new total collateral amount FixedPoint.Unsigned memory _newTotalCollateral = lpPosition.totalCollateralAmount.add(collateralToIncrease); lpPosition.totalCollateralAmount = _newTotalCollateral; newTotalCollateral = _newTotalCollateral.rawValue; emit IncreaseCollateral( sender, collateralToIncrease.rawValue, newTotalCollateral ); } /** * @notice Decrease collaterallization of Lp position * @notice Check that final position is not undercollateralized * @notice Only a sender with LP role can call this function * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param liquidationData Liquidation info (see LiquidationData struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param collateralToDecrease Collateral to decreased from the position * @param collateralToWithdraw Collateral to be transferred to the LP * @param sender Sender of the decreaseCollateral transaction * @return newTotalCollateral New total collateral amount */ function decreaseCollateral( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.Liquidation storage liquidationData, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, FixedPoint.Unsigned calldata collateralToDecrease, FixedPoint.Unsigned calldata collateralToWithdraw, address sender ) external returns (uint256 newTotalCollateral) { // Check that collateral to be decreased is not 0 require(collateralToDecrease.rawValue > 0, 'No collateral to be decreased'); // Resulting total collateral amount FixedPoint.Unsigned memory _newTotalCollateral = lpPosition.totalCollateralAmount.sub(collateralToDecrease); // Check that position doesn't become undercollateralized (bool _isOverCollateralized, , ) = lpPosition.isOverCollateralized( liquidationData, getPriceFeedRate(self.finder, self.priceIdentifier), getCollateralDecimals(self.collateralToken), _newTotalCollateral ); require(_isOverCollateralized, 'Position undercollateralized'); // Update new total collateral amount lpPosition.totalCollateralAmount = _newTotalCollateral; newTotalCollateral = _newTotalCollateral.rawValue; emit DecreaseCollateral( sender, collateralToDecrease.rawValue, newTotalCollateral ); if (collateralToWithdraw.rawValue > 0) { self._withdrawLiquidity( lpPosition, feeStatus, collateralToWithdraw, sender ); } } /** * @notice Withdraw fees gained by the sender * @param self Data type the library is attached to * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param sender Sender of the claimFee transaction * @return feeClaimed Amount of fee claimed */ function claimFee( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, address sender ) external returns (uint256 feeClaimed) { // Fee to claim FixedPoint.Unsigned memory _feeClaimed = feeStatus.feeGained[sender]; feeClaimed = _feeClaimed.rawValue; // Check that fee is available require(feeClaimed > 0, 'No fee to claim'); // Update fee status delete feeStatus.feeGained[sender]; FixedPoint.Unsigned memory _totalRemainingFees = feeStatus.totalFeeAmount.sub(_feeClaimed); feeStatus.totalFeeAmount = _totalRemainingFees; // Transfer amount to the sender self.collateralToken.safeTransfer(sender, feeClaimed); emit ClaimFee(sender, feeClaimed, _totalRemainingFees.rawValue); } /** * @notice Liquidate Lp position for an amount of synthetic tokens undercollateralized * @notice Revert if position is not undercollateralized * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param liquidationData Liquidation info (see LiquidationData struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param numSynthTokens Number of synthetic tokens that user wants to liquidate * @param sender Sender of the liquidation transaction * @return synthTokensLiquidated Amount of synthetic tokens liquidated * @return collateralReceived Amount of received collateral equal to the value of tokens liquidated * @return rewardAmount Amount of received collateral as reward for the liquidation */ function liquidate( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.Liquidation storage liquidationData, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, FixedPoint.Unsigned calldata numSynthTokens, address sender ) external returns ( uint256 synthTokensLiquidated, uint256 collateralReceived, uint256 rewardAmount ) { // Memory struct for saving local varibales ExecuteLiquidation memory executeLiquidation; executeLiquidation.totalCollateralAmount = lpPosition.totalCollateralAmount; executeLiquidation.priceRate = getPriceFeedRate( self.finder, self.priceIdentifier ); uint8 collateralDecimals = getCollateralDecimals(self.collateralToken); // Collateral value of the synthetic token passed { (bool _isOverCollaterlized, , ) = lpPosition.isOverCollateralized( liquidationData, executeLiquidation.priceRate, collateralDecimals, executeLiquidation.totalCollateralAmount ); // Revert if position is not undercollataralized require(!_isOverCollaterlized, 'Position is overcollateralized'); } IStandardERC20 _collateralToken = self.collateralToken; executeLiquidation.tokensCollateralized = lpPosition.tokensCollateralized; executeLiquidation.tokensInLiquidation = FixedPoint.min( numSynthTokens, executeLiquidation.tokensCollateralized ); executeLiquidation.expectedCollateral = calculateCollateralAmount( executeLiquidation.priceRate, collateralDecimals, executeLiquidation.tokensInLiquidation ); executeLiquidation.userCollateralization = executeLiquidation .tokensInLiquidation .div(executeLiquidation.tokensCollateralized) .mul(executeLiquidation.totalCollateralAmount); if ( executeLiquidation.userCollateralization.isGreaterThanOrEqual( executeLiquidation.expectedCollateral ) ) { executeLiquidation.settledCollateral = executeLiquidation .expectedCollateral; executeLiquidation.rewardAmount = executeLiquidation .userCollateralization .sub(executeLiquidation.expectedCollateral) .mul(liquidationData.liquidationReward); // Update Lp position lpPosition.totalCollateralAmount = executeLiquidation .totalCollateralAmount .sub(executeLiquidation.settledCollateral) .sub(executeLiquidation.rewardAmount); } else { executeLiquidation.unusedCollateral = self.calculateUnusedCollateral( executeLiquidation.totalCollateralAmount, feeStatus.totalFeeAmount, FixedPoint.Unsigned(0) ); executeLiquidation.settledCollateral = FixedPoint.min( executeLiquidation.expectedCollateral, executeLiquidation.userCollateralization.add( executeLiquidation.unusedCollateral ) ); // Update Lp position untill max 105% coverage using available liquidity lpPosition.totalCollateralAmount = FixedPoint.min( executeLiquidation .totalCollateralAmount .add(executeLiquidation.unusedCollateral) .sub(executeLiquidation.settledCollateral), calculateCollateralAmount( executeLiquidation .priceRate, collateralDecimals, executeLiquidation.tokensCollateralized.sub( executeLiquidation.tokensInLiquidation ) ) .mul(liquidationData.collateralRequirement) ); } lpPosition.tokensCollateralized = executeLiquidation .tokensCollateralized .sub(executeLiquidation.tokensInLiquidation); collateralReceived = executeLiquidation.settledCollateral.rawValue; rewardAmount = executeLiquidation.rewardAmount.rawValue; synthTokensLiquidated = executeLiquidation.tokensInLiquidation.rawValue; // Burn synthetic tokens to be liquidated self.burnSyntheticTokens(synthTokensLiquidated, sender); // Transfer liquidated collateral and reward to the user _collateralToken.safeTransfer(sender, collateralReceived + rewardAmount); emit Liquidate( sender, synthTokensLiquidated, executeLiquidation.priceRate.rawValue, executeLiquidation.expectedCollateral.rawValue, collateralReceived, rewardAmount ); } /** * @notice Shutdown the pool in case of emergency * @notice Only Synthereum manager contract can call this function * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param emergencyShutdownData Emergency shutdown info (see Shutdown struct) * @return timestamp Timestamp of emergency shutdown transaction * @return price Price of the pair at the moment of shutdown execution */ function emergencyShutdown( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ISynthereumLiquidityPoolStorage.Shutdown storage emergencyShutdownData ) external returns (uint256 timestamp, uint256 price) { ISynthereumFinder _finder = self.finder; require( msg.sender == _finder.getImplementationAddress(SynthereumInterfaces.Manager), 'Caller must be the Synthereum manager' ); timestamp = block.timestamp; emergencyShutdownData.timestamp = timestamp; FixedPoint.Unsigned memory _price = getPriceFeedRate(_finder, self.priceIdentifier); emergencyShutdownData.price = _price; price = _price.rawValue; // Move available liquidity in the position FixedPoint.Unsigned memory totalCollateral = lpPosition.totalCollateralAmount; FixedPoint.Unsigned memory unusedCollateral = self.calculateUnusedCollateral( totalCollateral, feeStatus.totalFeeAmount, FixedPoint.Unsigned(0) ); FixedPoint.Unsigned memory finalCollateral = totalCollateral.add(unusedCollateral); lpPosition.totalCollateralAmount = finalCollateral; emit EmergencyShutdown(timestamp, price, finalCollateral.rawValue); } /** * @notice Redeem tokens after emergency shutdown * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param emergencyShutdownData Emergency shutdown info (see Shutdown struct) * @param isLiquidityProvider True if the sender is an LP, otherwise false * @param sender Sender of the settleEmergencyShutdown transaction * @return synthTokensSettled Amount of synthetic tokens liquidated * @return collateralSettled Amount of collateral withdrawn after emergency shutdown */ function settleEmergencyShutdown( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ISynthereumLiquidityPoolStorage.Shutdown storage emergencyShutdownData, bool isLiquidityProvider, address sender ) external returns (uint256 synthTokensSettled, uint256 collateralSettled) { // Memory struct for saving local varibales ExecuteSettlement memory executeSettlement; IMintableBurnableERC20 syntheticToken = self.syntheticToken; executeSettlement.emergencyPrice = emergencyShutdownData.price; executeSettlement.userNumTokens = FixedPoint.Unsigned( syntheticToken.balanceOf(sender) ); require( executeSettlement.userNumTokens.rawValue > 0 || isLiquidityProvider, 'Sender has nothing to settle' ); if (executeSettlement.userNumTokens.rawValue > 0) { // Move synthetic tokens from the user to the pool // - This is because derivative expects the tokens to come from the sponsor address syntheticToken.safeTransferFrom( sender, address(this), executeSettlement.userNumTokens.rawValue ); } executeSettlement.totalCollateralAmount = lpPosition.totalCollateralAmount; executeSettlement.tokensCollaterlized = lpPosition.tokensCollateralized; executeSettlement.totalFeeAmount = feeStatus.totalFeeAmount; executeSettlement.overCollateral; IStandardERC20 _collateralToken = self.collateralToken; uint8 collateralDecimals = getCollateralDecimals(_collateralToken); // Add overcollateral and deposited synthetic tokens if the sender is the LP if (isLiquidityProvider) { FixedPoint.Unsigned memory totalRedeemableCollateral = calculateCollateralAmount( executeSettlement.emergencyPrice, collateralDecimals, executeSettlement.tokensCollaterlized ); executeSettlement.overCollateral = executeSettlement .totalCollateralAmount .isGreaterThan(totalRedeemableCollateral) ? executeSettlement.totalCollateralAmount.sub(totalRedeemableCollateral) : FixedPoint.Unsigned(0); executeSettlement.userNumTokens = FixedPoint.Unsigned( syntheticToken.balanceOf(address(this)) ); } // Calculate expected and settled collateral executeSettlement.redeemableCollateral = calculateCollateralAmount( executeSettlement .emergencyPrice, collateralDecimals, executeSettlement .userNumTokens ) .add(executeSettlement.overCollateral); executeSettlement.unusedCollateral = self.calculateUnusedCollateral( executeSettlement.totalCollateralAmount, executeSettlement.totalFeeAmount, FixedPoint.Unsigned(0) ); executeSettlement.transferableCollateral = FixedPoint.min( executeSettlement.redeemableCollateral, executeSettlement.totalCollateralAmount ); // Update Lp position lpPosition.totalCollateralAmount = executeSettlement .totalCollateralAmount .isGreaterThan(executeSettlement.redeemableCollateral) ? executeSettlement.totalCollateralAmount.sub( executeSettlement.redeemableCollateral ) : FixedPoint.Unsigned(0); lpPosition.tokensCollateralized = executeSettlement.tokensCollaterlized.sub( executeSettlement.userNumTokens ); synthTokensSettled = executeSettlement.userNumTokens.rawValue; collateralSettled = executeSettlement.transferableCollateral.rawValue; // Burn synthetic tokens syntheticToken.burn(synthTokensSettled); // Transfer settled collateral to the user _collateralToken.safeTransfer(sender, collateralSettled); emit Settle( sender, synthTokensSettled, executeSettlement.redeemableCollateral.rawValue, collateralSettled ); } /** * @notice Update the fee percentage * @param self Data type the library is attached to * @param _feePercentage The new fee percentage */ function setFeePercentage( ISynthereumLiquidityPoolStorage.Storage storage self, FixedPoint.Unsigned calldata _feePercentage ) external { require( _feePercentage.rawValue < 10**(18), 'Fee Percentage must be less than 100%' ); self.fee.feeData.feePercentage = _feePercentage; emit SetFeePercentage(_feePercentage.rawValue); } /** * @notice Update the addresses of recipients for generated fees and proportions of fees each address will receive * @param self Data type the library is attached to * @param _feeRecipients An array of the addresses of recipients that will receive generated fees * @param _feeProportions An array of the proportions of fees generated each recipient will receive */ function setFeeRecipients( ISynthereumLiquidityPoolStorage.Storage storage self, address[] calldata _feeRecipients, uint32[] calldata _feeProportions ) external { require( _feeRecipients.length == _feeProportions.length, 'Fee recipients and fee proportions do not match' ); uint256 totalActualFeeProportions; // Store the sum of all proportions for (uint256 i = 0; i < _feeProportions.length; i++) { totalActualFeeProportions += _feeProportions[i]; } ISynthereumLiquidityPoolStorage.FeeData storage _feeData = self.fee.feeData; _feeData.feeRecipients = _feeRecipients; _feeData.feeProportions = _feeProportions; self.fee.totalFeeProportions = totalActualFeeProportions; emit SetFeeRecipients(_feeRecipients, _feeProportions); } /** * @notice Update the overcollateralization percentage * @param self Data type the library is attached to * @param liquidationData Liquidation info (see LiquidationData struct) * @param _overCollateralization Overcollateralization percentage */ function setOverCollateralization( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.Liquidation storage liquidationData, FixedPoint.Unsigned calldata _overCollateralization ) external { require( _overCollateralization.isGreaterThan( liquidationData.collateralRequirement.sub(1) ), 'Overcollateralization must be bigger than the Lp part of the collateral requirement' ); self.overCollateralization = _overCollateralization; emit SetOverCollateralization(_overCollateralization.rawValue); } /** * @notice Update the liquidation reward percentage * @param liquidationData Liquidation info (see LiquidationData struct) * @param _liquidationReward Percentage of reward for correct liquidation by a liquidator */ function setLiquidationReward( ISynthereumLiquidityPoolStorage.Liquidation storage liquidationData, FixedPoint.Unsigned calldata _liquidationReward ) external { require( _liquidationReward.rawValue > 0 && _liquidationReward.isLessThanOrEqual(1), 'Liquidation reward must be between 0 and 100%' ); liquidationData.liquidationReward = _liquidationReward; emit SetLiquidationReward(_liquidationReward.rawValue); } //---------------------------------------- // External view functions //---------------------------------------- /** * @notice Returns the total amount of liquidity deposited in the pool, but nut used as collateral * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @return Total available liquidity */ function totalAvailableLiquidity( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus ) external view returns (uint256) { return self .calculateUnusedCollateral( lpPosition .totalCollateralAmount, feeStatus .totalFeeAmount, FixedPoint.Unsigned(0) ) .rawValue; } /** * @notice Returns if position is overcollateralized and thepercentage of coverage of the collateral according to the last price * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param liquidationData Liquidation info (see LiquidationData struct) * @return True if position is overcollaterlized, otherwise false + percentage of coverage (totalCollateralAmount / (price * tokensCollateralized)) */ function collateralCoverage( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.Liquidation storage liquidationData ) external view returns (bool, uint256) { FixedPoint.Unsigned memory priceRate = getPriceFeedRate(self.finder, self.priceIdentifier); uint8 collateralDecimals = getCollateralDecimals(self.collateralToken); ( bool _isOverCollateralized, , FixedPoint.Unsigned memory overCollateralValue ) = lpPosition.isOverCollateralized( liquidationData, priceRate, collateralDecimals, lpPosition.totalCollateralAmount ); FixedPoint.Unsigned memory coverageRatio = lpPosition.totalCollateralAmount.div(overCollateralValue); FixedPoint.Unsigned memory _collateralCoverage = liquidationData.collateralRequirement.mul(coverageRatio); return (_isOverCollateralized, _collateralCoverage.rawValue); } /** * @notice Returns the synthetic tokens will be received and fees will be paid in exchange for an input collateral amount * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param inputCollateral Input collateral amount to be exchanged * @return synthTokensReceived Synthetic tokens will be minted * @return feePaid Collateral fee will be paid */ function getMintTradeInfo( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, FixedPoint.Unsigned calldata inputCollateral ) external view returns (uint256 synthTokensReceived, uint256 feePaid) { ( FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory _feePaid, FixedPoint.Unsigned memory _synthTokensReceived ) = self.mintCalculation(inputCollateral); require( collateralAmount.rawValue > 0, 'Sending collateral amount is equal to 0' ); FixedPoint.Unsigned memory overCollateral = collateralAmount.mul(self.overCollateralization); FixedPoint.Unsigned memory unusedCollateral = self.calculateUnusedCollateral( lpPosition.totalCollateralAmount, feeStatus.totalFeeAmount, FixedPoint.Unsigned(0) ); require( unusedCollateral.isGreaterThanOrEqual(overCollateral), 'No enough liquidity for covering mint operation' ); synthTokensReceived = _synthTokensReceived.rawValue; feePaid = _feePaid.rawValue; } /** * @notice Returns the collateral amount will be received and fees will be paid in exchange for an input amount of synthetic tokens * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param syntheticTokens Amount of synthetic tokens to be exchanged * @return collateralAmountReceived Collateral amount will be received by the user * @return feePaid Collateral fee will be paid */ function getRedeemTradeInfo( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, FixedPoint.Unsigned calldata syntheticTokens ) external view returns (uint256 collateralAmountReceived, uint256 feePaid) { FixedPoint.Unsigned memory totalActualTokens = lpPosition.tokensCollateralized; require( syntheticTokens.rawValue > 0, 'Sending tokens amount is equal to 0' ); require( syntheticTokens.isLessThanOrEqual(totalActualTokens), 'Sending tokens amount bigger than amount in the position' ); ( FixedPoint.Unsigned memory totCollateralAmount, FixedPoint.Unsigned memory _feePaid, FixedPoint.Unsigned memory _collateralAmountReceived ) = self.redeemCalculation(syntheticTokens); FixedPoint.Unsigned memory collateralRedeemed = syntheticTokens.div(totalActualTokens).mul( lpPosition.totalCollateralAmount ); require( collateralRedeemed.isGreaterThanOrEqual(totCollateralAmount), 'Position undercapitalized' ); collateralAmountReceived = _collateralAmountReceived.rawValue; feePaid = _feePaid.rawValue; } /** * @notice Returns the destination synthetic tokens amount will be received and fees will be paid in exchange for an input amount of synthetic tokens * @notice This function is only trading-informative, it doesn't check liquidity and collateralization conditions * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param syntheticTokens Amount of synthetic tokens to be exchanged * @param destinationPool Pool in which mint the destination synthetic token * @return destSyntheticTokensReceived Synthetic tokens will be received from destination pool * @return feePaid Collateral fee will be paid */ function getExchangeTradeInfo( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, FixedPoint.Unsigned calldata syntheticTokens, ISynthereumLiquidityPoolGeneral destinationPool ) external view returns (uint256 destSyntheticTokensReceived, uint256 feePaid) { self.checkPool(destinationPool); require( address(this) != address(destinationPool), 'Same source and destination pool' ); FixedPoint.Unsigned memory totalActualTokens = lpPosition.tokensCollateralized; require( syntheticTokens.rawValue > 0, 'Sending tokens amount is equal to 0' ); require( syntheticTokens.isLessThanOrEqual(totalActualTokens), 'Sending tokens amount bigger than amount in the position' ); ( FixedPoint.Unsigned memory totCollateralAmount, FixedPoint.Unsigned memory _feePaid, FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory _destSyntheticTokensReceived ) = self.exchangeCalculation(syntheticTokens, destinationPool); FixedPoint.Unsigned memory collateralRedeemed = syntheticTokens.div(totalActualTokens).mul( lpPosition.totalCollateralAmount ); require( collateralRedeemed.isGreaterThanOrEqual(totCollateralAmount), 'Position undercapitalized' ); require( collateralAmount.rawValue > 0, 'Sending collateral amount is equal to 0' ); FixedPoint.Unsigned memory destOverCollateral = collateralAmount.mul( FixedPoint.Unsigned(destinationPool.overCollateralization()) ); FixedPoint.Unsigned memory destUnusedCollateral = FixedPoint.Unsigned(destinationPool.totalAvailableLiquidity()); require( destUnusedCollateral.isGreaterThanOrEqual(destOverCollateral), 'No enough liquidity for covering mint operation' ); destSyntheticTokensReceived = _destSyntheticTokensReceived.rawValue; feePaid = _feePaid.rawValue; } //---------------------------------------- // Internal functions //---------------------------------------- /** * @notice Execute mint of synthetic tokens * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param executeMintParams Params for execution of mint (see ExecuteMintParams struct) */ function executeMint( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ExecuteMintParams memory executeMintParams ) internal { // Sending amount must be different from 0 require( executeMintParams.collateralAmount.rawValue > 0, 'Sending collateral amount is equal to 0' ); // Collateral available FixedPoint.Unsigned memory unusedCollateral = self.calculateUnusedCollateral( lpPosition.totalCollateralAmount, feeStatus.totalFeeAmount, FixedPoint.Unsigned(0) ); // Update LP's collateralization status FixedPoint.Unsigned memory overCollateral = lpPosition.updateLpPositionInMint( self.overCollateralization, executeMintParams.collateralAmount, executeMintParams.numTokens ); //Check there is enough liquidity in the pool for overcollateralization require( unusedCollateral.isGreaterThanOrEqual(overCollateral), 'No enough liquidity for covering mint operation' ); // Update fees status feeStatus.updateFees(self.fee, executeMintParams.feeAmount); // Pull user's collateral self.pullCollateral( executeMintParams.sender, executeMintParams.totCollateralAmount ); // Mint synthetic asset and transfer to the recipient self.syntheticToken.mint( executeMintParams.recipient, executeMintParams.numTokens.rawValue ); emit Mint( executeMintParams.sender, executeMintParams.totCollateralAmount.rawValue, executeMintParams.numTokens.rawValue, executeMintParams.feeAmount.rawValue, executeMintParams.recipient ); } /** * @notice Execute redeem of collateral * @param self Data type the library is attached tfo * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param executeRedeemParams Params for execution of redeem (see ExecuteRedeemParams struct) */ function executeRedeem( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ExecuteRedeemParams memory executeRedeemParams ) internal { // Sending amount must be different from 0 require( executeRedeemParams.numTokens.rawValue > 0, 'Sending tokens amount is equal to 0' ); FixedPoint.Unsigned memory collateralRedeemed = lpPosition.updateLpPositionInRedeem(executeRedeemParams.numTokens); // Check that collateral redemeed is enough for cover the value of synthetic tokens require( collateralRedeemed.isGreaterThanOrEqual( executeRedeemParams.totCollateralAmount ), 'Position undercapitalized' ); // Update fees status feeStatus.updateFees(self.fee, executeRedeemParams.feeAmount); // Burn synthetic tokens self.burnSyntheticTokens( executeRedeemParams.numTokens.rawValue, executeRedeemParams.sender ); //Send net amount of collateral to the user that submitted the redeem request self.collateralToken.safeTransfer( executeRedeemParams.recipient, executeRedeemParams.collateralAmount.rawValue ); emit Redeem( executeRedeemParams.sender, executeRedeemParams.numTokens.rawValue, executeRedeemParams.collateralAmount.rawValue, executeRedeemParams.feeAmount.rawValue, executeRedeemParams.recipient ); } /** * @notice Execute exchange between synthetic tokens * @param self Data type the library is attached tfo * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param executeExchangeParams Params for execution of exchange (see ExecuteExchangeParams struct) */ function executeExchange( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ExecuteExchangeParams memory executeExchangeParams ) internal { // Sending amount must be different from 0 require( executeExchangeParams.numTokens.rawValue > 0, 'Sending tokens amount is equal to 0' ); FixedPoint.Unsigned memory collateralRedeemed = lpPosition.updateLpPositionInRedeem(executeExchangeParams.numTokens); // Check that collateral redemeed is enough for cover the value of synthetic tokens require( collateralRedeemed.isGreaterThanOrEqual( executeExchangeParams.totCollateralAmount ), 'Position undercapitalized' ); // Update fees status feeStatus.updateFees(self.fee, executeExchangeParams.feeAmount); // Burn synthetic tokens self.burnSyntheticTokens( executeExchangeParams.numTokens.rawValue, executeExchangeParams.sender ); ISynthereumLiquidityPoolGeneral destinationPool = executeExchangeParams.destPool; // Check that destination pool is different from this pool require( address(this) != address(destinationPool), 'Same source and destination pool' ); self.checkPool(destinationPool); // Transfer collateral amount (without overcollateralization) to the destination pool self.collateralToken.safeTransfer( address(destinationPool), executeExchangeParams.collateralAmount.rawValue ); // Mint the destination tokens with the withdrawn collateral destinationPool.exchangeMint( executeExchangeParams.collateralAmount.rawValue, executeExchangeParams.destNumTokens.rawValue, executeExchangeParams.recipient ); emit Exchange( executeExchangeParams.sender, address(destinationPool), executeExchangeParams.numTokens.rawValue, executeExchangeParams.destNumTokens.rawValue, executeExchangeParams.feeAmount.rawValue, executeExchangeParams.recipient ); } /** * @notice Withdraw unused deposited collateral by the LP * @param self Data type the library is attached to * @param lpPosition Position of the LP (see LPPosition struct) * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @param collateralAmount Collateral to be withdrawn * @param sender Sender that withdraws liquidity * @return remainingLiquidity Remaining unused collateral in the pool */ function _withdrawLiquidity( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, FixedPoint.Unsigned memory collateralAmount, address sender ) internal returns (uint256 remainingLiquidity) { // Collateral available FixedPoint.Unsigned memory unusedCollateral = self.calculateUnusedCollateral( lpPosition.totalCollateralAmount, feeStatus.totalFeeAmount, FixedPoint.Unsigned(0) ); // Check that available collateral is bigger than collateral to be withdrawn and returns the difference remainingLiquidity = (unusedCollateral.sub(collateralAmount)).rawValue; // Transfer amount to the Lp uint256 _collateralAmount = collateralAmount.rawValue; self.collateralToken.safeTransfer(sender, _collateralAmount); emit WithdrawLiquidity(sender, _collateralAmount, remainingLiquidity); } /** * @notice Update LP's collateralization status after a mint * @param lpPosition Position of the LP (see LPPosition struct) * @param overCollateralization Overcollateralization rate * @param collateralAmount Collateral amount to be added (only user collateral) * @param numTokens Tokens to be added * @return overCollateral Amount of collateral to be provided by LP for overcollateralization */ function updateLpPositionInMint( ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, FixedPoint.Unsigned storage overCollateralization, FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory numTokens ) internal returns (FixedPoint.Unsigned memory overCollateral) { overCollateral = collateralAmount.mul(overCollateralization); lpPosition.totalCollateralAmount = lpPosition .totalCollateralAmount .add(collateralAmount) .add(overCollateral); lpPosition.tokensCollateralized = lpPosition.tokensCollateralized.add( numTokens ); } /** * @notice Update LP's collateralization status after a redeem * @param lpPosition Position of the LP (see LPPosition struct) * @param numTokens Tokens to be removed * @return collateralRedeemed Collateral redeemed */ function updateLpPositionInRedeem( ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, FixedPoint.Unsigned memory numTokens ) internal returns (FixedPoint.Unsigned memory collateralRedeemed) { FixedPoint.Unsigned memory totalActualTokens = lpPosition.tokensCollateralized; FixedPoint.Unsigned memory totalActualCollateral = lpPosition.totalCollateralAmount; FixedPoint.Unsigned memory fractionRedeemed = numTokens.div(totalActualTokens); collateralRedeemed = fractionRedeemed.mul(totalActualCollateral); lpPosition.tokensCollateralized = totalActualTokens.sub(numTokens); lpPosition.totalCollateralAmount = totalActualCollateral.sub( collateralRedeemed ); } /** * @notice Update fee gained by the fee recipients * @param feeStatus Actual status of fee gained to be withdrawn * @param feeInfo Actual status of fee recipients and their proportions * @param feeAmount Collateral fee charged */ function updateFees( ISynthereumLiquidityPoolStorage.FeeStatus storage feeStatus, ISynthereumLiquidityPoolStorage.Fee storage feeInfo, FixedPoint.Unsigned memory feeAmount ) internal { FixedPoint.Unsigned memory feeCharged; address[] storage feeRecipients = feeInfo.feeData.feeRecipients; uint32[] storage feeProportions = feeInfo.feeData.feeProportions; uint256 totalFeeProportions = feeInfo.totalFeeProportions; uint256 numberOfRecipients = feeRecipients.length; mapping(address => FixedPoint.Unsigned) storage feeGained = feeStatus.feeGained; for (uint256 i = 0; i < numberOfRecipients - 1; i++) { address feeRecipient = feeRecipients[i]; FixedPoint.Unsigned memory feeReceived = FixedPoint.Unsigned( (feeAmount.rawValue * feeProportions[i]) / totalFeeProportions ); feeGained[feeRecipient] = feeGained[feeRecipient].add(feeReceived); feeCharged = feeCharged.add(feeReceived); } address lastRecipient = feeRecipients[numberOfRecipients - 1]; feeGained[lastRecipient] = feeGained[lastRecipient].add(feeAmount).sub( feeCharged ); feeStatus.totalFeeAmount = feeStatus.totalFeeAmount.add(feeAmount); } /** * @notice Pulls collateral tokens from the sender to store in the Pool * @param self Data type the library is attached to * @param numTokens The number of tokens to pull */ function pullCollateral( ISynthereumLiquidityPoolStorage.Storage storage self, address from, FixedPoint.Unsigned memory numTokens ) internal { self.collateralToken.safeTransferFrom( from, address(this), numTokens.rawValue ); } /** * @notice Pulls synthetic tokens from the sender and burn them * @param self Data type the library is attached to * @param numTokens The number of tokens to be burned * @param sender Sender of synthetic tokens */ function burnSyntheticTokens( ISynthereumLiquidityPoolStorage.Storage storage self, uint256 numTokens, address sender ) internal { IMintableBurnableERC20 synthToken = self.syntheticToken; // Transfer synthetic token from the user to the pool synthToken.safeTransferFrom(sender, address(this), numTokens); // Burn synthetic asset synthToken.burn(numTokens); } //---------------------------------------- // Internal views functions //---------------------------------------- /** * @notice Given a collateral value to be exchanged, returns the fee amount, net collateral and synthetic tokens * @param self Data type the library is attached tfo * @param totCollateralAmount Collateral amount to be exchanged * @return collateralAmount Net collateral amount (totCollateralAmount - feePercentage) * @return feeAmount Fee to be paid according to the fee percentage * @return numTokens Number of synthetic tokens will be received according to the actual price in exchange for collateralAmount */ function mintCalculation( ISynthereumLiquidityPoolStorage.Storage storage self, FixedPoint.Unsigned memory totCollateralAmount ) internal view returns ( FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory feeAmount, FixedPoint.Unsigned memory numTokens ) { feeAmount = totCollateralAmount.mul(self.fee.feeData.feePercentage); collateralAmount = totCollateralAmount.sub(feeAmount); numTokens = calculateNumberOfTokens( getPriceFeedRate(self.finder, self.priceIdentifier), getCollateralDecimals(self.collateralToken), collateralAmount ); } /** * @notice Given a an amount of synthetic tokens to be exchanged, returns the fee amount, net collateral and gross collateral * @param self Data type the library is attached tfo * @param numTokens Synthetic tokens amount to be exchanged * @return totCollateralAmount Gross collateral amount (collateralAmount + feeAmount) * @return feeAmount Fee to be paid according to the fee percentage * @return collateralAmount Net collateral amount will be received according to the actual price in exchange for numTokens */ function redeemCalculation( ISynthereumLiquidityPoolStorage.Storage storage self, FixedPoint.Unsigned memory numTokens ) internal view returns ( FixedPoint.Unsigned memory totCollateralAmount, FixedPoint.Unsigned memory feeAmount, FixedPoint.Unsigned memory collateralAmount ) { totCollateralAmount = calculateCollateralAmount( getPriceFeedRate(self.finder, self.priceIdentifier), getCollateralDecimals(self.collateralToken), numTokens ); feeAmount = totCollateralAmount.mul(self.fee.feeData.feePercentage); collateralAmount = totCollateralAmount.sub(feeAmount); } /** * @notice Given a an amount of synthetic tokens to be exchanged, returns the fee amount, net collateral and gross collateral and number of destination tokens * @param self Data type the library is attached tfo * @param numTokens Synthetic tokens amount to be exchanged * @param destinationPool Pool from which destination tokens will be received * @return totCollateralAmount Gross collateral amount according to the price * @return feeAmount Fee to be paid according to the fee percentage * @return collateralAmount Net collateral amount (totCollateralAmount - feeAmount) * @return destNumTokens Number of destination synthetic tokens will be received according to the actual price in exchange for synthetic tokens */ function exchangeCalculation( ISynthereumLiquidityPoolStorage.Storage storage self, FixedPoint.Unsigned memory numTokens, ISynthereumLiquidityPoolGeneral destinationPool ) internal view returns ( FixedPoint.Unsigned memory totCollateralAmount, FixedPoint.Unsigned memory feeAmount, FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory destNumTokens ) { ISynthereumFinder _finder = self.finder; IStandardERC20 _collateralToken = self.collateralToken; uint8 collateralDecimals = getCollateralDecimals(_collateralToken); totCollateralAmount = calculateCollateralAmount( getPriceFeedRate(_finder, self.priceIdentifier), collateralDecimals, numTokens ); feeAmount = totCollateralAmount.mul(self.fee.feeData.feePercentage); collateralAmount = totCollateralAmount.sub(feeAmount); destNumTokens = calculateNumberOfTokens( getPriceFeedRate(_finder, destinationPool.getPriceFeedIdentifier()), collateralDecimals, collateralAmount ); } /** * @notice Check expiration of mint, redeem and exchange transaction * @param expiration Expiration time of the transaction */ function checkExpiration(uint256 expiration) internal view { require(block.timestamp <= expiration, 'Transaction expired'); } /** * @notice Check if sender or receiver pool is a correct registered pool * @param self Data type the library is attached to * @param poolToCheck Pool that should be compared with this pool */ function checkPool( ISynthereumLiquidityPoolStorage.Storage storage self, ISynthereumLiquidityPoolGeneral poolToCheck ) internal view { IStandardERC20 collateralToken = self.collateralToken; require( collateralToken == poolToCheck.collateralToken(), 'Collateral tokens do not match' ); ISynthereumFinder finder = self.finder; require(finder == poolToCheck.synthereumFinder(), 'Finders do not match'); ISynthereumRegistry poolRegister = ISynthereumRegistry( finder.getImplementationAddress(SynthereumInterfaces.PoolRegistry) ); require( poolRegister.isDeployed( poolToCheck.syntheticTokenSymbol(), collateralToken, poolToCheck.version(), address(poolToCheck) ), 'Destination pool not registered' ); } /** * @notice Check if an amount of collateral is enough to collateralize the position * @param lpPosition Position of the LP (see LPPosition struct) * @param priceRate Price rate of the pair * @param collateralDecimals Number of decimals of the collateral * @param liquidationData Liquidation info (see LiquidationData struct) * @param collateralToCompare collateral used for checking the overcollaterlization * @return _isOverCollateralized True if position is overcollaterlized, otherwise false * @return collateralValue Collateral amount equal to the value of tokens * @return overCollateralValue Collateral amount equal to the value of tokens * collateralRequirement */ function isOverCollateralized( ISynthereumLiquidityPoolStorage.LPPosition storage lpPosition, ISynthereumLiquidityPoolStorage.Liquidation storage liquidationData, FixedPoint.Unsigned memory priceRate, uint8 collateralDecimals, FixedPoint.Unsigned memory collateralToCompare ) internal view returns ( bool _isOverCollateralized, FixedPoint.Unsigned memory collateralValue, FixedPoint.Unsigned memory overCollateralValue ) { collateralValue = calculateCollateralAmount( priceRate, collateralDecimals, lpPosition.tokensCollateralized ); overCollateralValue = collateralValue.mul( liquidationData.collateralRequirement ); _isOverCollateralized = collateralToCompare.isGreaterThanOrEqual( overCollateralValue ); } /** * @notice Calculate the unused collateral of this pool * @param self Data type the library is attached to * @param totalCollateral Total collateral used * @param totalFees Total fees gained to be whitdrawn * @param collateralReceived Collateral sent to the pool by a user or contract to be used for collateralization * @param unusedCollateral Unused collateral of the pool */ function calculateUnusedCollateral( ISynthereumLiquidityPoolStorage.Storage storage self, FixedPoint.Unsigned memory totalCollateral, FixedPoint.Unsigned memory totalFees, FixedPoint.Unsigned memory collateralReceived ) internal view returns (FixedPoint.Unsigned memory unusedCollateral) { // Collateral available FixedPoint.Unsigned memory actualBalance = FixedPoint.Unsigned(self.collateralToken.balanceOf(address(this))); unusedCollateral = actualBalance.sub( totalCollateral.add(totalFees).add(collateralReceived) ); } /** * @notice Retrun the on-chain oracle price for a pair * @param finder Synthereum finder * @param priceIdentifier Identifier of price pair * @return priceRate Latest rate of the pair */ function getPriceFeedRate(ISynthereumFinder finder, bytes32 priceIdentifier) internal view returns (FixedPoint.Unsigned memory priceRate) { ISynthereumPriceFeed priceFeed = ISynthereumPriceFeed( finder.getImplementationAddress(SynthereumInterfaces.PriceFeed) ); priceRate = FixedPoint.Unsigned(priceFeed.getLatestPrice(priceIdentifier)); } /** * @notice Retrun the number of decimals of collateral token * @param collateralToken Collateral token contract * @return decimals number of decimals */ function getCollateralDecimals(IStandardERC20 collateralToken) internal view returns (uint8 decimals) { decimals = collateralToken.decimals(); } /** * @notice Calculate synthetic token amount starting from an amount of collateral * @param priceRate Price rate of the pair * @param collateralDecimals Number of decimals of the collateral * @param numTokens Amount of collateral from which you want to calculate synthetic token amount * @return numTokens Amount of tokens after on-chain oracle conversion */ function calculateNumberOfTokens( FixedPoint.Unsigned memory priceRate, uint8 collateralDecimals, FixedPoint.Unsigned memory collateralAmount ) internal pure returns (FixedPoint.Unsigned memory numTokens) { numTokens = collateralAmount.mul(10**(18 - collateralDecimals)).div( priceRate ); } /** * @notice Calculate collateral amount starting from an amount of synthtic token * @param priceRate Price rate of the pair * @param collateralDecimals Number of decimals of the collateral * @param numTokens Amount of synthetic tokens from which you want to calculate collateral amount * @return collateralAmount Amount of collateral after on-chain oracle conversion */ function calculateCollateralAmount( FixedPoint.Unsigned memory priceRate, uint8 collateralDecimals, FixedPoint.Unsigned memory numTokens ) internal pure returns (FixedPoint.Unsigned memory collateralAmount) { collateralAmount = numTokens.mul(priceRate).div( 10**(18 - collateralDecimals) ); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IStandardERC20} from '../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableTokenFactory } from '../../tokens/factories/interfaces/IMintableBurnableTokenFactory.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { ISynthereumLiquidityPoolStorage } from './interfaces/ILiquidityPoolStorage.sol'; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; import { BaseControlledMintableBurnableERC20 } from '../../tokens/interfaces/BaseControlledMintableBurnableERC20.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import {SynthereumLiquidityPool} from './LiquidityPool.sol'; contract SynthereumLiquidityPoolCreator { struct Params { IStandardERC20 collateralToken; string syntheticName; string syntheticSymbol; address syntheticToken; ISynthereumLiquidityPoolStorage.Roles roles; uint256 overCollateralization; ISynthereumLiquidityPoolStorage.FeeData feeData; bytes32 priceIdentifier; uint256 collateralRequirement; uint256 liquidationReward; uint8 version; } // Address of Synthereum Finder ISynthereumFinder public immutable synthereumFinder; //---------------------------------------- // Events //---------------------------------------- event CreatedPool( address indexed poolAddress, uint8 indexed version, address indexed deployerAddress ); //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the Pool contract. * @param _synthereumFinder Synthereum Finder address used to discover other contracts */ constructor(address _synthereumFinder) { synthereumFinder = ISynthereumFinder(_synthereumFinder); } //---------------------------------------- // Public functions //---------------------------------------- /** * @notice Creates an instance of the pool * @param params is a `ConstructorParams` object from LiquidityPool. * @return pool address of the deployed pool contract. */ function createPool(Params calldata params) public virtual returns (SynthereumLiquidityPool pool) { require(bytes(params.syntheticName).length != 0, 'Missing synthetic name'); require( bytes(params.syntheticSymbol).length != 0, 'Missing synthetic symbol' ); if (params.syntheticToken == address(0)) { IMintableBurnableTokenFactory tokenFactory = IMintableBurnableTokenFactory( ISynthereumFinder(synthereumFinder).getImplementationAddress( SynthereumInterfaces.TokenFactory ) ); BaseControlledMintableBurnableERC20 tokenCurrency = tokenFactory.createToken( params.syntheticName, params.syntheticSymbol, 18 ); pool = new SynthereumLiquidityPool(_convertParams(params, tokenCurrency)); // Give permissions to new pool contract and then hand over ownership. tokenCurrency.addMinter(address(pool)); tokenCurrency.addBurner(address(pool)); tokenCurrency.addAdmin( synthereumFinder.getImplementationAddress(SynthereumInterfaces.Manager) ); tokenCurrency.renounceAdmin(); } else { BaseControlledMintableBurnableERC20 tokenCurrency = BaseControlledMintableBurnableERC20(params.syntheticToken); require( keccak256(abi.encodePacked(tokenCurrency.name())) == keccak256(abi.encodePacked(params.syntheticName)), 'Wrong synthetic token name' ); require( keccak256(abi.encodePacked(tokenCurrency.symbol())) == keccak256(abi.encodePacked(params.syntheticSymbol)), 'Wrong synthetic token symbol' ); pool = new SynthereumLiquidityPool(_convertParams(params, tokenCurrency)); } emit CreatedPool(address(pool), params.version, msg.sender); return pool; } // Converts createPool params to constructor params. function _convertParams( Params memory params, BaseControlledMintableBurnableERC20 tokenCurrency ) internal view returns (SynthereumLiquidityPool.ConstructorParams memory constructorParams) { require(params.roles.admin != address(0), 'Admin cannot be 0x00'); constructorParams.finder = synthereumFinder; constructorParams.version = params.version; constructorParams.collateralToken = params.collateralToken; constructorParams.syntheticToken = IMintableBurnableERC20( address(tokenCurrency) ); constructorParams.roles = params.roles; constructorParams.overCollateralization = params.overCollateralization; constructorParams.feeData = params.feeData; constructorParams.priceIdentifier = params.priceIdentifier; constructorParams.collateralRequirement = params.collateralRequirement; constructorParams.liquidationReward = params.liquidationReward; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { IDeploymentSignature } from '../../core/interfaces/IDeploymentSignature.sol'; import { ISynthereumCollateralWhitelist } from '../../core/interfaces/ICollateralWhitelist.sol'; import { ISynthereumIdentifierWhitelist } from '../../core/interfaces/IIdentifierWhitelist.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import {SynthereumLiquidityPoolCreator} from './LiquidityPoolCreator.sol'; import {SynthereumLiquidityPool} from './LiquidityPool.sol'; import {FactoryConditions} from '../../common/FactoryConditions.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; contract SynthereumLiquidityPoolFactory is IDeploymentSignature, ReentrancyGuard, FactoryConditions, SynthereumLiquidityPoolCreator { //---------------------------------------- // Storage //---------------------------------------- bytes4 public immutable override deploymentSignature; //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Set synthereum finder * @param synthereumFinder Synthereum finder contract */ constructor(address synthereumFinder) SynthereumLiquidityPoolCreator(synthereumFinder) { deploymentSignature = this.createPool.selector; } //---------------------------------------- // Public functions //---------------------------------------- /** * @notice Check if the sender is the deployer and deploy a pool * @param params input parameters of the pool * @return pool Deployed pool */ function createPool(Params calldata params) public override nonReentrant returns (SynthereumLiquidityPool pool) { checkDeploymentConditions( synthereumFinder, params.collateralToken, params.priceIdentifier ); pool = super.createPool(params); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from './interfaces/IFinder.sol'; import {ISynthereumManager} from './interfaces/IManager.sol'; import { IAccessControlEnumerable } from '../../@openzeppelin/contracts/access/IAccessControlEnumerable.sol'; import {IEmergencyShutdown} from '../common/interfaces/IEmergencyShutdown.sol'; import {SynthereumInterfaces} from './Constants.sol'; import { AccessControlEnumerable } from '../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; contract SynthereumManager is ISynthereumManager, AccessControlEnumerable { bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //Describe role structure struct Roles { address admin; address maintainer; } //---------------------------------------- // Storage //---------------------------------------- ISynthereumFinder public immutable synthereumFinder; //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, msg.sender), 'Sender must be the maintainer' ); _; } modifier onlyMaintainerOrDeployer() { require( hasRole(MAINTAINER_ROLE, msg.sender) || synthereumFinder.getImplementationAddress( SynthereumInterfaces.Deployer ) == msg.sender, 'Sender must be the maintainer or the deployer' ); _; } //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the SynthereumManager contract * @param _synthereumFinder Synthereum finder contract * @param roles Admin and Mainteiner roles */ constructor(ISynthereumFinder _synthereumFinder, Roles memory roles) { synthereumFinder = _synthereumFinder; _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, roles.admin); _setupRole(MAINTAINER_ROLE, roles.maintainer); } //---------------------------------------- // External functions //---------------------------------------- /** * @notice Allow to add roles in derivatives and synthetic tokens contracts * @param contracts Derivatives or Synthetic role contracts * @param roles Roles id * @param accounts Addresses to which give the grant */ function grantSynthereumRole( address[] calldata contracts, bytes32[] calldata roles, address[] calldata accounts ) external override onlyMaintainerOrDeployer { uint256 rolesCount = roles.length; require(rolesCount > 0, 'No roles paased'); require( rolesCount == accounts.length, 'Number of roles and accounts must be the same' ); require( rolesCount == contracts.length, 'Number of roles and contracts must be the same' ); for (uint256 i; i < rolesCount; i++) { IAccessControlEnumerable(contracts[i]).grantRole(roles[i], accounts[i]); } } /** * @notice Allow to revoke roles in derivatives and synthetic tokens contracts * @param contracts Derivatives or Synthetic role contracts * @param roles Roles id * @param accounts Addresses to which revoke the grant */ function revokeSynthereumRole( address[] calldata contracts, bytes32[] calldata roles, address[] calldata accounts ) external override onlyMaintainerOrDeployer { uint256 rolesCount = roles.length; require(rolesCount > 0, 'No roles paased'); require( rolesCount == accounts.length, 'Number of roles and accounts must be the same' ); require( rolesCount == contracts.length, 'Number of roles and contracts must be the same' ); for (uint256 i; i < rolesCount; i++) { IAccessControlEnumerable(contracts[i]).revokeRole(roles[i], accounts[i]); } } /** * @notice Allow to renounce roles in derivatives and synthetic tokens contracts * @param contracts Derivatives or Synthetic role contracts * @param roles Roles id */ function renounceSynthereumRole( address[] calldata contracts, bytes32[] calldata roles ) external override onlyMaintainerOrDeployer { uint256 rolesCount = roles.length; require(rolesCount > 0, 'No roles paased'); require( rolesCount == contracts.length, 'Number of roles and contracts must be the same' ); for (uint256 i; i < rolesCount; i++) { IAccessControlEnumerable(contracts[i]).renounceRole( roles[i], address(this) ); } } /** * @notice Allow to call emergency shutdown in a pool or self-minting derivative * @param contracts Contracts to shutdown */ function emergencyShutdown(IEmergencyShutdown[] calldata contracts) external override onlyMaintainer { require(contracts.length > 0, 'No Derivative passed'); for (uint256 i; i < contracts.length; i++) { contracts[i].emergencyShutdown(); } } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { ISynthereumFactoryVersioning } from './interfaces/IFactoryVersioning.sol'; import { EnumerableMap } from '../../@openzeppelin/contracts/utils/structs/EnumerableMap.sol'; import { AccessControlEnumerable } from '../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; /** * @title Provides addresses of different versions of pools factory and derivative factory */ contract SynthereumFactoryVersioning is ISynthereumFactoryVersioning, AccessControlEnumerable { using EnumerableMap for EnumerableMap.UintToAddressMap; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //Describe role structure struct Roles { address admin; address maintainer; } //---------------------------------------- // Storage //---------------------------------------- mapping(bytes32 => EnumerableMap.UintToAddressMap) private factories; //---------------------------------------- // Events //---------------------------------------- event AddFactory( bytes32 indexed factoryType, uint8 indexed version, address indexed factory ); event SetFactory( bytes32 indexed factoryType, uint8 indexed version, address indexed factory ); event RemoveFactory( bytes32 indexed factoryType, uint8 indexed version, address indexed factory ); //---------------------------------------- // Constructor //---------------------------------------- constructor(Roles memory roles) { _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, roles.admin); _setupRole(MAINTAINER_ROLE, roles.maintainer); } //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, msg.sender), 'Sender must be the maintainer' ); _; } //---------------------------------------- // External functions //---------------------------------------- /** @notice Sets a Factory * @param factoryType Type of factory * @param version Version of the factory to be set * @param factory The pool factory address to be set */ function setFactory( bytes32 factoryType, uint8 version, address factory ) external override onlyMaintainer { require(factory != address(0), 'Factory cannot be address 0'); bool isNewVersion = factories[factoryType].set(version, factory); if (isNewVersion) { emit AddFactory(factoryType, version, factory); } else { emit SetFactory(factoryType, version, factory); } } /** @notice Removes a factory * @param factoryType The type of factory to be removed * @param version Version of the factory to be removed */ function removeFactory(bytes32 factoryType, uint8 version) external override onlyMaintainer { EnumerableMap.UintToAddressMap storage selectedFactories = factories[factoryType]; address factoryToRemove = selectedFactories.get(version); selectedFactories.remove(version); emit RemoveFactory(factoryType, version, factoryToRemove); } //---------------------------------------- // External view functions //---------------------------------------- /** @notice Gets a factory contract address * @param factoryType The type of factory to be checked * @param version Version of the factory to be checked * @return factory Address of the factory contract */ function getFactoryVersion(bytes32 factoryType, uint8 version) external view override returns (address factory) { factory = factories[factoryType].get(version); } /** @notice Gets the number of factory versions for a specific type * @param factoryType The type of factory to be checked * @return numberOfVersions Total number of versions for a specific factory */ function numberOfFactoryVersions(bytes32 factoryType) external view override returns (uint8 numberOfVersions) { numberOfVersions = uint8(factories[factoryType].length()); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from './interfaces/IFinder.sol'; import { AccessControlEnumerable } from '../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; /** * @title Provides addresses of contracts implementing certain interfaces. */ contract SynthereumFinder is ISynthereumFinder, AccessControlEnumerable { bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //Describe role structure struct Roles { address admin; address maintainer; } //---------------------------------------- // Storage //---------------------------------------- mapping(bytes32 => address) public interfacesImplemented; //---------------------------------------- // Events //---------------------------------------- event InterfaceImplementationChanged( bytes32 indexed interfaceName, address indexed newImplementationAddress ); //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, msg.sender), 'Sender must be the maintainer' ); _; } //---------------------------------------- // Constructors //---------------------------------------- constructor(Roles memory roles) { _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, roles.admin); _setupRole(MAINTAINER_ROLE, roles.maintainer); } //---------------------------------------- // External view //---------------------------------------- /** * @notice Updates the address of the contract that implements `interfaceName`. * @param interfaceName bytes32 of the interface name that is either changed or registered. * @param implementationAddress address of the implementation contract. */ function changeImplementationAddress( bytes32 interfaceName, address implementationAddress ) external override onlyMaintainer { interfacesImplemented[interfaceName] = implementationAddress; emit InterfaceImplementationChanged(interfaceName, implementationAddress); } /** * @notice Gets the address of the contract that implements the given `interfaceName`. * @param interfaceName queried interface. * @return implementationAddress Address of the defined interface. */ function getImplementationAddress(bytes32 interfaceName) external view override returns (address) { address implementationAddress = interfacesImplemented[interfaceName]; require(implementationAddress != address(0x0), 'Implementation not found'); return implementationAddress; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; /** * @title Provides addresses of the contracts implementing certain interfaces. */ interface ISynthereumFinder { /** * @notice Updates the address of the contract that implements `interfaceName`. * @param interfaceName bytes32 encoding of the interface name that is either changed or registered. * @param implementationAddress address of the deployed contract that implements the interface. */ function changeImplementationAddress( bytes32 interfaceName, address implementationAddress ) external; /** * @notice Gets the address of the contract that implements the given `interfaceName`. * @param interfaceName queried interface. * @return implementationAddress Address of the deployed contract that implements the interface. */ function getImplementationAddress(bytes32 interfaceName) external view returns (address); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { IEmergencyShutdown } from '../../common/interfaces/IEmergencyShutdown.sol'; interface ISynthereumManager { /** * @notice Allow to add roles in derivatives and synthetic tokens contracts * @param contracts Derivatives or Synthetic role contracts * @param roles Roles id * @param accounts Addresses to which give the grant */ function grantSynthereumRole( address[] calldata contracts, bytes32[] calldata roles, address[] calldata accounts ) external; /** * @notice Allow to revoke roles in derivatives and synthetic tokens contracts * @param contracts Derivatives or Synthetic role contracts * @param roles Roles id * @param accounts Addresses to which revoke the grant */ function revokeSynthereumRole( address[] calldata contracts, bytes32[] calldata roles, address[] calldata accounts ) external; /** * @notice Allow to renounce roles in derivatives and synthetic tokens contracts * @param contracts Derivatives or Synthetic role contracts * @param roles Roles id */ function renounceSynthereumRole( address[] calldata contracts, bytes32[] calldata roles ) external; /** * @notice Allow to call emergency shutdown in a pool or self-minting derivative * @param contracts Contracts to shutdown */ function emergencyShutdown(IEmergencyShutdown[] calldata contracts) external; }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; /** * @title Provides addresses of different versions of pools factory and derivative factory */ interface ISynthereumFactoryVersioning { /** @notice Sets a Factory * @param factoryType Type of factory * @param version Version of the factory to be set * @param factory The pool factory address to be set */ function setFactory( bytes32 factoryType, uint8 version, address factory ) external; /** @notice Removes a factory * @param factoryType The type of factory to be removed * @param version Version of the factory to be removed */ function removeFactory(bytes32 factoryType, uint8 version) external; /** @notice Gets a factory contract address * @param factoryType The type of factory to be checked * @param version Version of the factory to be checked * @return factory Address of the factory contract */ function getFactoryVersion(bytes32 factoryType, uint8 version) external view returns (address factory); /** @notice Gets the number of factory versions for a specific type * @param factoryType The type of factory to be checked * @return numberOfVersions Total number of versions for a specific factory */ function numberOfFactoryVersions(bytes32 factoryType) external view returns (uint8 numberOfVersions); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; /** * @title Provides signature of function for deployment */ interface IDeploymentSignature { /** * @notice Returns the bytes4 signature of the function used for the deployment of a contract in a factory * @return signature returns signature of the deployment function */ function deploymentSignature() external view returns (bytes4 signature); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {ISynthereumDeployment} from '../../common/interfaces/IDeployment.sol'; /** * @title Provides interface with functions of Synthereum deployer */ interface ISynthereumDeployer { /** * @notice Deploy a new pool * @param poolVersion Version of the pool contract * @param poolParamsData Input params of pool constructor * @return pool Pool contract deployed */ function deployPool(uint8 poolVersion, bytes calldata poolParamsData) external returns (ISynthereumDeployment pool); /** * @notice Deploy a new self minting derivative contract * @param selfMintingDerVersion Version of the self minting derivative contract * @param selfMintingDerParamsData Input params of self minting derivative constructor * @return selfMintingDerivative Self minting derivative contract deployed */ function deploySelfMintingDerivative( uint8 selfMintingDerVersion, bytes calldata selfMintingDerParamsData ) external returns (ISynthereumDeployment selfMintingDerivative); /** * @notice Deploy a new fixed rate wrapper contract * @param fixedRateVersion Version of the fixed rate wrapper contract * @param fixedRateParamsData Input params of fixed rate wrapper constructor * @return fixedRate Fixed rate wrapper contract deployed */ function deployFixedRate( uint8 fixedRateVersion, bytes calldata fixedRateParamsData ) external returns (ISynthereumDeployment fixedRate); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; interface IJarvisBrrrrr { /** * @notice Mints synthetic token without collateral to a pre-defined address (SynthereumMoneyMarketManager) * @param token Synthetic token address to mint * @param amount Amount of tokens to mint * @return newCirculatingSupply New circulating supply in Money Market */ function mint(IMintableBurnableERC20 token, uint256 amount) external returns (uint256 newCirculatingSupply); /** * @notice Burns synthetic token without releasing collateral from the pre-defined address (SynthereumMoneyMarketManager) * @param token Synthetic token address to burn * @param amount Amount of tokens to burn * @return newCirculatingSupply New circulating supply in Money Market */ function redeem(IMintableBurnableERC20 token, uint256 amount) external returns (uint256 newCirculatingSupply); /** * @notice Sets the max circulating supply that can be minted for a specific token - only manager can set this * @param token Synthetic token address to set * @param newMaxSupply New Max supply value of the token */ function setMaxSupply(IMintableBurnableERC20 token, uint256 newMaxSupply) external; /** * @notice Returns the max circulating supply of a synthetic token * @param token Synthetic token address * @return maxCircSupply Max supply of the token */ function maxSupply(IMintableBurnableERC20 token) external view returns (uint256 maxCircSupply); /** * @notice Returns the circulating supply of a synthetic token * @param token Synthetic token address * @return circSupply Circulating supply of the token */ function supply(IMintableBurnableERC20 token) external view returns (uint256 circSupply); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; /** * @title Stores common interface names used throughout Synthereum. */ library SynthereumInterfaces { bytes32 public constant Deployer = 'Deployer'; bytes32 public constant FactoryVersioning = 'FactoryVersioning'; bytes32 public constant TokenFactory = 'TokenFactory'; bytes32 public constant PoolRegistry = 'PoolRegistry'; bytes32 public constant SelfMintingRegistry = 'SelfMintingRegistry'; bytes32 public constant PriceFeed = 'PriceFeed'; bytes32 public constant Manager = 'Manager'; bytes32 public constant CreditLineController = 'CreditLineController'; bytes32 public constant CollateralWhitelist = 'CollateralWhitelist'; bytes32 public constant IdentifierWhitelist = 'IdentifierWhitelist'; bytes32 public constant TrustedForwarder = 'TrustedForwarder'; bytes32 public constant FixedRateRegistry = 'FixedRateRegistry'; bytes32 public constant MoneyMarketManager = 'MoneyMarketManager'; bytes32 public constant JarvisBrrrrr = 'JarvisBrrrrr'; } library FactoryInterfaces { bytes32 public constant PoolFactory = 'PoolFactory'; bytes32 public constant SelfMintingFactory = 'SelfMintingFactory'; bytes32 public constant FixedRateFactory = 'FixedRateFactory'; }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from './interfaces/IFinder.sol'; import {ISynthereumDeployer} from './interfaces/IDeployer.sol'; import { ISynthereumFactoryVersioning } from './interfaces/IFactoryVersioning.sol'; import {ISynthereumRegistry} from './registries/interfaces/IRegistry.sol'; import {ISynthereumManager} from './interfaces/IManager.sol'; import {IERC20} from '../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {IDeploymentSignature} from './interfaces/IDeploymentSignature.sol'; import {ISynthereumDeployment} from '../common/interfaces/IDeployment.sol'; import { IAccessControlEnumerable } from '../../@openzeppelin/contracts/access/IAccessControlEnumerable.sol'; import {SynthereumInterfaces, FactoryInterfaces} from './Constants.sol'; import {Address} from '../../@openzeppelin/contracts/utils/Address.sol'; import { ReentrancyGuard } from '../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; import { AccessControlEnumerable } from '../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; contract SynthereumDeployer is ISynthereumDeployer, AccessControlEnumerable, ReentrancyGuard { using Address for address; bytes32 private constant ADMIN_ROLE = 0x00; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); bytes32 private constant MINTER_ROLE = keccak256('Minter'); bytes32 private constant BURNER_ROLE = keccak256('Burner'); //Describe role structure struct Roles { address admin; address maintainer; } //---------------------------------------- // State variables //---------------------------------------- ISynthereumFinder public immutable synthereumFinder; //---------------------------------------- // Events //---------------------------------------- event PoolDeployed(uint8 indexed poolVersion, address indexed newPool); event SelfMintingDerivativeDeployed( uint8 indexed selfMintingDerivativeVersion, address indexed selfMintingDerivative ); event FixedRateDeployed( uint8 indexed fixedRateVersion, address indexed fixedRate ); //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, msg.sender), 'Sender must be the maintainer' ); _; } //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the SynthereumDeployer contract * @param _synthereumFinder Synthereum finder contract * @param roles Admin and Maintainer roles */ constructor(ISynthereumFinder _synthereumFinder, Roles memory roles) { synthereumFinder = _synthereumFinder; _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, roles.admin); _setupRole(MAINTAINER_ROLE, roles.maintainer); } //---------------------------------------- // External functions //---------------------------------------- /** * @notice Deploy a new pool * @param poolVersion Version of the pool contract * @param poolParamsData Input params of pool constructor * @return pool Pool contract deployed */ function deployPool(uint8 poolVersion, bytes calldata poolParamsData) external override onlyMaintainer nonReentrant returns (ISynthereumDeployment pool) { pool = _deployPool(getFactoryVersioning(), poolVersion, poolParamsData); checkDeployment(pool, poolVersion); setSyntheticTokenRoles(pool); ISynthereumRegistry poolRegistry = getPoolRegistry(); poolRegistry.register( pool.syntheticTokenSymbol(), pool.collateralToken(), poolVersion, address(pool) ); emit PoolDeployed(poolVersion, address(pool)); } /** * @notice Deploy a new self minting derivative contract * @param selfMintingDerVersion Version of the self minting derivative contract * @param selfMintingDerParamsData Input params of self minting derivative constructor * @return selfMintingDerivative Self minting derivative contract deployed */ function deploySelfMintingDerivative( uint8 selfMintingDerVersion, bytes calldata selfMintingDerParamsData ) external override onlyMaintainer nonReentrant returns (ISynthereumDeployment selfMintingDerivative) { ISynthereumFactoryVersioning factoryVersioning = getFactoryVersioning(); selfMintingDerivative = _deploySelfMintingDerivative( factoryVersioning, selfMintingDerVersion, selfMintingDerParamsData ); checkDeployment(selfMintingDerivative, selfMintingDerVersion); address tokenCurrency = address(selfMintingDerivative.syntheticToken()); addSyntheticTokenRoles(tokenCurrency, address(selfMintingDerivative)); ISynthereumRegistry selfMintingRegistry = getSelfMintingRegistry(); selfMintingRegistry.register( selfMintingDerivative.syntheticTokenSymbol(), selfMintingDerivative.collateralToken(), selfMintingDerVersion, address(selfMintingDerivative) ); emit SelfMintingDerivativeDeployed( selfMintingDerVersion, address(selfMintingDerivative) ); } /** * @notice Deploy a fixed rate wrapper * @param fixedRateVersion Version of the fixed rate wrapper contract * @param fixedRateParamsData Input params of the fixed rate wrapper constructor * @return fixedRate FixedRate wrapper deployed */ function deployFixedRate( uint8 fixedRateVersion, bytes calldata fixedRateParamsData ) external override onlyMaintainer nonReentrant returns (ISynthereumDeployment fixedRate) { fixedRate = _deployFixedRate( getFactoryVersioning(), fixedRateVersion, fixedRateParamsData ); checkDeployment(fixedRate, fixedRateVersion); setSyntheticTokenRoles(fixedRate); ISynthereumRegistry fixedRateRegistry = getFixedRateRegistry(); fixedRateRegistry.register( fixedRate.syntheticTokenSymbol(), fixedRate.collateralToken(), fixedRateVersion, address(fixedRate) ); emit FixedRateDeployed(fixedRateVersion, address(fixedRate)); } //---------------------------------------- // Internal functions //---------------------------------------- /** * @notice Deploys a pool contract of a particular version * @param factoryVersioning factory versioning contract * @param poolVersion Version of pool contract to deploy * @param poolParamsData Input parameters of constructor of the pool * @return pool Pool deployed */ function _deployPool( ISynthereumFactoryVersioning factoryVersioning, uint8 poolVersion, bytes memory poolParamsData ) internal returns (ISynthereumDeployment pool) { address poolFactory = factoryVersioning.getFactoryVersion( FactoryInterfaces.PoolFactory, poolVersion ); bytes memory poolDeploymentResult = poolFactory.functionCall( abi.encodePacked(getDeploymentSignature(poolFactory), poolParamsData), 'Wrong pool deployment' ); pool = ISynthereumDeployment(abi.decode(poolDeploymentResult, (address))); } /** * @notice Deploys a self minting derivative contract of a particular version * @param factoryVersioning factory versioning contract * @param selfMintingDerVersion Version of self minting derivate contract to deploy * @param selfMintingDerParamsData Input parameters of constructor of self minting derivative * @return selfMintingDerivative Self minting derivative deployed */ function _deploySelfMintingDerivative( ISynthereumFactoryVersioning factoryVersioning, uint8 selfMintingDerVersion, bytes calldata selfMintingDerParamsData ) internal returns (ISynthereumDeployment selfMintingDerivative) { address selfMintingDerFactory = factoryVersioning.getFactoryVersion( FactoryInterfaces.SelfMintingFactory, selfMintingDerVersion ); bytes memory selfMintingDerDeploymentResult = selfMintingDerFactory.functionCall( abi.encodePacked( getDeploymentSignature(selfMintingDerFactory), selfMintingDerParamsData ), 'Wrong self-minting derivative deployment' ); selfMintingDerivative = ISynthereumDeployment( abi.decode(selfMintingDerDeploymentResult, (address)) ); } /** * @notice Deploys a fixed rate wrapper contract of a particular version * @param factoryVersioning factory versioning contract * @param fixedRateVersion Version of the fixed rate wrapper contract to deploy * @param fixedRateParamsData Input parameters of constructor of the fixed rate wrapper * @return fixedRate Fixed rate wrapper deployed */ function _deployFixedRate( ISynthereumFactoryVersioning factoryVersioning, uint8 fixedRateVersion, bytes memory fixedRateParamsData ) internal returns (ISynthereumDeployment fixedRate) { address fixedRateFactory = factoryVersioning.getFactoryVersion( FactoryInterfaces.FixedRateFactory, fixedRateVersion ); bytes memory fixedRateDeploymentResult = fixedRateFactory.functionCall( abi.encodePacked( getDeploymentSignature(fixedRateFactory), fixedRateParamsData ), 'Wrong fixed rate deployment' ); fixedRate = ISynthereumDeployment( abi.decode(fixedRateDeploymentResult, (address)) ); } /** * @notice Sets roles of the synthetic token contract to a pool or a fixed rate wrapper * @param financialContract Pool or fixed rate wrapper contract */ function setSyntheticTokenRoles(ISynthereumDeployment financialContract) internal { address _financialContract = address(financialContract); IAccessControlEnumerable tokenCurrency = IAccessControlEnumerable(address(financialContract.syntheticToken())); if ( !tokenCurrency.hasRole(MINTER_ROLE, _financialContract) || !tokenCurrency.hasRole(BURNER_ROLE, _financialContract) ) { addSyntheticTokenRoles(address(tokenCurrency), _financialContract); } } /** * @notice Grants minter and burner role of syntehtic token to derivative * @param tokenCurrency Address of the token contract * @param contractAddr Address of the pool or self-minting derivative */ function addSyntheticTokenRoles(address tokenCurrency, address contractAddr) internal { ISynthereumManager manager = getManager(); address[] memory contracts = new address[](2); bytes32[] memory roles = new bytes32[](2); address[] memory accounts = new address[](2); contracts[0] = tokenCurrency; contracts[1] = tokenCurrency; roles[0] = MINTER_ROLE; roles[1] = BURNER_ROLE; accounts[0] = contractAddr; accounts[1] = contractAddr; manager.grantSynthereumRole(contracts, roles, accounts); } //---------------------------------------- // Internal view functions //---------------------------------------- /** * @notice Get factory versioning contract from the finder * @return factoryVersioning Factory versioning contract */ function getFactoryVersioning() internal view returns (ISynthereumFactoryVersioning factoryVersioning) { factoryVersioning = ISynthereumFactoryVersioning( synthereumFinder.getImplementationAddress( SynthereumInterfaces.FactoryVersioning ) ); } /** * @notice Get pool registry contract from the finder * @return poolRegistry Registry of pools */ function getPoolRegistry() internal view returns (ISynthereumRegistry poolRegistry) { poolRegistry = ISynthereumRegistry( synthereumFinder.getImplementationAddress( SynthereumInterfaces.PoolRegistry ) ); } /** * @notice Get self minting registry contract from the finder * @return selfMintingRegistry Registry of self-minting derivatives */ function getSelfMintingRegistry() internal view returns (ISynthereumRegistry selfMintingRegistry) { selfMintingRegistry = ISynthereumRegistry( synthereumFinder.getImplementationAddress( SynthereumInterfaces.SelfMintingRegistry ) ); } /** * @notice Get fixed rate registry contract from the finder * @return fixedRateRegistry Registry of fixed rate contract */ function getFixedRateRegistry() internal view returns (ISynthereumRegistry fixedRateRegistry) { fixedRateRegistry = ISynthereumRegistry( synthereumFinder.getImplementationAddress( SynthereumInterfaces.FixedRateRegistry ) ); } /** * @notice Get manager contract from the finder * @return manager Synthereum manager */ function getManager() internal view returns (ISynthereumManager manager) { manager = ISynthereumManager( synthereumFinder.getImplementationAddress(SynthereumInterfaces.Manager) ); } /** * @notice Get signature of function to deploy a contract * @param factory Factory contract * @return signature Signature of deployment function of the factory */ function getDeploymentSignature(address factory) internal view returns (bytes4 signature) { signature = IDeploymentSignature(factory).deploymentSignature(); } /** * @notice Check correct finder and version of the deployed pool or self-minting derivative * @param poolOrDerivative Contract pool or self-minting derivative to check * @param version Pool or self-minting derivative version to check */ function checkDeployment( ISynthereumDeployment poolOrDerivative, uint8 version ) internal view { require( poolOrDerivative.synthereumFinder() == synthereumFinder, 'Wrong finder in deployment' ); require( poolOrDerivative.version() == version, 'Wrong version in deployment' ); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {ISynthereumFinder} from './interfaces/IFinder.sol'; import {IJarvisBrrrrr} from './interfaces/IJarvisBrrrrr.sol'; import { IMintableBurnableERC20 } from '../tokens/interfaces/IMintableBurnableERC20.sol'; import {SynthereumInterfaces} from './Constants.sol'; import { SafeERC20 } from '../../@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol'; import { AccessControlEnumerable } from '../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; import { ReentrancyGuard } from '../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; contract JarvisBrrrrr is AccessControlEnumerable, IJarvisBrrrrr, ReentrancyGuard { using SafeERC20 for IERC20; mapping(IMintableBurnableERC20 => uint256) private maxCirculatingSupply; mapping(IMintableBurnableERC20 => uint256) private circulatingSupply; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); ISynthereumFinder public immutable synthereumFinder; // Describe role structure struct Roles { address admin; address maintainer; } modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, msg.sender), 'Sender must be the maintainer' ); _; } modifier onlyMoneyMarketManager() { require( msg.sender == synthereumFinder.getImplementationAddress( SynthereumInterfaces.MoneyMarketManager ), 'Only mm manager can perform this operation' ); _; } event Minted(address token, address recipient, uint256 amount); event Redeemed(address token, address recipient, uint256 amount); event NewMaxSupply(address token, uint256 newMaxSupply); constructor(ISynthereumFinder _synthereumFinder, Roles memory _roles) { synthereumFinder = _synthereumFinder; _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, _roles.admin); _setupRole(MAINTAINER_ROLE, _roles.maintainer); } /** * @notice Mints synthetic token without collateral to a pre-defined address (SynthereumMoneyMarketManager) * @param token Synthetic token address to mint * @param amount Amount of tokens to mint * @return newCirculatingSupply New circulating supply in Money Market */ function mint(IMintableBurnableERC20 token, uint256 amount) external override onlyMoneyMarketManager() nonReentrant() returns (uint256 newCirculatingSupply) { newCirculatingSupply = amount + circulatingSupply[token]; require( newCirculatingSupply <= maxCirculatingSupply[token], 'Minting over max limit' ); circulatingSupply[token] = newCirculatingSupply; token.mint(msg.sender, amount); emit Minted(address(token), msg.sender, amount); } /** * @notice Burns synthetic token without releasing collateral from the pre-defined address (SynthereumMoneyMarketManager) * @param token Synthetic token address to burn * @param amount Amount of tokens to burn * @return newCirculatingSupply New circulating supply in Money Market */ function redeem(IMintableBurnableERC20 token, uint256 amount) external override onlyMoneyMarketManager() nonReentrant() returns (uint256 newCirculatingSupply) { uint256 actualSupply = circulatingSupply[token]; IERC20(token).safeTransferFrom(msg.sender, address(this), amount); newCirculatingSupply = actualSupply - amount; circulatingSupply[token] = newCirculatingSupply; token.burn(amount); emit Redeemed(address(token), msg.sender, amount); } /** * @notice Sets the max circulating supply that can be minted for a specific token - only manager can set this * @param token Synthetic token address to set * @param newMaxSupply New Max supply value of the token */ function setMaxSupply(IMintableBurnableERC20 token, uint256 newMaxSupply) external override onlyMaintainer() nonReentrant() { maxCirculatingSupply[token] = newMaxSupply; emit NewMaxSupply(address(token), newMaxSupply); } /** * @notice Returns the max circulating supply of a synthetic token * @param token Synthetic token address * @return maxCircSupply Max supply of the token */ function maxSupply(IMintableBurnableERC20 token) external view override returns (uint256 maxCircSupply) { maxCircSupply = maxCirculatingSupply[token]; } /** * @notice Returns the circulating supply of a synthetic token * @param token Synthetic token address * @return circSupply Circulating supply of the token */ function supply(IMintableBurnableERC20 token) external view override returns (uint256 circSupply) { circSupply = circulatingSupply[token]; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.0; import { ISynthereumCollateralWhitelist } from './interfaces/ICollateralWhitelist.sol'; import { EnumerableSet } from '../../@openzeppelin/contracts/utils/structs/EnumerableSet.sol'; import { AccessControlEnumerable } from '../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; /** * @title A contract to track a whitelist of addresses. */ contract SynthereumCollateralWhitelist is ISynthereumCollateralWhitelist, AccessControlEnumerable { using EnumerableSet for EnumerableSet.AddressSet; bytes32 private constant ADMIN_ROLE = 0x00; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //Describe role structure struct Roles { address admin; address maintainer; } EnumerableSet.AddressSet private collaterals; event AddedToWhitelist(address indexed addedCollateral); event RemovedFromWhitelist(address indexed removedCollateral); //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, msg.sender), 'Sender must be the maintainer' ); _; } /** * @notice Constructs the SynthereumCollateralWhitelist contract * @param roles Admin and Maintainer roles */ constructor(Roles memory roles) { _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, roles.admin); _setupRole(MAINTAINER_ROLE, roles.maintainer); } /** * @notice Adds an address to the whitelist. * @param newCollateral the new address to add. */ function addToWhitelist(address newCollateral) external override onlyMaintainer { require(collaterals.add(newCollateral), 'Collateral already supported'); emit AddedToWhitelist(newCollateral); } /** * @notice Removes an address from the whitelist. * @param collateralToRemove The existing address to remove. */ function removeFromWhitelist(address collateralToRemove) external override onlyMaintainer { require(collaterals.remove(collateralToRemove), 'Collateral not supported'); emit RemovedFromWhitelist(collateralToRemove); } /** * @notice Checks whether an address is on the whitelist. * @param collateralToCheck The address to check. * @return True if `collateralToCheck` is on the whitelist, or False. */ function isOnWhitelist(address collateralToCheck) external view override returns (bool) { return collaterals.contains(collateralToCheck); } /** * @notice Gets all addresses that are currently included in the whitelist. * @return The list of addresses on the whitelist. */ function getWhitelist() external view override returns (address[] memory) { uint256 numberOfElements = collaterals.length(); address[] memory activeCollaterals = new address[](numberOfElements); for (uint256 j = 0; j < numberOfElements; j++) { activeCollaterals[j] = collaterals.at(j); } return activeCollaterals; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.0; import { ISynthereumIdentifierWhitelist } from './interfaces/IIdentifierWhitelist.sol'; import { EnumerableSet } from '../../@openzeppelin/contracts/utils/structs/EnumerableSet.sol'; import {StringUtils} from '../base/utils/StringUtils.sol'; import { AccessControlEnumerable } from '../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; /** * @title A contract to track a whitelist of identifiers. */ contract SynthereumIdentifierWhitelist is ISynthereumIdentifierWhitelist, AccessControlEnumerable { using EnumerableSet for EnumerableSet.Bytes32Set; bytes32 private constant ADMIN_ROLE = 0x00; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //Describe role structure struct Roles { address admin; address maintainer; } EnumerableSet.Bytes32Set private identifiers; event AddedToWhitelist(bytes32 indexed addedIdentifier); event RemovedFromWhitelist(bytes32 indexed removedIdentifier); //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainer() { require( hasRole(MAINTAINER_ROLE, msg.sender), 'Sender must be the maintainer' ); _; } /** * @notice Constructs the SynthereumIdentifierWhitelist contract * @param roles Admin and Maintainer roles */ constructor(Roles memory roles) { _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, roles.admin); _setupRole(MAINTAINER_ROLE, roles.maintainer); } /** * @notice Adds an identifier to the whitelist. * @param newIdentifier the new identifier to add. */ function addToWhitelist(bytes32 newIdentifier) external override onlyMaintainer { require(identifiers.add(newIdentifier), 'Identifier already supported'); emit AddedToWhitelist(newIdentifier); } /** * @notice Removes an identifier from the whitelist. * @param identifierToRemove The existing identifier to remove. */ function removeFromWhitelist(bytes32 identifierToRemove) external override onlyMaintainer { require(identifiers.remove(identifierToRemove), 'Identifier not supported'); emit RemovedFromWhitelist(identifierToRemove); } /** * @notice Checks whether an address is on the whitelist. * @param identifierToCheck The address to check. * @return True if `identifierToCheck` is on the whitelist, or False. */ function isOnWhitelist(bytes32 identifierToCheck) external view override returns (bool) { return identifiers.contains(identifierToCheck); } /** * @notice Gets all identifiers that are currently included in the whitelist. * @return The list of identifiers on the whitelist. */ function getWhitelist() external view override returns (bytes32[] memory) { uint256 numberOfElements = identifiers.length(); bytes32[] memory activeIdentifiers = new bytes32[](numberOfElements); for (uint256 j = 0; j < numberOfElements; j++) { activeIdentifiers[j] = identifiers.at(j); } return activeIdentifiers; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumTrustedForwarder} from './interfaces/ITrustedForwarder.sol'; import {Address} from '../../@openzeppelin/contracts/utils/Address.sol'; import { MinimalForwarder } from '../../@openzeppelin/contracts/metatx/MinimalForwarder.sol'; contract SynthereumTrustedForwarder is ISynthereumTrustedForwarder, MinimalForwarder { /** * @notice Check if the execute function reverts or not */ function safeExecute(ForwardRequest calldata req, bytes calldata signature) public payable override returns (bytes memory) { (bool success, bytes memory returndata) = execute(req, signature); return Address.verifyCallResult( success, returndata, 'Error in the TrustedForwarder call' ); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.0; /** * @title An interface to track a whitelist of addresses. */ interface ISynthereumCollateralWhitelist { /** * @notice Adds an address to the whitelist. * @param newCollateral the new address to add. */ function addToWhitelist(address newCollateral) external; /** * @notice Removes an address from the whitelist. * @param collateralToRemove The existing address to remove. */ function removeFromWhitelist(address collateralToRemove) external; /** * @notice Checks whether an address is on the whitelist. * @param collateralToCheck The address to check. * @return True if `collateralToCheck` is on the whitelist, or False. */ function isOnWhitelist(address collateralToCheck) external view returns (bool); /** * @notice Gets all addresses that are currently included in the whitelist. * @return The list of addresses on the whitelist. */ function getWhitelist() external view returns (address[] memory); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.0; /** * @title An interface to track a whitelist of identifiers. */ interface ISynthereumIdentifierWhitelist { /** * @notice Adds an identifier to the whitelist. * @param newIdentifier the new identifier to add. */ function addToWhitelist(bytes32 newIdentifier) external; /** * @notice Removes an identifier from the whitelist. * @param identifierToRemove The existing identifier to remove. */ function removeFromWhitelist(bytes32 identifierToRemove) external; /** * @notice Checks whether an address is on the whitelist. * @param identifierToCheck The address to check. * @return True if `identifierToCheck` is on the whitelist, or False. */ function isOnWhitelist(bytes32 identifierToCheck) external view returns (bool); /** * @notice Gets all identifiers that are currently included in the whitelist. * @return The list of identifiers on the whitelist. */ function getWhitelist() external view returns (bytes32[] memory); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {SynthereumRegistry} from './Registry.sol'; import {ISynthereumFinder} from '../interfaces/IFinder.sol'; /** * @title Register and track all the self-minting derivatives deployed */ contract SelfMintingRegistry is SynthereumRegistry { /** * @notice Constructs the SelfMintingRegistry contract * @param _synthereumFinder Synthereum finder contract */ constructor(ISynthereumFinder _synthereumFinder) SynthereumRegistry('SELF MINTING REGISTRY', _synthereumFinder) {} }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; /** * @title Provides interface with functions of SynthereumRegistry */ interface ISynthereumRegistry { /** * @notice Allow the deployer to register an element * @param syntheticTokenSymbol Symbol of the syntheticToken * @param collateralToken Collateral ERC20 token of the element deployed * @param version Version of the element deployed * @param element Address of the element deployed */ function register( string calldata syntheticTokenSymbol, IERC20 collateralToken, uint8 version, address element ) external; /** * @notice Returns if a particular element exists or not * @param syntheticTokenSymbol Synthetic token symbol of the element * @param collateralToken ERC20 contract of collateral currency * @param version Version of the element * @param element Contract of the element to check * @return isElementDeployed Returns true if a particular element exists, otherwise false */ function isDeployed( string calldata syntheticTokenSymbol, IERC20 collateralToken, uint8 version, address element ) external view returns (bool isElementDeployed); /** * @notice Returns all the elements with partcular symbol, collateral and version * @param syntheticTokenSymbol Synthetic token symbol of the element * @param collateralToken ERC20 contract of collateral currency * @param version Version of the element * @return List of all elements */ function getElements( string calldata syntheticTokenSymbol, IERC20 collateralToken, uint8 version ) external view returns (address[] memory); /** * @notice Returns all the synthetic token symbol used * @return List of all synthetic token symbol */ function getSyntheticTokens() external view returns (string[] memory); /** * @notice Returns all the versions used * @return List of all versions */ function getVersions() external view returns (uint8[] memory); /** * @notice Returns all the collaterals used * @return List of all collaterals */ function getCollaterals() external view returns (address[] memory); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumRegistry} from './interfaces/IRegistry.sol'; import {ISynthereumFinder} from '../interfaces/IFinder.sol'; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {SynthereumInterfaces} from '../Constants.sol'; import { EnumerableSet } from '../../../@openzeppelin/contracts/utils/structs/EnumerableSet.sol'; import {StringUtils} from '../../base/utils/StringUtils.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; /** * @title Register and track all the pools deployed */ contract SynthereumRegistry is ISynthereumRegistry, ReentrancyGuard { using EnumerableSet for EnumerableSet.AddressSet; using EnumerableSet for EnumerableSet.UintSet; using EnumerableSet for EnumerableSet.Bytes32Set; using StringUtils for string; using StringUtils for bytes32; //---------------------------------------- // Storage //---------------------------------------- ISynthereumFinder public immutable synthereumFinder; string public registryType; mapping(string => mapping(IERC20 => mapping(uint8 => EnumerableSet.AddressSet))) private symbolToElements; EnumerableSet.Bytes32Set private syntheticTokens; EnumerableSet.AddressSet private collaterals; EnumerableSet.UintSet private versions; //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the SynthereumRegistry contract * @param _registryType Type of registry * @param _synthereumFinder Synthereum finder contract */ constructor(string memory _registryType, ISynthereumFinder _synthereumFinder) { synthereumFinder = _synthereumFinder; registryType = _registryType; } /** * @notice Allow the deployer to register an element * @param syntheticTokenSymbol Symbol of the syntheticToken * @param collateralToken Collateral ERC20 token of the element deployed * @param version Version of the element deployed * @param element Address of the element deployed */ function register( string calldata syntheticTokenSymbol, IERC20 collateralToken, uint8 version, address element ) external override nonReentrant { address deployer = ISynthereumFinder(synthereumFinder).getImplementationAddress( SynthereumInterfaces.Deployer ); require(msg.sender == deployer, 'Sender must be Synthereum deployer'); symbolToElements[syntheticTokenSymbol][collateralToken][version].add( element ); syntheticTokens.add(syntheticTokenSymbol.stringToBytes32()); collaterals.add(address(collateralToken)); versions.add(version); } /** * @notice Returns if a particular element exists or not * @param syntheticTokenSymbol Synthetic token symbol of the element * @param collateralToken ERC20 contract of collateral currency * @param version Version of the element * @param element Contract of the element to check * @return isElementDeployed Returns true if a particular element exists, otherwise false */ function isDeployed( string calldata syntheticTokenSymbol, IERC20 collateralToken, uint8 version, address element ) external view override returns (bool isElementDeployed) { isElementDeployed = symbolToElements[syntheticTokenSymbol][collateralToken][ version ] .contains(element); } /** * @notice Returns all the elements with partcular symbol, collateral and version * @param syntheticTokenSymbol Synthetic token symbol of the element * @param collateralToken ERC20 contract of collateral currency * @param version Version of the element * @return List of all elements */ function getElements( string calldata syntheticTokenSymbol, IERC20 collateralToken, uint8 version ) external view override returns (address[] memory) { EnumerableSet.AddressSet storage elementSet = symbolToElements[syntheticTokenSymbol][collateralToken][version]; uint256 numberOfElements = elementSet.length(); address[] memory elements = new address[](numberOfElements); for (uint256 j = 0; j < numberOfElements; j++) { elements[j] = elementSet.at(j); } return elements; } /** * @notice Returns all the synthetic token symbol used * @return List of all synthetic token symbol */ function getSyntheticTokens() external view override returns (string[] memory) { uint256 numberOfSynthTokens = syntheticTokens.length(); string[] memory synthTokens = new string[](numberOfSynthTokens); for (uint256 j = 0; j < numberOfSynthTokens; j++) { synthTokens[j] = syntheticTokens.at(j).bytes32ToString(); } return synthTokens; } /** * @notice Returns all the versions used * @return List of all versions */ function getVersions() external view override returns (uint8[] memory) { uint256 numberOfVersions = versions.length(); uint8[] memory actualVersions = new uint8[](numberOfVersions); for (uint256 j = 0; j < numberOfVersions; j++) { actualVersions[j] = uint8(versions.at(j)); } return actualVersions; } /** * @notice Returns all the collaterals used * @return List of all collaterals */ function getCollaterals() external view override returns (address[] memory) { uint256 numberOfCollaterals = collaterals.length(); address[] memory collateralAddresses = new address[](numberOfCollaterals); for (uint256 j = 0; j < numberOfCollaterals; j++) { collateralAddresses[j] = collaterals.at(j); } return collateralAddresses; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {SynthereumRegistry} from './Registry.sol'; import {ISynthereumFinder} from '../interfaces/IFinder.sol'; /** * @title Register and track all the pools deployed */ contract SynthereumPoolRegistry is SynthereumRegistry { /** * @notice Constructs the SynthereumPoolRegistry contract * @param _synthereumFinder Synthereum finder contract */ constructor(ISynthereumFinder _synthereumFinder) SynthereumRegistry('POOL REGISTRY', _synthereumFinder) {} }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import { FixedPoint } from '../../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; import {ISynthereumFinder} from '../../../core/interfaces/IFinder.sol'; /** * @title SelfMintingPerpetualMultiParty Contract. * @notice Convenient wrapper for Liquidatable. */ interface ISelfMintingMultiParty { //---------------------------------------- // Events //---------------------------------------- event Deposit(address indexed sponsor, uint256 indexed collateralAmount); event Withdrawal(address indexed sponsor, uint256 indexed collateralAmount); event RequestWithdrawal( address indexed sponsor, uint256 indexed collateralAmount ); event RequestWithdrawalExecuted( address indexed sponsor, uint256 indexed collateralAmount ); event RequestWithdrawalCanceled( address indexed sponsor, uint256 indexed collateralAmount ); event PositionCreated( address indexed sponsor, uint256 indexed collateralAmount, uint256 indexed tokenAmount, uint256 feeAmount ); event NewSponsor(address indexed sponsor); event EndedSponsorPosition(address indexed sponsor); event Redeem( address indexed sponsor, uint256 indexed collateralAmount, uint256 indexed tokenAmount, uint256 feeAmount ); event Repay( address indexed sponsor, uint256 indexed numTokensRepaid, uint256 indexed newTokenCount, uint256 feeAmount ); event EmergencyShutdown(address indexed caller, uint256 shutdownTimestamp); event SettleEmergencyShutdown( address indexed caller, uint256 indexed collateralReturned, uint256 indexed tokensBurned ); struct PositionData { FixedPoint.Unsigned tokensOutstanding; uint256 withdrawalRequestPassTimestamp; FixedPoint.Unsigned withdrawalRequestAmount; FixedPoint.Unsigned rawCollateral; } struct LiquidatableData { FixedPoint.Unsigned rawLiquidationCollateral; uint256 liquidationLiveness; FixedPoint.Unsigned collateralRequirement; FixedPoint.Unsigned disputeBondPct; FixedPoint.Unsigned sponsorDisputeRewardPct; FixedPoint.Unsigned disputerDisputeRewardPct; } //---------------------------------------- // External functions //---------------------------------------- /** * @notice Transfers `collateralAmount` of `feePayerData.collateralCurrency` into the caller's position. * @dev Increases the collateralization level of a position after creation. This contract must be approved to spend * at least `collateralAmount` of `feePayerData.collateralCurrency`. * @param collateralAmount total amount of collateral tokens to be sent to the sponsor's position. */ function deposit(uint256 collateralAmount) external; /** * @notice Transfers `collateralAmount` of `feePayerData.collateralCurrency` from the sponsor's position to the sponsor. * @dev Reverts if the withdrawal puts this position's collateralization ratio below the global collateralization * ratio. In that case, use `requestWithdrawal`. Might not withdraw the full requested amount to account for precision loss. * @param collateralAmount is the amount of collateral to withdraw. * @return amountWithdrawn The actual amount of collateral withdrawn. */ function withdraw(uint256 collateralAmount) external returns (uint256 amountWithdrawn); /** * @notice Starts a withdrawal request that, if passed, allows the sponsor to withdraw` from their position. * @dev The request will be pending for `withdrawalLiveness`, during which the position can be liquidated. * @param collateralAmount the amount of collateral requested to withdraw */ function requestWithdrawal(uint256 collateralAmount) external; /** * @notice After a passed withdrawal request (i.e., by a call to `requestWithdrawal` and waiting * `withdrawalLiveness`), withdraws `positionData.withdrawalRequestAmount` of collateral currency. * @dev Might not withdraw the full requested amount in order to account for precision loss or if the full requested * amount exceeds the collateral in the position (due to paying fees). * @return amountWithdrawn The actual amount of collateral withdrawn. */ function withdrawPassedRequest() external returns (uint256 amountWithdrawn); /** * @notice Cancels a pending withdrawal request. */ function cancelWithdrawal() external; /** * @notice Creates tokens by creating a new position or by augmenting an existing position. Pulls `collateralAmount * ` into the sponsor's position and mints `numTokens` of `tokenCurrency`. * @dev Can only be called by a token sponsor. Might not mint the full proportional amount of collateral * in order to account for precision loss. This contract must be approved to spend at least `collateralAmount` of * `collateralCurrency`. * @param collateralAmount is the number of collateral tokens to collateralize the position with * @param numTokens is the number of tokens to mint from the position. * @param feePercentage The percentage of fee that is paid in collateralCurrency */ function create( uint256 collateralAmount, uint256 numTokens, uint256 feePercentage ) external returns (uint256 daoFeeAmount); /** * @notice Burns `numTokens` of `tokenCurrency` and sends back the proportional amount of `feePayerData.collateralCurrency`. * @dev Can only be called by a token sponsor. Might not redeem the full proportional amount of collateral * in order to account for precision loss. This contract must be approved to spend at least `numTokens` of * `tokenCurrency`. * @param numTokens is the number of tokens to be burnt for a commensurate amount of collateral. * @return amountWithdrawn The actual amount of collateral withdrawn. */ function redeem(uint256 numTokens, uint256 feePercentage) external returns (uint256 amountWithdrawn, uint256 daoFeeAmount); /** * @notice Burns `numTokens` of `tokenCurrency` to decrease sponsors position size, without sending back `feePayerData.collateralCurrency`. * This is done by a sponsor to increase position CR. * @dev Can only be called by token sponsor. This contract must be approved to spend `numTokens` of `tokenCurrency`. * @param numTokens is the number of tokens to be burnt for a commensurate amount of collateral. * @param feePercentage the fee percentage paid by the token sponsor in collateralCurrency */ function repay(uint256 numTokens, uint256 feePercentage) external returns (uint256 daoFeeAmount); /** * @notice If the contract is emergency shutdown then all token holders and sponsor can redeem their tokens or * remaining collateral for underlying at the prevailing price defined by a DVM vote. * @dev This burns all tokens from the caller of `tokenCurrency` and sends back the resolved settlement value of * `feePayerData.collateralCurrency`. Might not redeem the full proportional amount of collateral in order to account for * precision loss. This contract must be approved to spend `tokenCurrency` at least up to the caller's full balance. * @dev This contract must have the Burner role for the `tokenCurrency`. * @return amountWithdrawn The actual amount of collateral withdrawn. */ function settleEmergencyShutdown() external returns (uint256 amountWithdrawn); /** * @notice Premature contract settlement under emergency circumstances. * @dev Only the governor can call this function as they are permissioned within the `FinancialContractAdmin`. * Upon emergency shutdown, the contract settlement time is set to the shutdown time. This enables withdrawal * to occur via the `settleEmergencyShutdown` function. */ function emergencyShutdown() external; /** @notice Remargin function */ function remargin() external; /** * @notice Drains any excess balance of the provided ERC20 token to a pre-selected beneficiary. * @dev This will drain down to the amount of tracked collateral and drain the full balance of any other token. * @param token address of the ERC20 token whose excess balance should be drained. */ function trimExcess(IERC20 token) external returns (uint256 amount); /** * @notice Delete a TokenSponsor position (This function can only be called by the contract itself) * @param sponsor address of the TokenSponsor. */ function deleteSponsorPosition(address sponsor) external; /** * @notice Accessor method for a sponsor's collateral. * @dev This is necessary because the struct returned by the positions() method shows * rawCollateral, which isn't a user-readable value. * @param sponsor address whose collateral amount is retrieved. * @return collateralAmount amount of collateral within a sponsors position. */ function getCollateral(address sponsor) external view returns (FixedPoint.Unsigned memory collateralAmount); /** * @notice Get SynthereumFinder contract address * @return finder SynthereumFinder contract */ function synthereumFinder() external view returns (ISynthereumFinder finder); /** * @notice Get synthetic token currency * @return synthToken Synthetic token */ function tokenCurrency() external view returns (IERC20 synthToken); /** * @notice Get synthetic token symbol * @return symbol Synthetic token symbol */ function syntheticTokenSymbol() external view returns (string memory symbol); /** @notice Get the version of a self minting derivative * @return contractVersion Contract version */ function version() external view returns (uint8 contractVersion); /** * @notice Get synthetic token price identifier registered with UMA DVM * @return identifier Synthetic token price identifier */ function priceIdentifier() external view returns (bytes32 identifier); /** * @notice Accessor method for the total collateral stored within the SelfMintingPerpetualPositionManagerMultiParty. * @return totalCollateral amount of all collateral within the position manager. */ function totalPositionCollateral() external view returns (uint256); /** * @notice Get the currently minted synthetic tokens from all self-minting derivatives * @return totalTokens Total amount of synthetic tokens minted */ function totalTokensOutstanding() external view returns (uint256); /** * @notice Get the price of synthetic token set by DVM after emergencyShutdown call * @return Price of synthetic token */ function emergencyShutdownPrice() external view returns (uint256); /** @notice Calculates the DAO fee based on the numTokens parameter * @param numTokens Number of synthetic tokens used in the transaction * @return rawValue The DAO fee to be paid in collateralCurrency */ function calculateDaoFee(uint256 numTokens) external view returns (uint256); /** @notice Checks the currently set fee recipient and fee percentage for the DAO fee * @return feePercentage The percentage set by the DAO to be taken as a fee on each transaction * @return feeRecipient The DAO address that receives the fee */ function daoFee() external view returns (uint256 feePercentage, address feeRecipient); /** @notice Check the current cap on self-minting synthetic tokens. * A cap mint amount is set in order to avoid depletion of liquidity pools, * by self-minting synthetic assets and redeeming collateral from the pools. * The cap mint amount is updateable and is based on a percentage of the currently * minted synthetic assets from the liquidity pools. * @return capMint The currently set cap amount for self-minting a synthetic token */ function capMintAmount() external view returns (uint256 capMint); /** @notice Check the current cap on deposit of collateral into a self-minting derivative. * A cap deposit ratio is set in order to avoid a troll attack in which an attacker * can increase infinitely the GCR thus making it extremelly expensive or impossible * for other users to self-mint synthetic assets with a given collateral. * @return capDeposit The current cap deposit ratio */ function capDepositRatio() external view returns (uint256 capDeposit); /** * @notice Transfers `collateralAmount` of `feePayerData.collateralCurrency` into the specified sponsor's position. * @dev Increases the collateralization level of a position after creation. This contract must be approved to spend * at least `collateralAmount` of `feePayerData.collateralCurrency`. * @param sponsor the sponsor to credit the deposit to. * @param collateralAmount total amount of collateral tokens to be sent to the sponsor's position. */ function depositTo(address sponsor, uint256 collateralAmount) external; /** @notice Check the collateralCurrency in which fees are paid for a given self-minting derivative * @return collateral The collateral currency */ function collateralCurrency() external view returns (IERC20 collateral); function positions(address tokenSponsor) external view returns (PositionData memory tsPosition); function liquidatableData() external view returns (LiquidatableData memory data); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IStandardERC20} from '../../base/interfaces/IStandardERC20.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import {ICreditLineController} from './interfaces/ICreditLineController.sol'; import {ICreditLineStorage} from './interfaces/ICreditLineStorage.sol'; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; import { BaseControlledMintableBurnableERC20 } from '../../tokens/interfaces/BaseControlledMintableBurnableERC20.sol'; import {CreditLineLib} from './CreditLineLib.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import { FixedPoint } from '../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; import {CreditLine} from './CreditLine.sol'; /** * @title Self-Minting Contract creator. * @notice Factory contract to create new self-minting derivative */ contract CreditLineCreator { using FixedPoint for FixedPoint.Unsigned; struct Params { IStandardERC20 collateralToken; bytes32 priceFeedIdentifier; string syntheticName; string syntheticSymbol; address syntheticToken; ICreditLineStorage.Fee fee; uint256 liquidationPercentage; uint256 capMintAmount; uint256 collateralRequirement; FixedPoint.Unsigned minSponsorTokens; address excessTokenBeneficiary; uint8 version; } // Address of Synthereum Finder ISynthereumFinder public immutable synthereumFinder; //---------------------------------------- // Events //---------------------------------------- event CreatedSelfMintingDerivative( address indexed selfMintingAddress, uint8 indexed version, address indexed deployerAddress ); //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the Perpetual contract. * @param _synthereumFinder Synthereum Finder address used to discover other contracts */ constructor(address _synthereumFinder) { synthereumFinder = ISynthereumFinder(_synthereumFinder); } //---------------------------------------- // External functions //---------------------------------------- /** * @notice Creates an instance of creditLine * @param params is a `ConstructorParams` object from creditLine. * @return creditLine address of the deployed contract. */ function createSelfMintingDerivative(Params calldata params) public virtual returns (CreditLine creditLine) { // Create a new synthetic token using the params. require(bytes(params.syntheticName).length != 0, 'Missing synthetic name'); require( bytes(params.syntheticSymbol).length != 0, 'Missing synthetic symbol' ); require( params.syntheticToken != address(0), 'Synthetic token address cannot be 0x00' ); BaseControlledMintableBurnableERC20 tokenCurrency = BaseControlledMintableBurnableERC20(params.syntheticToken); require( keccak256(abi.encodePacked(tokenCurrency.name())) == keccak256(abi.encodePacked(params.syntheticName)), 'Wrong synthetic token name' ); require( keccak256(abi.encodePacked(tokenCurrency.symbol())) == keccak256(abi.encodePacked(params.syntheticSymbol)), 'Wrong synthetic token symbol' ); creditLine = new CreditLine(_convertParams(params)); _setControllerValues( address(creditLine), params.fee, params.liquidationPercentage, params.capMintAmount, params.collateralRequirement ); emit CreatedSelfMintingDerivative( address(creditLine), params.version, msg.sender ); } //---------------------------------------- // Internal functions //---------------------------------------- // Converts createPerpetual params to constructor params. function _convertParams(Params calldata params) internal view returns (CreditLine.PositionManagerParams memory constructorParams) { constructorParams.synthereumFinder = synthereumFinder; require( params.excessTokenBeneficiary != address(0), 'Token Beneficiary cannot be 0x00' ); constructorParams.syntheticToken = IMintableBurnableERC20( address(params.syntheticToken) ); constructorParams.collateralToken = params.collateralToken; constructorParams.priceFeedIdentifier = params.priceFeedIdentifier; constructorParams.minSponsorTokens = params.minSponsorTokens; constructorParams.excessTokenBeneficiary = params.excessTokenBeneficiary; constructorParams.version = params.version; } /** @notice Sets the controller values for a self-minting derivative * @param derivative Address of the derivative to set controller values * @param feeStruct The fee config params * @param capMintAmount Cap on mint amount. How much synthetic tokens can be minted through a self-minting derivative. * This value is updatable */ function _setControllerValues( address derivative, ICreditLineStorage.Fee memory feeStruct, uint256 liquidationRewardPercentage, uint256 capMintAmount, uint256 collateralRequirement ) internal { ICreditLineController creditLineController = ICreditLineController( synthereumFinder.getImplementationAddress( SynthereumInterfaces.CreditLineController ) ); // prepare function calls args address[] memory derivatives = new address[](1); derivatives[0] = derivative; uint256[] memory capMintAmounts = new uint256[](1); capMintAmounts[0] = capMintAmount; uint256[] memory collateralRequirements = new uint256[](1); collateralRequirements[0] = collateralRequirement; uint256[] memory feePercentages = new uint256[](1); feePercentages[0] = feeStruct.feePercentage; uint256[] memory liqPercentages = new uint256[](1); liqPercentages[0] = liquidationRewardPercentage; address[][] memory feeRecipients = new address[][](1); feeRecipients[0] = feeStruct.feeRecipients; uint32[][] memory feeProportions = new uint32[][](1); feeProportions[0] = feeStruct.feeProportions; // set the derivative over collateralization percentage creditLineController.setCollateralRequirement( derivatives, collateralRequirements ); // set the derivative fee configuration creditLineController.setFeePercentage(derivatives, feePercentages); creditLineController.setFeeRecipients( derivatives, feeRecipients, feeProportions ); // set the derivative cap mint amount creditLineController.setCapMintAmount(derivatives, capMintAmounts); // set the derivative liquidation reward percentage creditLineController.setLiquidationRewardPercentage( derivatives, liqPercentages ); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { IDeploymentSignature } from '../../core/interfaces/IDeploymentSignature.sol'; import { ISynthereumCollateralWhitelist } from '../../core/interfaces/ICollateralWhitelist.sol'; import { ISynthereumIdentifierWhitelist } from '../../core/interfaces/IIdentifierWhitelist.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import {CreditLineCreator} from './CreditLineCreator.sol'; import {CreditLine} from './CreditLine.sol'; import {FactoryConditions} from '../../common/FactoryConditions.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; /** @title Contract factory of self-minting derivatives */ contract CreditLineFactory is IDeploymentSignature, ReentrancyGuard, FactoryConditions, CreditLineCreator { //---------------------------------------- // Storage //---------------------------------------- bytes4 public immutable override deploymentSignature; //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the CreditLineFactory contract * @param _synthereumFinder Synthereum Finder address used to discover other contracts */ constructor(address _synthereumFinder) CreditLineCreator(_synthereumFinder) { deploymentSignature = this.createSelfMintingDerivative.selector; } /** * @notice Check if the sender is the deployer and deploy a new creditLine contract * @param params is a `ConstructorParams` object from creditLine. * @return creditLine address of the deployed contract. */ function createSelfMintingDerivative(Params calldata params) public override nonReentrant returns (CreditLine creditLine) { checkDeploymentConditions( synthereumFinder, params.collateralToken, params.priceFeedIdentifier ); creditLine = super.createSelfMintingDerivative(params); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import {ICreditLineController} from './interfaces/ICreditLineController.sol'; import { ISynthereumRegistry } from '../../core/registries/interfaces/IRegistry.sol'; import {ICreditLine} from './interfaces/ICreditLine.sol'; import { ISynthereumFactoryVersioning } from '../../core/interfaces/IFactoryVersioning.sol'; import {ICreditLineStorage} from './interfaces/ICreditLineStorage.sol'; import { SynthereumInterfaces, FactoryInterfaces } from '../../core/Constants.sol'; import { FixedPoint } from '../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; import { AccessControlEnumerable } from '../../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; /** * @title SelfMintingController * Set capMintAmount, and fee recipient, proportions and percentage of each self-minting derivative */ contract CreditLineController is ICreditLineController, AccessControlEnumerable { using FixedPoint for FixedPoint.Unsigned; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //Describe role structure struct Roles { address admin; address maintainer; } //---------------------------------------- // Storage //---------------------------------------- ISynthereumFinder public immutable synthereumFinder; uint8 public immutable selfMintingVersion; mapping(address => uint256) private capMint; mapping(address => uint256) private liquidationReward; mapping(address => uint256) private collateralRequirement; mapping(address => ICreditLineStorage.Fee) private fee; //---------------------------------------- // Events //---------------------------------------- event SetCapMintAmount( address indexed selfMintingDerivative, uint256 capMintAmount ); event SetFeePercentage( address indexed selfMintingDerivative, uint256 feePercentage ); event SetFeeRecipients( address indexed selfMintingDerivative, address[] feeRecipient, uint32[] feeProportions ); event SetLiquidationReward( address indexed selfMintingDerivative, uint256 liquidationReward ); event SetCollateralRequirement( address indexed selfMintingDerivative, uint256 collateralRequirement ); //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMaintainerOrSelfMintingFactory() { if (hasRole(MAINTAINER_ROLE, msg.sender)) { _; } else { ISynthereumFactoryVersioning factoryVersioning = ISynthereumFactoryVersioning( synthereumFinder.getImplementationAddress( SynthereumInterfaces.FactoryVersioning ) ); uint256 numberOfFactories = factoryVersioning.numberOfFactoryVersions( FactoryInterfaces.SelfMintingFactory ); uint256 counter = 0; for (uint8 i = 0; counter < numberOfFactories; i++) { try factoryVersioning.getFactoryVersion( FactoryInterfaces.SelfMintingFactory, i ) returns (address factory) { if (msg.sender == factory) { _; break; } else { counter++; } } catch {} } if (numberOfFactories == counter) { revert('Sender must be the maintainer or a self-minting factory'); } } } //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the SynthereumManager contract * @param _synthereumFinder Synthereum finder contract * @param roles Admin and maintainer roles * @param version Version of self-minting contracts on which this controller has setting grants */ constructor( ISynthereumFinder _synthereumFinder, Roles memory roles, uint8 version ) { synthereumFinder = _synthereumFinder; selfMintingVersion = version; _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MAINTAINER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, roles.admin); _setupRole(MAINTAINER_ROLE, roles.maintainer); } //---------------------------------------- // External functions //---------------------------------------- function setCollateralRequirement( address[] calldata selfMintingDerivatives, uint256[] calldata collateralRequirements ) external override onlyMaintainerOrSelfMintingFactory { require( selfMintingDerivatives.length > 0, 'No self-minting derivatives passed' ); require( selfMintingDerivatives.length == collateralRequirements.length, 'Number of derivatives and overcollaterals must be the same' ); bool isMaintainer = hasRole(MAINTAINER_ROLE, msg.sender); for (uint256 j; j < selfMintingDerivatives.length; j++) { ICreditLine creditLineDerivative = ICreditLine(selfMintingDerivatives[j]); uint8 version = creditLineDerivative.version(); require(version == selfMintingVersion, 'Wrong self-minting version'); if (isMaintainer) { checkSelfMintingDerivativeRegistration(creditLineDerivative, version); } _setCollateralRequirement( address(creditLineDerivative), collateralRequirements[j] ); } } function setCapMintAmount( address[] calldata selfMintingDerivatives, uint256[] calldata capMintAmounts ) external override onlyMaintainerOrSelfMintingFactory { require( selfMintingDerivatives.length > 0, 'No self-minting derivatives passed' ); require( selfMintingDerivatives.length == capMintAmounts.length, 'Number of derivatives and mint cap amounts must be the same' ); bool isMaintainer = hasRole(MAINTAINER_ROLE, msg.sender); for (uint256 j; j < selfMintingDerivatives.length; j++) { ICreditLine creditLineDerivative = ICreditLine(selfMintingDerivatives[j]); uint8 version = creditLineDerivative.version(); require(version == selfMintingVersion, 'Wrong self-minting version'); if (isMaintainer) { checkSelfMintingDerivativeRegistration(creditLineDerivative, version); } _setCapMintAmount(address(creditLineDerivative), capMintAmounts[j]); } } function setFeePercentage( address[] calldata selfMintingDerivatives, uint256[] calldata feePercentages ) external override onlyMaintainerOrSelfMintingFactory { uint256 selfMintingDerCount = selfMintingDerivatives.length; require(selfMintingDerCount > 0, 'No self-minting derivatives passed'); require( selfMintingDerCount == feePercentages.length, 'Number of derivatives and fee percentages must be the same' ); bool isMaintainer = hasRole(MAINTAINER_ROLE, msg.sender); for (uint256 j; j < selfMintingDerCount; j++) { ICreditLine creditLineDerivative = ICreditLine(selfMintingDerivatives[j]); uint8 version = creditLineDerivative.version(); require(version == selfMintingVersion, 'Wrong self-minting version'); if (isMaintainer) { checkSelfMintingDerivativeRegistration(creditLineDerivative, version); } _setFeePercentage(address(creditLineDerivative), feePercentages[j]); } } function setFeeRecipients( address[] calldata selfMintingDerivatives, address[][] calldata feeRecipients, uint32[][] calldata feeProportions ) external override onlyMaintainerOrSelfMintingFactory { uint256 selfMintingDerCount = selfMintingDerivatives.length; require(selfMintingDerCount > 0, 'No self-minting derivatives passed'); require( selfMintingDerCount == feeRecipients.length, 'Mismatch between derivatives to update and fee recipients' ); require( selfMintingDerCount == feeProportions.length, 'Mismatch between derivatives to update and fee proportions' ); bool isMaintainer = hasRole(MAINTAINER_ROLE, msg.sender); // update each derivative fee parameters for (uint256 j; j < selfMintingDerCount; j++) { ICreditLine creditLineDerivative = ICreditLine(selfMintingDerivatives[j]); uint8 version = creditLineDerivative.version(); require(version == selfMintingVersion, 'Wrong self-minting version'); if (isMaintainer) { checkSelfMintingDerivativeRegistration(creditLineDerivative, version); } _setFeeRecipients( address(creditLineDerivative), feeRecipients[j], feeProportions[j] ); } } function setLiquidationRewardPercentage( address[] calldata selfMintingDerivatives, uint256[] calldata _liquidationRewards ) external override onlyMaintainerOrSelfMintingFactory { uint256 selfMintingDerCount = selfMintingDerivatives.length; require(selfMintingDerCount > 0, 'No self-minting derivatives passed'); require( selfMintingDerCount == _liquidationRewards.length, 'Mismatch between derivatives to update and liquidation rewards' ); bool isMaintainer = hasRole(MAINTAINER_ROLE, msg.sender); for (uint256 j; j < selfMintingDerCount; j++) { ICreditLine creditLineDerivative = ICreditLine(selfMintingDerivatives[j]); uint8 version = creditLineDerivative.version(); require(version == selfMintingVersion, 'Wrong self-minting version'); if (isMaintainer) { checkSelfMintingDerivativeRegistration(creditLineDerivative, version); } _setLiquidationReward(selfMintingDerivatives[j], _liquidationRewards[j]); } } function getCollateralRequirement(address selfMintingDerivative) external view override returns (uint256) { return collateralRequirement[selfMintingDerivative]; } function getLiquidationRewardPercentage(address selfMintingDerivative) external view override returns (uint256) { return liquidationReward[selfMintingDerivative]; } function getFeeInfo(address selfMintingDerivative) external view override returns (ICreditLineStorage.Fee memory) { return fee[selfMintingDerivative]; } function feePercentage(address selfMintingDerivative) external view override returns (uint256) { return fee[selfMintingDerivative].feePercentage; } function feeRecipientsInfo(address selfMintingDerivative) external view override returns ( address[] memory, uint32[] memory, uint256 ) { ICreditLineStorage.Fee storage _feeData = fee[selfMintingDerivative]; return ( _feeData.feeRecipients, _feeData.feeProportions, _feeData.totalFeeProportions ); } function getCapMintAmount(address selfMintingDerivative) external view override returns (uint256 capMintAmount) { return capMint[selfMintingDerivative]; } //---------------------------------------- // Internal functions //---------------------------------------- function _setLiquidationReward( address selfMintingDerivative, uint256 liqReward ) internal { require( liquidationReward[selfMintingDerivative] != liqReward, 'Liquidation reward is the same' ); require( liqReward > 0 && liqReward < 10**18, 'Liquidation reward must be between 0 and 100%' ); liquidationReward[selfMintingDerivative] = liqReward; emit SetLiquidationReward(selfMintingDerivative, liqReward); } function _setCollateralRequirement( address selfMintingDerivative, uint256 percentage ) internal { require( collateralRequirement[selfMintingDerivative] != percentage, 'Collateral requirement is the same' ); require( percentage > 10**18, 'Overcollateralisation must be bigger than 100%' ); collateralRequirement[selfMintingDerivative] = percentage; emit SetCollateralRequirement(selfMintingDerivative, percentage); } function _setFeeRecipients( address selfMintingDerivative, address[] calldata feeRecipients, uint32[] calldata feeProportions ) internal { uint256 totalActualFeeProportions = 0; // Store the sum of all proportions for (uint256 i = 0; i < feeProportions.length; i++) { totalActualFeeProportions += feeProportions[i]; fee[selfMintingDerivative].feeRecipients = feeRecipients; fee[selfMintingDerivative].feeProportions = feeProportions; fee[selfMintingDerivative] .totalFeeProportions = totalActualFeeProportions; emit SetFeeRecipients( selfMintingDerivative, feeRecipients, feeProportions ); } } function _setFeePercentage( address selfMintingDerivative, uint256 _feePercentage ) internal { require( fee[selfMintingDerivative].feePercentage != _feePercentage, 'Fee percentage is the same' ); require(_feePercentage <= 10**18, 'Fee percentage must be less than 100%'); fee[selfMintingDerivative].feePercentage = _feePercentage; emit SetFeePercentage(selfMintingDerivative, _feePercentage); } function _setCapMintAmount( address selfMintingDerivative, uint256 capMintAmount ) internal { require( capMint[selfMintingDerivative] != capMintAmount, 'Cap mint amount is the same' ); capMint[selfMintingDerivative] = capMintAmount; emit SetCapMintAmount(selfMintingDerivative, capMintAmount); } /** * @notice Check if a self-minting derivative is registered with the SelfMintingRegistry * @param selfMintingDerivative Self-minting derivative contract * @param version version of self-mintinting derivative */ function checkSelfMintingDerivativeRegistration( ICreditLine selfMintingDerivative, uint8 version ) internal view { ISynthereumRegistry selfMintingRegistry = ISynthereumRegistry( synthereumFinder.getImplementationAddress( SynthereumInterfaces.SelfMintingRegistry ) ); require( selfMintingRegistry.isDeployed( selfMintingDerivative.syntheticTokenSymbol(), selfMintingDerivative.collateralToken(), version, address(selfMintingDerivative) ), 'Self-minting derivative not registred' ); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../../../core/interfaces/IFinder.sol'; import { IStandardERC20, IERC20 } from '../../../base/interfaces/IStandardERC20.sol'; import { ISynthereumDeployment } from '../../../common/interfaces/IDeployment.sol'; import { IEmergencyShutdown } from '../../../common/interfaces/IEmergencyShutdown.sol'; import {ICreditLineStorage} from './ICreditLineStorage.sol'; import {ITypology} from '../../../common/interfaces/ITypology.sol'; import { FixedPoint } from '../../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; interface ICreditLine is ITypology, IEmergencyShutdown, ISynthereumDeployment { /** * @notice Transfers `collateralAmount` into the caller's position. * @dev Increases the collateralization level of a position after creation. This contract must be approved to spend * at least `collateralAmount` of collateral token * @param collateralAmount total amount of collateral tokens to be sent to the sponsor's position. */ function deposit(uint256 collateralAmount) external; /** * @notice Transfers `collateralAmount` into the specified sponsor's position. * @dev Increases the collateralization level of a position after creation. This contract must be approved to spend * at least `collateralAmount` of collateralCurrency. * @param sponsor the sponsor to credit the deposit to. * @param collateralAmount total amount of collateral tokens to be sent to the sponsor's position. */ function depositTo(address sponsor, uint256 collateralAmount) external; /** * @notice Transfers `collateralAmount` from the sponsor's position to the sponsor. * @dev Reverts if the withdrawal puts this position's collateralization ratio below the collateral requirement * @param collateralAmount is the amount of collateral to withdraw. * @return amountWithdrawn The actual amount of collateral withdrawn. */ function withdraw(uint256 collateralAmount) external returns (uint256 amountWithdrawn); /** * @notice Pulls `collateralAmount` into the sponsor's position and mints `numTokens` of `tokenCurrency`. * Mints new debt tokens by creating a new position or by augmenting an existing position. * @dev Can only be called by a token sponsor. This contract must be approved to spend at least `collateralAmount` of * `collateralCurrency`. * @param collateralAmount is the number of collateral tokens to collateralize the position with * @param numTokens is the number of debt tokens to mint to sponsor. */ function create(uint256 collateralAmount, uint256 numTokens) external returns (uint256 feeAmount); /** * @notice Burns `numTokens` of `tokenCurrency` and sends back the proportional amount of collateral * @dev Can only be called by a token sponsor- This contract must be approved to spend at least `numTokens` of * `tokenCurrency`. * @param numTokens is the number of tokens to be burnt. * @return amountWithdrawn The actual amount of collateral withdrawn. * @return feeAmount incurred fees in collateral token. */ function redeem(uint256 numTokens) external returns (uint256 amountWithdrawn, uint256 feeAmount); /** * @notice Burns `numTokens` of `tokenCurrency` to decrease sponsors position size, without sending back collateral. * This is done by a sponsor to increase position CR. * @dev Can only be called by token sponsor. This contract must be approved to spend `numTokens` of `tokenCurrency`. * @param numTokens is the number of tokens to be burnt. */ function repay(uint256 numTokens) external returns (uint256 daoFeeAmount); /** * @notice Liquidate sponsor position for an amount of synthetic tokens undercollateralized * @notice Revert if position is not undercollateralized * @param sponsor Address of sponsor to be liquidated. * @param maxTokensToLiquidate Max number of synthetic tokens to be liquidated * @return tokensLiquidated Amount of debt tokens burned * @return collateralLiquidated Amount of received collateral equal to the value of tokens liquidated * @return collateralReward Amount of received collateral as reward for the liquidation */ function liquidate(address sponsor, uint256 maxTokensToLiquidate) external returns ( uint256 tokensLiquidated, uint256 collateralLiquidated, uint256 collateralReward ); /** * @notice When in emergency shutdown state all token holders and sponsor can redeem their tokens and * remaining collateral at the prevailing price defined by the on-chain oracle * @dev This burns all tokens from the caller of `tokenCurrency` and sends back the resolved settlement value of * collateral. This contract must be approved to spend `tokenCurrency` at least up to the caller's full balance. * @dev This contract must have the Burner role for the `tokenCurrency`. * @return amountWithdrawn The actual amount of collateral withdrawn. */ function settleEmergencyShutdown() external returns (uint256 amountWithdrawn); /** * @notice Withdraw fees gained by the sender * @return feeClaimed Amount of fee claimed */ function claimFee() external returns (uint256 feeClaimed); /** * @notice trim any excess funds in the contract to the excessTokenBeneficiary address * @return amount the amount of tokens trimmed */ function trimExcess(IERC20 token) external returns (uint256 amount); /** * @notice Delete a TokenSponsor position. This function can only be called by the contract itself. * @param sponsor address of the TokenSponsor. */ function deleteSponsorPosition(address sponsor) external; /** * @notice Returns the minimum amount of tokens a sponsor must mint * @return amount the value */ function minSponsorTokens() external view returns (uint256 amount); /** * @notice Returns the address of the trim excess tokens receiver * @return beneficiary the addess */ function excessTokensBeneficiary() external view returns (address beneficiary); /** * @notice Returns the cap mint amount of the derivative contract * @return capMint cap mint amount */ function capMintAmount() external view returns (uint256 capMint); /** * @notice Returns the fee parameters of the derivative contract * @return fee Fee struct */ function feeInfo() external view returns (ICreditLineStorage.Fee memory fee); /** * @notice Returns the total fee produced by the contract * @return totalFee total amount of fees */ function totalFeeAmount() external view returns (uint256 totalFee); /** * @notice Returns the total fee gained by the input address * @param feeGainer address to check claimable fees * @return feeGained amount of fess claimable by feeGainer */ function userFeeGained(address feeGainer) external view returns (uint256 feeGained); /** * @notice Returns the liquidation rewrd percentage of the derivative contract * @return rewardPct liquidator reward percentage */ function liquidationReward() external view returns (uint256 rewardPct); /** * @notice Returns the over collateralization percentage of the derivative contract * @return collReq percentage of overcollateralization */ function collateralRequirement() external view returns (uint256 collReq); /** * @notice Accessor method for a sponsor's position. * @param sponsor address whose position data is retrieved. * @return collateralAmount amount of collateral of the sponsor's position. * @return tokensAmount amount of outstanding tokens of the sponsor's position. */ function getPositionData(address sponsor) external view returns (uint256 collateralAmount, uint256 tokensAmount); /** * @notice Accessor method for contract's global position (aggregate). * @return totCollateral total amount of collateral deposited by lps * @return totTokensOutstanding total amount of outstanding tokens. */ function getGlobalPositionData() external view returns (uint256 totCollateral, uint256 totTokensOutstanding); /** * @notice Returns if sponsor position is overcollateralized and thepercentage of coverage of the collateral according to the last price * @return True if position is overcollaterlized, otherwise false + percentage of coverage (totalCollateralAmount / (price * tokensCollateralized)) */ function collateralCoverage(address sponsor) external view returns (bool, uint256); /** * @notice Returns liquidation price of a position * @param sponsor address whose liquidation price is calculated. * @return liquidationPrice */ function liquidationPrice(address sponsor) external view returns (uint256 liquidationPrice); /** * @notice Get synthetic token price identifier as represented by the oracle interface * @return identifier Synthetic token price identifier */ function priceIdentifier() external view returns (bytes32 identifier); /** * @notice Get the price of synthetic token set by DVM after emergencyShutdown call * @return price Price of synthetic token */ function emergencyShutdownPrice() external view returns (uint256 price); /** * @notice Get the block number when the emergency shutdown was called * @return time Block time */ function emergencyShutdownTime() external view returns (uint256 time); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {ICreditLineStorage} from './ICreditLineStorage.sol'; import { FixedPoint } from '../../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; /** @title Interface for interacting with the SelfMintingController */ interface ICreditLineController { /** * @notice Allow to set collateralRequirement percentage on a list of registered self-minting derivatives * @param selfMintingDerivatives Self-minting derivatives * @param collateralRequirements Over collateralization percentage for self-minting derivatives */ function setCollateralRequirement( address[] calldata selfMintingDerivatives, uint256[] calldata collateralRequirements ) external; /** * @notice Allow to set capMintAmount on a list of registered self-minting derivatives * @param selfMintingDerivatives Self-minting derivatives * @param capMintAmounts Mint cap amounts for self-minting derivatives */ function setCapMintAmount( address[] calldata selfMintingDerivatives, uint256[] calldata capMintAmounts ) external; /** * @notice Allow to set fee percentages on a list of registered self-minting derivatives * @param selfMintingDerivatives Self-minting derivatives * @param feePercentages fee percentages for self-minting derivatives */ function setFeePercentage( address[] calldata selfMintingDerivatives, uint256[] calldata feePercentages ) external; /** * @notice Update the addresses and weight of recipients for generated fees * @param selfMintingDerivatives Derivatives to update * @param feeRecipients A two-dimension array containing for each derivative the addresses of fee recipients * @param feeProportions An array of the proportions of fees generated each recipient will receive */ function setFeeRecipients( address[] calldata selfMintingDerivatives, address[][] calldata feeRecipients, uint32[][] calldata feeProportions ) external; /** * @notice Update the liquidation reward percentage * @param selfMintingDerivatives Derivatives to update * @param _liquidationRewards Percentage of reward for correct liquidation by a liquidator */ function setLiquidationRewardPercentage( address[] calldata selfMintingDerivatives, uint256[] calldata _liquidationRewards ) external; /** * @notice Gets the over collateralization percentage of a self-minting derivative * @param selfMintingDerivative Derivative to read value of * @return the collateralRequirement percentage */ function getCollateralRequirement(address selfMintingDerivative) external view returns (uint256); /** * @notice Gets the set liquidtion reward percentage of a self-minting derivative * @param selfMintingDerivative Self-minting derivative * @return liquidation Reward percentage */ function getLiquidationRewardPercentage(address selfMintingDerivative) external view returns (uint256); /** * @notice Gets the set CapMintAmount of a self-minting derivative * @param selfMintingDerivative Self-minting derivative * @return capMintAmount Limit amount for minting */ function getCapMintAmount(address selfMintingDerivative) external view returns (uint256 capMintAmount); /** * @notice Gets the fee params of a self-minting derivative * @param selfMintingDerivative Self-minting derivative * @return fee fee info (percent + recipient + proportions) */ function getFeeInfo(address selfMintingDerivative) external view returns (ICreditLineStorage.Fee memory fee); /** * @notice Gets the fee percentage of a self-minting derivative * @param selfMintingDerivative Self-minting derivative * @return feePercentage value */ function feePercentage(address selfMintingDerivative) external view returns (uint256); /** * @notice Returns fee recipients info * @return Addresses, weigths and total of weigtht */ function feeRecipientsInfo(address selfMintingDerivative) external view returns ( address[] memory, uint32[] memory, uint256 ); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {MintableBurnableERC20} from './MintableBurnableERC20.sol'; /** * @title Synthetic token contract * Inherits from MintableBurnableERC20 */ contract MintableBurnableSyntheticToken is MintableBurnableERC20 { constructor( string memory tokenName, string memory tokenSymbol, uint8 tokenDecimals ) MintableBurnableERC20(tokenName, tokenSymbol, tokenDecimals) {} /** * @notice Add minter role to account * @dev The caller must have the admin role * @param account The address on which minter role is added */ function addMinter(address account) public override { super.addMinter(account); } /** * @notice Add burner role to account * @dev The caller must have the admin role * @param account The address to which burner role is added */ function addBurner(address account) public override { super.addBurner(account); } /** * @notice Add admin role to account. * @dev The caller must have the admin role. * @param account The address to which the admin role is added. */ function addAdmin(address account) public override { super.addAdmin(account); } /** * @notice Add admin, minter and burner roles to account. * @dev The caller must have the admin role. * @param account The address to which the admin, minter and burner roles are added. */ function addAdminAndMinterAndBurner(address account) public override { super.addAdminAndMinterAndBurner(account); } /** * @notice Minter renounce to minter role */ function renounceMinter() public override { super.renounceMinter(); } /** * @notice Burner renounce to burner role */ function renounceBurner() public override { super.renounceBurner(); } /** * @notice Admin renounce to admin role */ function renounceAdmin() public override { super.renounceAdmin(); } /** * @notice Admin, minter and murner renounce to admin, minter and burner roles */ function renounceAdminAndMinterAndBurner() public override { super.renounceAdminAndMinterAndBurner(); } /** * @notice Checks if a given account holds the minter role. * @param account The address which is checked for the minter role. * @return bool True if the provided account is a minter. */ function isMinter(address account) public view returns (bool) { return hasRole(MINTER_ROLE, account); } /** * @notice Checks if a given account holds the burner role. * @param account The address which is checked for the burner role. * @return bool True if the provided account is a burner. */ function isBurner(address account) public view returns (bool) { return hasRole(BURNER_ROLE, account); } /** * @notice Checks if a given account holds the admin role. * @param account The address which is checked for the admin role. * @return bool True if the provided account is an admin. */ function isAdmin(address account) public view returns (bool) { return hasRole(DEFAULT_ADMIN_ROLE, account); } /** * @notice Accessor method for the list of member with admin role * @return array of address with admin role */ function getAdminMembers() external view returns (address[] memory) { uint256 numberOfMembers = getRoleMemberCount(DEFAULT_ADMIN_ROLE); address[] memory members = new address[](numberOfMembers); for (uint256 j = 0; j < numberOfMembers; j++) { address newMember = getRoleMember(DEFAULT_ADMIN_ROLE, j); members[j] = newMember; } return members; } /** * @notice Accessor method for the list of member with minter role * @return array of address with minter role */ function getMinterMembers() external view returns (address[] memory) { uint256 numberOfMembers = getRoleMemberCount(MINTER_ROLE); address[] memory members = new address[](numberOfMembers); for (uint256 j = 0; j < numberOfMembers; j++) { address newMember = getRoleMember(MINTER_ROLE, j); members[j] = newMember; } return members; } /** * @notice Accessor method for the list of member with burner role * @return array of address with burner role */ function getBurnerMembers() external view returns (address[] memory) { uint256 numberOfMembers = getRoleMemberCount(BURNER_ROLE); address[] memory members = new address[](numberOfMembers); for (uint256 j = 0; j < numberOfMembers; j++) { address newMember = getRoleMember(BURNER_ROLE, j); members[j] = newMember; } return members; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { MintableBurnableSyntheticToken } from './MintableBurnableSyntheticToken.sol'; import { ERC20Permit } from '../../@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol'; import {ERC20} from '../../@openzeppelin/contracts/token/ERC20/ERC20.sol'; import {MintableBurnableERC20} from './MintableBurnableERC20.sol'; import { BaseControlledMintableBurnableERC20 } from './interfaces/BaseControlledMintableBurnableERC20.sol'; /** * @title Synthetic token contract * Inherits from ERC20Permit and MintableBurnableSyntheticToken */ contract MintableBurnableSyntheticTokenPermit is ERC20Permit, MintableBurnableSyntheticToken { constructor( string memory tokenName, string memory tokenSymbol, uint8 tokenDecimals ) MintableBurnableSyntheticToken(tokenName, tokenSymbol, tokenDecimals) ERC20Permit(tokenName) {} /** * @notice Returns the number of decimals used */ function decimals() public view virtual override(ERC20, BaseControlledMintableBurnableERC20) returns (uint8) { return BaseControlledMintableBurnableERC20.decimals(); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ERC20} from '../../../@openzeppelin/contracts/token/ERC20/ERC20.sol'; import {IMintableBurnableERC20} from './IMintableBurnableERC20.sol'; /** * @title ERC20 interface that includes burn mint and roles methods. */ abstract contract BaseControlledMintableBurnableERC20 is ERC20, IMintableBurnableERC20 { uint8 private _decimals; /** * @notice Constructs the ERC20 token contract * @param _tokenName Name of the token * @param _tokenSymbol Token symbol * @param _tokenDecimals Number of decimals for token */ constructor( string memory _tokenName, string memory _tokenSymbol, uint8 _tokenDecimals ) ERC20(_tokenName, _tokenSymbol) { _setupDecimals(_tokenDecimals); } /** * @notice Add Minter role to an account * @param account Address to which Minter role will be added */ function addMinter(address account) external virtual; /** * @notice Add Burner role to an account * @param account Address to which Burner role will be added */ function addBurner(address account) external virtual; /** * @notice Add Admin role to an account * @param account Address to which Admin role will be added */ function addAdmin(address account) external virtual; /** * @notice Add Admin, Minter and Burner roles to an account * @param account Address to which Admin, Minter and Burner roles will be added */ function addAdminAndMinterAndBurner(address account) external virtual; /** * @notice Add Admin, Minter and Burner roles to an account * @param account Address to which Admin, Minter and Burner roles will be added */ /** * @notice Self renounce the address calling the function from minter role */ function renounceMinter() external virtual; /** * @notice Self renounce the address calling the function from burner role */ function renounceBurner() external virtual; /** * @notice Self renounce the address calling the function from admin role */ function renounceAdmin() external virtual; /** * @notice Self renounce the address calling the function from admin, minter and burner role */ function renounceAdminAndMinterAndBurner() external virtual; /** * @notice Returns the number of decimals used to get its user representation. */ function decimals() public view virtual override(ERC20, IMintableBurnableERC20) returns (uint8) { return _decimals; } /** * @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_; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; /** * @title ERC20 interface that includes burn mint and roles methods. */ interface IMintableBurnableERC20 is IERC20 { /** * @notice Burns a specific amount of the caller's tokens. * @dev This method should be permissioned to only allow designated parties to burn tokens. */ function burn(uint256 value) external; /** * @notice Mints tokens and adds them to the balance of the `to` address. * @dev This method should be permissioned to only allow designated parties to mint tokens. */ function mint(address to, uint256 value) external returns (bool); /** * @notice Returns the number of decimals used to get its user representation. */ function decimals() external view returns (uint8); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { BaseControlledMintableBurnableERC20 } from '../../interfaces/BaseControlledMintableBurnableERC20.sol'; /** * @title Interface for interacting with the MintableBurnableTokenFactory contract */ interface IMintableBurnableTokenFactory { /** @notice Calls the deployment of a new ERC20 token * @param tokenName The name of the token to be deployed * @param tokenSymbol The symbol of the token that will be deployed * @param tokenDecimals Number of decimals for the token to be deployed */ function createToken( string memory tokenName, string memory tokenSymbol, uint8 tokenDecimals ) external returns (BaseControlledMintableBurnableERC20 newToken); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { BaseControlledMintableBurnableERC20 } from './interfaces/BaseControlledMintableBurnableERC20.sol'; import { AccessControlEnumerable } from '../../@openzeppelin/contracts/access/AccessControlEnumerable.sol'; /** * @title ERC20 token contract */ contract MintableBurnableERC20 is BaseControlledMintableBurnableERC20, AccessControlEnumerable { bytes32 public constant MINTER_ROLE = keccak256('Minter'); bytes32 public constant BURNER_ROLE = keccak256('Burner'); //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyMinter() { require(hasRole(MINTER_ROLE, msg.sender), 'Sender must be the minter'); _; } modifier onlyBurner() { require(hasRole(BURNER_ROLE, msg.sender), 'Sender must be the burner'); _; } //---------------------------------------- // Constructors //---------------------------------------- /** * @notice Constructs the ERC20 token contract * @param _tokenName Name of the token * @param _tokenSymbol Token symbol * @param _tokenDecimals Number of decimals for token */ constructor( string memory _tokenName, string memory _tokenSymbol, uint8 _tokenDecimals ) BaseControlledMintableBurnableERC20( _tokenName, _tokenSymbol, _tokenDecimals ) { _setupDecimals(_tokenDecimals); _setRoleAdmin(DEFAULT_ADMIN_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(MINTER_ROLE, DEFAULT_ADMIN_ROLE); _setRoleAdmin(BURNER_ROLE, DEFAULT_ADMIN_ROLE); _setupRole(DEFAULT_ADMIN_ROLE, msg.sender); } //---------------------------------------- // External functions //---------------------------------------- /** * @notice Mint new ERC20 tokens * @param recipient Recipient of the minted tokens * @param value Amount of tokens to be minted */ function mint(address recipient, uint256 value) external override onlyMinter() returns (bool) { _mint(recipient, value); return true; } /** * @notice Burn ERC20 tokens * @param value Amount of ERC20 tokens to be burned */ function burn(uint256 value) external override onlyBurner() { _burn(msg.sender, value); } /** * @notice Assign a new minting role * @param account Address of the new minter */ function addMinter(address account) public virtual override { grantRole(MINTER_ROLE, account); } /** * @notice Assign a new burning role * @param account Address of the new burner */ function addBurner(address account) public virtual override { grantRole(BURNER_ROLE, account); } /** * @notice Assign new admin role * @param account Address of the new admin */ function addAdmin(address account) public virtual override { grantRole(DEFAULT_ADMIN_ROLE, account); } /** * @notice Assign admin, minting and burning priviliges to an address * @param account Address to which roles are assigned */ function addAdminAndMinterAndBurner(address account) public virtual override { grantRole(DEFAULT_ADMIN_ROLE, account); grantRole(MINTER_ROLE, account); grantRole(BURNER_ROLE, account); } /** * @notice Self renounce the address calling the function from minter role */ function renounceMinter() public virtual override { renounceRole(MINTER_ROLE, msg.sender); } /** * @notice Self renounce the address calling the function from burner role */ function renounceBurner() public virtual override { renounceRole(BURNER_ROLE, msg.sender); } /** * @notice Self renounce the address calling the function from admin role */ function renounceAdmin() public virtual override { renounceRole(DEFAULT_ADMIN_ROLE, msg.sender); } /** * @notice Self renounce the address calling the function from admin, minter and burner role */ function renounceAdminAndMinterAndBurner() public virtual override { renounceRole(DEFAULT_ADMIN_ROLE, msg.sender); renounceRole(MINTER_ROLE, msg.sender); renounceRole(BURNER_ROLE, msg.sender); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { ISynthereumFactoryVersioning } from '../../core/interfaces/IFactoryVersioning.sol'; import { SynthereumInterfaces, FactoryInterfaces } from '../../core/Constants.sol'; import { BaseControlledMintableBurnableERC20 } from '../interfaces/BaseControlledMintableBurnableERC20.sol'; /** * @title Factory for creating new mintable and burnable tokens. */ abstract contract MintableBurnableTokenFactory { //---------------------------------------- // Storage //---------------------------------------- ISynthereumFinder public synthereumFinder; //---------------------------------------- // Modifiers //---------------------------------------- modifier onlyPoolFactoryOrFixedRateFactory() { ISynthereumFactoryVersioning factoryVersioning = ISynthereumFactoryVersioning( synthereumFinder.getImplementationAddress( SynthereumInterfaces.FactoryVersioning ) ); uint8 numberOfPoolFactories = factoryVersioning.numberOfFactoryVersions(FactoryInterfaces.PoolFactory); uint8 numberOfFixedRateFactories = factoryVersioning.numberOfFactoryVersions( FactoryInterfaces.FixedRateFactory ); bool isPoolFactory = _checkSenderIsFactory( factoryVersioning, numberOfPoolFactories, FactoryInterfaces.PoolFactory ); if (isPoolFactory) { _; return; } bool isFixedRateFactory = _checkSenderIsFactory( factoryVersioning, numberOfFixedRateFactories, FactoryInterfaces.FixedRateFactory ); if (isFixedRateFactory) { _; return; } revert('Sender must be a Pool or FixedRate factory'); } //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs SynthereumSyntheticTokenFactory contract * @param _synthereumFinder Synthereum finder contract */ constructor(address _synthereumFinder) { synthereumFinder = ISynthereumFinder(_synthereumFinder); } /** * @notice Create a new token and return it to the caller. * @param tokenName used to describe the new token. * @param tokenSymbol short ticker abbreviation of the name. Ideally < 5 chars. * @param tokenDecimals used to define the precision used in the token's numerical representation. * @return newToken an instance of the newly created token interface. */ function createToken( string memory tokenName, string memory tokenSymbol, uint8 tokenDecimals ) public virtual returns (BaseControlledMintableBurnableERC20 newToken); /** * @notice Set admin rol to the token * @param token Token on which the adim role is set */ function _setAdminRole(BaseControlledMintableBurnableERC20 token) internal { token.addAdmin(msg.sender); token.renounceAdmin(); } function _checkSenderIsFactory( ISynthereumFactoryVersioning factoryVersioning, uint8 numberOfFactories, bytes32 factoryKind ) internal view returns (bool isFactory) { uint8 counterFactory; for (uint8 i = 0; counterFactory < numberOfFactories; i++) { try factoryVersioning.getFactoryVersion(factoryKind, i) returns ( address factory ) { if (msg.sender == factory) { isFactory = true; break; } else { counterFactory++; if (counterFactory == numberOfFactories) { isFactory = false; } } } catch {} } } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { BaseControlledMintableBurnableERC20 } from '../interfaces/BaseControlledMintableBurnableERC20.sol'; import {MintableBurnableTokenFactory} from './MintableBurnableTokenFactory.sol'; import { MintableBurnableSyntheticToken } from '../MintableBurnableSyntheticToken.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; contract SynthereumSyntheticTokenFactory is ReentrancyGuard, MintableBurnableTokenFactory { //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs SynthereumSyntheticTokenFactory contract * @param _synthereumFinder Synthereum finder contract */ constructor(address _synthereumFinder) MintableBurnableTokenFactory(_synthereumFinder) {} /** * @notice Create a new synthetic token and return it to the caller. * @dev The caller will become the only minter and burner and the new owner capable of assigning the roles. * @param tokenName used to describe the new token. * @param tokenSymbol short ticker abbreviation of the name. Ideally < 5 chars. * @param tokenDecimals used to define the precision used in the token's numerical representation. * @return newToken an instance of the newly created token */ function createToken( string calldata tokenName, string calldata tokenSymbol, uint8 tokenDecimals ) public override onlyPoolFactoryOrFixedRateFactory nonReentrant returns (BaseControlledMintableBurnableERC20 newToken) { MintableBurnableSyntheticToken mintableToken = new MintableBurnableSyntheticToken(tokenName, tokenSymbol, tokenDecimals); newToken = BaseControlledMintableBurnableERC20(address(mintableToken)); _setAdminRole(newToken); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { BaseControlledMintableBurnableERC20 } from '../interfaces/BaseControlledMintableBurnableERC20.sol'; import {MintableBurnableTokenFactory} from './MintableBurnableTokenFactory.sol'; import { MintableBurnableSyntheticTokenPermit } from '../MintableBurnableSyntheticTokenPermit.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; contract SynthereumSyntheticTokenPermitFactory is ReentrancyGuard, MintableBurnableTokenFactory { //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs SynthereumSyntheticTokenPermitFactory contract * @param _synthereumFinder Synthereum finder contract */ constructor(address _synthereumFinder) MintableBurnableTokenFactory(_synthereumFinder) {} /** * @notice Create a new synthetic token with permit function and return it to the caller. * @dev The caller will become the only minter and burner and the new owner capable of assigning the roles. * @param tokenName used to describe the new token. * @param tokenSymbol short ticker abbreviation of the name. Ideally < 5 chars. * @param tokenDecimals used to define the precision used in the token's numerical representation. * @return newToken an instance of the newly created token */ function createToken( string calldata tokenName, string calldata tokenSymbol, uint8 tokenDecimals ) public override onlyPoolFactoryOrFixedRateFactory nonReentrant returns (BaseControlledMintableBurnableERC20 newToken) { MintableBurnableSyntheticTokenPermit mintableToken = new MintableBurnableSyntheticTokenPermit( tokenName, tokenSymbol, tokenDecimals ); newToken = BaseControlledMintableBurnableERC20(address(mintableToken)); _setAdminRole(newToken); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {SynthereumRegistry} from './Registry.sol'; import {ISynthereumFinder} from '../interfaces/IFinder.sol'; /** * @title Register and track all the fixed rate wrappers deployed */ contract SynthereumFixedRateRegistry is SynthereumRegistry { /** * @notice Constructs the SynthereumFixedRateRegistry contract * @param _synthereumFinder Synthereum finder contract */ constructor(ISynthereumFinder _synthereumFinder) SynthereumRegistry('FIXEDRATE_REGISTRY', _synthereumFinder) {} }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {IStandardERC20} from '../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableTokenFactory } from '../../tokens/factories/interfaces/IMintableBurnableTokenFactory.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; import { BaseControlledMintableBurnableERC20 } from '../../tokens/interfaces/BaseControlledMintableBurnableERC20.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import {SynthereumFixedRateWrapper} from './FixedRateWrapper.sol'; import {ISynthereumFixedRateWrapper} from './interfaces/IFixedRateWrapper.sol'; contract SynthereumFixedRateCreator { struct Params { IStandardERC20 collateralToken; string syntheticName; string syntheticSymbol; address syntheticToken; ISynthereumFixedRateWrapper.Roles roles; uint8 version; uint256 rate; } // Address of Synthereum Finder ISynthereumFinder public immutable synthereumFinder; //---------------------------------------- // Events //---------------------------------------- event CreatedFixedRate( address indexed fixedRateAddress, uint8 indexed version, address indexed deployerAddress ); //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Constructs the FixedRateWrapper contract. * @param _synthereumFinder Synthereum Finder address used to discover other contracts */ constructor(address _synthereumFinder) { synthereumFinder = ISynthereumFinder(_synthereumFinder); } //---------------------------------------- // Public functions //---------------------------------------- /** * @notice Creates an instance of the fixed rate * @param params is a `ConstructorParams` object from FixedRateWrapper. * @return fixedRate Address of the deployed fixedRate contract. */ function createFixedRate(Params calldata params) public virtual returns (SynthereumFixedRateWrapper fixedRate) { require(bytes(params.syntheticName).length != 0, 'Missing synthetic name'); require( bytes(params.syntheticSymbol).length != 0, 'Missing synthetic symbol' ); if (params.syntheticToken == address(0)) { IMintableBurnableTokenFactory tokenFactory = IMintableBurnableTokenFactory( ISynthereumFinder(synthereumFinder).getImplementationAddress( SynthereumInterfaces.TokenFactory ) ); BaseControlledMintableBurnableERC20 tokenCurrency = tokenFactory.createToken( params.syntheticName, params.syntheticSymbol, 18 ); fixedRate = new SynthereumFixedRateWrapper( _convertParams(params, tokenCurrency) ); // Give permissions to new pool contract and then hand over ownership. tokenCurrency.addMinter(address(fixedRate)); tokenCurrency.addBurner(address(fixedRate)); tokenCurrency.addAdmin( synthereumFinder.getImplementationAddress(SynthereumInterfaces.Manager) ); tokenCurrency.renounceAdmin(); } else { BaseControlledMintableBurnableERC20 tokenCurrency = BaseControlledMintableBurnableERC20(params.syntheticToken); require( keccak256(abi.encodePacked(tokenCurrency.name())) == keccak256(abi.encodePacked(params.syntheticName)), 'Wrong synthetic token name' ); require( keccak256(abi.encodePacked(tokenCurrency.symbol())) == keccak256(abi.encodePacked(params.syntheticSymbol)), 'Wrong synthetic token symbol' ); fixedRate = new SynthereumFixedRateWrapper( _convertParams(params, tokenCurrency) ); } emit CreatedFixedRate(address(fixedRate), params.version, msg.sender); return fixedRate; } // Converts createFixedRate params to constructor params. function _convertParams( Params memory params, BaseControlledMintableBurnableERC20 tokenCurrency ) internal view returns ( SynthereumFixedRateWrapper.ConstructorParams memory constructorParams ) { require(params.roles.admin != address(0), 'Admin cannot be 0x00'); constructorParams.finder = synthereumFinder; constructorParams.version = params.version; constructorParams.pegCollateralToken = params.collateralToken; constructorParams.fixedRateToken = IMintableBurnableERC20( address(tokenCurrency) ); constructorParams.roles = params.roles; constructorParams.rate = params.rate; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { IDeploymentSignature } from '../../core/interfaces/IDeploymentSignature.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import {SynthereumFixedRateCreator} from './FixedRateCreator.sol'; import {SynthereumFixedRateWrapper} from './FixedRateWrapper.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; contract SynthereumFixedRateFactory is IDeploymentSignature, ReentrancyGuard, SynthereumFixedRateCreator { //---------------------------------------- // Storage //---------------------------------------- bytes4 public immutable override deploymentSignature; //---------------------------------------- // Constructor //---------------------------------------- /** * @notice Set synthereum finder * @param synthereumFinder Synthereum finder contract */ constructor(address synthereumFinder) SynthereumFixedRateCreator(synthereumFinder) { deploymentSignature = this.createFixedRate.selector; } //---------------------------------------- // Public functions //---------------------------------------- /** * @notice Check if the sender is the deployer and deploy a fixed rate * @param params input parameters of the fixed rate * @return fixedRate Deployed fixed rate */ function createFixedRate(Params calldata params) public override nonReentrant returns (SynthereumFixedRateWrapper fixedRate) { address deployer = synthereumFinder.getImplementationAddress(SynthereumInterfaces.Deployer); require(msg.sender == deployer, 'Sender must be Synthereum deployer'); fixedRate = super.createFixedRate(params); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { ISynthereumDeployment } from '../../../common/interfaces/IDeployment.sol'; import {ITypology} from '../../../common/interfaces/ITypology.sol'; interface ISynthereumFixedRateWrapper is ITypology, ISynthereumDeployment { // Describe role structure struct Roles { address admin; address maintainer; } /** @notice This function is used to mint new fixed rate synthetic tokens by depositing peg collateral tokens * @notice The conversion is based on a fixed rate * @param _collateral The amount of peg collateral tokens to be deposited * @param _recipient The address of the recipient to receive the newly minted fixed rate synthetic tokens * @return amountTokens The amount of newly minted fixed rate synthetic tokens */ function wrap(uint256 _collateral, address _recipient) external returns (uint256 amountTokens); /** @notice This function is used to burn fixed rate synthetic tokens and receive the underlying peg collateral tokens * @notice The conversion is based on a fixed rate * @param _tokenAmount The amount of fixed rate synthetic tokens to be burned * @param _recipient The address of the recipient to receive the underlying peg collateral tokens * @return amountCollateral The amount of peg collateral tokens withdrawn */ function unwrap(uint256 _tokenAmount, address _recipient) external returns (uint256 amountCollateral); /** @notice A function that allows a maintainer to pause the execution of some functions in the contract * @notice This function suspends minting of new fixed rate synthetic tokens * @notice Pausing does not affect redeeming the peg collateral by burning the fixed rate synthetic tokens * @notice Pausing the contract is necessary in situations to prevent an issue with the smart contract or if the rate * between the fixed rate synthetic token and the peg collateral token changes */ function pauseContract() external; /** @notice A function that allows a maintainer to resume the execution of all functions in the contract * @notice After the resume contract function is called minting of new fixed rate synthetic assets is open again */ function resumeContract() external; /** @notice Check the conversion rate between peg-collateral and fixed-rate synthetic token * @return Coversion rate */ function conversionRate() external view returns (uint256); /** @notice Amount of peg collateral stored in the contract * @return Total peg collateral deposited */ function totalPegCollateral() external view returns (uint256); /** @notice Amount of synthetic tokens minted from the contract * @return Total synthetic tokens minted so far */ function totalSyntheticTokensMinted() external view returns (uint256); /** @notice Check if wrap can be performed or not * @return True if minting is paused, otherwise false */ function isPaused() external view returns (bool); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 standard as defined in the EIP. */ interface IERC20 { /** * @dev Returns the amount of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the amount of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves `amount` tokens from the caller's account to `recipient`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address recipient, uint256 amount) external returns (bool); /** * @dev Returns the remaining number of tokens that `spender` will be * allowed to spend on behalf of `owner` through {transferFrom}. This is * zero by default. * * This value changes when {approve} or {transferFrom} are called. */ function allowance(address owner, address spender) external view returns (uint256); /** * @dev Sets `amount` as the allowance of `spender` over the caller's tokens. * * Returns a boolean value indicating whether the operation succeeded. * * IMPORTANT: Beware that changing an allowance with this method brings the risk * that someone may use both the old and the new allowance by unfortunate * transaction ordering. One possible solution to mitigate this race * condition is to first reduce the spender's allowance to 0 and set the * desired value afterwards: * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 * * Emits an {Approval} event. */ function approve(address spender, uint256 amount) external returns (bool); /** * @dev Moves `amount` tokens from `sender` to `recipient` using the * allowance mechanism. `amount` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom( address sender, address recipient, uint256 amount ) external returns (bool); /** * @dev Emitted when `value` tokens are moved from one account (`from`) to * another (`to`). * * Note that `value` may be zero. */ event Transfer(address indexed from, address indexed to, uint256 value); /** * @dev Emitted when the allowance of a `spender` for an `owner` is set by * a call to {approve}. `value` is the new allowance. */ event Approval(address indexed owner, address indexed spender, uint256 value); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @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; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; // CAUTION // This version of SafeMath should only be used with Solidity 0.8 or later, // because it relies on the compiler's built in overflow checks. /** * @dev Wrappers over Solidity's arithmetic operations. * * NOTE: `SafeMath` is no longer needed starting with Solidity 0.8. The compiler * now has built in overflow checking. */ library SafeMath { /** * @dev Returns the addition of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) { unchecked { uint256 c = a + b; if (c < a) return (false, 0); return (true, c); } } /** * @dev Returns the substraction of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) { unchecked { if (b > a) return (false, 0); return (true, a - b); } } /** * @dev Returns the multiplication of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) { unchecked { // Gas optimization: this is cheaper than requiring 'a' not being zero, but the // benefit is lost if 'b' is also tested. // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 if (a == 0) return (true, 0); uint256 c = a * b; if (c / a != b) return (false, 0); return (true, c); } } /** * @dev Returns the division of two unsigned integers, with a division by zero flag. * * _Available since v3.4._ */ function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) { unchecked { if (b == 0) return (false, 0); return (true, a / b); } } /** * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag. * * _Available since v3.4._ */ function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) { unchecked { if (b == 0) return (false, 0); return (true, a % b); } } /** * @dev Returns the addition of two unsigned integers, reverting on * overflow. * * Counterpart to Solidity's `+` operator. * * Requirements: * * - Addition cannot overflow. */ function add(uint256 a, uint256 b) internal pure returns (uint256) { return a + b; } /** * @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 a - b; } /** * @dev Returns the multiplication of two unsigned integers, reverting on * overflow. * * Counterpart to Solidity's `*` operator. * * Requirements: * * - Multiplication cannot overflow. */ function mul(uint256 a, uint256 b) internal pure returns (uint256) { return a * b; } /** * @dev Returns the integer division of two unsigned integers, reverting on * division by zero. The result is rounded towards zero. * * Counterpart to Solidity's `/` operator. * * Requirements: * * - The divisor cannot be zero. */ function div(uint256 a, uint256 b) internal pure returns (uint256) { return a / b; } /** * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), * reverting when dividing by zero. * * Counterpart to Solidity's `%` operator. This function uses a `revert` * opcode (which leaves remaining gas untouched) while Solidity uses an * invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function mod(uint256 a, uint256 b) internal pure returns (uint256) { return a % b; } /** * @dev Returns the subtraction of two unsigned integers, reverting with custom message on * overflow (when the result is negative). * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {trySub}. * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub( uint256 a, uint256 b, string memory errorMessage ) internal pure returns (uint256) { unchecked { require(b <= a, errorMessage); return a - b; } } /** * @dev Returns the integer division of two unsigned integers, reverting with custom message on * division by zero. The result is rounded towards zero. * * Counterpart to Solidity's `/` operator. Note: this function uses a * `revert` opcode (which leaves remaining gas untouched) while Solidity * uses an invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function div( uint256 a, uint256 b, string memory errorMessage ) internal pure returns (uint256) { unchecked { require(b > 0, errorMessage); return a / b; } } /** * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), * reverting with custom message when dividing by zero. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {tryMod}. * * Counterpart to Solidity's `%` operator. This function uses a `revert` * opcode (which leaves remaining gas untouched) while Solidity uses an * invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function mod( uint256 a, uint256 b, string memory errorMessage ) internal pure returns (uint256) { unchecked { require(b > 0, errorMessage); return a % b; } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Wrappers over Solidity's arithmetic operations. * * NOTE: `SignedSafeMath` is no longer needed starting with Solidity 0.8. The compiler * now has built in overflow checking. */ library SignedSafeMath { /** * @dev Returns the multiplication of two signed integers, reverting on * overflow. * * Counterpart to Solidity's `*` operator. * * Requirements: * * - Multiplication cannot overflow. */ function mul(int256 a, int256 b) internal pure returns (int256) { return a * b; } /** * @dev Returns the integer division of two signed integers. Reverts on * division by zero. The result is rounded towards zero. * * Counterpart to Solidity's `/` operator. * * Requirements: * * - The divisor cannot be zero. */ function div(int256 a, int256 b) internal pure returns (int256) { return a / b; } /** * @dev Returns the subtraction of two signed integers, reverting on * overflow. * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub(int256 a, int256 b) internal pure returns (int256) { return a - b; } /** * @dev Returns the addition of two signed integers, reverting on * overflow. * * Counterpart to Solidity's `+` operator. * * Requirements: * * - Addition cannot overflow. */ function add(int256 a, int256 b) internal pure returns (int256) { return a + b; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "../utils/Context.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() { _setOwner(_msgSender()); } /** * @dev Returns the address of the current owner. */ function owner() public view virtual returns (address) { return _owner; } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { 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 { _setOwner(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"); _setOwner(newOwner); } function _setOwner(address newOwner) private { address oldOwner = _owner; _owner = newOwner; emit OwnershipTransferred(oldOwner, newOwner); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./IERC20.sol"; import "./extensions/IERC20Metadata.sol"; import "../../utils/Context.sol"; /** * @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 Contracts guidelines: functions revert * instead 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 Context, IERC20, IERC20Metadata { mapping(address => uint256) private _balances; mapping(address => mapping(address => uint256)) private _allowances; uint256 private _totalSupply; string private _name; string private _symbol; /** * @dev Sets the values for {name} and {symbol}. * * The default value of {decimals} is 18. To select a different value for * {decimals} you should overload it. * * All two of these values are immutable: they can only be set once during * construction. */ constructor(string memory name_, string memory symbol_) { _name = name_; _symbol = symbol_; } /** * @dev Returns the name of the token. */ function name() public view virtual override returns (string memory) { return _name; } /** * @dev Returns the symbol of the token, usually a shorter version of the * name. */ function symbol() public view virtual override 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 this function is * overridden; * * 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 virtual override returns (uint8) { return 18; } /** * @dev See {IERC20-totalSupply}. */ function totalSupply() public view virtual override returns (uint256) { return _totalSupply; } /** * @dev See {IERC20-balanceOf}. */ function balanceOf(address account) public view virtual 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(_msgSender(), 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(_msgSender(), 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); uint256 currentAllowance = _allowances[sender][_msgSender()]; require(currentAllowance >= amount, "ERC20: transfer amount exceeds allowance"); unchecked { _approve(sender, _msgSender(), currentAllowance - amount); } 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(_msgSender(), spender, _allowances[_msgSender()][spender] + 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) { uint256 currentAllowance = _allowances[_msgSender()][spender]; require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero"); unchecked { _approve(_msgSender(), spender, currentAllowance - subtractedValue); } return true; } /** * @dev Moves `amount` of tokens from `sender` to `recipient`. * * This 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), "ERC20: transfer from the zero address"); require(recipient != address(0), "ERC20: transfer to the zero address"); _beforeTokenTransfer(sender, recipient, amount); uint256 senderBalance = _balances[sender]; require(senderBalance >= amount, "ERC20: transfer amount exceeds balance"); unchecked { _balances[sender] = senderBalance - amount; } _balances[recipient] += amount; emit Transfer(sender, recipient, amount); _afterTokenTransfer(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: * * - `account` cannot be the zero address. */ function _mint(address account, uint256 amount) internal virtual { require(account != address(0), "ERC20: mint to the zero address"); _beforeTokenTransfer(address(0), account, amount); _totalSupply += amount; _balances[account] += amount; emit Transfer(address(0), account, amount); _afterTokenTransfer(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), "ERC20: burn from the zero address"); _beforeTokenTransfer(account, address(0), amount); uint256 accountBalance = _balances[account]; require(accountBalance >= amount, "ERC20: burn amount exceeds balance"); unchecked { _balances[account] = accountBalance - amount; } _totalSupply -= amount; emit Transfer(account, address(0), amount); _afterTokenTransfer(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 { require(owner != address(0), "ERC20: approve from the zero address"); require(spender != address(0), "ERC20: approve to the zero address"); _allowances[owner][spender] = amount; emit Approval(owner, spender, amount); } /** * @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 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 {} /** * @dev Hook that is called after any transfer of tokens. This includes * minting and burning. * * Calling conditions: * * - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens * has been transferred to `to`. * - when `from` is zero, `amount` tokens have been minted for `to`. * - when `to` is zero, `amount` of ``from``'s tokens have been 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 _afterTokenTransfer( address from, address to, uint256 amount ) internal virtual {} }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "../IERC20.sol"; /** * @dev Interface for the optional metadata functions from the ERC20 standard. * * _Available since v4.1._ */ interface IERC20Metadata is IERC20 { /** * @dev Returns the name of the token. */ function name() external view returns (string memory); /** * @dev Returns the symbol of the token. */ function symbol() external view returns (string memory); /** * @dev Returns the decimals places of the token. */ function decimals() external view returns (uint8); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ISynthereumFinder} from '../../../core/interfaces/IFinder.sol'; import {IStandardERC20} from '../../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableERC20 } from '../../../tokens/interfaces/IMintableBurnableERC20.sol'; import { FixedPoint } from '../../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; interface ICreditLineStorage { // Describe fee structure struct Fee { // Fees charged when a user mints, redeem and exchanges tokens uint256 feePercentage; // Recipient receiving fees address[] feeRecipients; // Proportion for each recipient uint32[] feeProportions; // Used with individual proportions to scale values uint256 totalFeeProportions; } struct FeeStatus { // Track the fee gained to be withdrawn by an address mapping(address => FixedPoint.Unsigned) feeGained; // Total amount of fees to be withdrawn FixedPoint.Unsigned totalFeeAmount; } // Represents a single sponsor's position. All collateral is held by this contract. // This struct acts as bookkeeping for how much of that collateral is allocated to each sponsor. struct PositionData { FixedPoint.Unsigned tokensOutstanding; FixedPoint.Unsigned rawCollateral; } struct GlobalPositionData { // Keep track of the total collateral and tokens across all positions FixedPoint.Unsigned totalTokensOutstanding; // Similar to the rawCollateral in PositionData, this value should not be used directly. //_getFeeAdjustedCollateral(), _addCollateral() and _removeCollateral() must be used to access and adjust. FixedPoint.Unsigned rawTotalPositionCollateral; } struct PositionManagerData { // SynthereumFinder contract ISynthereumFinder synthereumFinder; // Collateral token IStandardERC20 collateralToken; // Synthetic token created by this contract. IMintableBurnableERC20 tokenCurrency; // Unique identifier for DVM price feed ticker. bytes32 priceIdentifier; // Minimum number of tokens in a sponsor's position. FixedPoint.Unsigned minSponsorTokens; // Expiry price pulled from Chainlink in the case of an emergency shutdown. FixedPoint.Unsigned emergencyShutdownPrice; // Timestamp used in case of emergency shutdown. uint256 emergencyShutdownTimestamp; // The excessTokenBeneficiary of any excess tokens added to the contract. address excessTokenBeneficiary; // Version of the self-minting derivative uint8 version; } /** * @notice Construct the PerpetualPositionManager. * @dev Deployer of this contract should consider carefully which parties have ability to mint and burn * the synthetic tokens referenced by `_tokenAddress`. This contract's security assumes that no external accounts * can mint new tokens, which could be used to steal all of this contract's locked collateral. * We recommend to only use synthetic token contracts whose sole Owner role (the role capable of adding & removing roles) * is assigned to this contract, whose sole Minter role is assigned to this contract, and whose * total supply is 0 prior to construction of this contract. * @param collateralAddress ERC20 token used as collateral for all positions. * @param tokenAddress ERC20 token used as synthetic token. * @param priceFeedIdentifier registered in the ChainLink Oracle for the synthetic. * @param minSponsorTokens minimum amount of collateral that must exist at any time in a position. * @param timerAddress Contract that stores the current time in a testing environment. Set to 0x0 for production. * @param excessTokenBeneficiary Beneficiary to send all excess token balances that accrue in the contract. * @param version Version of the self-minting derivative * @param synthereumFinder The SynthereumFinder contract */ struct PositionManagerParams { IStandardERC20 collateralToken; IMintableBurnableERC20 syntheticToken; bytes32 priceFeedIdentifier; FixedPoint.Unsigned minSponsorTokens; address excessTokenBeneficiary; uint8 version; ISynthereumFinder synthereumFinder; } struct LiquidationData { address sponsor; address liquidator; uint256 liquidationTime; uint256 numTokensBurnt; uint256 liquidatedCollateral; } struct ExecuteLiquidationData { FixedPoint.Unsigned tokensToLiquidate; FixedPoint.Unsigned collateralValueLiquidatedTokens; FixedPoint.Unsigned collateralLiquidated; FixedPoint.Unsigned liquidatorReward; } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.0; import "../../../../../@openzeppelin/contracts/utils/math/SafeMath.sol"; import "../../../../../@openzeppelin/contracts/utils/math/SignedSafeMath.sol"; /** * @title Library for fixed point arithmetic on uints */ library FixedPoint { using SafeMath for uint256; using SignedSafeMath for int256; // Supports 18 decimals. E.g., 1e18 represents "1", 5e17 represents "0.5". // For unsigned values: // This can represent a value up to (2^256 - 1)/10^18 = ~10^59. 10^59 will be stored internally as uint256 10^77. uint256 private constant FP_SCALING_FACTOR = 10**18; // --------------------------------------- UNSIGNED ----------------------------------------------------------------------------- struct Unsigned { uint256 rawValue; } /** * @notice Constructs an `Unsigned` from an unscaled uint, e.g., `b=5` gets stored internally as `5*(10**18)`. * @param a uint to convert into a FixedPoint. * @return the converted FixedPoint. */ function fromUnscaledUint(uint256 a) internal pure returns (Unsigned memory) { return Unsigned(a.mul(FP_SCALING_FACTOR)); } /** * @notice Whether `a` is equal to `b`. * @param a a FixedPoint. * @param b a uint256. * @return True if equal, or False. */ function isEqual(Unsigned memory a, uint256 b) internal pure returns (bool) { return a.rawValue == fromUnscaledUint(b).rawValue; } /** * @notice Whether `a` is equal to `b`. * @param a a FixedPoint. * @param b a FixedPoint. * @return True if equal, or False. */ function isEqual(Unsigned memory a, Unsigned memory b) internal pure returns (bool) { return a.rawValue == b.rawValue; } /** * @notice Whether `a` is greater than `b`. * @param a a FixedPoint. * @param b a FixedPoint. * @return True if `a > b`, or False. */ function isGreaterThan(Unsigned memory a, Unsigned memory b) internal pure returns (bool) { return a.rawValue > b.rawValue; } /** * @notice Whether `a` is greater than `b`. * @param a a FixedPoint. * @param b a uint256. * @return True if `a > b`, or False. */ function isGreaterThan(Unsigned memory a, uint256 b) internal pure returns (bool) { return a.rawValue > fromUnscaledUint(b).rawValue; } /** * @notice Whether `a` is greater than `b`. * @param a a uint256. * @param b a FixedPoint. * @return True if `a > b`, or False. */ function isGreaterThan(uint256 a, Unsigned memory b) internal pure returns (bool) { return fromUnscaledUint(a).rawValue > b.rawValue; } /** * @notice Whether `a` is greater than or equal to `b`. * @param a a FixedPoint. * @param b a FixedPoint. * @return True if `a >= b`, or False. */ function isGreaterThanOrEqual(Unsigned memory a, Unsigned memory b) internal pure returns (bool) { return a.rawValue >= b.rawValue; } /** * @notice Whether `a` is greater than or equal to `b`. * @param a a FixedPoint. * @param b a uint256. * @return True if `a >= b`, or False. */ function isGreaterThanOrEqual(Unsigned memory a, uint256 b) internal pure returns (bool) { return a.rawValue >= fromUnscaledUint(b).rawValue; } /** * @notice Whether `a` is greater than or equal to `b`. * @param a a uint256. * @param b a FixedPoint. * @return True if `a >= b`, or False. */ function isGreaterThanOrEqual(uint256 a, Unsigned memory b) internal pure returns (bool) { return fromUnscaledUint(a).rawValue >= b.rawValue; } /** * @notice Whether `a` is less than `b`. * @param a a FixedPoint. * @param b a FixedPoint. * @return True if `a < b`, or False. */ function isLessThan(Unsigned memory a, Unsigned memory b) internal pure returns (bool) { return a.rawValue < b.rawValue; } /** * @notice Whether `a` is less than `b`. * @param a a FixedPoint. * @param b a uint256. * @return True if `a < b`, or False. */ function isLessThan(Unsigned memory a, uint256 b) internal pure returns (bool) { return a.rawValue < fromUnscaledUint(b).rawValue; } /** * @notice Whether `a` is less than `b`. * @param a a uint256. * @param b a FixedPoint. * @return True if `a < b`, or False. */ function isLessThan(uint256 a, Unsigned memory b) internal pure returns (bool) { return fromUnscaledUint(a).rawValue < b.rawValue; } /** * @notice Whether `a` is less than or equal to `b`. * @param a a FixedPoint. * @param b a FixedPoint. * @return True if `a <= b`, or False. */ function isLessThanOrEqual(Unsigned memory a, Unsigned memory b) internal pure returns (bool) { return a.rawValue <= b.rawValue; } /** * @notice Whether `a` is less than or equal to `b`. * @param a a FixedPoint. * @param b a uint256. * @return True if `a <= b`, or False. */ function isLessThanOrEqual(Unsigned memory a, uint256 b) internal pure returns (bool) { return a.rawValue <= fromUnscaledUint(b).rawValue; } /** * @notice Whether `a` is less than or equal to `b`. * @param a a uint256. * @param b a FixedPoint. * @return True if `a <= b`, or False. */ function isLessThanOrEqual(uint256 a, Unsigned memory b) internal pure returns (bool) { return fromUnscaledUint(a).rawValue <= b.rawValue; } /** * @notice The minimum of `a` and `b`. * @param a a FixedPoint. * @param b a FixedPoint. * @return the minimum of `a` and `b`. */ function min(Unsigned memory a, Unsigned memory b) internal pure returns (Unsigned memory) { return a.rawValue < b.rawValue ? a : b; } /** * @notice The maximum of `a` and `b`. * @param a a FixedPoint. * @param b a FixedPoint. * @return the maximum of `a` and `b`. */ function max(Unsigned memory a, Unsigned memory b) internal pure returns (Unsigned memory) { return a.rawValue > b.rawValue ? a : b; } /** * @notice Adds two `Unsigned`s, reverting on overflow. * @param a a FixedPoint. * @param b a FixedPoint. * @return the sum of `a` and `b`. */ function add(Unsigned memory a, Unsigned memory b) internal pure returns (Unsigned memory) { return Unsigned(a.rawValue.add(b.rawValue)); } /** * @notice Adds an `Unsigned` to an unscaled uint, reverting on overflow. * @param a a FixedPoint. * @param b a uint256. * @return the sum of `a` and `b`. */ function add(Unsigned memory a, uint256 b) internal pure returns (Unsigned memory) { return add(a, fromUnscaledUint(b)); } /** * @notice Subtracts two `Unsigned`s, reverting on overflow. * @param a a FixedPoint. * @param b a FixedPoint. * @return the difference of `a` and `b`. */ function sub(Unsigned memory a, Unsigned memory b) internal pure returns (Unsigned memory) { return Unsigned(a.rawValue.sub(b.rawValue)); } /** * @notice Subtracts an unscaled uint256 from an `Unsigned`, reverting on overflow. * @param a a FixedPoint. * @param b a uint256. * @return the difference of `a` and `b`. */ function sub(Unsigned memory a, uint256 b) internal pure returns (Unsigned memory) { return sub(a, fromUnscaledUint(b)); } /** * @notice Subtracts an `Unsigned` from an unscaled uint256, reverting on overflow. * @param a a uint256. * @param b a FixedPoint. * @return the difference of `a` and `b`. */ function sub(uint256 a, Unsigned memory b) internal pure returns (Unsigned memory) { return sub(fromUnscaledUint(a), b); } /** * @notice Multiplies two `Unsigned`s, reverting on overflow. * @dev This will "floor" the product. * @param a a FixedPoint. * @param b a FixedPoint. * @return the product of `a` and `b`. */ function mul(Unsigned memory a, Unsigned memory b) internal pure returns (Unsigned memory) { // There are two caveats with this computation: // 1. Max output for the represented number is ~10^41, otherwise an intermediate value overflows. 10^41 is // stored internally as a uint256 ~10^59. // 2. Results that can't be represented exactly are truncated not rounded. E.g., 1.4 * 2e-18 = 2.8e-18, which // would round to 3, but this computation produces the result 2. // No need to use SafeMath because FP_SCALING_FACTOR != 0. return Unsigned(a.rawValue.mul(b.rawValue) / FP_SCALING_FACTOR); } /** * @notice Multiplies an `Unsigned` and an unscaled uint256, reverting on overflow. * @dev This will "floor" the product. * @param a a FixedPoint. * @param b a uint256. * @return the product of `a` and `b`. */ function mul(Unsigned memory a, uint256 b) internal pure returns (Unsigned memory) { return Unsigned(a.rawValue.mul(b)); } /** * @notice Multiplies two `Unsigned`s and "ceil's" the product, reverting on overflow. * @param a a FixedPoint. * @param b a FixedPoint. * @return the product of `a` and `b`. */ function mulCeil(Unsigned memory a, Unsigned memory b) internal pure returns (Unsigned memory) { uint256 mulRaw = a.rawValue.mul(b.rawValue); uint256 mulFloor = mulRaw / FP_SCALING_FACTOR; uint256 mod = mulRaw.mod(FP_SCALING_FACTOR); if (mod != 0) { return Unsigned(mulFloor.add(1)); } else { return Unsigned(mulFloor); } } /** * @notice Multiplies an `Unsigned` and an unscaled uint256 and "ceil's" the product, reverting on overflow. * @param a a FixedPoint. * @param b a FixedPoint. * @return the product of `a` and `b`. */ function mulCeil(Unsigned memory a, uint256 b) internal pure returns (Unsigned memory) { // Since b is an int, there is no risk of truncation and we can just mul it normally return Unsigned(a.rawValue.mul(b)); } /** * @notice Divides one `Unsigned` by an `Unsigned`, reverting on overflow or division by 0. * @dev This will "floor" the quotient. * @param a a FixedPoint numerator. * @param b a FixedPoint denominator. * @return the quotient of `a` divided by `b`. */ function div(Unsigned memory a, Unsigned memory b) internal pure returns (Unsigned memory) { // There are two caveats with this computation: // 1. Max value for the number dividend `a` represents is ~10^41, otherwise an intermediate value overflows. // 10^41 is stored internally as a uint256 10^59. // 2. Results that can't be represented exactly are truncated not rounded. E.g., 2 / 3 = 0.6 repeating, which // would round to 0.666666666666666667, but this computation produces the result 0.666666666666666666. return Unsigned(a.rawValue.mul(FP_SCALING_FACTOR).div(b.rawValue)); } /** * @notice Divides one `Unsigned` by an unscaled uint256, reverting on overflow or division by 0. * @dev This will "floor" the quotient. * @param a a FixedPoint numerator. * @param b a uint256 denominator. * @return the quotient of `a` divided by `b`. */ function div(Unsigned memory a, uint256 b) internal pure returns (Unsigned memory) { return Unsigned(a.rawValue.div(b)); } /** * @notice Divides one unscaled uint256 by an `Unsigned`, reverting on overflow or division by 0. * @dev This will "floor" the quotient. * @param a a uint256 numerator. * @param b a FixedPoint denominator. * @return the quotient of `a` divided by `b`. */ function div(uint256 a, Unsigned memory b) internal pure returns (Unsigned memory) { return div(fromUnscaledUint(a), b); } /** * @notice Divides one `Unsigned` by an `Unsigned` and "ceil's" the quotient, reverting on overflow or division by 0. * @param a a FixedPoint numerator. * @param b a FixedPoint denominator. * @return the quotient of `a` divided by `b`. */ function divCeil(Unsigned memory a, Unsigned memory b) internal pure returns (Unsigned memory) { uint256 aScaled = a.rawValue.mul(FP_SCALING_FACTOR); uint256 divFloor = aScaled.div(b.rawValue); uint256 mod = aScaled.mod(b.rawValue); if (mod != 0) { return Unsigned(divFloor.add(1)); } else { return Unsigned(divFloor); } } /** * @notice Divides one `Unsigned` by an unscaled uint256 and "ceil's" the quotient, reverting on overflow or division by 0. * @param a a FixedPoint numerator. * @param b a uint256 denominator. * @return the quotient of `a` divided by `b`. */ function divCeil(Unsigned memory a, uint256 b) internal pure returns (Unsigned memory) { // Because it is possible that a quotient gets truncated, we can't just call "Unsigned(a.rawValue.div(b))" // similarly to mulCeil with a uint256 as the second parameter. Therefore we need to convert b into an Unsigned. // This creates the possibility of overflow if b is very large. return divCeil(a, fromUnscaledUint(b)); } /** * @notice Raises an `Unsigned` to the power of an unscaled uint256, reverting on overflow. E.g., `b=2` squares `a`. * @dev This will "floor" the result. * @param a a FixedPoint numerator. * @param b a uint256 denominator. * @return output is `a` to the power of `b`. */ function pow(Unsigned memory a, uint256 b) internal pure returns (Unsigned memory output) { output = fromUnscaledUint(1); for (uint256 i = 0; i < b; i = i.add(1)) { output = mul(output, a); } } // ------------------------------------------------- SIGNED ------------------------------------------------------------- // Supports 18 decimals. E.g., 1e18 represents "1", 5e17 represents "0.5". // For signed values: // This can represent a value up (or down) to +-(2^255 - 1)/10^18 = ~10^58. 10^58 will be stored internally as int256 10^76. int256 private constant SFP_SCALING_FACTOR = 10**18; struct Signed { int256 rawValue; } function fromSigned(Signed memory a) internal pure returns (Unsigned memory) { require(a.rawValue >= 0, "Negative value provided"); return Unsigned(uint256(a.rawValue)); } function fromUnsigned(Unsigned memory a) internal pure returns (Signed memory) { require(a.rawValue <= uint256(type(int256).max), "Unsigned too large"); return Signed(int256(a.rawValue)); } /** * @notice Constructs a `Signed` from an unscaled int, e.g., `b=5` gets stored internally as `5*(10**18)`. * @param a int to convert into a FixedPoint.Signed. * @return the converted FixedPoint.Signed. */ function fromUnscaledInt(int256 a) internal pure returns (Signed memory) { return Signed(a.mul(SFP_SCALING_FACTOR)); } /** * @notice Whether `a` is equal to `b`. * @param a a FixedPoint.Signed. * @param b a int256. * @return True if equal, or False. */ function isEqual(Signed memory a, int256 b) internal pure returns (bool) { return a.rawValue == fromUnscaledInt(b).rawValue; } /** * @notice Whether `a` is equal to `b`. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return True if equal, or False. */ function isEqual(Signed memory a, Signed memory b) internal pure returns (bool) { return a.rawValue == b.rawValue; } /** * @notice Whether `a` is greater than `b`. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return True if `a > b`, or False. */ function isGreaterThan(Signed memory a, Signed memory b) internal pure returns (bool) { return a.rawValue > b.rawValue; } /** * @notice Whether `a` is greater than `b`. * @param a a FixedPoint.Signed. * @param b an int256. * @return True if `a > b`, or False. */ function isGreaterThan(Signed memory a, int256 b) internal pure returns (bool) { return a.rawValue > fromUnscaledInt(b).rawValue; } /** * @notice Whether `a` is greater than `b`. * @param a an int256. * @param b a FixedPoint.Signed. * @return True if `a > b`, or False. */ function isGreaterThan(int256 a, Signed memory b) internal pure returns (bool) { return fromUnscaledInt(a).rawValue > b.rawValue; } /** * @notice Whether `a` is greater than or equal to `b`. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return True if `a >= b`, or False. */ function isGreaterThanOrEqual(Signed memory a, Signed memory b) internal pure returns (bool) { return a.rawValue >= b.rawValue; } /** * @notice Whether `a` is greater than or equal to `b`. * @param a a FixedPoint.Signed. * @param b an int256. * @return True if `a >= b`, or False. */ function isGreaterThanOrEqual(Signed memory a, int256 b) internal pure returns (bool) { return a.rawValue >= fromUnscaledInt(b).rawValue; } /** * @notice Whether `a` is greater than or equal to `b`. * @param a an int256. * @param b a FixedPoint.Signed. * @return True if `a >= b`, or False. */ function isGreaterThanOrEqual(int256 a, Signed memory b) internal pure returns (bool) { return fromUnscaledInt(a).rawValue >= b.rawValue; } /** * @notice Whether `a` is less than `b`. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return True if `a < b`, or False. */ function isLessThan(Signed memory a, Signed memory b) internal pure returns (bool) { return a.rawValue < b.rawValue; } /** * @notice Whether `a` is less than `b`. * @param a a FixedPoint.Signed. * @param b an int256. * @return True if `a < b`, or False. */ function isLessThan(Signed memory a, int256 b) internal pure returns (bool) { return a.rawValue < fromUnscaledInt(b).rawValue; } /** * @notice Whether `a` is less than `b`. * @param a an int256. * @param b a FixedPoint.Signed. * @return True if `a < b`, or False. */ function isLessThan(int256 a, Signed memory b) internal pure returns (bool) { return fromUnscaledInt(a).rawValue < b.rawValue; } /** * @notice Whether `a` is less than or equal to `b`. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return True if `a <= b`, or False. */ function isLessThanOrEqual(Signed memory a, Signed memory b) internal pure returns (bool) { return a.rawValue <= b.rawValue; } /** * @notice Whether `a` is less than or equal to `b`. * @param a a FixedPoint.Signed. * @param b an int256. * @return True if `a <= b`, or False. */ function isLessThanOrEqual(Signed memory a, int256 b) internal pure returns (bool) { return a.rawValue <= fromUnscaledInt(b).rawValue; } /** * @notice Whether `a` is less than or equal to `b`. * @param a an int256. * @param b a FixedPoint.Signed. * @return True if `a <= b`, or False. */ function isLessThanOrEqual(int256 a, Signed memory b) internal pure returns (bool) { return fromUnscaledInt(a).rawValue <= b.rawValue; } /** * @notice The minimum of `a` and `b`. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return the minimum of `a` and `b`. */ function min(Signed memory a, Signed memory b) internal pure returns (Signed memory) { return a.rawValue < b.rawValue ? a : b; } /** * @notice The maximum of `a` and `b`. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return the maximum of `a` and `b`. */ function max(Signed memory a, Signed memory b) internal pure returns (Signed memory) { return a.rawValue > b.rawValue ? a : b; } /** * @notice Adds two `Signed`s, reverting on overflow. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return the sum of `a` and `b`. */ function add(Signed memory a, Signed memory b) internal pure returns (Signed memory) { return Signed(a.rawValue.add(b.rawValue)); } /** * @notice Adds an `Signed` to an unscaled int, reverting on overflow. * @param a a FixedPoint.Signed. * @param b an int256. * @return the sum of `a` and `b`. */ function add(Signed memory a, int256 b) internal pure returns (Signed memory) { return add(a, fromUnscaledInt(b)); } /** * @notice Subtracts two `Signed`s, reverting on overflow. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return the difference of `a` and `b`. */ function sub(Signed memory a, Signed memory b) internal pure returns (Signed memory) { return Signed(a.rawValue.sub(b.rawValue)); } /** * @notice Subtracts an unscaled int256 from an `Signed`, reverting on overflow. * @param a a FixedPoint.Signed. * @param b an int256. * @return the difference of `a` and `b`. */ function sub(Signed memory a, int256 b) internal pure returns (Signed memory) { return sub(a, fromUnscaledInt(b)); } /** * @notice Subtracts an `Signed` from an unscaled int256, reverting on overflow. * @param a an int256. * @param b a FixedPoint.Signed. * @return the difference of `a` and `b`. */ function sub(int256 a, Signed memory b) internal pure returns (Signed memory) { return sub(fromUnscaledInt(a), b); } /** * @notice Multiplies two `Signed`s, reverting on overflow. * @dev This will "floor" the product. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return the product of `a` and `b`. */ function mul(Signed memory a, Signed memory b) internal pure returns (Signed memory) { // There are two caveats with this computation: // 1. Max output for the represented number is ~10^41, otherwise an intermediate value overflows. 10^41 is // stored internally as an int256 ~10^59. // 2. Results that can't be represented exactly are truncated not rounded. E.g., 1.4 * 2e-18 = 2.8e-18, which // would round to 3, but this computation produces the result 2. // No need to use SafeMath because SFP_SCALING_FACTOR != 0. return Signed(a.rawValue.mul(b.rawValue) / SFP_SCALING_FACTOR); } /** * @notice Multiplies an `Signed` and an unscaled int256, reverting on overflow. * @dev This will "floor" the product. * @param a a FixedPoint.Signed. * @param b an int256. * @return the product of `a` and `b`. */ function mul(Signed memory a, int256 b) internal pure returns (Signed memory) { return Signed(a.rawValue.mul(b)); } /** * @notice Multiplies two `Signed`s and "ceil's" the product, reverting on overflow. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return the product of `a` and `b`. */ function mulAwayFromZero(Signed memory a, Signed memory b) internal pure returns (Signed memory) { int256 mulRaw = a.rawValue.mul(b.rawValue); int256 mulTowardsZero = mulRaw / SFP_SCALING_FACTOR; // Manual mod because SignedSafeMath doesn't support it. int256 mod = mulRaw % SFP_SCALING_FACTOR; if (mod != 0) { bool isResultPositive = isLessThan(a, 0) == isLessThan(b, 0); int256 valueToAdd = isResultPositive ? int256(1) : int256(-1); return Signed(mulTowardsZero.add(valueToAdd)); } else { return Signed(mulTowardsZero); } } /** * @notice Multiplies an `Signed` and an unscaled int256 and "ceil's" the product, reverting on overflow. * @param a a FixedPoint.Signed. * @param b a FixedPoint.Signed. * @return the product of `a` and `b`. */ function mulAwayFromZero(Signed memory a, int256 b) internal pure returns (Signed memory) { // Since b is an int, there is no risk of truncation and we can just mul it normally return Signed(a.rawValue.mul(b)); } /** * @notice Divides one `Signed` by an `Signed`, reverting on overflow or division by 0. * @dev This will "floor" the quotient. * @param a a FixedPoint numerator. * @param b a FixedPoint denominator. * @return the quotient of `a` divided by `b`. */ function div(Signed memory a, Signed memory b) internal pure returns (Signed memory) { // There are two caveats with this computation: // 1. Max value for the number dividend `a` represents is ~10^41, otherwise an intermediate value overflows. // 10^41 is stored internally as an int256 10^59. // 2. Results that can't be represented exactly are truncated not rounded. E.g., 2 / 3 = 0.6 repeating, which // would round to 0.666666666666666667, but this computation produces the result 0.666666666666666666. return Signed(a.rawValue.mul(SFP_SCALING_FACTOR).div(b.rawValue)); } /** * @notice Divides one `Signed` by an unscaled int256, reverting on overflow or division by 0. * @dev This will "floor" the quotient. * @param a a FixedPoint numerator. * @param b an int256 denominator. * @return the quotient of `a` divided by `b`. */ function div(Signed memory a, int256 b) internal pure returns (Signed memory) { return Signed(a.rawValue.div(b)); } /** * @notice Divides one unscaled int256 by an `Signed`, reverting on overflow or division by 0. * @dev This will "floor" the quotient. * @param a an int256 numerator. * @param b a FixedPoint denominator. * @return the quotient of `a` divided by `b`. */ function div(int256 a, Signed memory b) internal pure returns (Signed memory) { return div(fromUnscaledInt(a), b); } /** * @notice Divides one `Signed` by an `Signed` and "ceil's" the quotient, reverting on overflow or division by 0. * @param a a FixedPoint numerator. * @param b a FixedPoint denominator. * @return the quotient of `a` divided by `b`. */ function divAwayFromZero(Signed memory a, Signed memory b) internal pure returns (Signed memory) { int256 aScaled = a.rawValue.mul(SFP_SCALING_FACTOR); int256 divTowardsZero = aScaled.div(b.rawValue); // Manual mod because SignedSafeMath doesn't support it. int256 mod = aScaled % b.rawValue; if (mod != 0) { bool isResultPositive = isLessThan(a, 0) == isLessThan(b, 0); int256 valueToAdd = isResultPositive ? int256(1) : int256(-1); return Signed(divTowardsZero.add(valueToAdd)); } else { return Signed(divTowardsZero); } } /** * @notice Divides one `Signed` by an unscaled int256 and "ceil's" the quotient, reverting on overflow or division by 0. * @param a a FixedPoint numerator. * @param b an int256 denominator. * @return the quotient of `a` divided by `b`. */ function divAwayFromZero(Signed memory a, int256 b) internal pure returns (Signed memory) { // Because it is possible that a quotient gets truncated, we can't just call "Signed(a.rawValue.div(b))" // similarly to mulCeil with an int256 as the second parameter. Therefore we need to convert b into an Signed. // This creates the possibility of overflow if b is very large. return divAwayFromZero(a, fromUnscaledInt(b)); } /** * @notice Raises an `Signed` to the power of an unscaled uint256, reverting on overflow. E.g., `b=2` squares `a`. * @dev This will "floor" the result. * @param a a FixedPoint.Signed. * @param b a uint256 (negative exponents are not allowed). * @return output is `a` to the power of `b`. */ function pow(Signed memory a, uint256 b) internal pure returns (Signed memory output) { output = fromUnscaledInt(1); for (uint256 i = 0; i < b; i = i.add(1)) { output = mul(output, a); } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Library for managing * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive * types. * * Sets have the following properties: * * - Elements are added, removed, and checked for existence in constant time * (O(1)). * - Elements are enumerated in O(n). No guarantees are made on the ordering. * * ``` * contract Example { * // Add the library methods * using EnumerableSet for EnumerableSet.AddressSet; * * // Declare a set state variable * EnumerableSet.AddressSet private mySet; * } * ``` * * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`) * and `uint256` (`UintSet`) are supported. */ library EnumerableSet { // To implement this library for multiple types with as little code // repetition as possible, we write it in terms of a generic Set type with // bytes32 values. // The Set implementation uses private functions, and user-facing // implementations (such as AddressSet) are just wrappers around the // underlying Set. // This means that we can only create new EnumerableSets for types that fit // in bytes32. struct Set { // Storage of set values bytes32[] _values; // Position of the value in the `values` array, plus 1 because index 0 // means a value is not in the set. mapping(bytes32 => uint256) _indexes; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function _add(Set storage set, bytes32 value) private returns (bool) { if (!_contains(set, value)) { set._values.push(value); // The value is stored at length-1, but we add 1 to all indexes // and use 0 as a sentinel value set._indexes[value] = set._values.length; return true; } else { return false; } } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function _remove(Set storage set, bytes32 value) private returns (bool) { // We read and store the value's index to prevent multiple reads from the same storage slot uint256 valueIndex = set._indexes[value]; if (valueIndex != 0) { // Equivalent to contains(set, value) // To delete an element from the _values array in O(1), we swap the element to delete with the last one in // the array, and then remove the last element (sometimes called as 'swap and pop'). // This modifies the order of the array, as noted in {at}. uint256 toDeleteIndex = valueIndex - 1; uint256 lastIndex = set._values.length - 1; if (lastIndex != toDeleteIndex) { bytes32 lastvalue = set._values[lastIndex]; // Move the last value to the index where the value to delete is set._values[toDeleteIndex] = lastvalue; // Update the index for the moved value set._indexes[lastvalue] = valueIndex; // Replace lastvalue's index to valueIndex } // Delete the slot where the moved value was stored set._values.pop(); // Delete the index for the deleted slot delete set._indexes[value]; return true; } else { return false; } } /** * @dev Returns true if the value is in the set. O(1). */ function _contains(Set storage set, bytes32 value) private view returns (bool) { return set._indexes[value] != 0; } /** * @dev Returns the number of values on the set. O(1). */ function _length(Set storage set) private view returns (uint256) { return set._values.length; } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function _at(Set storage set, uint256 index) private view returns (bytes32) { return set._values[index]; } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function _values(Set storage set) private view returns (bytes32[] memory) { return set._values; } // Bytes32Set struct Bytes32Set { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(Bytes32Set storage set, bytes32 value) internal returns (bool) { return _add(set._inner, value); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) { return _remove(set._inner, value); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) { return _contains(set._inner, value); } /** * @dev Returns the number of values in the set. O(1). */ function length(Bytes32Set storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) { return _at(set._inner, index); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(Bytes32Set storage set) internal view returns (bytes32[] memory) { return _values(set._inner); } // AddressSet struct AddressSet { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(AddressSet storage set, address value) internal returns (bool) { return _add(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(AddressSet storage set, address value) internal returns (bool) { return _remove(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(AddressSet storage set, address value) internal view returns (bool) { return _contains(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Returns the number of values in the set. O(1). */ function length(AddressSet storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(AddressSet storage set, uint256 index) internal view returns (address) { return address(uint160(uint256(_at(set._inner, index)))); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(AddressSet storage set) internal view returns (address[] memory) { bytes32[] memory store = _values(set._inner); address[] memory result; assembly { result := store } return result; } // UintSet struct UintSet { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(UintSet storage set, uint256 value) internal returns (bool) { return _add(set._inner, bytes32(value)); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(UintSet storage set, uint256 value) internal returns (bool) { return _remove(set._inner, bytes32(value)); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(UintSet storage set, uint256 value) internal view returns (bool) { return _contains(set._inner, bytes32(value)); } /** * @dev Returns the number of values on the set. O(1). */ function length(UintSet storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(UintSet storage set, uint256 index) internal view returns (uint256) { return uint256(_at(set._inner, index)); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(UintSet storage set) internal view returns (uint256[] memory) { bytes32[] memory store = _values(set._inner); uint256[] memory result; assembly { result := store } return result; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Contract module that helps prevent reentrant calls to a function. * * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier * available, which can be applied to functions to make sure there are no nested * (reentrant) calls to them. * * Note that because there is a single `nonReentrant` guard, functions marked as * `nonReentrant` may not call one another. This can be worked around by making * those functions `private`, and then adding `external` `nonReentrant` entry * points to them. * * TIP: If you would like to learn more about reentrancy and alternative ways * to protect against it, check out our blog post * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul]. */ abstract contract ReentrancyGuard { // Booleans are more expensive than uint256 or any type that takes up a full // word because each write operation emits an extra SLOAD to first read the // slot's contents, replace the bits taken up by the boolean, and then write // back. This is the compiler's defense against contract upgrades and // pointer aliasing, and it cannot be disabled. // The values being non-zero value makes deployment a bit more expensive, // but in exchange the refund on every call to nonReentrant will be lower in // amount. Since refunds are capped to a percentage of the total // transaction's gas, it is best to keep them low in cases like this one, to // increase the likelihood of the full refund coming into effect. uint256 private constant _NOT_ENTERED = 1; uint256 private constant _ENTERED = 2; uint256 private _status; constructor() { _status = _NOT_ENTERED; } /** * @dev Prevents a contract from calling itself, directly or indirectly. * Calling a `nonReentrant` function from another `nonReentrant` * function is not supported. It is possible to prevent this from happening * by making the `nonReentrant` function external, and make it call a * `private` function that does the actual work. */ modifier nonReentrant() { // On the first call to nonReentrant, _notEntered will be true require(_status != _ENTERED, "ReentrancyGuard: reentrant call"); // Any calls to nonReentrant after this point will fail _status = _ENTERED; _; // By storing the original value once again, a refund is triggered (see // https://eips.ethereum.org/EIPS/eip-2200) _status = _NOT_ENTERED; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./IAccessControlEnumerable.sol"; import "./AccessControl.sol"; import "../utils/structs/EnumerableSet.sol"; /** * @dev Extension of {AccessControl} that allows enumerating the members of each role. */ abstract contract AccessControlEnumerable is IAccessControlEnumerable, AccessControl { using EnumerableSet for EnumerableSet.AddressSet; mapping(bytes32 => EnumerableSet.AddressSet) private _roleMembers; /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IAccessControlEnumerable).interfaceId || super.supportsInterface(interfaceId); } /** * @dev Returns one of the accounts that have `role`. `index` must be a * value between 0 and {getRoleMemberCount}, non-inclusive. * * Role bearers are not sorted in any particular way, and their ordering may * change at any point. * * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure * you perform all queries on the same block. See the following * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] * for more information. */ function getRoleMember(bytes32 role, uint256 index) public view override returns (address) { return _roleMembers[role].at(index); } /** * @dev Returns the number of accounts that have `role`. Can be used * together with {getRoleMember} to enumerate all bearers of a role. */ function getRoleMemberCount(bytes32 role) public view override returns (uint256) { return _roleMembers[role].length(); } /** * @dev Overload {grantRole} to track enumerable memberships */ function grantRole(bytes32 role, address account) public virtual override(AccessControl, IAccessControl) { super.grantRole(role, account); _roleMembers[role].add(account); } /** * @dev Overload {revokeRole} to track enumerable memberships */ function revokeRole(bytes32 role, address account) public virtual override(AccessControl, IAccessControl) { super.revokeRole(role, account); _roleMembers[role].remove(account); } /** * @dev Overload {renounceRole} to track enumerable memberships */ function renounceRole(bytes32 role, address account) public virtual override(AccessControl, IAccessControl) { super.renounceRole(role, account); _roleMembers[role].remove(account); } /** * @dev Overload {_setupRole} to track enumerable memberships */ function _setupRole(bytes32 role, address account) internal virtual override { super._setupRole(role, account); _roleMembers[role].add(account); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; interface ITypology { /** * @notice Return typology of the contract */ function typology() external view returns (string memory); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "../IERC20.sol"; import "../../../utils/Address.sol"; /** * @title SafeERC20 * @dev Wrappers around ERC20 operations that throw on failure (when the token * contract returns false). Tokens that return no value (and instead revert or * throw on failure) are also supported, non-reverting calls are assumed to be * successful. * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract, * which allows you to call the safe operations as `token.safeTransfer(...)`, etc. */ library SafeERC20 { using Address for address; function safeTransfer( IERC20 token, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value)); } function safeTransferFrom( IERC20 token, address from, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value)); } /** * @dev Deprecated. This function has issues similar to the ones found in * {IERC20-approve}, and its usage is discouraged. * * Whenever possible, use {safeIncreaseAllowance} and * {safeDecreaseAllowance} instead. */ function safeApprove( IERC20 token, address spender, uint256 value ) internal { // safeApprove should only be called when setting an initial allowance, // or when resetting it to zero. To increase and decrease it, use // 'safeIncreaseAllowance' and 'safeDecreaseAllowance' require( (value == 0) || (token.allowance(address(this), spender) == 0), "SafeERC20: approve from non-zero to non-zero allowance" ); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value)); } function safeIncreaseAllowance( IERC20 token, address spender, uint256 value ) internal { uint256 newAllowance = token.allowance(address(this), spender) + value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } function safeDecreaseAllowance( IERC20 token, address spender, uint256 value ) internal { unchecked { uint256 oldAllowance = token.allowance(address(this), spender); require(oldAllowance >= value, "SafeERC20: decreased allowance below zero"); uint256 newAllowance = oldAllowance - value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } } /** * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement * on the return value: the return value is optional (but if data is returned, it must not be false). * @param token The token targeted by the call. * @param data The call data (encoded using abi.encode or one of its variants). */ function _callOptionalReturn(IERC20 token, bytes memory data) private { // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that // the target address contains contract code and also asserts for success in the low-level call. bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed"); if (returndata.length > 0) { // Return data is optional require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed"); } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev Returns true if `account` is a contract. * * [IMPORTANT] * ==== * It is unsafe to assume that an address for which this function returns * false is an externally-owned account (EOA) and not a contract. * * Among others, `isContract` will return false for the following * types of addresses: * * - an externally-owned account * - a contract in construction * - an address where a contract will be created * - an address where a contract lived, but was destroyed * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize, which returns 0 for contracts in // construction, since the code is only stored at the end of the // constructor execution. uint256 size; assembly { size := extcodesize(account) } return size > 0; } /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { require(address(this).balance >= amount, "Address: insufficient balance"); (bool success, ) = recipient.call{value: amount}(""); require(success, "Address: unable to send value, recipient may have reverted"); } /** * @dev Performs a Solidity function call using a low level `call`. A * plain `call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason, it is bubbled up by this * function (like regular Solidity function calls). * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCall(target, data, "Address: low-level call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value ) internal returns (bytes memory) { return functionCallWithValue(target, data, value, "Address: low-level call with value failed"); } /** * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value, string memory errorMessage ) internal returns (bytes memory) { require(address(this).balance >= value, "Address: insufficient balance for call"); require(isContract(target), "Address: call to non-contract"); (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { return functionStaticCall(target, data, "Address: low-level static call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall( address target, bytes memory data, string memory errorMessage ) internal view returns (bytes memory) { require(isContract(target), "Address: static call to non-contract"); (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { require(isContract(target), "Address: delegate call to non-contract"); (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the * revert reason 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 { // 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 assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert(errorMessage); } } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./IAccessControl.sol"; /** * @dev External interface of AccessControlEnumerable declared to support ERC165 detection. */ interface IAccessControlEnumerable is IAccessControl { /** * @dev Returns one of the accounts that have `role`. `index` must be a * value between 0 and {getRoleMemberCount}, non-inclusive. * * Role bearers are not sorted in any particular way, and their ordering may * change at any point. * * WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure * you perform all queries on the same block. See the following * https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] * for more information. */ function getRoleMember(bytes32 role, uint256 index) external view returns (address); /** * @dev Returns the number of accounts that have `role`. Can be used * together with {getRoleMember} to enumerate all bearers of a role. */ function getRoleMemberCount(bytes32 role) external view returns (uint256); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./IAccessControl.sol"; import "../utils/Context.sol"; import "../utils/Strings.sol"; import "../utils/introspection/ERC165.sol"; /** * @dev Contract module that allows children to implement role-based access * control mechanisms. This is a lightweight version that doesn't allow enumerating role * members except through off-chain means by accessing the contract event logs. Some * applications may benefit from on-chain enumerability, for those cases see * {AccessControlEnumerable}. * * Roles are referred to by their `bytes32` identifier. These should be exposed * in the external API and be unique. The best way to achieve this is by * using `public constant` hash digests: * * ``` * bytes32 public constant MY_ROLE = keccak256("MY_ROLE"); * ``` * * Roles can be used to represent a set of permissions. To restrict access to a * function call, use {hasRole}: * * ``` * function foo() public { * require(hasRole(MY_ROLE, msg.sender)); * ... * } * ``` * * Roles can be granted and revoked dynamically via the {grantRole} and * {revokeRole} functions. Each role has an associated admin role, and only * accounts that have a role's admin role can call {grantRole} and {revokeRole}. * * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means * that only accounts with this role will be able to grant or revoke other * roles. More complex role relationships can be created by using * {_setRoleAdmin}. * * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to * grant and revoke this role. Extra precautions should be taken to secure * accounts that have been granted it. */ abstract contract AccessControl is Context, IAccessControl, ERC165 { struct RoleData { mapping(address => bool) members; bytes32 adminRole; } mapping(bytes32 => RoleData) private _roles; bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00; /** * @dev Modifier that checks that an account has a specific role. Reverts * with a standardized message including the required role. * * The format of the revert reason is given by the following regular expression: * * /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/ * * _Available since v4.1._ */ modifier onlyRole(bytes32 role) { _checkRole(role, _msgSender()); _; } /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId); } /** * @dev Returns `true` if `account` has been granted `role`. */ function hasRole(bytes32 role, address account) public view override returns (bool) { return _roles[role].members[account]; } /** * @dev Revert with a standard message if `account` is missing `role`. * * The format of the revert reason is given by the following regular expression: * * /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/ */ function _checkRole(bytes32 role, address account) internal view { if (!hasRole(role, account)) { revert( string( abi.encodePacked( "AccessControl: account ", Strings.toHexString(uint160(account), 20), " is missing role ", Strings.toHexString(uint256(role), 32) ) ) ); } } /** * @dev Returns the admin role that controls `role`. See {grantRole} and * {revokeRole}. * * To change a role's admin, use {_setRoleAdmin}. */ function getRoleAdmin(bytes32 role) public view override returns (bytes32) { return _roles[role].adminRole; } /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. * * Requirements: * * - the caller must have ``role``'s admin role. */ function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) { _grantRole(role, account); } /** * @dev Revokes `role` from `account`. * * If `account` had been granted `role`, emits a {RoleRevoked} event. * * Requirements: * * - the caller must have ``role``'s admin role. */ function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) { _revokeRole(role, account); } /** * @dev Revokes `role` from the calling account. * * Roles are often managed via {grantRole} and {revokeRole}: this function's * purpose is to provide a mechanism for accounts to lose their privileges * if they are compromised (such as when a trusted device is misplaced). * * If the calling account had been granted `role`, emits a {RoleRevoked} * event. * * Requirements: * * - the caller must be `account`. */ function renounceRole(bytes32 role, address account) public virtual override { require(account == _msgSender(), "AccessControl: can only renounce roles for self"); _revokeRole(role, account); } /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. Note that unlike {grantRole}, this function doesn't perform any * checks on the calling account. * * [WARNING] * ==== * This function should only be called from the constructor when setting * up the initial roles for the system. * * Using this function in any other way is effectively circumventing the admin * system imposed by {AccessControl}. * ==== */ function _setupRole(bytes32 role, address account) internal virtual { _grantRole(role, account); } /** * @dev Sets `adminRole` as ``role``'s admin role. * * Emits a {RoleAdminChanged} event. */ function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual { bytes32 previousAdminRole = getRoleAdmin(role); _roles[role].adminRole = adminRole; emit RoleAdminChanged(role, previousAdminRole, adminRole); } function _grantRole(bytes32 role, address account) private { if (!hasRole(role, account)) { _roles[role].members[account] = true; emit RoleGranted(role, account, _msgSender()); } } function _revokeRole(bytes32 role, address account) private { if (hasRole(role, account)) { _roles[role].members[account] = false; emit RoleRevoked(role, account, _msgSender()); } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev External interface of AccessControl declared to support ERC165 detection. */ interface IAccessControl { /** * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole` * * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite * {RoleAdminChanged} not being emitted signaling this. * * _Available since v3.1._ */ event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole); /** * @dev Emitted when `account` is granted `role`. * * `sender` is the account that originated the contract call, an admin role * bearer except when using {AccessControl-_setupRole}. */ event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender); /** * @dev Emitted when `account` is revoked `role`. * * `sender` is the account that originated the contract call: * - if using `revokeRole`, it is the admin role bearer * - if using `renounceRole`, it is the role bearer (i.e. `account`) */ event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender); /** * @dev Returns `true` if `account` has been granted `role`. */ function hasRole(bytes32 role, address account) external view returns (bool); /** * @dev Returns the admin role that controls `role`. See {grantRole} and * {revokeRole}. * * To change a role's admin, use {AccessControl-_setRoleAdmin}. */ function getRoleAdmin(bytes32 role) external view returns (bytes32); /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. * * Requirements: * * - the caller must have ``role``'s admin role. */ function grantRole(bytes32 role, address account) external; /** * @dev Revokes `role` from `account`. * * If `account` had been granted `role`, emits a {RoleRevoked} event. * * Requirements: * * - the caller must have ``role``'s admin role. */ function revokeRole(bytes32 role, address account) external; /** * @dev Revokes `role` from the calling account. * * Roles are often managed via {grantRole} and {revokeRole}: this function's * purpose is to provide a mechanism for accounts to lose their privileges * if they are compromised (such as when a trusted device is misplaced). * * If the calling account had been granted `role`, emits a {RoleRevoked} * event. * * Requirements: * * - the caller must be `account`. */ function renounceRole(bytes32 role, address account) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev String operations. */ library Strings { bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef"; /** * @dev Converts a `uint256` to its ASCII `string` decimal representation. */ function toString(uint256 value) internal pure returns (string memory) { // Inspired by OraclizeAPI's implementation - MIT licence // https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol if (value == 0) { return "0"; } uint256 temp = value; uint256 digits; while (temp != 0) { digits++; temp /= 10; } bytes memory buffer = new bytes(digits); while (value != 0) { digits -= 1; buffer[digits] = bytes1(uint8(48 + uint256(value % 10))); value /= 10; } return string(buffer); } /** * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation. */ function toHexString(uint256 value) internal pure returns (string memory) { if (value == 0) { return "0x00"; } uint256 temp = value; uint256 length = 0; while (temp != 0) { length++; temp >>= 8; } return toHexString(value, length); } /** * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length. */ function toHexString(uint256 value, uint256 length) internal pure returns (string memory) { bytes memory buffer = new bytes(2 * length + 2); buffer[0] = "0"; buffer[1] = "x"; for (uint256 i = 2 * length + 1; i > 1; --i) { buffer[i] = _HEX_SYMBOLS[value & 0xf]; value >>= 4; } require(value == 0, "Strings: hex length insufficient"); return string(buffer); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./IERC165.sol"; /** * @dev Implementation of the {IERC165} interface. * * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check * for the additional interface id that will be supported. For example: * * ```solidity * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { * return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId); * } * ``` * * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation. */ abstract contract ERC165 is IERC165 { /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IERC165).interfaceId; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Interface of the ERC165 standard, as defined in the * https://eips.ethereum.org/EIPS/eip-165[EIP]. * * Implementers can declare support of contract interfaces, which can then be * queried by others ({ERC165Checker}). * * For an implementation, see {ERC165}. */ interface IERC165 { /** * @dev Returns true if this contract implements the interface defined by * `interfaceId`. See the corresponding * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] * to learn more about how these ids are created. * * This function call must use less than 30 000 gas. */ function supportsInterface(bytes4 interfaceId) external view returns (bool); }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ICreditLineStorage} from './interfaces/ICreditLineStorage.sol'; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {IStandardERC20} from '../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import {ICreditLine} from './interfaces/ICreditLine.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import {CreditLineLib} from './CreditLineLib.sol'; import { ReentrancyGuard } from '../../../@openzeppelin/contracts/security/ReentrancyGuard.sol'; import { ERC2771Context } from '../../../@jarvis-network/synthereum-contracts/contracts/common/ERC2771Context.sol'; import { FixedPoint } from '../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; import { SafeERC20 } from '../../../@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol'; /** * @title * @notice */ contract CreditLine is ICreditLine, ICreditLineStorage, ReentrancyGuard, ERC2771Context { using FixedPoint for FixedPoint.Unsigned; using SafeERC20 for IERC20; using SafeERC20 for IMintableBurnableERC20; using CreditLineLib for PositionData; using CreditLineLib for PositionManagerData; //---------------------------------------- // Constants //---------------------------------------- string public constant override typology = 'SELF-MINTING'; bytes32 public constant MAINTAINER_ROLE = keccak256('Maintainer'); //---------------------------------------- // Storage //---------------------------------------- // Maps sponsor addresses to their positions. Each sponsor can have only one position. mapping(address => PositionData) private positions; // uint256 tokenSponsorsCount; // each new token sponsor will be identified with an incremental uint GlobalPositionData private globalPositionData; PositionManagerData private positionManagerData; FeeStatus private feeStatus; //---------------------------------------- // Events //---------------------------------------- event Deposit(address indexed sponsor, uint256 indexed collateralAmount); event Withdrawal(address indexed sponsor, uint256 indexed collateralAmount); event PositionCreated( address indexed sponsor, uint256 indexed collateralAmount, uint256 indexed tokenAmount, uint256 feeAmount ); event NewSponsor(address indexed sponsor); event EndedSponsorPosition(address indexed sponsor); event Redeem( address indexed sponsor, uint256 indexed collateralAmount, uint256 indexed tokenAmount, uint256 feeAmount ); event Repay( address indexed sponsor, uint256 indexed numTokensRepaid, uint256 indexed newTokenCount, uint256 feeAmount ); event EmergencyShutdown( address indexed caller, uint256 settlementPrice, uint256 shutdowntimestamp ); event SettleEmergencyShutdown( address indexed caller, uint256 indexed collateralReturned, uint256 indexed tokensBurned ); event Liquidation( address indexed sponsor, address indexed liquidator, uint256 liquidatedTokens, uint256 liquidatedCollateral, uint256 collateralReward, uint256 liquidationTime ); //---------------------------------------- // Modifiers //---------------------------------------- modifier notEmergencyShutdown() { require( positionManagerData.emergencyShutdownTimestamp == 0, 'Contract emergency shutdown' ); _; } modifier isEmergencyShutdown() { require( positionManagerData.emergencyShutdownTimestamp != 0, 'Contract not emergency shutdown' ); _; } modifier onlyCollateralisedPosition(address sponsor) { require( positions[sponsor].rawCollateral.isGreaterThan(0), 'Position has no collateral' ); _; } //---------------------------------------- // Constructor //---------------------------------------- constructor(PositionManagerParams memory _positionManagerData) nonReentrant { positionManagerData.initialize( _positionManagerData.synthereumFinder, _positionManagerData.collateralToken, _positionManagerData.syntheticToken, _positionManagerData.priceFeedIdentifier, _positionManagerData.minSponsorTokens, _positionManagerData.excessTokenBeneficiary, _positionManagerData.version ); } //---------------------------------------- // External functions //---------------------------------------- function deposit(uint256 collateralAmount) external override notEmergencyShutdown { PositionData storage positionData = _getPositionData(_msgSender()); positionData.depositTo( globalPositionData, positionManagerData, FixedPoint.Unsigned(collateralAmount), _msgSender(), _msgSender() ); } function depositTo(address sponsor, uint256 collateralAmount) external override notEmergencyShutdown nonReentrant { PositionData storage positionData = _getPositionData(sponsor); positionData.depositTo( globalPositionData, positionManagerData, FixedPoint.Unsigned(collateralAmount), sponsor, _msgSender() ); } function withdraw(uint256 collateralAmount) external override notEmergencyShutdown nonReentrant returns (uint256 amountWithdrawn) { PositionData storage positionData = _getPositionData(_msgSender()); amountWithdrawn = positionData .withdraw( globalPositionData, positionManagerData, FixedPoint.Unsigned(collateralAmount), _msgSender() ) .rawValue; } function create(uint256 collateralAmount, uint256 numTokens) external override notEmergencyShutdown nonReentrant returns (uint256 feeAmount) { PositionData storage positionData = positions[_msgSender()]; feeAmount = positionData .create( globalPositionData, positionManagerData, FixedPoint.Unsigned(collateralAmount), FixedPoint.Unsigned(numTokens), feeStatus, _msgSender() ) .rawValue; } function redeem(uint256 numTokens) external override notEmergencyShutdown nonReentrant returns (uint256 amountWithdrawn, uint256 feeAmount) { PositionData storage positionData = _getPositionData(_msgSender()); ( FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory uFeeAmount ) = positionData.redeem( globalPositionData, positionManagerData, FixedPoint.Unsigned(numTokens), feeStatus, _msgSender() ); amountWithdrawn = collateralAmount.rawValue; feeAmount = uFeeAmount.rawValue; } function repay(uint256 numTokens) external override notEmergencyShutdown nonReentrant returns (uint256 feeAmount) { PositionData storage positionData = _getPositionData(_msgSender()); feeAmount = ( positionData.repay( globalPositionData, positionManagerData, FixedPoint.Unsigned(numTokens), feeStatus, _msgSender() ) ) .rawValue; } function liquidate(address sponsor, uint256 maxTokensToLiquidate) external override notEmergencyShutdown nonReentrant returns ( uint256 tokensLiquidated, uint256 collateralLiquidated, uint256 collateralReward ) { // Retrieve Position data for sponsor PositionData storage positionToLiquidate = _getPositionData(sponsor); // try to liquidate it - reverts if is properly collateralised ( collateralLiquidated, tokensLiquidated, collateralReward ) = positionToLiquidate.liquidate( positionManagerData, globalPositionData, FixedPoint.Unsigned(maxTokensToLiquidate), _msgSender() ); emit Liquidation( sponsor, _msgSender(), tokensLiquidated, collateralLiquidated, collateralReward, block.timestamp ); } function settleEmergencyShutdown() external override isEmergencyShutdown() nonReentrant returns (uint256 amountWithdrawn) { PositionData storage positionData = positions[_msgSender()]; amountWithdrawn = positionData .settleEmergencyShutdown( globalPositionData, positionManagerData, _msgSender() ) .rawValue; } function emergencyShutdown() external override notEmergencyShutdown nonReentrant returns (uint256 timestamp, uint256 price) { return positionManagerData.emergencyShutdown(); } function claimFee() external override nonReentrant returns (uint256 feeClaimed) { feeClaimed = positionManagerData.claimFee(feeStatus, _msgSender()); } function trimExcess(IERC20 token) external override nonReentrant returns (uint256 amount) { amount = positionManagerData .trimExcess(globalPositionData, feeStatus, token) .rawValue; } function deleteSponsorPosition(address sponsor) external override { require( _msgSender() == address(this), 'Only the contract can invoke this function' ); delete positions[sponsor]; } function minSponsorTokens() external view override returns (uint256 amount) { amount = positionManagerData.minSponsorTokens.rawValue; } function excessTokensBeneficiary() external view override returns (address beneficiary) { beneficiary = positionManagerData.excessTokenBeneficiary; } function capMintAmount() external view override returns (uint256 capMint) { capMint = positionManagerData.capMintAmount().rawValue; } function feeInfo() external view override returns (Fee memory fee) { fee = positionManagerData.feeInfo(); } function totalFeeAmount() external view override returns (uint256 totalFee) { totalFee = feeStatus.totalFeeAmount.rawValue; } function userFeeGained(address feeGainer) external view override returns (uint256 feeGained) { feeGained = feeStatus.feeGained[feeGainer].rawValue; } function liquidationReward() external view override returns (uint256 rewardPct) { rewardPct = positionManagerData.liquidationRewardPercentage().rawValue; } function collateralRequirement() external view override returns (uint256 collReq) { collReq = positionManagerData.collateralRequirement().rawValue; } function getPositionData(address sponsor) external view override returns (uint256 collateralAmount, uint256 tokensAmount) { return ( positions[sponsor].rawCollateral.rawValue, positions[sponsor].tokensOutstanding.rawValue ); } function getGlobalPositionData() external view override returns (uint256 totCollateral, uint256 totTokensOutstanding) { totCollateral = globalPositionData.rawTotalPositionCollateral.rawValue; totTokensOutstanding = globalPositionData.totalTokensOutstanding.rawValue; } function collateralCoverage(address sponsor) external view override returns (bool, uint256) { return positionManagerData.collateralCoverage(positions[sponsor]); } function liquidationPrice(address sponsor) external view override returns (uint256) { return positionManagerData.liquidationPrice(positions[sponsor]); } function synthereumFinder() external view override returns (ISynthereumFinder finder) { finder = positionManagerData.synthereumFinder; } function syntheticToken() external view override returns (IERC20 synthToken) { synthToken = positionManagerData.tokenCurrency; } function collateralToken() public view override returns (IERC20 collateral) { collateral = positionManagerData.collateralToken; } function syntheticTokenSymbol() external view override returns (string memory symbol) { symbol = IStandardERC20(address(positionManagerData.tokenCurrency)) .symbol(); } function version() external view override returns (uint8 contractVersion) { contractVersion = positionManagerData.version; } function priceIdentifier() external view override returns (bytes32 identifier) { identifier = positionManagerData.priceIdentifier; } function emergencyShutdownPrice() external view override isEmergencyShutdown() returns (uint256 price) { price = positionManagerData.emergencyShutdownPrice.rawValue; } function emergencyShutdownTime() external view override isEmergencyShutdown() returns (uint256 time) { time = positionManagerData.emergencyShutdownTimestamp; } /** * @notice Check if an address is the trusted forwarder * @param forwarder Address to check * @return True is the input address is the trusted forwarder, otherwise false */ function isTrustedForwarder(address forwarder) public view override returns (bool) { try positionManagerData.synthereumFinder.getImplementationAddress( SynthereumInterfaces.TrustedForwarder ) returns (address trustedForwarder) { if (forwarder == trustedForwarder) { return true; } else { return false; } } catch { return false; } } //---------------------------------------- // Internal functions //---------------------------------------- function _getPositionData(address sponsor) internal view onlyCollateralisedPosition(sponsor) returns (PositionData storage) { return positions[sponsor]; } function _msgSender() internal view override(ERC2771Context) returns (address sender) { return ERC2771Context._msgSender(); } function _msgData() internal view override(ERC2771Context) returns (bytes calldata) { return ERC2771Context._msgData(); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import {ICreditLineStorage} from './interfaces/ICreditLineStorage.sol'; import {IERC20} from '../../../@openzeppelin/contracts/token/ERC20/IERC20.sol'; import {IStandardERC20} from '../../base/interfaces/IStandardERC20.sol'; import { IMintableBurnableERC20 } from '../../tokens/interfaces/IMintableBurnableERC20.sol'; import {ICreditLineController} from './interfaces/ICreditLineController.sol'; import {SynthereumInterfaces} from '../../core/Constants.sol'; import {ISynthereumFinder} from '../../core/interfaces/IFinder.sol'; import { ISynthereumPriceFeed } from '../../oracle/common/interfaces/IPriceFeed.sol'; import { FixedPoint } from '../../../@uma/core/contracts/common/implementation/FixedPoint.sol'; import { SafeERC20 } from '../../../@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol'; import {CreditLine} from './CreditLine.sol'; library CreditLineLib { using FixedPoint for FixedPoint.Unsigned; using SafeERC20 for IERC20; using SafeERC20 for IStandardERC20; using SafeERC20 for IMintableBurnableERC20; using CreditLineLib for ICreditLineStorage.PositionData; using CreditLineLib for ICreditLineStorage.PositionManagerData; using CreditLineLib for ICreditLineStorage.FeeStatus; using CreditLineLib for FixedPoint.Unsigned; //---------------------------------------- // Events //---------------------------------------- event Deposit(address indexed sponsor, uint256 indexed collateralAmount); event Withdrawal(address indexed sponsor, uint256 indexed collateralAmount); event PositionCreated( address indexed sponsor, uint256 indexed collateralAmount, uint256 indexed tokenAmount, uint256 feeAmount ); event NewSponsor(address indexed sponsor); event EndedSponsorPosition(address indexed sponsor); event Redeem( address indexed sponsor, uint256 indexed collateralAmount, uint256 indexed tokenAmount, uint256 feeAmount ); event ClaimFee( address indexed claimer, uint256 feeAmount, uint256 totalRemainingFees ); event Repay( address indexed sponsor, uint256 indexed numTokensRepaid, uint256 indexed newTokenCount, uint256 feeAmount ); event EmergencyShutdown( address indexed caller, uint256 settlementPrice, uint256 shutdownTimestamp ); event SettleEmergencyShutdown( address indexed caller, uint256 indexed collateralReturned, uint256 indexed tokensBurned ); event SetFeePercentage(uint256 feePercentage); event SetFeeRecipients(address[] feeRecipients, uint32[] feeProportions); //---------------------------------------- // External functions //---------------------------------------- function initialize( ICreditLineStorage.PositionManagerData storage self, ISynthereumFinder _finder, IStandardERC20 _collateralToken, IMintableBurnableERC20 _tokenCurrency, bytes32 _priceIdentifier, FixedPoint.Unsigned memory _minSponsorTokens, address _excessTokenBeneficiary, uint8 _version ) external { ISynthereumPriceFeed priceFeed = ISynthereumPriceFeed( _finder.getImplementationAddress(SynthereumInterfaces.PriceFeed) ); require( priceFeed.isPriceSupported(_priceIdentifier), 'Price identifier not supported' ); require( _collateralToken.decimals() <= 18, 'Collateral has more than 18 decimals' ); require( _tokenCurrency.decimals() == 18, 'Synthetic token has more or less than 18 decimals' ); self.priceIdentifier = _priceIdentifier; self.synthereumFinder = _finder; self.collateralToken = _collateralToken; self.tokenCurrency = _tokenCurrency; self.minSponsorTokens = _minSponsorTokens; self.excessTokenBeneficiary = _excessTokenBeneficiary; self.version = _version; } function depositTo( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.PositionManagerData storage positionManagerData, FixedPoint.Unsigned memory collateralAmount, address sponsor, address msgSender ) external { require(collateralAmount.rawValue > 0, 'Invalid collateral amount'); // Increase the position and global collateral balance by collateral amount. positionData._incrementCollateralBalances( globalPositionData, collateralAmount ); emit Deposit(sponsor, collateralAmount.rawValue); positionManagerData.collateralToken.safeTransferFrom( msgSender, address(this), collateralAmount.rawValue ); } function withdraw( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.PositionManagerData storage positionManagerData, FixedPoint.Unsigned memory collateralAmount, address msgSender ) external returns (FixedPoint.Unsigned memory) { require(collateralAmount.rawValue > 0, 'Invalid collateral amount'); // Decrement the sponsor's collateral and global collateral amounts. // Reverts if the resulting position is not properly collateralized _decrementCollateralBalancesCheckCR( positionData, globalPositionData, positionManagerData, collateralAmount ); emit Withdrawal(msgSender, collateralAmount.rawValue); // Move collateral currency from contract to sender. positionManagerData.collateralToken.safeTransfer( msgSender, collateralAmount.rawValue ); return collateralAmount; } function create( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.PositionManagerData storage positionManagerData, FixedPoint.Unsigned memory collateralAmount, FixedPoint.Unsigned memory numTokens, ICreditLineStorage.FeeStatus storage feeStatus, address msgSender ) external returns (FixedPoint.Unsigned memory feeAmount) { // Update fees status - percentage is retrieved from Credit Line Controller FixedPoint.Unsigned memory priceRate = _getOraclePrice(positionManagerData); uint8 collateralDecimals = getCollateralDecimals(positionManagerData.collateralToken); feeAmount = calculateCollateralAmount( numTokens, priceRate, collateralDecimals ) .mul( FixedPoint.Unsigned(positionManagerData._getFeeInfo().feePercentage) ); positionManagerData.updateFees(feeStatus, feeAmount); if (positionData.tokensOutstanding.isEqual(0)) { require( _checkCollateralization( positionManagerData, collateralAmount.sub(feeAmount), numTokens, priceRate, collateralDecimals ), 'Insufficient Collateral' ); require( numTokens.isGreaterThanOrEqual(positionManagerData.minSponsorTokens), 'Below minimum sponsor position' ); emit NewSponsor(msgSender); } else { require( _checkCollateralization( positionManagerData, positionData.rawCollateral.add(collateralAmount).sub(feeAmount), positionData.tokensOutstanding.add(numTokens), priceRate, collateralDecimals ), 'Insufficient Collateral' ); } // Increase or decrease the position and global collateral balance by collateral amount or fee amount. collateralAmount.isGreaterThanOrEqual(feeAmount) ? positionData._incrementCollateralBalances( globalPositionData, collateralAmount.sub(feeAmount) ) : positionData._decrementCollateralBalances( globalPositionData, feeAmount.sub(collateralAmount) ); // Add the number of tokens created to the position's outstanding tokens and global. positionData.tokensOutstanding = positionData.tokensOutstanding.add( numTokens ); globalPositionData.totalTokensOutstanding = globalPositionData .totalTokensOutstanding .add(numTokens); checkMintLimit(globalPositionData, positionManagerData); if (collateralAmount.rawValue > 0) { // pull collateral IERC20 collateralCurrency = positionManagerData.collateralToken; // Transfer tokens into the contract from caller collateralCurrency.safeTransferFrom( msgSender, address(this), (collateralAmount).rawValue ); } // mint corresponding synthetic tokens to the caller's address. positionManagerData.tokenCurrency.mint(msgSender, numTokens.rawValue); emit PositionCreated( msgSender, collateralAmount.rawValue, numTokens.rawValue, feeAmount.rawValue ); } function redeem( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.PositionManagerData storage positionManagerData, FixedPoint.Unsigned memory numTokens, ICreditLineStorage.FeeStatus storage feeStatus, address sponsor ) external returns ( FixedPoint.Unsigned memory amountWithdrawn, FixedPoint.Unsigned memory feeAmount ) { require( numTokens.isLessThanOrEqual(positionData.tokensOutstanding), 'Invalid token amount' ); FixedPoint.Unsigned memory collateralRedeemed = positionData.rawCollateral.mul(numTokens).div( positionData.tokensOutstanding ); FixedPoint.Unsigned memory priceRate = _getOraclePrice(positionManagerData); // Update fee status feeAmount = calculateCollateralAmount( numTokens, priceRate, getCollateralDecimals(positionManagerData.collateralToken) ) .mul( FixedPoint.Unsigned(positionManagerData._getFeeInfo().feePercentage) ); positionManagerData.updateFees(feeStatus, feeAmount); // If redemption returns all tokens the sponsor has then we can delete their position. Else, downsize. if (positionData.tokensOutstanding.isEqual(numTokens)) { positionData._deleteSponsorPosition(globalPositionData, sponsor); } else { // Decrement the sponsor's collateral and global collateral amounts. positionData._decrementCollateralBalances( globalPositionData, collateralRedeemed ); // Decrease the sponsors position tokens size. Ensure it is above the min sponsor size. FixedPoint.Unsigned memory newTokenCount = positionData.tokensOutstanding.sub(numTokens); require( newTokenCount.isGreaterThanOrEqual( positionManagerData.minSponsorTokens ), 'Below minimum sponsor position' ); positionData.tokensOutstanding = newTokenCount; // Update the totalTokensOutstanding after redemption. globalPositionData.totalTokensOutstanding = globalPositionData .totalTokensOutstanding .sub(numTokens); } // adjust the fees from collateral to withdraws amountWithdrawn = collateralRedeemed.sub(feeAmount); // transfer collateral to user IERC20 collateralCurrency = positionManagerData.collateralToken; { collateralCurrency.safeTransfer(sponsor, amountWithdrawn.rawValue); // Pull and burn callers synthetic tokens. positionManagerData.tokenCurrency.safeTransferFrom( sponsor, address(this), numTokens.rawValue ); positionManagerData.tokenCurrency.burn(numTokens.rawValue); } emit Redeem( sponsor, amountWithdrawn.rawValue, numTokens.rawValue, feeAmount.rawValue ); } function repay( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.PositionManagerData storage positionManagerData, FixedPoint.Unsigned memory numTokens, ICreditLineStorage.FeeStatus storage feeStatus, address msgSender ) external returns (FixedPoint.Unsigned memory feeAmount) { require( numTokens.isLessThanOrEqual(positionData.tokensOutstanding), 'Invalid token amount' ); // Decrease the sponsors position tokens size. Ensure it is above the min sponsor size. FixedPoint.Unsigned memory newTokenCount = positionData.tokensOutstanding.sub(numTokens); require( newTokenCount.isGreaterThanOrEqual(positionManagerData.minSponsorTokens), 'Below minimum sponsor position' ); FixedPoint.Unsigned memory priceRate = _getOraclePrice(positionManagerData); // Update fee status feeAmount = calculateCollateralAmount( numTokens, priceRate, getCollateralDecimals(positionManagerData.collateralToken) ) .mul( FixedPoint.Unsigned(positionManagerData._getFeeInfo().feePercentage) ); positionManagerData.updateFees(feeStatus, feeAmount); // update position positionData.tokensOutstanding = newTokenCount; _decrementCollateralBalances(positionData, globalPositionData, feeAmount); // Update the totalTokensOutstanding after redemption. globalPositionData.totalTokensOutstanding = globalPositionData .totalTokensOutstanding .sub(numTokens); // Transfer the tokens back from the sponsor and burn them. positionManagerData.tokenCurrency.safeTransferFrom( msgSender, address(this), numTokens.rawValue ); positionManagerData.tokenCurrency.burn(numTokens.rawValue); emit Repay( msgSender, numTokens.rawValue, newTokenCount.rawValue, feeAmount.rawValue ); } function liquidate( ICreditLineStorage.PositionData storage positionToLiquidate, ICreditLineStorage.PositionManagerData storage positionManagerData, ICreditLineStorage.GlobalPositionData storage globalPositionData, FixedPoint.Unsigned calldata numSynthTokens, address msgSender ) external returns ( uint256, uint256, uint256 ) { // to avoid stack too deep ICreditLineStorage.ExecuteLiquidationData memory executeLiquidationData; uint8 collateralDecimals = getCollateralDecimals(positionManagerData.collateralToken); FixedPoint.Unsigned memory priceRate = _getOraclePrice(positionManagerData); // make sure position is undercollateralised require( !positionManagerData._checkCollateralization( positionToLiquidate.rawCollateral, positionToLiquidate.tokensOutstanding, priceRate, collateralDecimals ), 'Position is properly collateralised' ); // calculate tokens to liquidate executeLiquidationData.tokensToLiquidate.rawValue = positionToLiquidate .tokensOutstanding .isGreaterThan(numSynthTokens) ? numSynthTokens.rawValue : positionToLiquidate.tokensOutstanding.rawValue; // calculate collateral value of those tokens executeLiquidationData .collateralValueLiquidatedTokens = calculateCollateralAmount( executeLiquidationData.tokensToLiquidate, priceRate, collateralDecimals ); // calculate proportion of collateral liquidated from position executeLiquidationData.collateralLiquidated = executeLiquidationData .tokensToLiquidate .div(positionToLiquidate.tokensOutstanding) .mul(positionToLiquidate.rawCollateral); // compute final liquidation outcome if ( executeLiquidationData.collateralLiquidated.isGreaterThan( executeLiquidationData.collateralValueLiquidatedTokens ) ) { // position is still capitalised - liquidator profits executeLiquidationData.liquidatorReward = ( executeLiquidationData.collateralLiquidated.sub( executeLiquidationData.collateralValueLiquidatedTokens ) ) .mul(positionManagerData._getLiquidationReward()); executeLiquidationData.collateralLiquidated = executeLiquidationData .collateralValueLiquidatedTokens .add(executeLiquidationData.liquidatorReward); } // reduce position positionToLiquidate._reducePosition( globalPositionData, executeLiquidationData.tokensToLiquidate, executeLiquidationData.collateralLiquidated ); // transfer tokens from liquidator to here and burn them _burnLiquidatedTokens( positionManagerData, msgSender, executeLiquidationData.tokensToLiquidate.rawValue ); // pay sender with collateral unlocked + rewards positionManagerData.collateralToken.safeTransfer( msgSender, executeLiquidationData.collateralLiquidated.rawValue ); // return values return ( executeLiquidationData.collateralLiquidated.rawValue, executeLiquidationData.tokensToLiquidate.rawValue, executeLiquidationData.liquidatorReward.rawValue ); } function emergencyShutdown( ICreditLineStorage.PositionManagerData storage self ) external returns (uint256 timestamp, uint256 price) { require( msg.sender == self.synthereumFinder.getImplementationAddress( SynthereumInterfaces.Manager ), 'Caller must be a Synthereum manager' ); timestamp = block.timestamp; FixedPoint.Unsigned memory _price = self._getOraclePrice(); // store timestamp and last price self.emergencyShutdownTimestamp = timestamp; self.emergencyShutdownPrice = _price; price = _price.rawValue; emit EmergencyShutdown(msg.sender, price, timestamp); } function settleEmergencyShutdown( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.PositionManagerData storage positionManagerData, address msgSender ) external returns (FixedPoint.Unsigned memory amountWithdrawn) { // copy value FixedPoint.Unsigned memory emergencyShutdownPrice = positionManagerData.emergencyShutdownPrice; IMintableBurnableERC20 tokenCurrency = positionManagerData.tokenCurrency; FixedPoint.Unsigned memory rawCollateral = positionData.rawCollateral; FixedPoint.Unsigned memory totalCollateral = globalPositionData.rawTotalPositionCollateral; // Get caller's tokens balance FixedPoint.Unsigned memory tokensToRedeem = FixedPoint.Unsigned(tokenCurrency.balanceOf(msgSender)); // calculate amount of underlying collateral entitled to them, with oracle emergency price FixedPoint.Unsigned memory totalRedeemableCollateral = tokensToRedeem.mul(emergencyShutdownPrice); // If the caller is a sponsor with outstanding collateral they are also entitled to their excess collateral after their debt. if (rawCollateral.rawValue > 0) { // Calculate the underlying entitled to a token sponsor. This is collateral - debt FixedPoint.Unsigned memory tokenDebtValueInCollateral = positionData.tokensOutstanding.mul(emergencyShutdownPrice); // accrued to withdrawable collateral eventual excess collateral after debt if (tokenDebtValueInCollateral.isLessThan(rawCollateral)) { totalRedeemableCollateral = totalRedeemableCollateral.add( rawCollateral.sub(tokenDebtValueInCollateral) ); } CreditLine(address(this)).deleteSponsorPosition(msgSender); emit EndedSponsorPosition(msgSender); } // Take the min of the remaining collateral and the collateral "owed". If the contract is undercapitalized, // the caller will get as much collateral as the contract can pay out. amountWithdrawn = FixedPoint.min( totalCollateral, totalRedeemableCollateral ); // Decrement total contract collateral and outstanding debt. globalPositionData.rawTotalPositionCollateral = totalCollateral.sub( amountWithdrawn ); globalPositionData.totalTokensOutstanding = globalPositionData .totalTokensOutstanding .sub(tokensToRedeem); emit SettleEmergencyShutdown( msgSender, amountWithdrawn.rawValue, tokensToRedeem.rawValue ); // Transfer tokens & collateral and burn the redeemed tokens. positionManagerData.collateralToken.safeTransfer( msgSender, amountWithdrawn.rawValue ); tokenCurrency.safeTransferFrom( msgSender, address(this), tokensToRedeem.rawValue ); tokenCurrency.burn(tokensToRedeem.rawValue); } /** * @notice Withdraw fees gained by the sender * @param self Data type the library is attached to * @param feeStatus Actual status of fee gained (see FeeStatus struct) * @return feeClaimed Amount of fee claimed */ function claimFee( ICreditLineStorage.PositionManagerData storage self, ICreditLineStorage.FeeStatus storage feeStatus, address msgSender ) external returns (uint256 feeClaimed) { // Fee to claim FixedPoint.Unsigned memory _feeClaimed = feeStatus.feeGained[msgSender]; // Check that fee is available require(_feeClaimed.rawValue > 0, 'No fee to claim'); // Update fee status delete feeStatus.feeGained[msgSender]; FixedPoint.Unsigned memory _totalRemainingFees = feeStatus.totalFeeAmount.sub(_feeClaimed); feeStatus.totalFeeAmount = _totalRemainingFees; // Transfer amount to the sender feeClaimed = _feeClaimed.rawValue; self.collateralToken.safeTransfer(msgSender, _feeClaimed.rawValue); emit ClaimFee(msgSender, feeClaimed, _totalRemainingFees.rawValue); } function trimExcess( ICreditLineStorage.PositionManagerData storage positionManagerData, ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.FeeStatus storage feeStatus, IERC20 token ) external returns (FixedPoint.Unsigned memory amount) { FixedPoint.Unsigned memory balance = FixedPoint.Unsigned(token.balanceOf(address(this))); if (address(token) == address(positionManagerData.collateralToken)) { FixedPoint.Unsigned memory rawTotalPositionCollateral = globalPositionData.rawTotalPositionCollateral; FixedPoint.Unsigned memory totalFeeAmount = feeStatus.totalFeeAmount; // If it is the collateral currency, send only the amount that the contract is not tracking (ie minus fees and positions) balance.isGreaterThan(rawTotalPositionCollateral.add(totalFeeAmount)) ? amount = balance.sub(rawTotalPositionCollateral).sub(totalFeeAmount) : amount = FixedPoint.Unsigned(0); } else { // If it's not the collateral currency, send the entire balance. amount = balance; } token.safeTransfer( positionManagerData.excessTokenBeneficiary, amount.rawValue ); } /** * @notice Returns if position is overcollateralized and thepercentage of coverage of the collateral according to the last price * @param self Data type the library is attached to * @param positionData Position of the LP * @return True if position is overcollaterlized, otherwise false + percentage of coverage (totalCollateralAmount / (price * tokensCollateralized)) */ function collateralCoverage( ICreditLineStorage.PositionManagerData storage self, ICreditLineStorage.PositionData storage positionData ) external view returns (bool, uint256) { FixedPoint.Unsigned memory priceRate = _getOraclePrice(self); uint8 collateralDecimals = getCollateralDecimals(self.collateralToken); FixedPoint.Unsigned memory positionCollateral = positionData.rawCollateral; FixedPoint.Unsigned memory positionTokens = positionData.tokensOutstanding; bool _isOverCollateralised = _checkCollateralization( self, positionCollateral, positionTokens, priceRate, collateralDecimals ); FixedPoint.Unsigned memory collateralRequirementPrc = self._getCollateralRequirement(); FixedPoint.Unsigned memory overCollateralValue = getOverCollateralizationLimit( calculateCollateralAmount( positionData.tokensOutstanding, priceRate, collateralDecimals ), collateralRequirementPrc ); FixedPoint.Unsigned memory coverageRatio = positionCollateral.div(overCollateralValue); FixedPoint.Unsigned memory _collateralCoverage = collateralRequirementPrc.mul(coverageRatio); return (_isOverCollateralised, _collateralCoverage.rawValue); } function liquidationPrice( ICreditLineStorage.PositionManagerData storage self, ICreditLineStorage.PositionData storage positionData ) external view returns (uint256 liqPrice) { // liquidationPrice occurs when totalCollateral is entirely occupied in the position value * collateral requirement // positionCollateral = positionTokensOut * liqPrice * collRequirement uint8 collateralDecimals = getCollateralDecimals(self.collateralToken); liqPrice = positionData .rawCollateral .div(self._getCollateralRequirement()) .mul(10**(18 - collateralDecimals)) .div(positionData.tokensOutstanding) .rawValue; } //Calls to the CreditLine controller function capMintAmount( ICreditLineStorage.PositionManagerData storage positionManagerData ) external view returns (FixedPoint.Unsigned memory capMint) { capMint = positionManagerData._getCapMintAmount(); } function liquidationRewardPercentage( ICreditLineStorage.PositionManagerData storage positionManagerData ) external view returns (FixedPoint.Unsigned memory liqRewardPercentage) { liqRewardPercentage = positionManagerData._getLiquidationReward(); } function feeInfo( ICreditLineStorage.PositionManagerData storage positionManagerData ) external view returns (ICreditLineStorage.Fee memory fee) { fee = positionManagerData._getFeeInfo(); } function collateralRequirement( ICreditLineStorage.PositionManagerData storage positionManagerData ) external view returns (FixedPoint.Unsigned memory) { return positionManagerData._getCollateralRequirement(); } //---------------------------------------- // Internal functions //---------------------------------------- /** * @notice Update fee gained by the fee recipients * @param feeStatus Actual status of fee gained to be withdrawn * @param feeAmount Collateral fee charged */ function updateFees( ICreditLineStorage.PositionManagerData storage positionManagerData, ICreditLineStorage.FeeStatus storage feeStatus, FixedPoint.Unsigned memory feeAmount ) internal { FixedPoint.Unsigned memory feeCharged; ICreditLineStorage.Fee memory feeStruct = positionManagerData._getFeeInfo(); address[] memory feeRecipients = feeStruct.feeRecipients; uint32[] memory feeProportions = feeStruct.feeProportions; uint256 totalFeeProportions = feeStruct.totalFeeProportions; uint256 numberOfRecipients = feeRecipients.length; mapping(address => FixedPoint.Unsigned) storage feeGained = feeStatus.feeGained; for (uint256 i = 0; i < numberOfRecipients - 1; i++) { address feeRecipient = feeRecipients[i]; FixedPoint.Unsigned memory feeReceived = FixedPoint.Unsigned( (feeAmount.rawValue * feeProportions[i]) / totalFeeProportions ); feeGained[feeRecipient] = feeGained[feeRecipient].add(feeReceived); feeCharged = feeCharged.add(feeReceived); } address lastRecipient = feeRecipients[numberOfRecipients - 1]; feeGained[lastRecipient] = feeGained[lastRecipient].add(feeAmount).sub( feeCharged ); feeStatus.totalFeeAmount = feeStatus.totalFeeAmount.add(feeAmount); } function _burnLiquidatedTokens( ICreditLineStorage.PositionManagerData storage positionManagerData, address liquidator, uint256 amount ) internal { positionManagerData.tokenCurrency.safeTransferFrom( liquidator, address(this), amount ); positionManagerData.tokenCurrency.burn(amount); } function _incrementCollateralBalances( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, FixedPoint.Unsigned memory collateralAmount ) internal { positionData.rawCollateral = positionData.rawCollateral.add( collateralAmount ); globalPositionData.rawTotalPositionCollateral = globalPositionData .rawTotalPositionCollateral .add(collateralAmount); } function _decrementCollateralBalances( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, FixedPoint.Unsigned memory collateralAmount ) internal { positionData.rawCollateral = positionData.rawCollateral.sub( collateralAmount ); globalPositionData.rawTotalPositionCollateral = globalPositionData .rawTotalPositionCollateral .sub(collateralAmount); } //remove the withdrawn collateral from the position and then check its CR function _decrementCollateralBalancesCheckCR( ICreditLineStorage.PositionData storage positionData, ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.PositionManagerData storage positionManagerData, FixedPoint.Unsigned memory collateralAmount ) internal { FixedPoint.Unsigned memory newRawCollateral = positionData.rawCollateral.sub(collateralAmount); positionData.rawCollateral = newRawCollateral; globalPositionData.rawTotalPositionCollateral = globalPositionData .rawTotalPositionCollateral .sub(collateralAmount); require( _checkCollateralization( positionManagerData, newRawCollateral, positionData.tokensOutstanding, _getOraclePrice(positionManagerData), getCollateralDecimals(positionManagerData.collateralToken) ), 'CR is not sufficiently high after the withdraw - try less amount' ); } // Deletes a sponsor's position and updates global counters. Does not make any external transfers. function _deleteSponsorPosition( ICreditLineStorage.PositionData storage positionToLiquidate, ICreditLineStorage.GlobalPositionData storage globalPositionData, address sponsor ) internal returns (FixedPoint.Unsigned memory) { // Remove the collateral and outstanding from the overall total position. globalPositionData.rawTotalPositionCollateral = globalPositionData .rawTotalPositionCollateral .sub(positionToLiquidate.rawCollateral); globalPositionData.totalTokensOutstanding = globalPositionData .totalTokensOutstanding .sub(positionToLiquidate.tokensOutstanding); // delete position entry from storage CreditLine(address(this)).deleteSponsorPosition(sponsor); emit EndedSponsorPosition(sponsor); // Return unlocked amount of collateral return positionToLiquidate.rawCollateral; } function _reducePosition( ICreditLineStorage.PositionData storage positionToLiquidate, ICreditLineStorage.GlobalPositionData storage globalPositionData, FixedPoint.Unsigned memory tokensToLiquidate, FixedPoint.Unsigned memory collateralToLiquidate ) internal { // reduce position positionToLiquidate.tokensOutstanding = positionToLiquidate .tokensOutstanding .sub(tokensToLiquidate); positionToLiquidate.rawCollateral = positionToLiquidate.rawCollateral.sub( collateralToLiquidate ); // update global position data globalPositionData.totalTokensOutstanding = globalPositionData .totalTokensOutstanding .sub(tokensToLiquidate); globalPositionData.rawTotalPositionCollateral = globalPositionData .rawTotalPositionCollateral .sub(collateralToLiquidate); } function _checkCollateralization( ICreditLineStorage.PositionManagerData storage positionManagerData, FixedPoint.Unsigned memory collateral, FixedPoint.Unsigned memory numTokens, FixedPoint.Unsigned memory oraclePrice, uint8 collateralDecimals ) internal view returns (bool) { // calculate the min collateral of numTokens with chainlink FixedPoint.Unsigned memory thresholdValue = numTokens.mul(oraclePrice).div(10**(18 - collateralDecimals)); thresholdValue = getOverCollateralizationLimit( thresholdValue, positionManagerData._getCollateralRequirement() ); return collateral.isGreaterThanOrEqual(thresholdValue); } // Check new total number of tokens does not overcome mint limit function checkMintLimit( ICreditLineStorage.GlobalPositionData storage globalPositionData, ICreditLineStorage.PositionManagerData storage positionManagerData ) internal view { require( globalPositionData.totalTokensOutstanding.isLessThanOrEqual( positionManagerData._getCapMintAmount() ), 'Total amount minted overcomes mint limit' ); } /** * @notice Retrun the on-chain oracle price for a pair * @return priceRate Latest rate of the pair */ function _getOraclePrice( ICreditLineStorage.PositionManagerData storage positionManagerData ) internal view returns (FixedPoint.Unsigned memory priceRate) { ISynthereumPriceFeed priceFeed = ISynthereumPriceFeed( positionManagerData.synthereumFinder.getImplementationAddress( SynthereumInterfaces.PriceFeed ) ); priceRate = FixedPoint.Unsigned( priceFeed.getLatestPrice(positionManagerData.priceIdentifier) ); } /// @notice calls CreditLineController to retrieve liquidation reward percentage function _getLiquidationReward( ICreditLineStorage.PositionManagerData storage positionManagerData ) internal view returns (FixedPoint.Unsigned memory liqRewardPercentage) { liqRewardPercentage = FixedPoint.Unsigned( positionManagerData .getCreditLineController() .getLiquidationRewardPercentage(address(this)) ); } function _getFeeInfo( ICreditLineStorage.PositionManagerData storage positionManagerData ) internal view returns (ICreditLineStorage.Fee memory fee) { fee = positionManagerData.getCreditLineController().getFeeInfo( address(this) ); } function _getCollateralRequirement( ICreditLineStorage.PositionManagerData storage positionManagerData ) internal view returns (FixedPoint.Unsigned memory) { return FixedPoint.Unsigned( positionManagerData.getCreditLineController().getCollateralRequirement( address(this) ) ); } // Get mint amount limit from CreditLineController function _getCapMintAmount( ICreditLineStorage.PositionManagerData storage positionManagerData ) internal view returns (FixedPoint.Unsigned memory capMint) { capMint = FixedPoint.Unsigned( positionManagerData.getCreditLineController().getCapMintAmount( address(this) ) ); } // Get self-minting controller instance function getCreditLineController( ICreditLineStorage.PositionManagerData storage positionManagerData ) internal view returns (ICreditLineController creditLineController) { creditLineController = ICreditLineController( positionManagerData.synthereumFinder.getImplementationAddress( SynthereumInterfaces.CreditLineController ) ); } function getCollateralDecimals(IStandardERC20 collateralToken) internal view returns (uint8 decimals) { decimals = collateralToken.decimals(); } /** * @notice Calculate collateral amount starting from an amount of synthtic token * @param numTokens Amount of synthetic tokens from which you want to calculate collateral amount * @param priceRate On-chain price rate * @return collateralAmount Amount of collateral after on-chain oracle conversion */ function calculateCollateralAmount( FixedPoint.Unsigned memory numTokens, FixedPoint.Unsigned memory priceRate, uint256 collateraDecimals ) internal pure returns (FixedPoint.Unsigned memory collateralAmount) { collateralAmount = numTokens.mul(priceRate).div( 10**(18 - collateraDecimals) ); } function getOverCollateralizationLimit( FixedPoint.Unsigned memory collateral, FixedPoint.Unsigned memory collateralRequirementPrc ) internal pure returns (FixedPoint.Unsigned memory) { return collateral.mul(collateralRequirementPrc); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.3.2 (metatx/ERC2771Context.sol) pragma solidity ^0.8.0; import {Context} from '../../../../@openzeppelin/contracts/utils/Context.sol'; /** * @dev Context variant with ERC2771 support. */ abstract contract ERC2771Context is Context { function isTrustedForwarder(address forwarder) public view virtual returns (bool); function _msgSender() internal view virtual override returns (address sender) { if (isTrustedForwarder(msg.sender)) { // The assembly code is more direct than the Solidity version using `abi.decode`. assembly { sender := shr(96, calldataload(sub(calldatasize(), 20))) } } else { return super._msgSender(); } } function _msgData() internal view virtual override returns (bytes calldata) { if (isTrustedForwarder(msg.sender)) { return msg.data[0:msg.data.length - 20]; } else { return super._msgData(); } } }
// SPDX-License-Identifier: MIT pragma solidity >= 0.4.22 <0.9.0; library console { address constant CONSOLE_ADDRESS = address(0x000000000000000000636F6e736F6c652e6c6f67); function _sendLogPayload(bytes memory payload) private view { uint256 payloadLength = payload.length; address consoleAddress = CONSOLE_ADDRESS; assembly { let payloadStart := add(payload, 32) let r := staticcall(gas(), consoleAddress, payloadStart, payloadLength, 0, 0) } } function log() internal view { _sendLogPayload(abi.encodeWithSignature("log()")); } function logInt(int p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(int)", p0)); } function logUint(uint p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint)", p0)); } function logString(string memory p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(string)", p0)); } function logBool(bool p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool)", p0)); } function logAddress(address p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(address)", p0)); } function logBytes(bytes memory p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes)", p0)); } function logBytes1(bytes1 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes1)", p0)); } function logBytes2(bytes2 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes2)", p0)); } function logBytes3(bytes3 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes3)", p0)); } function logBytes4(bytes4 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes4)", p0)); } function logBytes5(bytes5 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes5)", p0)); } function logBytes6(bytes6 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes6)", p0)); } function logBytes7(bytes7 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes7)", p0)); } function logBytes8(bytes8 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes8)", p0)); } function logBytes9(bytes9 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes9)", p0)); } function logBytes10(bytes10 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes10)", p0)); } function logBytes11(bytes11 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes11)", p0)); } function logBytes12(bytes12 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes12)", p0)); } function logBytes13(bytes13 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes13)", p0)); } function logBytes14(bytes14 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes14)", p0)); } function logBytes15(bytes15 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes15)", p0)); } function logBytes16(bytes16 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes16)", p0)); } function logBytes17(bytes17 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes17)", p0)); } function logBytes18(bytes18 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes18)", p0)); } function logBytes19(bytes19 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes19)", p0)); } function logBytes20(bytes20 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes20)", p0)); } function logBytes21(bytes21 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes21)", p0)); } function logBytes22(bytes22 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes22)", p0)); } function logBytes23(bytes23 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes23)", p0)); } function logBytes24(bytes24 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes24)", p0)); } function logBytes25(bytes25 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes25)", p0)); } function logBytes26(bytes26 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes26)", p0)); } function logBytes27(bytes27 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes27)", p0)); } function logBytes28(bytes28 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes28)", p0)); } function logBytes29(bytes29 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes29)", p0)); } function logBytes30(bytes30 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes30)", p0)); } function logBytes31(bytes31 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes31)", p0)); } function logBytes32(bytes32 p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bytes32)", p0)); } function log(uint p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint)", p0)); } function log(string memory p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(string)", p0)); } function log(bool p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool)", p0)); } function log(address p0) internal view { _sendLogPayload(abi.encodeWithSignature("log(address)", p0)); } function log(uint p0, uint p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint)", p0, p1)); } function log(uint p0, string memory p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string)", p0, p1)); } function log(uint p0, bool p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool)", p0, p1)); } function log(uint p0, address p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address)", p0, p1)); } function log(string memory p0, uint p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint)", p0, p1)); } function log(string memory p0, string memory p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string)", p0, p1)); } function log(string memory p0, bool p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool)", p0, p1)); } function log(string memory p0, address p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address)", p0, p1)); } function log(bool p0, uint p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint)", p0, p1)); } function log(bool p0, string memory p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string)", p0, p1)); } function log(bool p0, bool p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool)", p0, p1)); } function log(bool p0, address p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address)", p0, p1)); } function log(address p0, uint p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint)", p0, p1)); } function log(address p0, string memory p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string)", p0, p1)); } function log(address p0, bool p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool)", p0, p1)); } function log(address p0, address p1) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address)", p0, p1)); } function log(uint p0, uint p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint)", p0, p1, p2)); } function log(uint p0, uint p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string)", p0, p1, p2)); } function log(uint p0, uint p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool)", p0, p1, p2)); } function log(uint p0, uint p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address)", p0, p1, p2)); } function log(uint p0, string memory p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint)", p0, p1, p2)); } function log(uint p0, string memory p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,string)", p0, p1, p2)); } function log(uint p0, string memory p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool)", p0, p1, p2)); } function log(uint p0, string memory p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,address)", p0, p1, p2)); } function log(uint p0, bool p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint)", p0, p1, p2)); } function log(uint p0, bool p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string)", p0, p1, p2)); } function log(uint p0, bool p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool)", p0, p1, p2)); } function log(uint p0, bool p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address)", p0, p1, p2)); } function log(uint p0, address p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint)", p0, p1, p2)); } function log(uint p0, address p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,string)", p0, p1, p2)); } function log(uint p0, address p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool)", p0, p1, p2)); } function log(uint p0, address p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,address)", p0, p1, p2)); } function log(string memory p0, uint p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint)", p0, p1, p2)); } function log(string memory p0, uint p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,string)", p0, p1, p2)); } function log(string memory p0, uint p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool)", p0, p1, p2)); } function log(string memory p0, uint p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,address)", p0, p1, p2)); } function log(string memory p0, string memory p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,uint)", p0, p1, p2)); } function log(string memory p0, string memory p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,string)", p0, p1, p2)); } function log(string memory p0, string memory p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,bool)", p0, p1, p2)); } function log(string memory p0, string memory p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,address)", p0, p1, p2)); } function log(string memory p0, bool p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint)", p0, p1, p2)); } function log(string memory p0, bool p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,string)", p0, p1, p2)); } function log(string memory p0, bool p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool)", p0, p1, p2)); } function log(string memory p0, bool p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,address)", p0, p1, p2)); } function log(string memory p0, address p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,uint)", p0, p1, p2)); } function log(string memory p0, address p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,string)", p0, p1, p2)); } function log(string memory p0, address p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,bool)", p0, p1, p2)); } function log(string memory p0, address p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,address)", p0, p1, p2)); } function log(bool p0, uint p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint)", p0, p1, p2)); } function log(bool p0, uint p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string)", p0, p1, p2)); } function log(bool p0, uint p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool)", p0, p1, p2)); } function log(bool p0, uint p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address)", p0, p1, p2)); } function log(bool p0, string memory p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint)", p0, p1, p2)); } function log(bool p0, string memory p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,string)", p0, p1, p2)); } function log(bool p0, string memory p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool)", p0, p1, p2)); } function log(bool p0, string memory p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,address)", p0, p1, p2)); } function log(bool p0, bool p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint)", p0, p1, p2)); } function log(bool p0, bool p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string)", p0, p1, p2)); } function log(bool p0, bool p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool)", p0, p1, p2)); } function log(bool p0, bool p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address)", p0, p1, p2)); } function log(bool p0, address p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint)", p0, p1, p2)); } function log(bool p0, address p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,string)", p0, p1, p2)); } function log(bool p0, address p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool)", p0, p1, p2)); } function log(bool p0, address p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,address)", p0, p1, p2)); } function log(address p0, uint p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint)", p0, p1, p2)); } function log(address p0, uint p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,string)", p0, p1, p2)); } function log(address p0, uint p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool)", p0, p1, p2)); } function log(address p0, uint p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,address)", p0, p1, p2)); } function log(address p0, string memory p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,uint)", p0, p1, p2)); } function log(address p0, string memory p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,string)", p0, p1, p2)); } function log(address p0, string memory p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,bool)", p0, p1, p2)); } function log(address p0, string memory p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,address)", p0, p1, p2)); } function log(address p0, bool p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint)", p0, p1, p2)); } function log(address p0, bool p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,string)", p0, p1, p2)); } function log(address p0, bool p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool)", p0, p1, p2)); } function log(address p0, bool p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,address)", p0, p1, p2)); } function log(address p0, address p1, uint p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,uint)", p0, p1, p2)); } function log(address p0, address p1, string memory p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,string)", p0, p1, p2)); } function log(address p0, address p1, bool p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,bool)", p0, p1, p2)); } function log(address p0, address p1, address p2) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,address)", p0, p1, p2)); } function log(uint p0, uint p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint,uint)", p0, p1, p2, p3)); } function log(uint p0, uint p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint,string)", p0, p1, p2, p3)); } function log(uint p0, uint p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint,bool)", p0, p1, p2, p3)); } function log(uint p0, uint p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,uint,address)", p0, p1, p2, p3)); } function log(uint p0, uint p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string,uint)", p0, p1, p2, p3)); } function log(uint p0, uint p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string,string)", p0, p1, p2, p3)); } function log(uint p0, uint p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string,bool)", p0, p1, p2, p3)); } function log(uint p0, uint p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,string,address)", p0, p1, p2, p3)); } function log(uint p0, uint p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool,uint)", p0, p1, p2, p3)); } function log(uint p0, uint p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool,string)", p0, p1, p2, p3)); } function log(uint p0, uint p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool,bool)", p0, p1, p2, p3)); } function log(uint p0, uint p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,bool,address)", p0, p1, p2, p3)); } function log(uint p0, uint p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address,uint)", p0, p1, p2, p3)); } function log(uint p0, uint p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address,string)", p0, p1, p2, p3)); } function log(uint p0, uint p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address,bool)", p0, p1, p2, p3)); } function log(uint p0, uint p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,uint,address,address)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint,uint)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint,string)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint,bool)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,uint,address)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,string,uint)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,string,string)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,string,bool)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,string,address)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool,uint)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool,string)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool,bool)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,bool,address)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,address,uint)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,address,string)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,address,bool)", p0, p1, p2, p3)); } function log(uint p0, string memory p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,string,address,address)", p0, p1, p2, p3)); } function log(uint p0, bool p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint,uint)", p0, p1, p2, p3)); } function log(uint p0, bool p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint,string)", p0, p1, p2, p3)); } function log(uint p0, bool p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint,bool)", p0, p1, p2, p3)); } function log(uint p0, bool p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,uint,address)", p0, p1, p2, p3)); } function log(uint p0, bool p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string,uint)", p0, p1, p2, p3)); } function log(uint p0, bool p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string,string)", p0, p1, p2, p3)); } function log(uint p0, bool p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string,bool)", p0, p1, p2, p3)); } function log(uint p0, bool p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,string,address)", p0, p1, p2, p3)); } function log(uint p0, bool p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool,uint)", p0, p1, p2, p3)); } function log(uint p0, bool p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool,string)", p0, p1, p2, p3)); } function log(uint p0, bool p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool,bool)", p0, p1, p2, p3)); } function log(uint p0, bool p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,bool,address)", p0, p1, p2, p3)); } function log(uint p0, bool p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address,uint)", p0, p1, p2, p3)); } function log(uint p0, bool p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address,string)", p0, p1, p2, p3)); } function log(uint p0, bool p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address,bool)", p0, p1, p2, p3)); } function log(uint p0, bool p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,bool,address,address)", p0, p1, p2, p3)); } function log(uint p0, address p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint,uint)", p0, p1, p2, p3)); } function log(uint p0, address p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint,string)", p0, p1, p2, p3)); } function log(uint p0, address p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint,bool)", p0, p1, p2, p3)); } function log(uint p0, address p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,uint,address)", p0, p1, p2, p3)); } function log(uint p0, address p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,string,uint)", p0, p1, p2, p3)); } function log(uint p0, address p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,string,string)", p0, p1, p2, p3)); } function log(uint p0, address p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,string,bool)", p0, p1, p2, p3)); } function log(uint p0, address p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,string,address)", p0, p1, p2, p3)); } function log(uint p0, address p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool,uint)", p0, p1, p2, p3)); } function log(uint p0, address p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool,string)", p0, p1, p2, p3)); } function log(uint p0, address p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool,bool)", p0, p1, p2, p3)); } function log(uint p0, address p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,bool,address)", p0, p1, p2, p3)); } function log(uint p0, address p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,address,uint)", p0, p1, p2, p3)); } function log(uint p0, address p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,address,string)", p0, p1, p2, p3)); } function log(uint p0, address p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,address,bool)", p0, p1, p2, p3)); } function log(uint p0, address p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(uint,address,address,address)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint,uint)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint,string)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint,bool)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,uint,address)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,string,uint)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,string,string)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,string,bool)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,string,address)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool,uint)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool,string)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool,bool)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,bool,address)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,address,uint)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,address,string)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,address,bool)", p0, p1, p2, p3)); } function log(string memory p0, uint p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,uint,address,address)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,uint,uint)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,uint,string)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,uint,bool)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,uint,address)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,string,uint)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,string,string)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,string,bool)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,string,address)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,bool,uint)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,bool,string)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,bool,bool)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,bool,address)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,address,uint)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,address,string)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,address,bool)", p0, p1, p2, p3)); } function log(string memory p0, string memory p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,string,address,address)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint,uint)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint,string)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint,bool)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,uint,address)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,string,uint)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,string,string)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,string,bool)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,string,address)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool,uint)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool,string)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool,bool)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,bool,address)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,address,uint)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,address,string)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,address,bool)", p0, p1, p2, p3)); } function log(string memory p0, bool p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,bool,address,address)", p0, p1, p2, p3)); } function log(string memory p0, address p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,uint,uint)", p0, p1, p2, p3)); } function log(string memory p0, address p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,uint,string)", p0, p1, p2, p3)); } function log(string memory p0, address p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,uint,bool)", p0, p1, p2, p3)); } function log(string memory p0, address p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,uint,address)", p0, p1, p2, p3)); } function log(string memory p0, address p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,string,uint)", p0, p1, p2, p3)); } function log(string memory p0, address p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,string,string)", p0, p1, p2, p3)); } function log(string memory p0, address p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,string,bool)", p0, p1, p2, p3)); } function log(string memory p0, address p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,string,address)", p0, p1, p2, p3)); } function log(string memory p0, address p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,bool,uint)", p0, p1, p2, p3)); } function log(string memory p0, address p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,bool,string)", p0, p1, p2, p3)); } function log(string memory p0, address p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,bool,bool)", p0, p1, p2, p3)); } function log(string memory p0, address p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,bool,address)", p0, p1, p2, p3)); } function log(string memory p0, address p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,address,uint)", p0, p1, p2, p3)); } function log(string memory p0, address p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,address,string)", p0, p1, p2, p3)); } function log(string memory p0, address p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,address,bool)", p0, p1, p2, p3)); } function log(string memory p0, address p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(string,address,address,address)", p0, p1, p2, p3)); } function log(bool p0, uint p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint,uint)", p0, p1, p2, p3)); } function log(bool p0, uint p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint,string)", p0, p1, p2, p3)); } function log(bool p0, uint p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint,bool)", p0, p1, p2, p3)); } function log(bool p0, uint p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,uint,address)", p0, p1, p2, p3)); } function log(bool p0, uint p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string,uint)", p0, p1, p2, p3)); } function log(bool p0, uint p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string,string)", p0, p1, p2, p3)); } function log(bool p0, uint p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string,bool)", p0, p1, p2, p3)); } function log(bool p0, uint p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,string,address)", p0, p1, p2, p3)); } function log(bool p0, uint p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool,uint)", p0, p1, p2, p3)); } function log(bool p0, uint p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool,string)", p0, p1, p2, p3)); } function log(bool p0, uint p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool,bool)", p0, p1, p2, p3)); } function log(bool p0, uint p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,bool,address)", p0, p1, p2, p3)); } function log(bool p0, uint p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address,uint)", p0, p1, p2, p3)); } function log(bool p0, uint p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address,string)", p0, p1, p2, p3)); } function log(bool p0, uint p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address,bool)", p0, p1, p2, p3)); } function log(bool p0, uint p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,uint,address,address)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint,uint)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint,string)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint,bool)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,uint,address)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,string,uint)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,string,string)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,string,bool)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,string,address)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool,uint)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool,string)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool,bool)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,bool,address)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,address,uint)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,address,string)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,address,bool)", p0, p1, p2, p3)); } function log(bool p0, string memory p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,string,address,address)", p0, p1, p2, p3)); } function log(bool p0, bool p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint,uint)", p0, p1, p2, p3)); } function log(bool p0, bool p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint,string)", p0, p1, p2, p3)); } function log(bool p0, bool p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint,bool)", p0, p1, p2, p3)); } function log(bool p0, bool p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,uint,address)", p0, p1, p2, p3)); } function log(bool p0, bool p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string,uint)", p0, p1, p2, p3)); } function log(bool p0, bool p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string,string)", p0, p1, p2, p3)); } function log(bool p0, bool p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string,bool)", p0, p1, p2, p3)); } function log(bool p0, bool p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,string,address)", p0, p1, p2, p3)); } function log(bool p0, bool p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool,uint)", p0, p1, p2, p3)); } function log(bool p0, bool p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool,string)", p0, p1, p2, p3)); } function log(bool p0, bool p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool,bool)", p0, p1, p2, p3)); } function log(bool p0, bool p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,bool,address)", p0, p1, p2, p3)); } function log(bool p0, bool p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address,uint)", p0, p1, p2, p3)); } function log(bool p0, bool p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address,string)", p0, p1, p2, p3)); } function log(bool p0, bool p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address,bool)", p0, p1, p2, p3)); } function log(bool p0, bool p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,bool,address,address)", p0, p1, p2, p3)); } function log(bool p0, address p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint,uint)", p0, p1, p2, p3)); } function log(bool p0, address p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint,string)", p0, p1, p2, p3)); } function log(bool p0, address p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint,bool)", p0, p1, p2, p3)); } function log(bool p0, address p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,uint,address)", p0, p1, p2, p3)); } function log(bool p0, address p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,string,uint)", p0, p1, p2, p3)); } function log(bool p0, address p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,string,string)", p0, p1, p2, p3)); } function log(bool p0, address p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,string,bool)", p0, p1, p2, p3)); } function log(bool p0, address p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,string,address)", p0, p1, p2, p3)); } function log(bool p0, address p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool,uint)", p0, p1, p2, p3)); } function log(bool p0, address p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool,string)", p0, p1, p2, p3)); } function log(bool p0, address p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool,bool)", p0, p1, p2, p3)); } function log(bool p0, address p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,bool,address)", p0, p1, p2, p3)); } function log(bool p0, address p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,address,uint)", p0, p1, p2, p3)); } function log(bool p0, address p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,address,string)", p0, p1, p2, p3)); } function log(bool p0, address p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,address,bool)", p0, p1, p2, p3)); } function log(bool p0, address p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(bool,address,address,address)", p0, p1, p2, p3)); } function log(address p0, uint p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint,uint)", p0, p1, p2, p3)); } function log(address p0, uint p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint,string)", p0, p1, p2, p3)); } function log(address p0, uint p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint,bool)", p0, p1, p2, p3)); } function log(address p0, uint p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,uint,address)", p0, p1, p2, p3)); } function log(address p0, uint p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,string,uint)", p0, p1, p2, p3)); } function log(address p0, uint p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,string,string)", p0, p1, p2, p3)); } function log(address p0, uint p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,string,bool)", p0, p1, p2, p3)); } function log(address p0, uint p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,string,address)", p0, p1, p2, p3)); } function log(address p0, uint p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool,uint)", p0, p1, p2, p3)); } function log(address p0, uint p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool,string)", p0, p1, p2, p3)); } function log(address p0, uint p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool,bool)", p0, p1, p2, p3)); } function log(address p0, uint p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,bool,address)", p0, p1, p2, p3)); } function log(address p0, uint p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,address,uint)", p0, p1, p2, p3)); } function log(address p0, uint p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,address,string)", p0, p1, p2, p3)); } function log(address p0, uint p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,address,bool)", p0, p1, p2, p3)); } function log(address p0, uint p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,uint,address,address)", p0, p1, p2, p3)); } function log(address p0, string memory p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,uint,uint)", p0, p1, p2, p3)); } function log(address p0, string memory p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,uint,string)", p0, p1, p2, p3)); } function log(address p0, string memory p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,uint,bool)", p0, p1, p2, p3)); } function log(address p0, string memory p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,uint,address)", p0, p1, p2, p3)); } function log(address p0, string memory p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,string,uint)", p0, p1, p2, p3)); } function log(address p0, string memory p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,string,string)", p0, p1, p2, p3)); } function log(address p0, string memory p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,string,bool)", p0, p1, p2, p3)); } function log(address p0, string memory p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,string,address)", p0, p1, p2, p3)); } function log(address p0, string memory p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,bool,uint)", p0, p1, p2, p3)); } function log(address p0, string memory p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,bool,string)", p0, p1, p2, p3)); } function log(address p0, string memory p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,bool,bool)", p0, p1, p2, p3)); } function log(address p0, string memory p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,bool,address)", p0, p1, p2, p3)); } function log(address p0, string memory p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,address,uint)", p0, p1, p2, p3)); } function log(address p0, string memory p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,address,string)", p0, p1, p2, p3)); } function log(address p0, string memory p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,address,bool)", p0, p1, p2, p3)); } function log(address p0, string memory p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,string,address,address)", p0, p1, p2, p3)); } function log(address p0, bool p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint,uint)", p0, p1, p2, p3)); } function log(address p0, bool p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint,string)", p0, p1, p2, p3)); } function log(address p0, bool p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint,bool)", p0, p1, p2, p3)); } function log(address p0, bool p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,uint,address)", p0, p1, p2, p3)); } function log(address p0, bool p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,string,uint)", p0, p1, p2, p3)); } function log(address p0, bool p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,string,string)", p0, p1, p2, p3)); } function log(address p0, bool p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,string,bool)", p0, p1, p2, p3)); } function log(address p0, bool p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,string,address)", p0, p1, p2, p3)); } function log(address p0, bool p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool,uint)", p0, p1, p2, p3)); } function log(address p0, bool p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool,string)", p0, p1, p2, p3)); } function log(address p0, bool p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool,bool)", p0, p1, p2, p3)); } function log(address p0, bool p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,bool,address)", p0, p1, p2, p3)); } function log(address p0, bool p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,address,uint)", p0, p1, p2, p3)); } function log(address p0, bool p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,address,string)", p0, p1, p2, p3)); } function log(address p0, bool p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,address,bool)", p0, p1, p2, p3)); } function log(address p0, bool p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,bool,address,address)", p0, p1, p2, p3)); } function log(address p0, address p1, uint p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,uint,uint)", p0, p1, p2, p3)); } function log(address p0, address p1, uint p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,uint,string)", p0, p1, p2, p3)); } function log(address p0, address p1, uint p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,uint,bool)", p0, p1, p2, p3)); } function log(address p0, address p1, uint p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,uint,address)", p0, p1, p2, p3)); } function log(address p0, address p1, string memory p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,string,uint)", p0, p1, p2, p3)); } function log(address p0, address p1, string memory p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,string,string)", p0, p1, p2, p3)); } function log(address p0, address p1, string memory p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,string,bool)", p0, p1, p2, p3)); } function log(address p0, address p1, string memory p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,string,address)", p0, p1, p2, p3)); } function log(address p0, address p1, bool p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,bool,uint)", p0, p1, p2, p3)); } function log(address p0, address p1, bool p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,bool,string)", p0, p1, p2, p3)); } function log(address p0, address p1, bool p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,bool,bool)", p0, p1, p2, p3)); } function log(address p0, address p1, bool p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,bool,address)", p0, p1, p2, p3)); } function log(address p0, address p1, address p2, uint p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,address,uint)", p0, p1, p2, p3)); } function log(address p0, address p1, address p2, string memory p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,address,string)", p0, p1, p2, p3)); } function log(address p0, address p1, address p2, bool p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,address,bool)", p0, p1, p2, p3)); } function log(address p0, address p1, address p2, address p3) internal view { _sendLogPayload(abi.encodeWithSignature("log(address,address,address,address)", p0, p1, p2, p3)); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./EnumerableSet.sol"; /** * @dev Library for managing an enumerable variant of Solidity's * https://solidity.readthedocs.io/en/latest/types.html#mapping-types[`mapping`] * type. * * Maps have the following properties: * * - Entries are added, removed, and checked for existence in constant time * (O(1)). * - Entries are enumerated in O(n). No guarantees are made on the ordering. * * ``` * contract Example { * // Add the library methods * using EnumerableMap for EnumerableMap.UintToAddressMap; * * // Declare a set state variable * EnumerableMap.UintToAddressMap private myMap; * } * ``` * * As of v3.0.0, only maps of type `uint256 -> address` (`UintToAddressMap`) are * supported. */ library EnumerableMap { using EnumerableSet for EnumerableSet.Bytes32Set; // To implement this library for multiple types with as little code // repetition as possible, we write it in terms of a generic Map type with // bytes32 keys and values. // The Map implementation uses private functions, and user-facing // implementations (such as Uint256ToAddressMap) are just wrappers around // the underlying Map. // This means that we can only create new EnumerableMaps for types that fit // in bytes32. struct Map { // Storage of keys EnumerableSet.Bytes32Set _keys; mapping(bytes32 => bytes32) _values; } /** * @dev Adds a key-value pair to a map, or updates the value for an existing * key. O(1). * * Returns true if the key was added to the map, that is if it was not * already present. */ function _set( Map storage map, bytes32 key, bytes32 value ) private returns (bool) { map._values[key] = value; return map._keys.add(key); } /** * @dev Removes a key-value pair from a map. O(1). * * Returns true if the key was removed from the map, that is if it was present. */ function _remove(Map storage map, bytes32 key) private returns (bool) { delete map._values[key]; return map._keys.remove(key); } /** * @dev Returns true if the key is in the map. O(1). */ function _contains(Map storage map, bytes32 key) private view returns (bool) { return map._keys.contains(key); } /** * @dev Returns the number of key-value pairs in the map. O(1). */ function _length(Map storage map) private view returns (uint256) { return map._keys.length(); } /** * @dev Returns the key-value pair stored at position `index` in the map. O(1). * * Note that there are no guarantees on the ordering of entries inside the * array, and it may change when more entries are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function _at(Map storage map, uint256 index) private view returns (bytes32, bytes32) { bytes32 key = map._keys.at(index); return (key, map._values[key]); } /** * @dev Tries to returns the value associated with `key`. O(1). * Does not revert if `key` is not in the map. */ function _tryGet(Map storage map, bytes32 key) private view returns (bool, bytes32) { bytes32 value = map._values[key]; if (value == bytes32(0)) { return (_contains(map, key), bytes32(0)); } else { return (true, value); } } /** * @dev Returns the value associated with `key`. O(1). * * Requirements: * * - `key` must be in the map. */ function _get(Map storage map, bytes32 key) private view returns (bytes32) { bytes32 value = map._values[key]; require(value != 0 || _contains(map, key), "EnumerableMap: nonexistent key"); return value; } /** * @dev Same as {_get}, with a custom error message when `key` is not in the map. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {_tryGet}. */ function _get( Map storage map, bytes32 key, string memory errorMessage ) private view returns (bytes32) { bytes32 value = map._values[key]; require(value != 0 || _contains(map, key), errorMessage); return value; } // UintToAddressMap struct UintToAddressMap { Map _inner; } /** * @dev Adds a key-value pair to a map, or updates the value for an existing * key. O(1). * * Returns true if the key was added to the map, that is if it was not * already present. */ function set( UintToAddressMap storage map, uint256 key, address value ) internal returns (bool) { return _set(map._inner, bytes32(key), bytes32(uint256(uint160(value)))); } /** * @dev Removes a value from a set. O(1). * * Returns true if the key was removed from the map, that is if it was present. */ function remove(UintToAddressMap storage map, uint256 key) internal returns (bool) { return _remove(map._inner, bytes32(key)); } /** * @dev Returns true if the key is in the map. O(1). */ function contains(UintToAddressMap storage map, uint256 key) internal view returns (bool) { return _contains(map._inner, bytes32(key)); } /** * @dev Returns the number of elements in the map. O(1). */ function length(UintToAddressMap storage map) internal view returns (uint256) { return _length(map._inner); } /** * @dev Returns the element stored at position `index` in the set. O(1). * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(UintToAddressMap storage map, uint256 index) internal view returns (uint256, address) { (bytes32 key, bytes32 value) = _at(map._inner, index); return (uint256(key), address(uint160(uint256(value)))); } /** * @dev Tries to returns the value associated with `key`. O(1). * Does not revert if `key` is not in the map. * * _Available since v3.4._ */ function tryGet(UintToAddressMap storage map, uint256 key) internal view returns (bool, address) { (bool success, bytes32 value) = _tryGet(map._inner, bytes32(key)); return (success, address(uint160(uint256(value)))); } /** * @dev Returns the value associated with `key`. O(1). * * Requirements: * * - `key` must be in the map. */ function get(UintToAddressMap storage map, uint256 key) internal view returns (address) { return address(uint160(uint256(_get(map._inner, bytes32(key))))); } /** * @dev Same as {get}, with a custom error message when `key` is not in the map. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {tryGet}. */ function get( UintToAddressMap storage map, uint256 key, string memory errorMessage ) internal view returns (address) { return address(uint160(uint256(_get(map._inner, bytes32(key), errorMessage)))); } }
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity ^0.8.4; import { MinimalForwarder } from '../../../@openzeppelin/contracts/metatx/MinimalForwarder.sol'; interface ISynthereumTrustedForwarder { /** * @notice Check if the execute function reverts or not */ function safeExecute( MinimalForwarder.ForwardRequest calldata req, bytes calldata signature ) external payable returns (bytes memory); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "../utils/cryptography/ECDSA.sol"; import "../utils/cryptography/draft-EIP712.sol"; /** * @dev Simple minimal forwarder to be used together with an ERC2771 compatible contract. See {ERC2771Context}. */ contract MinimalForwarder is EIP712 { using ECDSA for bytes32; struct ForwardRequest { address from; address to; uint256 value; uint256 gas; uint256 nonce; bytes data; } bytes32 private constant _TYPEHASH = keccak256("ForwardRequest(address from,address to,uint256 value,uint256 gas,uint256 nonce,bytes data)"); mapping(address => uint256) private _nonces; constructor() EIP712("MinimalForwarder", "0.0.1") {} function getNonce(address from) public view returns (uint256) { return _nonces[from]; } function verify(ForwardRequest calldata req, bytes calldata signature) public view returns (bool) { address signer = _hashTypedDataV4( keccak256(abi.encode(_TYPEHASH, req.from, req.to, req.value, req.gas, req.nonce, keccak256(req.data))) ).recover(signature); return _nonces[req.from] == req.nonce && signer == req.from; } function execute(ForwardRequest calldata req, bytes calldata signature) public payable returns (bool, bytes memory) { require(verify(req, signature), "MinimalForwarder: signature does not match request"); _nonces[req.from] = req.nonce + 1; (bool success, bytes memory returndata) = req.to.call{gas: req.gas, value: req.value}( abi.encodePacked(req.data, req.from) ); // Validate that the relayer has sent enough gas for the call. // See https://ronan.eth.link/blog/ethereum-gas-dangers/ assert(gasleft() > req.gas / 63); return (success, returndata); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations. * * These functions can be used to verify that a message was signed by the holder * of the private keys of a given address. */ library ECDSA { enum RecoverError { NoError, InvalidSignature, InvalidSignatureLength, InvalidSignatureS, InvalidSignatureV } function _throwError(RecoverError error) private pure { if (error == RecoverError.NoError) { return; // no error: do nothing } else if (error == RecoverError.InvalidSignature) { revert("ECDSA: invalid signature"); } else if (error == RecoverError.InvalidSignatureLength) { revert("ECDSA: invalid signature length"); } else if (error == RecoverError.InvalidSignatureS) { revert("ECDSA: invalid signature 's' value"); } else if (error == RecoverError.InvalidSignatureV) { revert("ECDSA: invalid signature 'v' value"); } } /** * @dev Returns the address that signed a hashed message (`hash`) with * `signature` or error string. This address can then be used for verification purposes. * * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures: * this function rejects them by requiring the `s` value to be in the lower * half order, and the `v` value to be either 27 or 28. * * IMPORTANT: `hash` _must_ be the result of a hash operation for the * verification to be secure: it is possible to craft signatures that * recover to arbitrary addresses for non-hashed data. A safe way to ensure * this is by receiving a hash of the original message (which may otherwise * be too long), and then calling {toEthSignedMessageHash} on it. * * Documentation for signature generation: * - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js] * - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers] * * _Available since v4.3._ */ function tryRecover(bytes32 hash, bytes memory signature) internal pure returns (address, RecoverError) { // Check the signature length // - case 65: r,s,v signature (standard) // - case 64: r,vs signature (cf https://eips.ethereum.org/EIPS/eip-2098) _Available since v4.1._ if (signature.length == 65) { bytes32 r; bytes32 s; uint8 v; // ecrecover takes the signature parameters, and the only way to get them // currently is to use assembly. assembly { r := mload(add(signature, 0x20)) s := mload(add(signature, 0x40)) v := byte(0, mload(add(signature, 0x60))) } return tryRecover(hash, v, r, s); } else if (signature.length == 64) { bytes32 r; bytes32 vs; // ecrecover takes the signature parameters, and the only way to get them // currently is to use assembly. assembly { r := mload(add(signature, 0x20)) vs := mload(add(signature, 0x40)) } return tryRecover(hash, r, vs); } else { return (address(0), RecoverError.InvalidSignatureLength); } } /** * @dev Returns the address that signed a hashed message (`hash`) with * `signature`. This address can then be used for verification purposes. * * The `ecrecover` EVM opcode allows for malleable (non-unique) signatures: * this function rejects them by requiring the `s` value to be in the lower * half order, and the `v` value to be either 27 or 28. * * IMPORTANT: `hash` _must_ be the result of a hash operation for the * verification to be secure: it is possible to craft signatures that * recover to arbitrary addresses for non-hashed data. A safe way to ensure * this is by receiving a hash of the original message (which may otherwise * be too long), and then calling {toEthSignedMessageHash} on it. */ function recover(bytes32 hash, bytes memory signature) internal pure returns (address) { (address recovered, RecoverError error) = tryRecover(hash, signature); _throwError(error); return recovered; } /** * @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately. * * See https://eips.ethereum.org/EIPS/eip-2098[EIP-2098 short signatures] * * _Available since v4.3._ */ function tryRecover( bytes32 hash, bytes32 r, bytes32 vs ) internal pure returns (address, RecoverError) { bytes32 s; uint8 v; assembly { s := and(vs, 0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff) v := add(shr(255, vs), 27) } return tryRecover(hash, v, r, s); } /** * @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately. * * _Available since v4.2._ */ function recover( bytes32 hash, bytes32 r, bytes32 vs ) internal pure returns (address) { (address recovered, RecoverError error) = tryRecover(hash, r, vs); _throwError(error); return recovered; } /** * @dev Overload of {ECDSA-tryRecover} that receives the `v`, * `r` and `s` signature fields separately. * * _Available since v4.3._ */ function tryRecover( bytes32 hash, uint8 v, bytes32 r, bytes32 s ) internal pure returns (address, RecoverError) { // EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature // unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines // the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most // signatures from current libraries generate a unique signature with an s-value in the lower half order. // // If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value // with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or // vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept // these malleable signatures as well. if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) { return (address(0), RecoverError.InvalidSignatureS); } if (v != 27 && v != 28) { return (address(0), RecoverError.InvalidSignatureV); } // If the signature is valid (and not malleable), return the signer address address signer = ecrecover(hash, v, r, s); if (signer == address(0)) { return (address(0), RecoverError.InvalidSignature); } return (signer, RecoverError.NoError); } /** * @dev Overload of {ECDSA-recover} that receives the `v`, * `r` and `s` signature fields separately. */ function recover( bytes32 hash, uint8 v, bytes32 r, bytes32 s ) internal pure returns (address) { (address recovered, RecoverError error) = tryRecover(hash, v, r, s); _throwError(error); return recovered; } /** * @dev Returns an Ethereum Signed Message, created from a `hash`. This * produces hash corresponding to the one signed with the * https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] * JSON-RPC method as part of EIP-191. * * See {recover}. */ function toEthSignedMessageHash(bytes32 hash) internal pure returns (bytes32) { // 32 is the length in bytes of hash, // enforced by the type signature above return keccak256(abi.encodePacked("\x19Ethereum Signed Message:\n32", hash)); } /** * @dev Returns an Ethereum Signed Typed Data, created from a * `domainSeparator` and a `structHash`. This produces hash corresponding * to the one signed with the * https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] * JSON-RPC method as part of EIP-712. * * See {recover}. */ function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32) { return keccak256(abi.encodePacked("\x19\x01", domainSeparator, structHash)); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./ECDSA.sol"; /** * @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 */ // Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to // invalidate the cached domain separator if the chain id changes. bytes32 private immutable _CACHED_DOMAIN_SEPARATOR; uint256 private immutable _CACHED_CHAIN_ID; 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) { bytes32 hashedName = keccak256(bytes(name)); bytes32 hashedVersion = keccak256(bytes(version)); bytes32 typeHash = keccak256( "EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)" ); _HASHED_NAME = hashedName; _HASHED_VERSION = hashedVersion; _CACHED_CHAIN_ID = block.chainid; _CACHED_DOMAIN_SEPARATOR = _buildDomainSeparator(typeHash, hashedName, hashedVersion); _TYPE_HASH = typeHash; } /** * @dev Returns the domain separator for the current chain. */ function _domainSeparatorV4() internal view returns (bytes32) { if (block.chainid == _CACHED_CHAIN_ID) { return _CACHED_DOMAIN_SEPARATOR; } else { return _buildDomainSeparator(_TYPE_HASH, _HASHED_NAME, _HASHED_VERSION); } } function _buildDomainSeparator( bytes32 typeHash, bytes32 nameHash, bytes32 versionHash ) private view returns (bytes32) { return keccak256(abi.encode(typeHash, nameHash, versionHash, block.chainid, 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 ECDSA.toTypedDataHash(_domainSeparatorV4(), structHash); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./draft-IERC20Permit.sol"; import "../ERC20.sol"; import "../../../utils/cryptography/draft-EIP712.sol"; import "../../../utils/cryptography/ECDSA.sol"; import "../../../utils/Counters.sol"; /** * @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 { using Counters for Counters.Counter; mapping(address => Counters.Counter) 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 { require(block.timestamp <= deadline, "ERC20Permit: expired deadline"); bytes32 structHash = keccak256(abi.encode(_PERMIT_TYPEHASH, owner, spender, value, _useNonce(owner), deadline)); bytes32 hash = _hashTypedDataV4(structHash); address signer = ECDSA.recover(hash, v, r, s); require(signer == owner, "ERC20Permit: invalid signature"); _approve(owner, spender, value); } /** * @dev See {IERC20Permit-nonces}. */ function nonces(address owner) public view virtual override returns (uint256) { return _nonces[owner].current(); } /** * @dev See {IERC20Permit-DOMAIN_SEPARATOR}. */ // solhint-disable-next-line func-name-mixedcase function DOMAIN_SEPARATOR() external view override returns (bytes32) { return _domainSeparatorV4(); } /** * @dev "Consume a nonce": return the current value and increment. * * _Available since v4.1._ */ function _useNonce(address owner) internal virtual returns (uint256 current) { Counters.Counter storage nonce = _nonces[owner]; current = nonce.current(); nonce.increment(); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't * need to send a transaction, and thus is not required to hold Ether at all. */ interface IERC20Permit { /** * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens, * given ``owner``'s signed approval. * * IMPORTANT: The same issues {IERC20-approve} has related to transaction * ordering also apply here. * * Emits an {Approval} event. * * Requirements: * * - `spender` cannot be the zero address. * - `deadline` must be a timestamp in the future. * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner` * over the EIP712-formatted function arguments. * - the signature must use ``owner``'s current nonce (see {nonces}). * * For more information on the signature format, see the * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP * section]. */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external; /** * @dev Returns the current nonce for `owner`. This value must be * included whenever a signature is generated for {permit}. * * Every successful call to {permit} increases ``owner``'s nonce by one. This * prevents a signature from being used multiple times. */ function nonces(address owner) external view returns (uint256); /** * @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}. */ // solhint-disable-next-line func-name-mixedcase function DOMAIN_SEPARATOR() external view returns (bytes32); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @title Counters * @author Matt Condon (@shrugs) * @dev Provides counters that can only be incremented, decremented or reset. This can be used e.g. to track the number * of elements in a mapping, issuing ERC721 ids, or counting request ids. * * Include with `using Counters for Counters.Counter;` */ library Counters { struct Counter { // This variable should never be directly accessed by users of the library: interactions must be restricted to // the library's function. As of Solidity v0.5.2, this cannot be enforced, though there is a proposal to add // this feature: see https://github.com/ethereum/solidity/issues/4637 uint256 _value; // default: 0 } function current(Counter storage counter) internal view returns (uint256) { return counter._value; } function increment(Counter storage counter) internal { unchecked { counter._value += 1; } } function decrement(Counter storage counter) internal { uint256 value = counter._value; require(value > 0, "Counter: decrement overflow"); unchecked { counter._value = value - 1; } } function reset(Counter storage counter) internal { counter._value = 0; } }
{ "optimizer": { "enabled": true, "runs": 200 }, "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "devdoc", "userdoc", "metadata", "abi" ] } }, "libraries": {} }
Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
[{"inputs":[{"components":[{"internalType":"contract ISynthereumFinder","name":"finder","type":"address"},{"internalType":"uint8","name":"version","type":"uint8"},{"internalType":"contract IStandardERC20","name":"pegCollateralToken","type":"address"},{"internalType":"contract IMintableBurnableERC20","name":"fixedRateToken","type":"address"},{"components":[{"internalType":"address","name":"admin","type":"address"},{"internalType":"address","name":"maintainer","type":"address"}],"internalType":"struct ISynthereumFixedRateWrapper.Roles","name":"roles","type":"tuple"},{"internalType":"uint256","name":"rate","type":"uint256"}],"internalType":"struct SynthereumFixedRateWrapper.ConstructorParams","name":"params","type":"tuple"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[],"name":"ContractPaused","type":"event"},{"anonymous":false,"inputs":[],"name":"ContractResumed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"previousAdminRole","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"newAdminRole","type":"bytes32"}],"name":"RoleAdminChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"sender","type":"address"}],"name":"RoleGranted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"role","type":"bytes32"},{"indexed":true,"internalType":"address","name":"account","type":"address"},{"indexed":true,"internalType":"address","name":"sender","type":"address"}],"name":"RoleRevoked","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"amountCollateral","type":"uint256"},{"indexed":false,"internalType":"address","name":"recipient","type":"address"}],"name":"Unwrap","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"amountTokens","type":"uint256"},{"indexed":false,"internalType":"address","name":"recipient","type":"address"}],"name":"Wrap","type":"event"},{"inputs":[],"name":"DEFAULT_ADMIN_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAINTAINER_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"PRECISION","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"collateralToken","outputs":[{"internalType":"contract IERC20","name":"collateralCurrency","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"conversionRate","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"}],"name":"getRoleAdmin","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"uint256","name":"index","type":"uint256"}],"name":"getRoleMember","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"}],"name":"getRoleMemberCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"grantRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"hasRole","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"isPaused","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"forwarder","type":"address"}],"name":"isTrustedForwarder","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pauseContract","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"renounceRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"resumeContract","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"revokeRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"synthereumFinder","outputs":[{"internalType":"contract ISynthereumFinder","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"syntheticToken","outputs":[{"internalType":"contract IERC20","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"syntheticTokenSymbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalPegCollateral","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSyntheticTokensMinted","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"typology","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_tokenAmount","type":"uint256"},{"internalType":"address","name":"_recipient","type":"address"}],"name":"unwrap","outputs":[{"internalType":"uint256","name":"amountCollateral","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"version","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_collateral","type":"uint256"},{"internalType":"address","name":"_recipient","type":"address"}],"name":"wrap","outputs":[{"internalType":"uint256","name":"amountTokens","type":"uint256"}],"stateMutability":"nonpayable","type":"function"}]
Contract Creation Code
6101006040523480156200001257600080fd5b506040516200224138038062002241833981016040819052620000359162000606565b600160025562000049565b60405180910390fd5b60028081905550601281604001516001600160a01b031663313ce5676040518163ffffffff1660e01b815260040160206040518083038186803b1580156200009057600080fd5b505afa158015620000a5573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620000cb9190620006ce565b60ff1611156200012a5760405162461bcd60e51b8152602060048201526024808201527f436f6c6c61746572616c20686173206d6f7265207468616e20313820646563696044820152636d616c7360e01b606482015260840162000040565b80606001516001600160a01b031663313ce5676040518163ffffffff1660e01b815260040160206040518083038186803b1580156200016857600080fd5b505afa1580156200017d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620001a39190620006ce565b60ff16601214620002115760405162461bcd60e51b815260206004820152603160248201527f46697865645261746520746f6b656e20686173206d6f7265206f72206c657373604482015270207468616e20313820646563696d616c7360781b606482015260840162000040565b60a0818101516080526040820151606090811b6001600160601b031990811660c0528184015190911b169052602081015160f81b7fff000000000000000000000000000000000000000000000000000000000000001660e0528051600380546001600160a01b0319166001600160a01b0390921691909117905562000298600080620002fd565b620002b4600080516020620022218339815191526000620002fd565b608081015151620002c89060009062000348565b620002f1600080516020620022218339815191528260800151602001516200034860201b60201c565b5060016002556200076c565b600082815260208190526040808220600101805490849055905190918391839186917fbd79b86ffe0ab8e8776151514217cd7cacd52c909f66475c3af44e129f0b00ff9190a4505050565b6200035f82826200038b60201b62000eeb1760201c565b60008281526001602090815260409091206200038691839062000ef96200039b821b17901c565b505050565b620003978282620003bb565b5050565b6000620003b2836001600160a01b0384166200045d565b90505b92915050565b6000828152602081815260408083206001600160a01b038516845290915290205460ff1662000397576000828152602081815260408083206001600160a01b03851684529091529020805460ff1916600117905562000419620004af565b6001600160a01b0316816001600160a01b0316837f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a45050565b6000818152600183016020526040812054620004a657508154600181810184556000848152602080822090930184905584548482528286019093526040902091909155620003b5565b506000620003b5565b6000620004c6620004cb60201b62000f0e1760201c565b905090565b6000620004d83362000500565b15620004eb575060131936013560601c90565b620004c6620005ca60201b62000f301760201c565b6003546040516302abf57960e61b81526f2a393ab9ba32b22337b93bb0b93232b960811b60048201526000916001600160a01b03169063aafd5e409060240160206040518083038186803b1580156200055857600080fd5b505afa9250505080156200058b575060408051601f3d908101601f191682019092526200058891810190620005e0565b60015b6200059857506000919050565b806001600160a01b0316836001600160a01b03161415620005bc5750600192915050565b50600092915050565b919050565b3390565b805160ff81168114620005c557600080fd5b600060208284031215620005f2578081fd5b8151620005ff8162000753565b9392505050565b600081830360e081121562000619578182fd5b62000623620006eb565b8351620006308162000753565b81526200064060208501620005ce565b60208201526040840151620006558162000753565b604082015260608401516200066a8162000753565b60608201526040607f198301121562000681578283fd5b6200068b62000722565b915060808401516200069d8162000753565b825260a0840151620006af8162000753565b6020830152608081019190915260c0929092015160a083015250919050565b600060208284031215620006e0578081fd5b620003b282620005ce565b60405160c081016001600160401b03811182821017156200071c57634e487b7160e01b600052604160045260246000fd5b60405290565b604080519081016001600160401b03811182821017156200071c57634e487b7160e01b600052604160045260246000fd5b6001600160a01b03811681146200076957600080fd5b50565b60805160a05160601c60c05160601c60e05160f81c611a33620007ee6000396000610253015260008181610355015281816104e5015281816105cd0152610d1a0152600081816102d3015281816106e3015281816107fa01528181610a6401528181610b580152610c650152600081816102ad01526105ac0152611a336000f3fe608060405234801561001057600080fd5b506004361061018e5760003560e01c80638230ecd6116100de578063b2016bd411610097578063d547741f11610071578063d547741f14610394578063e7ce2361146103a7578063f6bf3ef6146103d0578063f8742254146103e157600080fd5b8063b2016bd414610353578063c4bc5da514610379578063ca15c8731461038157600080fd5b80638230ecd6146102d15780639010d07c1461030b57806391d148541461031e578063a217fddf14610331578063aaf5eb6814610339578063b187bd261461034857600080fd5b806336815bb71161014b578063572b6c0511610125578063572b6c051461027d5780636340f2b2146102905780637647691d146102985780637ffdf53e146102ab57600080fd5b806336815bb71461022f578063439766ce1461024457806354fd4d501461024c57600080fd5b806301ffc9a71461019357806313bac820146101bb578063248a9ca3146101dc5780632b7e47a4146101ff5780632f2ff15d1461020757806336568abe1461021c575b600080fd5b6101a66101a136600461162f565b610408565b60405190151581526020015b60405180910390f35b6101ce6101c9366004611718565b610433565b6040519081526020016101b2565b6101ce6101ea3660046115c7565b60009081526020819052604090206001015490565b6005546101ce565b61021a6102153660046115df565b6107ad565b005b61021a61022a3660046115df565b6107d4565b6102376107f6565b6040516101b291906117c0565b61021a610892565b60405160ff7f00000000000000000000000000000000000000000000000000000000000000001681526020016101b2565b6101a661028b36600461156f565b610942565b6004546101ce565b6101ce6102a6366004611718565b610a01565b7f00000000000000000000000000000000000000000000000000000000000000006101ce565b7f00000000000000000000000000000000000000000000000000000000000000005b6040516001600160a01b0390911681526020016101b2565b6102f361031936600461160e565b610dd5565b6101a661032c3660046115df565b610df4565b6101ce600081565b6101ce670de0b6b3a764000081565b60065460ff166101a6565b7f00000000000000000000000000000000000000000000000000000000000000006102f3565b61021a610e1d565b6101ce61038f3660046115c7565b610eca565b61021a6103a23660046115df565b610ee1565b6102376040518060400160405280600a81526020016946495845445f5241544560b01b81525081565b6003546001600160a01b03166102f3565b6101ce7f126303c860ea810f85e857ad8768056e2eebc24b7796655ff3107e4af18e3f1e81565b60006001600160e01b03198216635a05180f60e01b148061042d575061042d82610f34565b92915050565b600060028054141561048c5760405162461bcd60e51b815260206004820152601f60248201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c0060448201526064015b60405180910390fd5b6002805560065460ff16156104e35760405162461bcd60e51b815260206004820152601860248201527f436f6e747261637420686173206265656e2070617573656400000000000000006044820152606401610483565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166323b872dd61051a610f69565b6040516001600160e01b031960e084901b1681526001600160a01b03909116600482015230602482015260448101869052606401602060405180830381600087803b15801561056857600080fd5b505af115801561057c573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105a091906115a7565b50670de0b6b3a76400007f00000000000000000000000000000000000000000000000000000000000000007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663313ce5676040518163ffffffff1660e01b815260040160206040518083038186803b15801561062457600080fd5b505afa158015610638573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061065c919061172a565b61066790601261194f565b61067290600a61186e565b61067c9086611919565b6106869190611919565b610690919061180b565b9050826004546106a091906117f3565b60048190555080600560008282546106b891906117f3565b90915550506040516340c10f1960e01b81526001600160a01b038381166004830152602482018390527f000000000000000000000000000000000000000000000000000000000000000016906340c10f1990604401602060405180830381600087803b15801561072757600080fd5b505af115801561073b573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061075f91906115a7565b50604080518281526001600160a01b03841660208201527f2cb58623e27d6c011ddecc98abb0b9d4f8b0158ca972030636701d45c8f2120691015b60405180910390a1600160025592915050565b6107b78282610f73565b60008281526001602052604090206107cf9082610ef9565b505050565b6107de8282610fa0565b60008281526001602052604090206107cf908261102a565b60607f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166395d89b416040518163ffffffff1660e01b815260040160006040518083038186803b15801561085157600080fd5b505afa158015610865573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f1916820160405261088d9190810190611657565b905090565b6108be7f126303c860ea810f85e857ad8768056e2eebc24b7796655ff3107e4af18e3f1e61032c610f69565b61090a5760405162461bcd60e51b815260206004820152601d60248201527f53656e646572206d75737420626520746865206d61696e7461696e65720000006044820152606401610483565b6006805460ff191660011790556040517fab35696f06e428ebc5ceba8cd17f8fed287baf43440206d1943af1ee53e6d26790600090a1565b6003546040516302abf57960e61b81526f2a393ab9ba32b22337b93bb0b93232b960811b60048201526000916001600160a01b03169063aafd5e409060240160206040518083038186803b15801561099957600080fd5b505afa9250505080156109c9575060408051601f3d908101601f191682019092526109c69181019061158b565b60015b6109d557506000919050565b806001600160a01b0316836001600160a01b031614156109f85750600192915050565b50600092915050565b6000600280541415610a555760405162461bcd60e51b815260206004820152601f60248201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c006044820152606401610483565b60028055826001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000166370a08231610a91610f69565b6040516001600160e01b031960e084901b1681526001600160a01b03909116600482015260240160206040518083038186803b158015610ad057600080fd5b505afa158015610ae4573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610b089190611700565b1015610b565760405162461bcd60e51b815260206004820152601c60248201527f4e6f7420656e6f7567687420746f6b656e7320746f20756e77726170000000006044820152606401610483565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166323b872dd610b8d610f69565b6040516001600160e01b031960e084901b1681526001600160a01b03909116600482015230602482015260448101869052606401602060405180830381600087803b158015610bdb57600080fd5b505af1158015610bef573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c1391906115a7565b50600554670de0b6b3a764000090610c2b8286611919565b610c35919061180b565b600454610c429190611919565b610c4c919061180b565b604051630852cd8d60e31b8152600481018590529091507f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316906342966c6890602401600060405180830381600087803b158015610cb157600080fd5b505af1158015610cc5573d6000803e3d6000fd5b5050505080600454610cd79190611938565b6004819055508260056000828254610cef9190611938565b909155505060405163a9059cbb60e01b81526001600160a01b038381166004830152602482018390527f0000000000000000000000000000000000000000000000000000000000000000169063a9059cbb90604401602060405180830381600087803b158015610d5e57600080fd5b505af1158015610d72573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d9691906115a7565b50604080518281526001600160a01b03841660208201527f847d35e0e1ceb4da9ff56e0cc0888b15ad7c4a7c16c13dca4bc7642defec8292910161079a565b6000828152600160205260408120610ded908361103f565b9392505050565b6000918252602082815260408084206001600160a01b0393909316845291905290205460ff1690565b610e497f126303c860ea810f85e857ad8768056e2eebc24b7796655ff3107e4af18e3f1e61032c610f69565b610e955760405162461bcd60e51b815260206004820152601d60248201527f53656e646572206d75737420626520746865206d61696e7461696e65720000006044820152606401610483565b6006805460ff191690556040517fab5f6dacf93a267a93a533de8a56370de8341bbd8102017307e7be375c3dda6a90600090a1565b600081815260016020526040812061042d9061104b565b6107de8282611055565b610ef5828261107d565b5050565b6000610ded836001600160a01b038416611102565b6000610f1933610942565b15610f2b575060131936013560601c90565b503390565b3390565b60006001600160e01b03198216637965db0b60e01b148061042d57506301ffc9a760e01b6001600160e01b031983161461042d565b600061088d610f0e565b600082815260208190526040902060010154610f9681610f91610f69565b611151565b6107cf838361107d565b610fa8610f69565b6001600160a01b0316816001600160a01b0316146110205760405162461bcd60e51b815260206004820152602f60248201527f416363657373436f6e74726f6c3a2063616e206f6e6c792072656e6f756e636560448201526e103937b632b9903337b91039b2b63360891b6064820152608401610483565b610ef582826111b5565b6000610ded836001600160a01b038416611238565b6000610ded8383611355565b600061042d825490565b60008281526020819052604090206001015461107381610f91610f69565b6107cf83836111b5565b6110878282610df4565b610ef5576000828152602081815260408083206001600160a01b03851684529091529020805460ff191660011790556110be610f69565b6001600160a01b0316816001600160a01b0316837f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a45050565b60008181526001830160205260408120546111495750815460018181018455600084815260208082209093018490558454848252828601909352604090209190915561042d565b50600061042d565b61115b8282610df4565b610ef557611173816001600160a01b0316601461138d565b61117e83602061138d565b60405160200161118f92919061174b565b60408051601f198184030181529082905262461bcd60e51b8252610483916004016117c0565b6111bf8282610df4565b15610ef5576000828152602081815260408083206001600160a01b03851684529091529020805460ff191690556111f4610f69565b6001600160a01b0316816001600160a01b0316837ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b60405160405180910390a45050565b6000818152600183016020526040812054801561134b57600061125c600183611938565b855490915060009061127090600190611938565b90508181146112f157600086600001828154811061129e57634e487b7160e01b600052603260045260246000fd5b90600052602060002001549050808760000184815481106112cf57634e487b7160e01b600052603260045260246000fd5b6000918252602080832090910192909255918252600188019052604090208390555b855486908061131057634e487b7160e01b600052603160045260246000fd5b60019003818190600052602060002001600090559055856001016000868152602001908152602001600020600090556001935050505061042d565b600091505061042d565b600082600001828154811061137a57634e487b7160e01b600052603260045260246000fd5b9060005260206000200154905092915050565b6060600061139c836002611919565b6113a79060026117f3565b67ffffffffffffffff8111156113cd57634e487b7160e01b600052604160045260246000fd5b6040519080825280601f01601f1916602001820160405280156113f7576020820181803683370190505b509050600360fc1b8160008151811061142057634e487b7160e01b600052603260045260246000fd5b60200101906001600160f81b031916908160001a905350600f60fb1b8160018151811061145d57634e487b7160e01b600052603260045260246000fd5b60200101906001600160f81b031916908160001a9053506000611481846002611919565b61148c9060016117f3565b90505b6001811115611520576f181899199a1a9b1b9c1cb0b131b232b360811b85600f16601081106114ce57634e487b7160e01b600052603260045260246000fd5b1a60f81b8282815181106114f257634e487b7160e01b600052603260045260246000fd5b60200101906001600160f81b031916908160001a90535060049490941c93611519816119a2565b905061148f565b508315610ded5760405162461bcd60e51b815260206004820181905260248201527f537472696e67733a20686578206c656e67746820696e73756666696369656e746044820152606401610483565b600060208284031215611580578081fd5b8135610ded816119e5565b60006020828403121561159c578081fd5b8151610ded816119e5565b6000602082840312156115b8578081fd5b81518015158114610ded578182fd5b6000602082840312156115d8578081fd5b5035919050565b600080604083850312156115f1578081fd5b823591506020830135611603816119e5565b809150509250929050565b60008060408385031215611620578182fd5b50508035926020909101359150565b600060208284031215611640578081fd5b81356001600160e01b031981168114610ded578182fd5b600060208284031215611668578081fd5b815167ffffffffffffffff8082111561167f578283fd5b818401915084601f830112611692578283fd5b8151818111156116a4576116a46119cf565b604051601f8201601f19908116603f011681019083821181831017156116cc576116cc6119cf565b816040528281528760208487010111156116e4578586fd5b6116f5836020830160208801611972565b979650505050505050565b600060208284031215611711578081fd5b5051919050565b600080604083850312156115f1578182fd5b60006020828403121561173b578081fd5b815160ff81168114610ded578182fd5b7f416363657373436f6e74726f6c3a206163636f756e7420000000000000000000815260008351611783816017850160208801611972565b7001034b99036b4b9b9b4b733903937b6329607d1b60179184019182015283516117b4816028840160208801611972565b01602801949350505050565b60208152600082518060208401526117df816040850160208701611972565b601f01601f19169190910160400192915050565b60008219821115611806576118066119b9565b500190565b60008261182657634e487b7160e01b81526012600452602481fd5b500490565b600181815b8085111561186657816000190482111561184c5761184c6119b9565b8085161561185957918102915b93841c9390800290611830565b509250929050565b6000610ded60ff8416836000826118875750600161042d565b816118945750600061042d565b81600181146118aa57600281146118b4576118d0565b600191505061042d565b60ff8411156118c5576118c56119b9565b50506001821b61042d565b5060208310610133831016604e8410600b84101617156118f3575081810a61042d565b6118fd838361182b565b8060001904821115611911576119116119b9565b029392505050565b6000816000190483118215151615611933576119336119b9565b500290565b60008282101561194a5761194a6119b9565b500390565b600060ff821660ff841680821015611969576119696119b9565b90039392505050565b60005b8381101561198d578181015183820152602001611975565b8381111561199c576000848401525b50505050565b6000816119b1576119b16119b9565b506000190190565b634e487b7160e01b600052601160045260246000fd5b634e487b7160e01b600052604160045260246000fd5b6001600160a01b03811681146119fa57600080fd5b5056fea26469706673582212201435666496254f57dd66eba7f786c24d93e36eab424aabfd4b7b27f101ddc0a664736f6c63430008040033126303c860ea810f85e857ad8768056e2eebc24b7796655ff3107e4af18e3f1e00000000000000000000000043a98e5c4a7f3b7f11080fc9d58b0b8a80ca954e000000000000000000000000000000000000000000000000000000000000000100000000000000000000000018ec0a6e18e5bc3784fdd3a3634b31245ab704f60000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c0000000000000000000000008a73fda882601c4b84b0c52d7d85e4ba46357ca1000000000000000000000000685723b9dc89bdf28ba5f98f9a8c0ac899bd6e770000000000000000000000000000000000000000000000000de0b6b3a7640000
Deployed Bytecode
0x608060405234801561001057600080fd5b506004361061018e5760003560e01c80638230ecd6116100de578063b2016bd411610097578063d547741f11610071578063d547741f14610394578063e7ce2361146103a7578063f6bf3ef6146103d0578063f8742254146103e157600080fd5b8063b2016bd414610353578063c4bc5da514610379578063ca15c8731461038157600080fd5b80638230ecd6146102d15780639010d07c1461030b57806391d148541461031e578063a217fddf14610331578063aaf5eb6814610339578063b187bd261461034857600080fd5b806336815bb71161014b578063572b6c0511610125578063572b6c051461027d5780636340f2b2146102905780637647691d146102985780637ffdf53e146102ab57600080fd5b806336815bb71461022f578063439766ce1461024457806354fd4d501461024c57600080fd5b806301ffc9a71461019357806313bac820146101bb578063248a9ca3146101dc5780632b7e47a4146101ff5780632f2ff15d1461020757806336568abe1461021c575b600080fd5b6101a66101a136600461162f565b610408565b60405190151581526020015b60405180910390f35b6101ce6101c9366004611718565b610433565b6040519081526020016101b2565b6101ce6101ea3660046115c7565b60009081526020819052604090206001015490565b6005546101ce565b61021a6102153660046115df565b6107ad565b005b61021a61022a3660046115df565b6107d4565b6102376107f6565b6040516101b291906117c0565b61021a610892565b60405160ff7f00000000000000000000000000000000000000000000000000000000000000011681526020016101b2565b6101a661028b36600461156f565b610942565b6004546101ce565b6101ce6102a6366004611718565b610a01565b7f0000000000000000000000000000000000000000000000000de0b6b3a76400006101ce565b7f0000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c5b6040516001600160a01b0390911681526020016101b2565b6102f361031936600461160e565b610dd5565b6101a661032c3660046115df565b610df4565b6101ce600081565b6101ce670de0b6b3a764000081565b60065460ff166101a6565b7f00000000000000000000000018ec0a6e18e5bc3784fdd3a3634b31245ab704f66102f3565b61021a610e1d565b6101ce61038f3660046115c7565b610eca565b61021a6103a23660046115df565b610ee1565b6102376040518060400160405280600a81526020016946495845445f5241544560b01b81525081565b6003546001600160a01b03166102f3565b6101ce7f126303c860ea810f85e857ad8768056e2eebc24b7796655ff3107e4af18e3f1e81565b60006001600160e01b03198216635a05180f60e01b148061042d575061042d82610f34565b92915050565b600060028054141561048c5760405162461bcd60e51b815260206004820152601f60248201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c0060448201526064015b60405180910390fd5b6002805560065460ff16156104e35760405162461bcd60e51b815260206004820152601860248201527f436f6e747261637420686173206265656e2070617573656400000000000000006044820152606401610483565b7f00000000000000000000000018ec0a6e18e5bc3784fdd3a3634b31245ab704f66001600160a01b03166323b872dd61051a610f69565b6040516001600160e01b031960e084901b1681526001600160a01b03909116600482015230602482015260448101869052606401602060405180830381600087803b15801561056857600080fd5b505af115801561057c573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105a091906115a7565b50670de0b6b3a76400007f0000000000000000000000000000000000000000000000000de0b6b3a76400007f00000000000000000000000018ec0a6e18e5bc3784fdd3a3634b31245ab704f66001600160a01b031663313ce5676040518163ffffffff1660e01b815260040160206040518083038186803b15801561062457600080fd5b505afa158015610638573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061065c919061172a565b61066790601261194f565b61067290600a61186e565b61067c9086611919565b6106869190611919565b610690919061180b565b9050826004546106a091906117f3565b60048190555080600560008282546106b891906117f3565b90915550506040516340c10f1960e01b81526001600160a01b038381166004830152602482018390527f0000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c16906340c10f1990604401602060405180830381600087803b15801561072757600080fd5b505af115801561073b573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061075f91906115a7565b50604080518281526001600160a01b03841660208201527f2cb58623e27d6c011ddecc98abb0b9d4f8b0158ca972030636701d45c8f2120691015b60405180910390a1600160025592915050565b6107b78282610f73565b60008281526001602052604090206107cf9082610ef9565b505050565b6107de8282610fa0565b60008281526001602052604090206107cf908261102a565b60607f0000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c6001600160a01b03166395d89b416040518163ffffffff1660e01b815260040160006040518083038186803b15801561085157600080fd5b505afa158015610865573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f1916820160405261088d9190810190611657565b905090565b6108be7f126303c860ea810f85e857ad8768056e2eebc24b7796655ff3107e4af18e3f1e61032c610f69565b61090a5760405162461bcd60e51b815260206004820152601d60248201527f53656e646572206d75737420626520746865206d61696e7461696e65720000006044820152606401610483565b6006805460ff191660011790556040517fab35696f06e428ebc5ceba8cd17f8fed287baf43440206d1943af1ee53e6d26790600090a1565b6003546040516302abf57960e61b81526f2a393ab9ba32b22337b93bb0b93232b960811b60048201526000916001600160a01b03169063aafd5e409060240160206040518083038186803b15801561099957600080fd5b505afa9250505080156109c9575060408051601f3d908101601f191682019092526109c69181019061158b565b60015b6109d557506000919050565b806001600160a01b0316836001600160a01b031614156109f85750600192915050565b50600092915050565b6000600280541415610a555760405162461bcd60e51b815260206004820152601f60248201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c006044820152606401610483565b60028055826001600160a01b037f0000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c166370a08231610a91610f69565b6040516001600160e01b031960e084901b1681526001600160a01b03909116600482015260240160206040518083038186803b158015610ad057600080fd5b505afa158015610ae4573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610b089190611700565b1015610b565760405162461bcd60e51b815260206004820152601c60248201527f4e6f7420656e6f7567687420746f6b656e7320746f20756e77726170000000006044820152606401610483565b7f0000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c6001600160a01b03166323b872dd610b8d610f69565b6040516001600160e01b031960e084901b1681526001600160a01b03909116600482015230602482015260448101869052606401602060405180830381600087803b158015610bdb57600080fd5b505af1158015610bef573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c1391906115a7565b50600554670de0b6b3a764000090610c2b8286611919565b610c35919061180b565b600454610c429190611919565b610c4c919061180b565b604051630852cd8d60e31b8152600481018590529091507f0000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c6001600160a01b0316906342966c6890602401600060405180830381600087803b158015610cb157600080fd5b505af1158015610cc5573d6000803e3d6000fd5b5050505080600454610cd79190611938565b6004819055508260056000828254610cef9190611938565b909155505060405163a9059cbb60e01b81526001600160a01b038381166004830152602482018390527f00000000000000000000000018ec0a6e18e5bc3784fdd3a3634b31245ab704f6169063a9059cbb90604401602060405180830381600087803b158015610d5e57600080fd5b505af1158015610d72573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d9691906115a7565b50604080518281526001600160a01b03841660208201527f847d35e0e1ceb4da9ff56e0cc0888b15ad7c4a7c16c13dca4bc7642defec8292910161079a565b6000828152600160205260408120610ded908361103f565b9392505050565b6000918252602082815260408084206001600160a01b0393909316845291905290205460ff1690565b610e497f126303c860ea810f85e857ad8768056e2eebc24b7796655ff3107e4af18e3f1e61032c610f69565b610e955760405162461bcd60e51b815260206004820152601d60248201527f53656e646572206d75737420626520746865206d61696e7461696e65720000006044820152606401610483565b6006805460ff191690556040517fab5f6dacf93a267a93a533de8a56370de8341bbd8102017307e7be375c3dda6a90600090a1565b600081815260016020526040812061042d9061104b565b6107de8282611055565b610ef5828261107d565b5050565b6000610ded836001600160a01b038416611102565b6000610f1933610942565b15610f2b575060131936013560601c90565b503390565b3390565b60006001600160e01b03198216637965db0b60e01b148061042d57506301ffc9a760e01b6001600160e01b031983161461042d565b600061088d610f0e565b600082815260208190526040902060010154610f9681610f91610f69565b611151565b6107cf838361107d565b610fa8610f69565b6001600160a01b0316816001600160a01b0316146110205760405162461bcd60e51b815260206004820152602f60248201527f416363657373436f6e74726f6c3a2063616e206f6e6c792072656e6f756e636560448201526e103937b632b9903337b91039b2b63360891b6064820152608401610483565b610ef582826111b5565b6000610ded836001600160a01b038416611238565b6000610ded8383611355565b600061042d825490565b60008281526020819052604090206001015461107381610f91610f69565b6107cf83836111b5565b6110878282610df4565b610ef5576000828152602081815260408083206001600160a01b03851684529091529020805460ff191660011790556110be610f69565b6001600160a01b0316816001600160a01b0316837f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a45050565b60008181526001830160205260408120546111495750815460018181018455600084815260208082209093018490558454848252828601909352604090209190915561042d565b50600061042d565b61115b8282610df4565b610ef557611173816001600160a01b0316601461138d565b61117e83602061138d565b60405160200161118f92919061174b565b60408051601f198184030181529082905262461bcd60e51b8252610483916004016117c0565b6111bf8282610df4565b15610ef5576000828152602081815260408083206001600160a01b03851684529091529020805460ff191690556111f4610f69565b6001600160a01b0316816001600160a01b0316837ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b60405160405180910390a45050565b6000818152600183016020526040812054801561134b57600061125c600183611938565b855490915060009061127090600190611938565b90508181146112f157600086600001828154811061129e57634e487b7160e01b600052603260045260246000fd5b90600052602060002001549050808760000184815481106112cf57634e487b7160e01b600052603260045260246000fd5b6000918252602080832090910192909255918252600188019052604090208390555b855486908061131057634e487b7160e01b600052603160045260246000fd5b60019003818190600052602060002001600090559055856001016000868152602001908152602001600020600090556001935050505061042d565b600091505061042d565b600082600001828154811061137a57634e487b7160e01b600052603260045260246000fd5b9060005260206000200154905092915050565b6060600061139c836002611919565b6113a79060026117f3565b67ffffffffffffffff8111156113cd57634e487b7160e01b600052604160045260246000fd5b6040519080825280601f01601f1916602001820160405280156113f7576020820181803683370190505b509050600360fc1b8160008151811061142057634e487b7160e01b600052603260045260246000fd5b60200101906001600160f81b031916908160001a905350600f60fb1b8160018151811061145d57634e487b7160e01b600052603260045260246000fd5b60200101906001600160f81b031916908160001a9053506000611481846002611919565b61148c9060016117f3565b90505b6001811115611520576f181899199a1a9b1b9c1cb0b131b232b360811b85600f16601081106114ce57634e487b7160e01b600052603260045260246000fd5b1a60f81b8282815181106114f257634e487b7160e01b600052603260045260246000fd5b60200101906001600160f81b031916908160001a90535060049490941c93611519816119a2565b905061148f565b508315610ded5760405162461bcd60e51b815260206004820181905260248201527f537472696e67733a20686578206c656e67746820696e73756666696369656e746044820152606401610483565b600060208284031215611580578081fd5b8135610ded816119e5565b60006020828403121561159c578081fd5b8151610ded816119e5565b6000602082840312156115b8578081fd5b81518015158114610ded578182fd5b6000602082840312156115d8578081fd5b5035919050565b600080604083850312156115f1578081fd5b823591506020830135611603816119e5565b809150509250929050565b60008060408385031215611620578182fd5b50508035926020909101359150565b600060208284031215611640578081fd5b81356001600160e01b031981168114610ded578182fd5b600060208284031215611668578081fd5b815167ffffffffffffffff8082111561167f578283fd5b818401915084601f830112611692578283fd5b8151818111156116a4576116a46119cf565b604051601f8201601f19908116603f011681019083821181831017156116cc576116cc6119cf565b816040528281528760208487010111156116e4578586fd5b6116f5836020830160208801611972565b979650505050505050565b600060208284031215611711578081fd5b5051919050565b600080604083850312156115f1578182fd5b60006020828403121561173b578081fd5b815160ff81168114610ded578182fd5b7f416363657373436f6e74726f6c3a206163636f756e7420000000000000000000815260008351611783816017850160208801611972565b7001034b99036b4b9b9b4b733903937b6329607d1b60179184019182015283516117b4816028840160208801611972565b01602801949350505050565b60208152600082518060208401526117df816040850160208701611972565b601f01601f19169190910160400192915050565b60008219821115611806576118066119b9565b500190565b60008261182657634e487b7160e01b81526012600452602481fd5b500490565b600181815b8085111561186657816000190482111561184c5761184c6119b9565b8085161561185957918102915b93841c9390800290611830565b509250929050565b6000610ded60ff8416836000826118875750600161042d565b816118945750600061042d565b81600181146118aa57600281146118b4576118d0565b600191505061042d565b60ff8411156118c5576118c56119b9565b50506001821b61042d565b5060208310610133831016604e8410600b84101617156118f3575081810a61042d565b6118fd838361182b565b8060001904821115611911576119116119b9565b029392505050565b6000816000190483118215151615611933576119336119b9565b500290565b60008282101561194a5761194a6119b9565b500390565b600060ff821660ff841680821015611969576119696119b9565b90039392505050565b60005b8381101561198d578181015183820152602001611975565b8381111561199c576000848401525b50505050565b6000816119b1576119b16119b9565b506000190190565b634e487b7160e01b600052601160045260246000fd5b634e487b7160e01b600052604160045260246000fd5b6001600160a01b03811681146119fa57600080fd5b5056fea26469706673582212201435666496254f57dd66eba7f786c24d93e36eab424aabfd4b7b27f101ddc0a664736f6c63430008040033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
00000000000000000000000043a98e5c4a7f3b7f11080fc9d58b0b8a80ca954e000000000000000000000000000000000000000000000000000000000000000100000000000000000000000018ec0a6e18e5bc3784fdd3a3634b31245ab704f60000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c0000000000000000000000008a73fda882601c4b84b0c52d7d85e4ba46357ca1000000000000000000000000685723b9dc89bdf28ba5f98f9a8c0ac899bd6e770000000000000000000000000000000000000000000000000de0b6b3a7640000
-----Decoded View---------------
Arg [0] : params (tuple): System.Collections.Generic.List`1[Nethereum.ABI.FunctionEncoding.ParameterOutput]
-----Encoded View---------------
7 Constructor Arguments found :
Arg [0] : 00000000000000000000000043a98e5c4a7f3b7f11080fc9d58b0b8a80ca954e
Arg [1] : 0000000000000000000000000000000000000000000000000000000000000001
Arg [2] : 00000000000000000000000018ec0a6e18e5bc3784fdd3a3634b31245ab704f6
Arg [3] : 0000000000000000000000004e3decbb3645551b8a19f0ea1678079fcb33fb4c
Arg [4] : 0000000000000000000000008a73fda882601c4b84b0c52d7d85e4ba46357ca1
Arg [5] : 000000000000000000000000685723b9dc89bdf28ba5f98f9a8c0ac899bd6e77
Arg [6] : 0000000000000000000000000000000000000000000000000de0b6b3a7640000
Loading...
Loading
Loading...
Loading
Multichain Portfolio | 29 Chains
Chain | Token | Portfolio % | Price | Amount | Value |
---|---|---|---|---|---|
POL | 100.00% | $1.06 | 1.0013 | $1.06 |
[ Download: CSV Export ]
[ Download: CSV Export ]
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.