Source Code
Overview
ETH Balance
0 ETH
Eth Value
$0.00View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Loading...
Loading
Loading...
Loading
Cross-Chain Transactions
Loading...
Loading
This contract may be a proxy contract. Click on More Options and select Is this a proxy? to confirm and enable the "Read as Proxy" & "Write as Proxy" tabs.
Contract Name:
TermRepoCollateralManager
Compiler Version
v0.8.18+commit.87f61d96
Optimization Enabled:
Yes with 50 runs
Other Settings:
default evmVersion
Contract Source Code (Solidity Standard Json-Input format)
//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./interfaces/ITermController.sol";
import "./interfaces/ITermEventEmitter.sol";
import "./interfaces/ITermRepoCollateralManager.sol";
import "./interfaces/ITermRepoCollateralManagerErrors.sol";
import "./interfaces/ITermRepoLocker.sol";
import "./interfaces/ITermRepoServicer.sol";
import "./interfaces/ITermRepoToken.sol";
import "./interfaces/ITermPriceOracle.sol";
import "./interfaces/ITermRepoRolloverManager.sol";
import "./lib/Collateral.sol";
import "./lib/ExponentialNoError.sol";
import "./lib/TermAuctionGroup.sol";
import "./TermPriceConsumerV3.sol";
import "./TermRepoLocker.sol";
import "./TermRepoServicer.sol";
import "./TermRepoToken.sol";
import "./lib/TermRepoRolloverElection.sol";
import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
/// @author TermLabs
/// @title Term Repo Collateral Manager
/// @notice This contract enforces margin maintenance rules for adding/withdrawing, repurchasing and liquidating collateral
/// @dev This contract belongs to the Term Servicer group of contracts and is specific to a Term Repo deployment
contract TermRepoCollateralManager is
ITermRepoCollateralManager,
ITermRepoCollateralManagerErrors,
Initializable,
UUPSUpgradeable,
AccessControlUpgradeable,
ExponentialNoError
{
// ========================================================================
// = Access Role =========================================================
// ========================================================================
bytes32 public constant AUCTION_LOCKER = keccak256("AUCTION_LOCKER");
bytes32 public constant SERVICER_ROLE = keccak256("SERVICER_ROLE");
bytes32 public constant ROLLOVER_MANAGER = keccak256("ROLLOVER_MANAGER");
bytes32 public constant ROLLOVER_TARGET_AUCTIONEER_ROLE =
keccak256("ROLLOVER_TARGET_AUCTIONEER_ROLE");
bytes32 public constant INITIALIZER_ROLE = keccak256("INITIALIZER_ROLE");
// ========================================================================
// = State Variables =====================================================
// ========================================================================
// Term Identifier
bytes32 public termRepoId;
// Boolean indicating if liquidations are paused
bool public liquidationsPaused;
// Boolean indicatting if term contracts paired
bool internal termContractPaired;
// Number of Collateral Tokens Accepted By Term
uint8 public numOfAcceptedCollateralTokens;
// De minimis margin threshold triggering full liquidation
uint256 public deMinimisMarginThreshold;
// Collateral Seizures Share for Protocol in Liquidations
uint256 public liquidateDamangesDueToProtocol;
//Max percentage collateralization of repurchase after liquidation
uint256 public netExposureCapOnLiquidation;
// Repo servicer within same term
ITermRepoServicer internal termRepoServicer;
// token used for purchase/loans
address public purchaseToken;
// consumer for Chainlink price feeds
ITermPriceOracle internal termPriceOracle;
// TermRepoLocker for term funds
ITermRepoLocker public termRepoLocker;
// Term Controller contract
ITermController internal termController;
// Term Event Emitter contract
ITermEventEmitter internal emitter;
//list of acceptable collateral token addresses
address[] public collateralTokens;
// mapping of encumbered collateral balances
mapping(address => uint256) internal encumberedCollateralBalances;
// maintenance collateral ratios applicable to accepted collateral token basket
mapping(address => uint256) public maintenanceCollateralRatios;
// initial collateral ratios applicable to accepted collateral token basket
mapping(address => uint256) public initialCollateralRatios;
// liquidated damages schedule applicable to collateral token basket
mapping(address => uint256) public liquidatedDamages;
// Locked Collateral Balance Ledger
// For each wallet address, keep ledger of collateral balances of different token addresses
mapping(address => mapping(address => uint256))
internal lockedCollateralLedger;
// ========================================================================
// = Modifiers ===========================================================
// ========================================================================
modifier isCollateralTokenAccepted(address token) {
if (!_isAcceptedCollateralToken(token)) {
revert CollateralTokenNotAllowed(token);
}
_;
}
modifier whileLiquidationsNotPaused() {
if (liquidationsPaused) {
revert LiquidationsPaused();
}
_;
}
modifier notTermContractPaired() {
if (termContractPaired) {
revert AlreadyTermContractPaired();
}
termContractPaired = true;
_;
}
// ========================================================================
// = Deploy ==============================================================
// ========================================================================
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
function initialize(
string calldata termRepoId_,
uint256 liquidateDamangesDueToProtocol_,
uint256 netExposureCapOnLiquidation_,
uint256 deMinimisMarginThreshold_,
address purchaseToken_,
Collateral[] calldata collateralTokens_,
ITermEventEmitter emitter_
) external initializer {
UUPSUpgradeable.__UUPSUpgradeable_init();
AccessControlUpgradeable.__AccessControl_init();
termRepoId = keccak256(abi.encodePacked(termRepoId_));
liquidationsPaused = false;
// slither-disable-start reentrancy-no-eth events-maths
liquidateDamangesDueToProtocol = liquidateDamangesDueToProtocol_;
netExposureCapOnLiquidation = netExposureCapOnLiquidation_;
deMinimisMarginThreshold = deMinimisMarginThreshold_;
// slither-disable-end reentrancy-no-eth events-maths
require(purchaseToken_ != address(0), "Zero address purchase token");
purchaseToken = purchaseToken_;
numOfAcceptedCollateralTokens = uint8(collateralTokens_.length);
collateralTokens = new address[](collateralTokens_.length);
for (uint256 i = 0; i < collateralTokens_.length; ++i) {
collateralTokens[i] = collateralTokens_[i].tokenAddress;
maintenanceCollateralRatios[
collateralTokens_[i].tokenAddress
] = collateralTokens_[i].maintenanceRatio;
initialCollateralRatios[
collateralTokens_[i].tokenAddress
] = collateralTokens_[i].initialCollateralRatio;
require(
collateralTokens_[i].liquidatedDamage != 0,
"Liquidated damage is zero"
);
liquidatedDamages[
collateralTokens_[i].tokenAddress
] = collateralTokens_[i].liquidatedDamage;
termContractPaired = false;
}
emitter = emitter_;
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(INITIALIZER_ROLE, msg.sender);
}
function pairTermContracts(
address termRepoLocker_,
address termRepoServicer_,
address termAuctionBidLocker_,
address termAuction_,
address termController_,
address termPriceOracle_,
address termRepoRolloverManager_
) external onlyRole(INITIALIZER_ROLE) notTermContractPaired {
termRepoLocker = TermRepoLocker(termRepoLocker_);
termRepoServicer = TermRepoServicer(termRepoServicer_);
termPriceOracle = TermPriceConsumerV3(termPriceOracle_);
termController = ITermController(termController_);
_grantRole(AUCTION_LOCKER, termAuctionBidLocker_);
_grantRole(AUCTION_LOCKER, termAuction_);
_grantRole(AUCTION_LOCKER, termRepoServicer_);
_grantRole(SERVICER_ROLE, termRepoServicer_);
_grantRole(ROLLOVER_MANAGER, termRepoRolloverManager_);
uint256[] memory maintenanceRatioList = new uint256[](
collateralTokens.length
);
uint256[] memory initialCollateralRatioList = new uint256[](
collateralTokens.length
);
uint256[] memory liquidatedDamagesList = new uint256[](
collateralTokens.length
);
for (uint256 i = 0; i < collateralTokens.length; ++i) {
maintenanceRatioList[i] = maintenanceCollateralRatios[
collateralTokens[i]
];
initialCollateralRatioList[i] = initialCollateralRatios[
collateralTokens[i]
];
liquidatedDamagesList[i] = liquidatedDamages[collateralTokens[i]];
}
emitter.emitTermRepoCollateralManagerInitialized(
termRepoId,
address(this),
collateralTokens,
initialCollateralRatioList,
maintenanceRatioList,
liquidatedDamagesList
);
}
// ========================================================================
// = APIs ================================================================
// ========================================================================
/// @param collateralToken The address of the collateral token to lock
/// @param amount The amount of collateral token to lock
function externalLockCollateral(
address collateralToken,
uint256 amount
) external isCollateralTokenAccepted(collateralToken) {
address borrower = msg.sender;
if (block.timestamp > termRepoServicer.endOfRepurchaseWindow()) {
revert CollateralDepositClosed();
}
if (termRepoServicer.getBorrowerRepurchaseObligation(borrower) == 0) {
revert ZeroBorrowerRepurchaseObligation();
}
_lockCollateral(borrower, collateralToken, amount);
}
/// @param collateralToken The address of the collateral token to unlock
/// @param amount The amount of collateral token to unlock
function externalUnlockCollateral(
address collateralToken,
uint256 amount
) external isCollateralTokenAccepted(collateralToken) {
address borrower = msg.sender;
if (amount == 0) {
revert InvalidParameters("Zero amount");
}
if (lockedCollateralLedger[borrower][collateralToken] == 0) {
revert ZeroCollateralBalance();
}
if (
// solhint-disable-next-line not-rely-on-time
block.timestamp >= termRepoServicer.endOfRepurchaseWindow() &&
block.timestamp < termRepoServicer.redemptionTimestamp()
) {
revert CollateralWithdrawalClosed();
}
bool decrementEncumberedCollateral;
// if borrow balance is zero, collateral has already been unencumbered through liquidation
if (termRepoServicer.getBorrowerRepurchaseObligation(borrower) != 0) {
decrementEncumberedCollateral = true;
}
_unlockCollateral(
borrower,
collateralToken,
amount,
decrementEncumberedCollateral
);
if (isBorrowerInShortfall(borrower)) {
revert CollateralBelowMaintenanceRatios(borrower, collateralToken);
}
}
/// @param borrower The address of the borrower
/// @param closureAmounts An array specifying the amounts of Term Repo exposure the liquidator proposes to cover in liquidation; an amount is required to be specified for each collateral token
function batchLiquidation(
address borrower,
uint256[] calldata closureAmounts
) external whileLiquidationsNotPaused {
bool allowFullLiquidation = _validateBatchLiquidationForFullLiquidation(
borrower,
msg.sender,
closureAmounts
);
uint256 totalClosureAmount = 0;
uint256 collateralSeizureAmount;
uint256 collateralSeizureProtocolShare;
for (uint256 i = 0; i < closureAmounts.length; ++i) {
if (closureAmounts[i] == 0) {
continue;
}
if (closureAmounts[i] == type(uint256).max) {
revert InvalidParameters("closureAmounts cannot be uint max");
}
totalClosureAmount += closureAmounts[i];
termRepoServicer.liquidatorCoverExposure(
borrower,
msg.sender,
closureAmounts[i]
);
(
collateralSeizureAmount,
collateralSeizureProtocolShare
) = _collateralSeizureAmounts(
closureAmounts[i],
collateralTokens[i]
);
_transferLiquidationCollateral(
borrower,
msg.sender,
collateralTokens[i],
closureAmounts[i],
collateralSeizureAmount,
collateralSeizureProtocolShare,
false
);
}
if (totalClosureAmount == 0) {
revert ZeroLiquidationNotPermitted();
}
/// allow any liquidations if within margin minimum
if (!allowFullLiquidation) {
if (!_withinNetExposureCapOnLiquidation(borrower)) {
revert ExceedsNetExposureCapOnLiquidation();
}
}
// unencumber all collateral tokens owned by borrower if balance paid off
if (termRepoServicer.getBorrowerRepurchaseObligation(borrower) == 0) {
_unencumberRemainingBorrowerCollateralOnZeroObligation(borrower);
}
}
/// @param borrower The address of the borrower
/// @param closureRepoTokenAmounts An array specifying the amounts of Term Repo Tokens the liquidator proposes to cover borrower repo exposure in liquidation; an amount is required to be specified for each collateral token
function batchLiquidationWithRepoToken(
address borrower,
uint256[] calldata closureRepoTokenAmounts
) external whileLiquidationsNotPaused {
bool allowFullLiquidation = _validateBatchLiquidationForFullLiquidation(
borrower,
msg.sender,
closureRepoTokenAmounts
);
uint256 totalClosureRepoTokenAmounts = 0;
uint256 closureValue;
uint256 collateralSeizureAmount;
uint256 collateralSeizureProtocolShare;
for (uint256 i = 0; i < closureRepoTokenAmounts.length; ++i) {
if (closureRepoTokenAmounts[i] == 0) {
continue;
}
if (closureRepoTokenAmounts[i] == type(uint256).max) {
revert InvalidParameters(
"closureRepoTokenAmounts cannot be uint max"
);
}
totalClosureRepoTokenAmounts += closureRepoTokenAmounts[i];
closureValue = termRepoServicer
.liquidatorCoverExposureWithRepoToken(
borrower,
msg.sender,
closureRepoTokenAmounts[i]
);
(
collateralSeizureAmount,
collateralSeizureProtocolShare
) = _collateralSeizureAmounts(closureValue, collateralTokens[i]);
_transferLiquidationCollateral(
borrower,
msg.sender,
collateralTokens[i],
closureRepoTokenAmounts[i],
collateralSeizureAmount,
collateralSeizureProtocolShare,
false
);
}
if (totalClosureRepoTokenAmounts == 0) {
revert ZeroLiquidationNotPermitted();
}
/// allow any liquidations if within margin minimum
if (!allowFullLiquidation) {
if (!_withinNetExposureCapOnLiquidation(borrower)) {
revert ExceedsNetExposureCapOnLiquidation();
}
}
// unencumber all collateral tokens owned by borrower if balance paid off
if (termRepoServicer.getBorrowerRepurchaseObligation(borrower) == 0) {
_unencumberRemainingBorrowerCollateralOnZeroObligation(borrower);
}
}
/// @param borrower The address of the borrower
/// @param closureAmounts An array specifying the amounts of Term Repo exposure the liquidator proposes to cover in liquidation; an amount is required to be specified for each collateral token
function batchDefault(
address borrower,
uint256[] calldata closureAmounts
) external whileLiquidationsNotPaused {
// solhint-disable-next-line not-rely-on-time
if (block.timestamp <= termRepoServicer.endOfRepurchaseWindow()) {
revert DefaultsClosed();
}
if (msg.sender == borrower) {
revert SelfLiquidationNotPermitted();
}
if (collateralTokens.length != closureAmounts.length) {
revert InvalidParameters(
"Closure amounts array not same length as collateral tokens list"
);
}
uint256 totalClosureAmount = 0;
uint256 borrowerRepurchaseObligation = termRepoServicer
.getBorrowerRepurchaseObligation(borrower);
if (borrowerRepurchaseObligation == 0) {
revert ZeroBorrowerRepurchaseObligation();
}
uint256 collateralSeizureAmount;
uint256 collateralSeizureProtocolShare;
for (uint256 i = 0; i < closureAmounts.length; ++i) {
if (closureAmounts[i] == 0) {
continue;
}
if (closureAmounts[i] == type(uint256).max) {
revert InvalidParameters("closureAmounts cannot be uint max");
}
totalClosureAmount += closureAmounts[i];
if (totalClosureAmount > borrowerRepurchaseObligation) {
revert TotalRepaymentGreaterThangetBorrowerRepurchaseObligation();
}
termRepoServicer.liquidatorCoverExposure(
borrower,
msg.sender,
closureAmounts[i]
);
(
collateralSeizureAmount,
collateralSeizureProtocolShare
) = _collateralSeizureAmounts(
closureAmounts[i],
collateralTokens[i]
);
_transferLiquidationCollateral(
borrower,
msg.sender,
collateralTokens[i],
closureAmounts[i],
collateralSeizureAmount,
collateralSeizureProtocolShare,
true
);
}
if (totalClosureAmount == 0) {
revert ZeroLiquidationNotPermitted();
}
// unencumber all collateral tokens owned by borrower if balance paid off
if (termRepoServicer.getBorrowerRepurchaseObligation(borrower) == 0) {
_unencumberRemainingBorrowerCollateralOnZeroObligation(borrower);
}
}
/// @param collateralToken The collateral token address of tokens locked
/// @param amountToLock The amount of collateral tokens to lock
function calculateMintableExposure(
address collateralToken,
uint256 amountToLock
) external view returns (Exp memory) {
return
div_(
div_(
termPriceOracle.usdValueOfTokens(
collateralToken,
amountToLock
),
Exp({mantissa: initialCollateralRatios[collateralToken]})
),
termPriceOracle.usdValueOfTokens(purchaseToken, 1)
);
}
/// @param borrower The address of the borrower
/// @return An array of collateral token addresses
/// @return An array collateral token balances locked on behalf of borrower
function getCollateralBalances(
address borrower
) external view returns (address[] memory, uint256[] memory) {
address[] memory collateralTokensOwnedByBorrower = new address[](
collateralTokens.length
);
uint256[] memory collateralBalancesOwnedByBorrower = new uint256[](
collateralTokens.length
);
for (uint256 i = 0; i < collateralTokens.length; ++i) {
address collateralToken = collateralTokens[i];
uint256 collateralAmount = lockedCollateralLedger[borrower][
collateralToken
];
collateralTokensOwnedByBorrower[i] = collateralToken;
collateralBalancesOwnedByBorrower[i] = collateralAmount;
}
return (
collateralTokensOwnedByBorrower,
collateralBalancesOwnedByBorrower
);
}
/// @param borrower The address of the borrower
/// @param collateralToken The collateral token address to query
/// @return uint256 The amount of collateralToken locked on behalf of borrower
function getCollateralBalance(
address borrower,
address collateralToken
) external view returns (uint256) {
return lockedCollateralLedger[borrower][collateralToken];
}
/// @return bool A boolean that tests whether any encumbered collateral remains locked
function encumberedCollateralRemaining() external view returns (bool) {
for (uint256 i = 0; i < collateralTokens.length; ++i) {
if (encumberedCollateralBalances[collateralTokens[i]] > 0) {
return true;
}
}
return false;
}
// ========================================================================
// = Auction Functions ===================================================
// ========================================================================
/// @param bidder The bidder's address
/// @param collateralToken The address of the token to be used as collateral
/// @param amount The amount of the token to lock
function auctionLockCollateral(
address bidder,
address collateralToken,
uint256 amount
) external onlyRole(AUCTION_LOCKER) {
termRepoLocker.transferTokenFromWallet(bidder, collateralToken, amount);
}
/// @param bidder The bidder's address
/// @param collateralToken The address of the token used as collateral
/// @param amount The amount of collateral tokens to unlock
function auctionUnlockCollateral(
address bidder,
address collateralToken,
uint256 amount
) external onlyRole(AUCTION_LOCKER) {
termRepoLocker.transferTokenToWallet(bidder, collateralToken, amount);
}
// ========================================================================
// = Rollover Functions ==================================================
// ========================================================================
/// @param borrower The address of the borrower
/// @param collateralToken The address of a collateral token
/// @param amount The amount of collateral tokens to lock
function acceptRolloverCollateral(
address borrower,
address collateralToken,
uint256 amount
) external onlyRole(AUCTION_LOCKER) {
lockedCollateralLedger[borrower][collateralToken] += amount;
encumberedCollateralBalances[collateralToken] += amount;
emitter.emitCollateralLocked(
termRepoId,
borrower,
collateralToken,
amount
);
}
/// @param borrower The borrower's address
/// @param rolloverProportion The proportion of the collateral to be unlocked, equal to the proportion of the collateral repaid
/// @param rolloverTermRepoLocker The address of the new TermRepoLocker contract to roll into
/// @return An array representing a list of accepted collateral token addresses
/// @return An array containing the amount of collateral tokens to pairoff and transfer to new TermRepoLocker to roll into
function transferRolloverCollateral(
address borrower,
uint256 rolloverProportion,
address rolloverTermRepoLocker
)
external
onlyRole(ROLLOVER_TARGET_AUCTIONEER_ROLE)
returns (address[] memory, uint256[] memory)
{
return (
collateralTokens,
_partialUnlockCollateral(
borrower,
rolloverProportion,
rolloverTermRepoLocker
)
);
}
/// @param rolloverAuction The address of the rollover auction
function approveRolloverAuction(
address rolloverAuction
) external onlyRole(ROLLOVER_MANAGER) {
_grantRole(ROLLOVER_TARGET_AUCTIONEER_ROLE, rolloverAuction);
}
// ========================================================================
// = Servicer Functions ========================================
// ========================================================================
/// @param borrower The address of the borrower
function unlockCollateralOnRepurchase(
address borrower
) external onlyRole(SERVICER_ROLE) {
for (uint256 i = 0; i < collateralTokens.length; ++i) {
address collateralToken = collateralTokens[i];
uint256 collateralAmount = lockedCollateralLedger[borrower][
collateralToken
];
if (collateralAmount > 0) {
_unlockCollateral(
borrower,
collateralToken,
collateralAmount,
true
);
}
}
}
/// @param borrower The address of the borrower
/// @param collateralTokenAddresses Collateral token addresses
/// @param collateralTokenAmounts Collateral token amounts
function journalBidCollateralToCollateralManager(
address borrower,
address[] calldata collateralTokenAddresses,
uint256[] calldata collateralTokenAmounts
) external onlyRole(SERVICER_ROLE) {
for (uint256 i = 0; i < collateralTokenAddresses.length; ++i) {
lockedCollateralLedger[borrower][
collateralTokenAddresses[i]
] += collateralTokenAmounts[i];
encumberedCollateralBalances[
collateralTokenAddresses[i]
] += collateralTokenAmounts[i];
emitter.emitCollateralLocked(
termRepoId,
borrower,
collateralTokenAddresses[i],
collateralTokenAmounts[i]
);
}
}
/// @param borrower The address of the borrower
/// @param collateralToken Collateral token addresse
/// @param amount Collateral token amount
function mintOpenExposureLockCollateral(
address borrower,
address collateralToken,
uint256 amount
) external onlyRole(SERVICER_ROLE) {
_lockCollateral(borrower, collateralToken, amount);
}
// ========================================================================
// = Admin Functions ======================================================
// ========================================================================
/// @param termAuctionGroup A struct of auction contracts
function reopenToNewAuction(
TermAuctionGroup calldata termAuctionGroup
) external onlyRole(INITIALIZER_ROLE) {
_grantRole(
AUCTION_LOCKER,
address(termAuctionGroup.termAuctionBidLocker)
);
_grantRole(AUCTION_LOCKER, address(termAuctionGroup.auction));
termPriceOracle.reOpenToNewBidLocker(
address(termAuctionGroup.termAuctionBidLocker)
);
emitter.emitPairReopeningBidLocker(
termRepoId,
address(this),
address(termAuctionGroup.termAuctionBidLocker)
);
}
function pauseLiquidations() external onlyRole(DEFAULT_ADMIN_ROLE) {
liquidationsPaused = true;
emitter.emitLiquidationPaused(termRepoId);
}
function unpauseLiquidations() external onlyRole(DEFAULT_ADMIN_ROLE) {
liquidationsPaused = false;
emitter.emitLiquidationUnpaused(termRepoId);
}
// ========================================================================
// = Public Functions ====================================================
// ========================================================================
/// @param borrower The address of the borrower
/// @return Boolean testing whether the given borrower is in shortfall or margin deficit
function isBorrowerInShortfall(
address borrower
) public view returns (bool) {
Exp memory repurchasePriceUSDValue = termPriceOracle.usdValueOfTokens(
purchaseToken,
termRepoServicer.getBorrowerRepurchaseObligation(borrower)
);
Exp memory haircutUSDTotalCollateralValue = Exp({mantissa: 0});
for (uint256 i = 0; i < collateralTokens.length; ++i) {
address collateralToken = collateralTokens[i];
Exp memory additionalHairCutUSDCollateralValue = div_(
termPriceOracle.usdValueOfTokens(
collateralToken,
lockedCollateralLedger[borrower][collateralToken]
),
Exp({mantissa: maintenanceCollateralRatios[collateralToken]})
);
haircutUSDTotalCollateralValue = add_(
additionalHairCutUSDCollateralValue,
haircutUSDTotalCollateralValue
);
}
if (
lessThanExp(haircutUSDTotalCollateralValue, repurchasePriceUSDValue)
) {
return true;
}
return false;
}
/// @param borrower The address of the borrower
/// @return The market value of borrower's locked collateral denominated in USD
function getCollateralMarketValue(
address borrower
) public view returns (uint256) {
return _usdValueOfBalances(lockedCollateralLedger[borrower]);
}
// ========================================================================
// = Internal Functions ==================================================
// ========================================================================
function _lockCollateral(
address borrower,
address collateralToken,
uint256 amount
) internal {
lockedCollateralLedger[borrower][collateralToken] += amount;
encumberedCollateralBalances[collateralToken] += amount;
termRepoLocker.transferTokenFromWallet(
borrower,
collateralToken,
amount
);
emitter.emitCollateralLocked(
termRepoId,
borrower,
collateralToken,
amount
);
}
function _unlockCollateral(
address borrower,
address collateralToken,
uint256 amount,
bool decrementEncumberedCollateral
) internal {
if (amount > lockedCollateralLedger[borrower][collateralToken]) {
revert UnlockAmountGreaterThanCollateralBalance();
}
lockedCollateralLedger[borrower][collateralToken] -= amount;
if (decrementEncumberedCollateral) {
encumberedCollateralBalances[collateralToken] -= amount;
}
termRepoLocker.transferTokenToWallet(borrower, collateralToken, amount);
emitter.emitCollateralUnlocked(
termRepoId,
borrower,
collateralToken,
amount
);
}
function _partialUnlockCollateral(
address borrower,
uint256 unlockProportion,
address destinationwallet
) internal returns (uint256[] memory) {
uint256[] memory unlockedCollateral = new uint256[](
collateralTokens.length
);
for (uint256 i = 0; i < collateralTokens.length; ++i) {
address collateralToken = collateralTokens[i];
uint256 collateralAmount = lockedCollateralLedger[borrower][
collateralToken
];
if (collateralAmount > 0) {
if (unlockProportion == expScale) {
uint256 unlockedAmount = lockedCollateralLedger[borrower][
collateralToken
];
// slither-disable-start reentrancy-no-eth
lockedCollateralLedger[borrower][collateralToken] = 0;
unlockedCollateral[i] = unlockedAmount;
encumberedCollateralBalances[
collateralToken
] -= unlockedAmount;
// slither-disable-end reentrancy-no-eth
termRepoLocker.transferTokenToWallet(
destinationwallet,
collateralToken,
unlockedAmount
);
emitter.emitCollateralUnlocked(
termRepoId,
borrower,
collateralToken,
unlockedAmount
);
} else {
uint256 proportionToUnlock = mul_ScalarTruncate(
Exp({mantissa: unlockProportion}),
collateralAmount
);
// slither-disable-start reentrancy-no-eth
lockedCollateralLedger[borrower][
collateralToken
] -= proportionToUnlock;
unlockedCollateral[i] = proportionToUnlock;
encumberedCollateralBalances[
collateralToken
] -= proportionToUnlock;
// slither-disable-end reentrancy-no-eth
termRepoLocker.transferTokenToWallet(
destinationwallet,
collateralToken,
proportionToUnlock
);
emitter.emitCollateralUnlocked(
termRepoId,
borrower,
collateralToken,
proportionToUnlock
);
}
}
}
return unlockedCollateral;
}
/// @dev A helper function to validate various conditions required to liquidate
/// @return A boolean for whether borrower position eligible for full liquidation
function _validateBatchLiquidationForFullLiquidation(
address borrower,
address liquidator,
uint256[] calldata closureTokenAmounts
) internal returns (bool) {
// solhint-disable-next-line not-rely-on-time
if (block.timestamp > termRepoServicer.endOfRepurchaseWindow()) {
revert ShortfallLiquidationsClosed();
}
if (liquidator == borrower) {
revert SelfLiquidationNotPermitted();
}
if (collateralTokens.length != closureTokenAmounts.length) {
revert InvalidParameters(
"Closure amounts array not same length as collateral tokens list"
);
}
uint256 borrowerRepurchaseObligation = termRepoServicer
.getBorrowerRepurchaseObligation(borrower);
if (borrowerRepurchaseObligation == 0) {
revert ZeroBorrowerRepurchaseObligation();
}
bool allowFullLiquidation = getCollateralMarketValue(borrower) <
termPriceOracle
.usdValueOfTokens(purchaseToken, borrowerRepurchaseObligation)
.mantissa +
deMinimisMarginThreshold;
if (!allowFullLiquidation && !isBorrowerInShortfall(borrower)) {
revert BorrowerNotInShortfall();
}
return allowFullLiquidation;
}
function _unencumberRemainingBorrowerCollateralOnZeroObligation(
address borrower
) internal {
for (uint256 i = 0; i < collateralTokens.length; ++i) {
encumberedCollateralBalances[
collateralTokens[i]
] -= lockedCollateralLedger[borrower][collateralTokens[i]];
}
}
function _withinNetExposureCapOnLiquidation(
address borrower
) internal view returns (bool) {
uint256 borrowerRepurchaseObligation = termRepoServicer
.getBorrowerRepurchaseObligation(borrower);
/// Borrower should not be liquidated to zero balance in this case.
if (borrowerRepurchaseObligation == 0) {
return false;
}
Exp memory haircutUSDTotalCollateralValue = Exp({mantissa: 0});
for (uint256 i = 0; i < collateralTokens.length; ++i) {
address collateralToken = collateralTokens[i];
Exp memory additionalHairCutUSDCollateralValue = div_(
termPriceOracle.usdValueOfTokens(
collateralToken,
lockedCollateralLedger[borrower][collateralToken]
),
Exp({mantissa: initialCollateralRatios[collateralToken]})
);
haircutUSDTotalCollateralValue = add_(
additionalHairCutUSDCollateralValue,
haircutUSDTotalCollateralValue
);
}
Exp memory borrowerRepurchaseValue = termPriceOracle.usdValueOfTokens(
purchaseToken,
borrowerRepurchaseObligation
);
if (
lessThanExp(haircutUSDTotalCollateralValue, borrowerRepurchaseValue)
) {
return true;
}
Exp memory excessEquity = sub_(
haircutUSDTotalCollateralValue,
borrowerRepurchaseValue
);
return
lessThanOrEqualExp(
div_(excessEquity, borrowerRepurchaseValue),
Exp({mantissa: netExposureCapOnLiquidation})
);
}
///@dev returns total amount of collateral seized in liquidation and the amount of that total going protocol
function _collateralSeizureAmounts(
uint256 amountToCover_,
address collateralToken
) internal view returns (uint256, uint256) {
IERC20MetadataUpgradeable tokenInstance = IERC20MetadataUpgradeable(
collateralToken
);
Exp memory usdValueOfCoverAmount = termPriceOracle.usdValueOfTokens(
purchaseToken,
amountToCover_
);
Exp memory latestPriceValueCollateralAmount = div_(
usdValueOfCoverAmount,
termPriceOracle.usdValueOfTokens(
collateralToken,
10 ** (tokenInstance.decimals())
)
);
Exp memory collateralAmountWithDiscount = mul_(
latestPriceValueCollateralAmount,
add_(
Exp({mantissa: expScale}),
Exp({mantissa: liquidatedDamages[collateralToken]})
)
);
Exp memory protocolSeizureAmount = mul_(
latestPriceValueCollateralAmount,
Exp({mantissa: liquidateDamangesDueToProtocol})
);
// this is equivalent to usdValueOfClosureAmount / discountedPriceofCollateralToken
return (
collateralAmountWithDiscount.mantissa /
10 ** (18 - tokenInstance.decimals()),
protocolSeizureAmount.mantissa /
10 ** (18 - tokenInstance.decimals())
);
}
/// @dev A helper function to transfer tokens and update relevant state variables and mappings
function _transferLiquidationCollateral(
address borrower,
address liquidator,
address collateralAddress,
uint256 closureAmount,
uint256 collateralSeizureAmount,
uint256 collateralSeizureProtocolShare,
bool isDefault
) internal {
if (
collateralSeizureAmount >
lockedCollateralLedger[borrower][collateralAddress]
) {
revert InsufficientCollateralForLiquidationRepayment(
collateralAddress
);
}
// slither-disable-start reentrancy-no-eth
lockedCollateralLedger[borrower][
collateralAddress
] -= collateralSeizureAmount;
encumberedCollateralBalances[
collateralAddress
] -= collateralSeizureAmount;
// slither-disable-end reentrancy-no-eth
termRepoLocker.transferTokenToWallet(
termController.getProtocolReserveAddress(),
collateralAddress,
collateralSeizureProtocolShare
);
termRepoLocker.transferTokenToWallet(
liquidator,
collateralAddress,
collateralSeizureAmount - collateralSeizureProtocolShare // Liquidation yield
);
emitter.emitLiquidation(
termRepoId,
borrower,
liquidator,
closureAmount,
collateralAddress,
collateralSeizureAmount,
collateralSeizureProtocolShare,
isDefault
);
}
function _isAcceptedCollateralToken(
address token_
) internal view returns (bool) {
if (liquidatedDamages[token_] == 0) {
return false;
}
return true;
}
function _usdValueOfBalances(
mapping(address => uint256) storage _tokenBalances
) internal view returns (uint256) {
Exp memory totalValue = Exp({mantissa: 0});
for (uint256 i = 0; i < collateralTokens.length; ++i) {
totalValue = add_(
totalValue,
termPriceOracle.usdValueOfTokens(
collateralTokens[i],
_tokenBalances[collateralTokens[i]]
)
);
}
return totalValue.mantissa;
}
// solhint-disable no-empty-blocks
///@dev required override by the OpenZeppelin UUPS module
function _authorizeUpgrade(
address
) internal view override onlyRole(DEFAULT_ADMIN_ROLE) {}
// solhint-enable no-empty-blocks
}// 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);
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: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (access/AccessControl.sol)
pragma solidity ^0.8.0;
import "./IAccessControlUpgradeable.sol";
import "../utils/ContextUpgradeable.sol";
import "../utils/StringsUpgradeable.sol";
import "../utils/introspection/ERC165Upgradeable.sol";
import "../proxy/utils/Initializable.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:
*
* ```solidity
* 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}:
*
* ```solidity
* 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. We recommend using {AccessControlDefaultAdminRules}
* to enforce additional security measures for this role.
*/
abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable {
function __AccessControl_init() internal onlyInitializing {
}
function __AccessControl_init_unchained() internal onlyInitializing {
}
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);
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControlUpgradeable).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual override returns (bool) {
return _roles[role].members[account];
}
/**
* @dev Revert with a standard message if `_msgSender()` is missing `role`.
* Overriding this function changes the behavior of the {onlyRole} modifier.
*
* Format of the revert message is described in {_checkRole}.
*
* _Available since v4.6._
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @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 virtual {
if (!hasRole(role, account)) {
revert(
string(
abi.encodePacked(
"AccessControl: account ",
StringsUpgradeable.toHexString(account),
" is missing role ",
StringsUpgradeable.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 virtual 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.
*
* May emit a {RoleGranted} event.
*/
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.
*
* May emit a {RoleRevoked} event.
*/
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 revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*
* May emit a {RoleRevoked} event.
*/
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.
*
* May emit a {RoleGranted} event.
*
* [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}.
* ====
*
* NOTE: This function is deprecated in favor of {_grantRole}.
*/
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);
}
/**
* @dev Grants `role` to `account`.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual {
if (!hasRole(role, account)) {
_roles[role].members[account] = true;
emit RoleGranted(role, account, _msgSender());
}
}
/**
* @dev Revokes `role` from `account`.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual {
if (hasRole(role, account)) {
_roles[role].members[account] = false;
emit RoleRevoked(role, account, _msgSender());
}
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
pragma solidity ^0.8.0;
/**
* @dev External interface of AccessControl declared to support ERC165 detection.
*/
interface IAccessControlUpgradeable {
/**
* @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
// OpenZeppelin Contracts (last updated v4.5.0) (interfaces/draft-IERC1822.sol)
pragma solidity ^0.8.0;
/**
* @dev ERC1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified
* proxy whose upgrades are fully controlled by the current implementation.
*/
interface IERC1822ProxiableUpgradeable {
/**
* @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation
* address.
*
* IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
* bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
* function revert if invoked through a proxy.
*/
function proxiableUUID() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (interfaces/IERC1967.sol)
pragma solidity ^0.8.0;
/**
* @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC.
*
* _Available since v4.8.3._
*/
interface IERC1967Upgradeable {
/**
* @dev Emitted when the implementation is upgraded.
*/
event Upgraded(address indexed implementation);
/**
* @dev Emitted when the admin account has changed.
*/
event AdminChanged(address previousAdmin, address newAdmin);
/**
* @dev Emitted when the beacon is changed.
*/
event BeaconUpgraded(address indexed beacon);
}// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (interfaces/IERC20Metadata.sol) pragma solidity ^0.8.0; import "../token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (proxy/beacon/IBeacon.sol)
pragma solidity ^0.8.0;
/**
* @dev This is the interface that {BeaconProxy} expects of its beacon.
*/
interface IBeaconUpgradeable {
/**
* @dev Must return an address that can be used as a delegate call target.
*
* {BeaconProxy} will check that this address is a contract.
*/
function implementation() external view returns (address);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/ERC1967/ERC1967Upgrade.sol)
pragma solidity ^0.8.2;
import "../beacon/IBeaconUpgradeable.sol";
import "../../interfaces/IERC1967Upgradeable.sol";
import "../../interfaces/draft-IERC1822Upgradeable.sol";
import "../../utils/AddressUpgradeable.sol";
import "../../utils/StorageSlotUpgradeable.sol";
import "../utils/Initializable.sol";
/**
* @dev This abstract contract provides getters and event emitting update functions for
* https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.
*
* _Available since v4.1._
*/
abstract contract ERC1967UpgradeUpgradeable is Initializable, IERC1967Upgradeable {
function __ERC1967Upgrade_init() internal onlyInitializing {
}
function __ERC1967Upgrade_init_unchained() internal onlyInitializing {
}
// This is the keccak-256 hash of "eip1967.proxy.rollback" subtracted by 1
bytes32 private constant _ROLLBACK_SLOT = 0x4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd9143;
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
/**
* @dev Returns the current implementation address.
*/
function _getImplementation() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_IMPLEMENTATION_SLOT).value;
}
/**
* @dev Stores a new address in the EIP1967 implementation slot.
*/
function _setImplementation(address newImplementation) private {
require(AddressUpgradeable.isContract(newImplementation), "ERC1967: new implementation is not a contract");
StorageSlotUpgradeable.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
}
/**
* @dev Perform implementation upgrade
*
* Emits an {Upgraded} event.
*/
function _upgradeTo(address newImplementation) internal {
_setImplementation(newImplementation);
emit Upgraded(newImplementation);
}
/**
* @dev Perform implementation upgrade with additional setup call.
*
* Emits an {Upgraded} event.
*/
function _upgradeToAndCall(address newImplementation, bytes memory data, bool forceCall) internal {
_upgradeTo(newImplementation);
if (data.length > 0 || forceCall) {
AddressUpgradeable.functionDelegateCall(newImplementation, data);
}
}
/**
* @dev Perform implementation upgrade with security checks for UUPS proxies, and additional setup call.
*
* Emits an {Upgraded} event.
*/
function _upgradeToAndCallUUPS(address newImplementation, bytes memory data, bool forceCall) internal {
// Upgrades from old implementations will perform a rollback test. This test requires the new
// implementation to upgrade back to the old, non-ERC1822 compliant, implementation. Removing
// this special case will break upgrade paths from old UUPS implementation to new ones.
if (StorageSlotUpgradeable.getBooleanSlot(_ROLLBACK_SLOT).value) {
_setImplementation(newImplementation);
} else {
try IERC1822ProxiableUpgradeable(newImplementation).proxiableUUID() returns (bytes32 slot) {
require(slot == _IMPLEMENTATION_SLOT, "ERC1967Upgrade: unsupported proxiableUUID");
} catch {
revert("ERC1967Upgrade: new implementation is not UUPS");
}
_upgradeToAndCall(newImplementation, data, forceCall);
}
}
/**
* @dev Storage slot with the admin of the contract.
* This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
/**
* @dev Returns the current admin.
*/
function _getAdmin() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_ADMIN_SLOT).value;
}
/**
* @dev Stores a new address in the EIP1967 admin slot.
*/
function _setAdmin(address newAdmin) private {
require(newAdmin != address(0), "ERC1967: new admin is the zero address");
StorageSlotUpgradeable.getAddressSlot(_ADMIN_SLOT).value = newAdmin;
}
/**
* @dev Changes the admin of the proxy.
*
* Emits an {AdminChanged} event.
*/
function _changeAdmin(address newAdmin) internal {
emit AdminChanged(_getAdmin(), newAdmin);
_setAdmin(newAdmin);
}
/**
* @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
* This is bytes32(uint256(keccak256('eip1967.proxy.beacon')) - 1)) and is validated in the constructor.
*/
bytes32 internal constant _BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;
/**
* @dev Returns the current beacon.
*/
function _getBeacon() internal view returns (address) {
return StorageSlotUpgradeable.getAddressSlot(_BEACON_SLOT).value;
}
/**
* @dev Stores a new beacon in the EIP1967 beacon slot.
*/
function _setBeacon(address newBeacon) private {
require(AddressUpgradeable.isContract(newBeacon), "ERC1967: new beacon is not a contract");
require(
AddressUpgradeable.isContract(IBeaconUpgradeable(newBeacon).implementation()),
"ERC1967: beacon implementation is not a contract"
);
StorageSlotUpgradeable.getAddressSlot(_BEACON_SLOT).value = newBeacon;
}
/**
* @dev Perform beacon upgrade with additional setup call. Note: This upgrades the address of the beacon, it does
* not upgrade the implementation contained in the beacon (see {UpgradeableBeacon-_setImplementation} for that).
*
* Emits a {BeaconUpgraded} event.
*/
function _upgradeBeaconToAndCall(address newBeacon, bytes memory data, bool forceCall) internal {
_setBeacon(newBeacon);
emit BeaconUpgraded(newBeacon);
if (data.length > 0 || forceCall) {
AddressUpgradeable.functionDelegateCall(IBeaconUpgradeable(newBeacon).implementation(), data);
}
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a
* constructor.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
bool isTopLevelCall = !_initializing;
require(
(isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
"Initializable: contract is already initialized"
);
_initialized = 1;
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: setting the version to 255 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint8 version) {
require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
_initialized = version;
_initializing = true;
_;
_initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized != type(uint8).max) {
_initialized = type(uint8).max;
emit Initialized(type(uint8).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint8) {
return _initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _initializing;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/utils/UUPSUpgradeable.sol)
pragma solidity ^0.8.0;
import "../../interfaces/draft-IERC1822Upgradeable.sol";
import "../ERC1967/ERC1967UpgradeUpgradeable.sol";
import "./Initializable.sol";
/**
* @dev An upgradeability mechanism designed for UUPS proxies. The functions included here can perform an upgrade of an
* {ERC1967Proxy}, when this contract is set as the implementation behind such a proxy.
*
* A security mechanism ensures that an upgrade does not turn off upgradeability accidentally, although this risk is
* reinstated if the upgrade retains upgradeability but removes the security mechanism, e.g. by replacing
* `UUPSUpgradeable` with a custom implementation of upgrades.
*
* The {_authorizeUpgrade} function must be overridden to include access restriction to the upgrade mechanism.
*
* _Available since v4.1._
*/
abstract contract UUPSUpgradeable is Initializable, IERC1822ProxiableUpgradeable, ERC1967UpgradeUpgradeable {
function __UUPSUpgradeable_init() internal onlyInitializing {
}
function __UUPSUpgradeable_init_unchained() internal onlyInitializing {
}
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment
address private immutable __self = address(this);
/**
* @dev Check that the execution is being performed through a delegatecall call and that the execution context is
* a proxy contract with an implementation (as defined in ERC1967) pointing to self. This should only be the case
* for UUPS and transparent proxies that are using the current contract as their implementation. Execution of a
* function through ERC1167 minimal proxies (clones) would not normally pass this test, but is not guaranteed to
* fail.
*/
modifier onlyProxy() {
require(address(this) != __self, "Function must be called through delegatecall");
require(_getImplementation() == __self, "Function must be called through active proxy");
_;
}
/**
* @dev Check that the execution is not being performed through a delegate call. This allows a function to be
* callable on the implementing contract but not through proxies.
*/
modifier notDelegated() {
require(address(this) == __self, "UUPSUpgradeable: must not be called through delegatecall");
_;
}
/**
* @dev Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the
* implementation. It is used to validate the implementation's compatibility when performing an upgrade.
*
* IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
* bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
* function revert if invoked through a proxy. This is guaranteed by the `notDelegated` modifier.
*/
function proxiableUUID() external view virtual override notDelegated returns (bytes32) {
return _IMPLEMENTATION_SLOT;
}
/**
* @dev Upgrade the implementation of the proxy to `newImplementation`.
*
* Calls {_authorizeUpgrade}.
*
* Emits an {Upgraded} event.
*
* @custom:oz-upgrades-unsafe-allow-reachable delegatecall
*/
function upgradeTo(address newImplementation) public virtual onlyProxy {
_authorizeUpgrade(newImplementation);
_upgradeToAndCallUUPS(newImplementation, new bytes(0), false);
}
/**
* @dev Upgrade the implementation of the proxy to `newImplementation`, and subsequently execute the function call
* encoded in `data`.
*
* Calls {_authorizeUpgrade}.
*
* Emits an {Upgraded} event.
*
* @custom:oz-upgrades-unsafe-allow-reachable delegatecall
*/
function upgradeToAndCall(address newImplementation, bytes memory data) public payable virtual onlyProxy {
_authorizeUpgrade(newImplementation);
_upgradeToAndCallUUPS(newImplementation, data, true);
}
/**
* @dev Function that should revert when `msg.sender` is not authorized to upgrade the contract. Called by
* {upgradeTo} and {upgradeToAndCall}.
*
* Normally, this function will use an xref:access.adoc[access control] modifier such as {Ownable-onlyOwner}.
*
* ```solidity
* function _authorizeUpgrade(address) internal override onlyOwner {}
* ```
*/
function _authorizeUpgrade(address newImplementation) internal virtual;
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
import "../proxy/utils/Initializable.sol";
/**
* @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 ReentrancyGuardUpgradeable is Initializable {
// 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;
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.0;
import "./IERC20Upgradeable.sol";
import "./extensions/IERC20MetadataUpgradeable.sol";
import "../../utils/ContextUpgradeable.sol";
import "../../proxy/utils/Initializable.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.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* 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 ERC20Upgradeable is Initializable, ContextUpgradeable, IERC20Upgradeable, IERC20MetadataUpgradeable {
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}.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
function __ERC20_init(string memory name_, string memory symbol_) internal onlyInitializing {
__ERC20_init_unchained(name_, symbol_);
}
function __ERC20_init_unchained(string memory name_, string memory symbol_) internal onlyInitializing {
_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 default value returned by this function, unless
* it's 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:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `amount`.
*/
function transfer(address to, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_transfer(owner, to, 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}.
*
* NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_approve(owner, 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}.
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
* - the caller must have allowance for ``from``'s tokens of at least
* `amount`.
*/
function transferFrom(address from, address to, uint256 amount) public virtual override returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, amount);
_transfer(from, to, 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) {
address owner = _msgSender();
_approve(owner, spender, allowance(owner, 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) {
address owner = _msgSender();
uint256 currentAllowance = allowance(owner, spender);
require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero");
unchecked {
_approve(owner, spender, currentAllowance - subtractedValue);
}
return true;
}
/**
* @dev Moves `amount` of tokens from `from` to `to`.
*
* 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:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
*/
function _transfer(address from, address to, uint256 amount) internal virtual {
require(from != address(0), "ERC20: transfer from the zero address");
require(to != address(0), "ERC20: transfer to the zero address");
_beforeTokenTransfer(from, to, amount);
uint256 fromBalance = _balances[from];
require(fromBalance >= amount, "ERC20: transfer amount exceeds balance");
unchecked {
_balances[from] = fromBalance - amount;
// Overflow not possible: the sum of all balances is capped by totalSupply, and the sum is preserved by
// decrementing then incrementing.
_balances[to] += amount;
}
emit Transfer(from, to, amount);
_afterTokenTransfer(from, to, 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;
unchecked {
// Overflow not possible: balance + amount is at most totalSupply + amount, which is checked above.
_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;
// Overflow not possible: amount <= accountBalance <= totalSupply.
_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 Updates `owner` s allowance for `spender` based on spent `amount`.
*
* Does not update the allowance amount in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Might emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 amount) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance != type(uint256).max) {
require(currentAllowance >= amount, "ERC20: insufficient allowance");
unchecked {
_approve(owner, spender, currentAllowance - 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 {}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[45] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.0;
import "../IERC20Upgradeable.sol";
/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20MetadataUpgradeable is IERC20Upgradeable {
/**
* @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: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
interface IERC20PermitUpgradeable {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20Upgradeable {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 amount) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "../IERC20Upgradeable.sol";
import "../extensions/IERC20PermitUpgradeable.sol";
import "../../../utils/AddressUpgradeable.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 SafeERC20Upgradeable {
using AddressUpgradeable for address;
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20Upgradeable token, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20Upgradeable 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(IERC20Upgradeable 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));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(IERC20Upgradeable token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance + value));
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20Upgradeable token, address spender, uint256 value) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, oldAllowance - value));
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Compatible with tokens that require the approval to be set to
* 0 before setting it to a non-zero value.
*/
function forceApprove(IERC20Upgradeable token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeWithSelector(token.approve.selector, spender, value);
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, 0));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Use a ERC-2612 signature to set the `owner` approval toward `spender` on `token`.
* Revert on invalid signature.
*/
function safePermit(
IERC20PermitUpgradeable token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20Upgradeable 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");
require(returndata.length == 0 || abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20Upgradeable token, bytes memory data) private returns (bool) {
// 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 cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return
success && (returndata.length == 0 || abi.decode(returndata, (bool))) && AddressUpgradeable.isContract(address(token));
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library AddressUpgradeable {
/**
* @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
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/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.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
import "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)
pragma solidity ^0.8.0;
import "./IERC165Upgradeable.sol";
import "../../proxy/utils/Initializable.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 ERC165Upgradeable is Initializable, IERC165Upgradeable {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IERC165Upgradeable).interfaceId;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)
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 IERC165Upgradeable {
/**
* @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: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/math/Math.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library MathUpgradeable {
enum Rounding {
Down, // Toward negative infinity
Up, // Toward infinity
Zero // Toward zero
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds up instead
* of rounding down.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b - 1) / b can overflow on addition, so we distribute.
return a == 0 ? 0 : (a - 1) / b + 1;
}
/**
* @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
* @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv)
* with further edits by Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use
// use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2^256 + prod0.
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod0 := mul(x, y)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2^256. Also prevents denominator == 0.
require(denominator > prod1, "Math: mulDiv overflow");
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1.
// See https://cs.stackexchange.com/q/138556/92363.
// Does not overflow because the denominator cannot be zero at this stage in the function.
uint256 twos = denominator & (~denominator + 1);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such
// that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv = 1 mod 2^4.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works
// in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2^8
inverse *= 2 - denominator * inverse; // inverse mod 2^16
inverse *= 2 - denominator * inverse; // inverse mod 2^32
inverse *= 2 - denominator * inverse; // inverse mod 2^64
inverse *= 2 - denominator * inverse; // inverse mod 2^128
inverse *= 2 - denominator * inverse; // inverse mod 2^256
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is
// less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @notice Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
uint256 result = mulDiv(x, y, denominator);
if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) {
result += 1;
}
return result;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down.
*
* Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11).
*/
function sqrt(uint256 a) internal pure returns (uint256) {
if (a == 0) {
return 0;
}
// For our first guess, we get the biggest power of 2 which is smaller than the square root of the target.
//
// We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have
// `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`.
//
// This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)`
// → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))`
// → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)`
//
// Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit.
uint256 result = 1 << (log2(a) >> 1);
// At this point `result` is an estimation with one bit of precision. We know the true value is a uint128,
// since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at
// every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision
// into the expected uint128 result.
unchecked {
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
result = (result + a / result) >> 1;
return min(result, a / result);
}
}
/**
* @notice Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + (rounding == Rounding.Up && result * result < a ? 1 : 0);
}
}
/**
* @dev Return the log in base 2, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 128;
}
if (value >> 64 > 0) {
value >>= 64;
result += 64;
}
if (value >> 32 > 0) {
value >>= 32;
result += 32;
}
if (value >> 16 > 0) {
value >>= 16;
result += 16;
}
if (value >> 8 > 0) {
value >>= 8;
result += 8;
}
if (value >> 4 > 0) {
value >>= 4;
result += 4;
}
if (value >> 2 > 0) {
value >>= 2;
result += 2;
}
if (value >> 1 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 10, rounded down, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + (rounding == Rounding.Up && 10 ** result < value ? 1 : 0);
}
}
/**
* @dev Return the log in base 256, rounded down, of a positive value.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >> 128 > 0) {
value >>= 128;
result += 16;
}
if (value >> 64 > 0) {
value >>= 64;
result += 8;
}
if (value >> 32 > 0) {
value >>= 32;
result += 4;
}
if (value >> 16 > 0) {
value >>= 16;
result += 2;
}
if (value >> 8 > 0) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + (rounding == Rounding.Up && 1 << (result << 3) < value ? 1 : 0);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/math/SignedMath.sol)
pragma solidity ^0.8.0;
/**
* @dev Standard signed math utilities missing in the Solidity language.
*/
library SignedMathUpgradeable {
/**
* @dev Returns the largest of two signed numbers.
*/
function max(int256 a, int256 b) internal pure returns (int256) {
return a > b ? a : b;
}
/**
* @dev Returns the smallest of two signed numbers.
*/
function min(int256 a, int256 b) internal pure returns (int256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two signed numbers without overflow.
* The result is rounded towards zero.
*/
function average(int256 a, int256 b) internal pure returns (int256) {
// Formula from the book "Hacker's Delight"
int256 x = (a & b) + ((a ^ b) >> 1);
return x + (int256(uint256(x) >> 255) & (a ^ b));
}
/**
* @dev Returns the absolute unsigned value of a signed value.
*/
function abs(int256 n) internal pure returns (uint256) {
unchecked {
// must be unchecked in order to support `n = type(int256).min`
return uint256(n >= 0 ? n : -n);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.0;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC1967 implementation slot:
* ```solidity
* contract ERC1967 {
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract");
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* _Available since v4.1 for `address`, `bool`, `bytes32`, `uint256`._
* _Available since v4.9 for `string`, `bytes`._
*/
library StorageSlotUpgradeable {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
/**
* @dev Returns an `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Strings.sol)
pragma solidity ^0.8.0;
import "./math/MathUpgradeable.sol";
import "./math/SignedMathUpgradeable.sol";
/**
* @dev String operations.
*/
library StringsUpgradeable {
bytes16 private constant _SYMBOLS = "0123456789abcdef";
uint8 private constant _ADDRESS_LENGTH = 20;
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = MathUpgradeable.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
/// @solidity memory-safe-assembly
assembly {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
/// @solidity memory-safe-assembly
assembly {
mstore8(ptr, byte(mod(value, 10), _SYMBOLS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toString(int256 value) internal pure returns (string memory) {
return string(abi.encodePacked(value < 0 ? "-" : "", toString(SignedMathUpgradeable.abs(value))));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, MathUpgradeable.log256(value) + 1);
}
}
/**
* @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] = _SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return keccak256(bytes(a)) == keccak256(bytes(b));
}
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./ITermRepoServicer.sol";
import "../lib/TermAuctionBid.sol";
import "../lib/TermAuctionBidSubmission.sol";
import "../lib/TermAuctionRevealedBid.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
interface ITermAuctionBidLocker {
function termRepoId() external view returns (bytes32);
function termAuctionId() external view returns (bytes32);
function auctionEndTime() external view returns (uint256);
function dayCountFractionMantissa() external view returns (uint256);
function purchaseToken() external view returns (address);
function collateralTokens(
IERC20Upgradeable token
) external view returns (bool);
function termRepoServicer() external view returns (ITermRepoServicer);
// ========================================================================
// = Interface/API ========================================================
// ========================================================================
/// @param bid A struct containing details of the bid
/// @return A bool representing whether the bid was locked or not
function lockRolloverBid(
TermAuctionBid calldata bid
) external returns (bool);
/// @param bidSubmissions An array of bid submissions
/// @return A bytes32 array of unique on chain bid ids.
function lockBids(
TermAuctionBidSubmission[] calldata bidSubmissions
) external returns (bytes32[] memory);
/// @param bidSubmissions An array of Term Auction bid submissions to borrow an amount of money at rate up to but not exceeding the bid rate
/// @param referralAddress A user address that referred the submitter of this bid
/// @return A bytes32 array of unique on chain bid ids.
function lockBidsWithReferral(
TermAuctionBidSubmission[] calldata bidSubmissions,
address referralAddress
) external returns (bytes32[] memory);
/// @param id A bid Id
/// @return A struct containing details of the locked bid
function lockedBid(
bytes32 id
) external view returns (TermAuctionBid memory);
/// @param ids An array of bid ids of the bids to reveal
/// @param prices An array of the bid prices to reveal
/// @param nonces An array of nonce values to generate bid price hashes
function revealBids(
bytes32[] calldata ids,
uint256[] calldata prices,
uint256[] calldata nonces
) external;
/// @notice unlockBids unlocks multiple bids and returns funds to the borrower
/// @param ids An array of ids to unlock
function unlockBids(bytes32[] calldata ids) external;
// ========================================================================
// = Internal Interface/API ===============================================
// ========================================================================
/// @param revealedBids An array of the revealed offer ids
/// @param expiredRolloverBids An array of the expired rollover bid ids
/// @param unrevealedBids An array of the unrevealed offer ids
/// @return An array of TermAuctionRevealedBid structs containing details of the revealed bids
/// @return An array of TermAuctionBid structs containing details of the unrevealed bids
function getAllBids(
bytes32[] calldata revealedBids,
bytes32[] calldata expiredRolloverBids,
bytes32[] calldata unrevealedBids
)
external
returns (TermAuctionRevealedBid[] memory, TermAuctionBid[] memory);
/// @param id A bytes32 bid id
/// @param bidder The address of the bidder
/// @param bidCollateralTokens The addresses of the token used as collateral
/// @param amounts The amounts of collateral tokens to unlock
function auctionUnlockBid(
bytes32 id,
address bidder,
address[] calldata bidCollateralTokens,
uint256[] calldata amounts
) external;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermAuctionBidLockerEvents is an interface that defines all events emitted by the Term Auction Bid Locker.
interface ITermAuctionBidLockerEvents {
event TermAuctionBidLockerInitialized(
bytes32 termRepoId,
bytes32 termAuctionId,
address termAuctionBidLocker,
uint256 auctionStartTime,
uint256 revealTime,
uint256 maxBidPrice,
uint256 minimumTenderAmount,
uint256 dayCountFractionMantissa
);
event BidLocked(
bytes32 termAuctionId,
bytes32 id,
address bidder,
bytes32 bidPrice,
uint256 amount,
address token,
address[] collateralTokens,
uint256[] collateralAmounts,
bool isRollover,
address rolloverPairOffTermRepoServicer,
address referralAddress
);
event BidRevealed(bytes32 termAuctionId, bytes32 id, uint256 bidPrice);
event BidUnlocked(bytes32 termAuctionId, bytes32 id);
event BidInShortfall(bytes32 termAuctionId, bytes32 id);
event BidLockingPaused(bytes32 termAuctionId, bytes32 termRepoId);
event BidLockingUnpaused(bytes32 termAuctionId, bytes32 termRepoId);
event BidUnlockingPaused(bytes32 termAuctionId, bytes32 termRepoId);
event BidUnlockingUnpaused(bytes32 termAuctionId, bytes32 termRepoId);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @title ITermAuctionErrors defines all errors emitted by the Term Auction
interface ITermAuctionErrors {
/// Term contracts have already been paired.
error AlreadyTermContractPaired();
/// Error emmitted when completing an auction that has already been completed
error AuctionAlreadyCompleted();
/// Error emmitted when completing an auction that has been cancelled for withdrawal
error AuctionCancelledForWithdrawal();
/// Error emmitted when the auction is not closed, but must be
error AuctionNotClosed();
/// Error emitted when the provided clearingOffset is not 0 or 1
error ClearingOffsetNot0Or1(uint256 clearingOffset);
/// Complete Auction has been paused.
error CompleteAuctionPaused();
/// Invalid Parameters passed into function
error InvalidParameters(string message);
/// Error emitted when the maximum binary search depth has been exceeded
error MaxPriceSearchDepthExceeded(uint256 maxDepth);
/// Error emitted when there are no bids or offers
error NoBidsOrOffers();
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @title ITermAuctionEvents defines all events emitted by the TermAuctionContract.
interface ITermAuctionEvents {
/// Event emitted when a new auction is initialized
/// @param termRepoId The term ID
/// @param termAuctionId The term auction Id
/// @param termAuction auction contract address
/// @param auctionEndTime The auction end time
/// @param version The version tag of the smart contract deployed
event TermAuctionInitialized(
bytes32 termRepoId,
bytes32 termAuctionId,
address termAuction,
uint256 auctionEndTime,
string version
);
/// Event emitted when a bid is assigned
/// @param termAuctionId The auction ID
/// @param id The bid ID
/// @param amount The amount assigned
event BidAssigned(bytes32 termAuctionId, bytes32 id, uint256 amount);
/// Event emitted when an offer is assigned
/// @param termAuctionId The term ID
/// @param id The offer ID
/// @param amount The amount assigned
event OfferAssigned(bytes32 termAuctionId, bytes32 id, uint256 amount);
/// Event emitted when an auction is completed
/// @param termAuctionId The ID of the auction
/// @param timestamp The timestamp of the auction completion
/// @param block The block of the auction completion
/// @param totalAssignedBids The total amount of bids assigned
/// @param totalAssignedOffers The total amount of offers assigned
/// @param clearingPrice The clearing price of the auction
event AuctionCompleted(
bytes32 termAuctionId,
uint256 timestamp,
uint256 block,
uint256 totalAssignedBids,
uint256 totalAssignedOffers,
uint256 clearingPrice
);
/// Event emitted when an auction is cancelled.
/// @param termAuctionId The ID of the auction.
/// @param nonViableAuction Auction not viable due to bid and offer prices not intersecting
/// @param auctionCancelledforWithdrawal Auction has been cancelled for manual fund withdrawal
event AuctionCancelled(
bytes32 termAuctionId,
bool nonViableAuction,
bool auctionCancelledforWithdrawal
);
/// Event emitted when an auction is paused.
/// @param termAuctionId The ID of the auction.
/// @param termRepoId The ID of the repo.
event CompleteAuctionPaused(bytes32 termAuctionId, bytes32 termRepoId);
/// Event emitted when an auction is unpaused.
/// @param termAuctionId The ID of the auction.
/// @param termRepoId The ID of the repo.
event CompleteAuctionUnpaused(bytes32 termAuctionId, bytes32 termRepoId);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "../lib/TermAuctionOffer.sol";
import "../lib/TermAuctionOfferSubmission.sol";
import "../lib/TermAuctionRevealedOffer.sol";
interface ITermAuctionOfferLocker {
function auctionEndTime() external view returns (uint256);
// ========================================================================
// = Interface/API ========================================================
// ========================================================================
/// @param offerSubmissions An array of offer submissions
/// @return A bytes32 array of unique on chain offer ids.
function lockOffers(
TermAuctionOfferSubmission[] calldata offerSubmissions
) external returns (bytes32[] memory);
/// @param offerSubmissions An array of Term Auction offer submissions to lend an amount of money at rate no lower than the offer rate
/// @param referralAddress A user address that referred the submitter of this offer
/// @return A bytes32 array of unique on chain offer ids.
function lockOffersWithReferral(
TermAuctionOfferSubmission[] calldata offerSubmissions,
address referralAddress
) external returns (bytes32[] memory);
/// @param id An offer Id
/// @return A struct containing the details of the locked offer
function lockedOffer(
bytes32 id
) external view returns (TermAuctionOffer memory);
/// @param ids An array offer ids to reveal
/// @param prices An array of the offer prices to reveal
/// @param nonces An array of nonce values to generate bid price hashes
function revealOffers(
bytes32[] calldata ids,
uint256[] calldata prices,
uint256[] calldata nonces
) external;
/// @notice unlockOffers unlocks multiple offers and returns funds to the offeror
/// @param ids An array of offer ids
function unlockOffers(bytes32[] calldata ids) external;
// ========================================================================
// = Internal Interface/API ===============================================
// ========================================================================
/// @param revealedOffers An array of the revealed offer ids
/// @param unrevealedOffers An array of the unrevealed offer ids
/// @return An array of TermAuctionRevealedOffer structs containing details of the revealed offers
/// @return An array of TermAuctionOffer structs containing details of the unrevealed offers
function getAllOffers(
bytes32[] calldata revealedOffers,
bytes32[] calldata unrevealedOffers
)
external
returns (TermAuctionRevealedOffer[] memory, TermAuctionOffer[] memory);
/// @param id An offer Id
/// @param offeror The address of the offeror
/// @param amount The amount to unlock
function unlockOfferPartial(
bytes32 id,
address offeror,
uint256 amount
) external;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermAuctionOfferLockerEvents is an interface that defines all events emitted by the Term Auction Offer Locker.
interface ITermAuctionOfferLockerEvents {
event TermAuctionOfferLockerInitialized(
bytes32 termRepoId,
bytes32 termAuctionId,
address termAuctionOfferLocker,
uint256 auctionStartTime,
uint256 revealTime,
uint256 maxOfferPrice,
uint256 minimumTenderAmount
);
event OfferLocked(
bytes32 termAuctionId,
bytes32 id,
address offeror,
bytes32 offerPrice,
uint256 amount,
address token,
address referralAddress
);
event OfferRevealed(bytes32 termAuctionId, bytes32 id, uint256 offerPrice);
event OfferUnlocked(bytes32 termAuctionId, bytes32 id);
event OfferLockingPaused(bytes32 termAuctionId, bytes32 termRepoId);
event OfferLockingUnpaused(bytes32 termAuctionId, bytes32 termRepoId);
event OfferUnlockingPaused(bytes32 termAuctionId, bytes32 termRepoId);
event OfferUnlockingUnpaused(bytes32 termAuctionId, bytes32 termRepoId);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermController is an interface that defines events and functions of the Controller contract.
interface ITermController {
// ========================================================================
// = Interface/API ========================================================
// ========================================================================
/// @notice External view function which returns contract address of treasury wallet
function getTreasuryAddress() external view returns (address);
/// @notice External view function which returns contract address of protocol reserve
function getProtocolReserveAddress() external view returns (address);
/// @notice External view function which returns if contract address is a Term Finance contract or not
/// @param contractAddress input contract address
function isTermDeployed(
address contractAddress
) external view returns (bool);
// ========================================================================
// = Admin Functions ======================================================
// ========================================================================
/// @notice Admin function to update the Term Finance treasury wallet address
/// @param treasuryWallet new treasury address
function updateTreasuryAddress(address treasuryWallet) external;
/// @notice Admin function to update the Term Finance protocol reserve wallet address
/// @param protocolReserveAddress new protocol reserve wallet address
function updateProtocolReserveAddress(
address protocolReserveAddress
) external;
/// @notice Admin function to add a new Term Finance contract to Controller
/// @param termContract new term contract address
function markTermDeployed(address termContract) external;
/// @notice Admin function to remove a contract from Controller
/// @param termContract term contract address to remove
function unmarkTermDeployed(address termContract) external;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./ITermAuctionEvents.sol";
import "./ITermAuctionBidLockerEvents.sol";
import "./ITermAuctionOfferLockerEvents.sol";
import "./ITermRepoCollateralManagerEvents.sol";
import "./ITermRepoServicerEvents.sol";
import "./ITermRepoRolloverManagerEvents.sol";
import "./ITermRepoLockerEvents.sol";
import "./ITermRepoTokenEvents.sol";
import "./ITermEventEmitterEvents.sol";
import "../lib/TermAuctionBid.sol";
interface ITermEventEmitter is
ITermAuctionEvents,
ITermAuctionBidLockerEvents,
ITermAuctionOfferLockerEvents,
ITermRepoCollateralManagerEvents,
ITermRepoServicerEvents,
ITermRepoRolloverManagerEvents,
ITermRepoLockerEvents,
ITermRepoTokenEvents,
ITermEventEmitterEvents
{
// ========================================================================
// = TermAuction Events ===================================================
// ========================================================================
/// @param termRepoId The id of the current Term Repo deployment being initialized
/// @param termAuctionId The id of the auction being initialized
/// @param termAuction The address of the auction contract being initialized
/// @param auctionEndTime The end time of the auction being initialized
/// @param version The version tag of the smart contract deployed
function emitTermAuctionInitialized(
bytes32 termRepoId,
bytes32 termAuctionId,
address termAuction,
uint256 auctionEndTime,
string calldata version
) external;
/// @param termAuctionId A Term Auction id
/// @param id A bid id
/// @param amount The amount assigned to this bid
function emitBidAssigned(
bytes32 termAuctionId,
bytes32 id,
uint256 amount
) external;
/// @param termAuctionId A Term Auction id
/// @param id An offer id
/// @param amount The amount assigned to this offer
function emitOfferAssigned(
bytes32 termAuctionId,
bytes32 id,
uint256 amount
) external;
/// @param termAuctionId The Term Auction id of auction completed
/// @param timestamp The timestamp of the current block
/// @param blockNumber The number of the current block
/// @param totalAssignedBids The number of assigned bids in the auction
/// @param totalAssignedOffers The number of assigned offers in the auction
/// @param clearingPrice The clearing price of the auction
function emitAuctionCompleted(
bytes32 termAuctionId,
uint256 timestamp,
uint256 blockNumber,
uint256 totalAssignedBids,
uint256 totalAssignedOffers,
uint256 clearingPrice
) external;
/// @param nonViableAuction Auction not viable due to bid and offer prices not intersecting
/// @param auctionCancelledforWithdrawal Auction has been cancelled for withdrawal
function emitAuctionCancelled(
bytes32 termAuctionId,
bool nonViableAuction,
bool auctionCancelledforWithdrawal
) external;
/// @param termAuctionId The id of the auction paused
/// @param termRepoId The Term Repo id associated with auction paused
function emitCompleteAuctionPaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
/// @param termAuctionId The id of the auction unpaused
/// @param termRepoId The Term Repo id associated with auction unpaused
function emitCompleteAuctionUnpaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
// ========================================================================
// = TermAuctionBidLocker Events ==========================================
// ========================================================================
/// @param termRepoId The Term Repo id associated with BidLocker initialized
/// @param termAuctionId The Term Auction id associated with BidLocker initialized
/// @param termAuctionBidLocker The address of the TermAuctionBidLocker contract being intialized
/// @param auctionStartTime The time at which auction bids will be accepted for submission
/// @param revealTime The time at which sealed auction bids can be revealed
/// @param maxBidPrice The maximum tender price (interest rate) in percentage
/// @param minimumTenderAmount The minimum amount of borrowed purchase token that will be accepted
/// @param dayCountFractionMantissa The day count fraction remainder
function emitTermAuctionBidLockerInitialized(
bytes32 termRepoId,
bytes32 termAuctionId,
address termAuctionBidLocker,
uint256 auctionStartTime,
uint256 revealTime,
uint256 maxBidPrice,
uint256 minimumTenderAmount,
uint256 dayCountFractionMantissa
) external;
/// @param termAuctionId A Term Auction id
/// @param bid A struct containing details of the locked bid
/// @param referralAddress The address of the referrer. Zero Address if none.
function emitBidLocked(
bytes32 termAuctionId,
TermAuctionBid calldata bid,
address referralAddress
) external;
/// @param termAuctionId A Term Auction id
/// @param id The bid id
/// @param bidPrice The revealed price of the bid
function emitBidRevealed(
bytes32 termAuctionId,
bytes32 id,
uint256 bidPrice
) external;
/// @param termAuctionId A Term Auction id
/// @param id A bid id
function emitBidUnlocked(bytes32 termAuctionId, bytes32 id) external;
/// @param termAuctionId A Term Auction id
/// @param id A bid id
function emitBidInShortfall(bytes32 termAuctionId, bytes32 id) external;
/// @param termAuctionId The id of Term Auction where bid locking is paused
/// @param termRepoId The Term Repo id where bid locking is paused
function emitBidLockingPaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
/// @param termAuctionId The id of Term Auction where bid locking is unpaused
/// @param termRepoId The Term Repo id where bid locking is unpaused
function emitBidLockingUnpaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
/// @param termAuctionId The id of Term Auction where bid unlocking is paused
/// @param termRepoId The Term Repo id where bid unlocking is paused
function emitBidUnlockingPaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
/// @param termAuctionId The id of Term Auction where bid unlocking is unpaused
/// @param termRepoId The Term Repo id where bid unlocking is unpaused
function emitBidUnlockingUnpaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
// ========================================================================
// = TermAuctionOfferLocker Events ========================================
// ========================================================================
/// @param termRepoId The Term Repo id associated with OfferLocker initialized
/// @param termAuctionId The Term Auction id associated with OfferLocker initialized
/// @param termAuctionOfferLocker The address of the TermAuctionOfferLocker contract being intialized
/// @param auctionStartTime The time at which auction bids will be accepted for submission
/// @param revealTime The time at which sealed auction bids can be revealed
function emitTermAuctionOfferLockerInitialized(
bytes32 termRepoId,
bytes32 termAuctionId,
address termAuctionOfferLocker,
uint256 auctionStartTime,
uint256 revealTime,
uint256 maxOfferPrice,
uint256 minimumTenderAmount
) external;
/// @param termAuctionId A Term Auction id
/// @param id An offer id
/// @param offeror The address of the offeror
/// @param offerPrice The offer price
/// @param amount The amount of purchase tokens offered
/// @param purchaseToken The address of the purchase token being offered
/// @param referralAddress The address of the referrer. Zero Address if none.
function emitOfferLocked(
bytes32 termAuctionId,
bytes32 id,
address offeror,
bytes32 offerPrice,
uint256 amount,
address purchaseToken,
address referralAddress
) external;
/// @param termAuctionId A Term Auction id
/// @param id An offer id
/// @param offerPrice The offer price revealed
function emitOfferRevealed(
bytes32 termAuctionId,
bytes32 id,
uint256 offerPrice
) external;
/// @param termAuctionId A Term Auction id
/// @param id An offer id
function emitOfferUnlocked(bytes32 termAuctionId, bytes32 id) external;
/// @param termAuctionId The id of Term Auction where offer locking is paused
/// @param termRepoId The Term Repo id where offer locking is paused
function emitOfferLockingPaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
/// @param termAuctionId The id of Term Auction where offer locking is unpaused
/// @param termRepoId The Term Repo id where offer locking is unpaused
function emitOfferLockingUnpaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
/// @param termAuctionId The id of Term Auction where offer unlocking is paused
/// @param termRepoId The Term Repo id where offer unlocking is paused
function emitOfferUnlockingPaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
/// @param termAuctionId The id of Term Auction where offer unlocking is unpaused
/// @param termRepoId The Term Repo id where offer unlocking is unpaused
function emitOfferUnlockingUnpaused(
bytes32 termAuctionId,
bytes32 termRepoId
) external;
// ========================================================================
// = TermRepoCollateralManager Events =========================================
// ========================================================================
/// @param termRepoId The Term Repo id associated with collateral manger being initialized
/// @param termRepoCollateralManager The address of the TermRepoCollateralManager contract being intialized
/// @param collateralTokens An array containing a list of the addresses of all accepted collateral tokens
/// @param initialCollateralRatios An array containing the initial collateral ratios for each collateral token
/// @param maintenanceCollateralRatios An array containing the maintenance collateral ratios for each collateral token
/// @param liquidatedDamagesSchedule An array containing the liquidated damages applicable to each collateral token
function emitTermRepoCollateralManagerInitialized(
bytes32 termRepoId,
address termRepoCollateralManager,
address[] calldata collateralTokens,
uint256[] calldata initialCollateralRatios,
uint256[] calldata maintenanceCollateralRatios,
uint256[] calldata liquidatedDamagesSchedule
) external;
/// @param termRepoId The Term Repo id for the Term Repo being reopened
/// @param termRepoCollateralManager The TermRepoCollateralManager address for the Term Repo being reopened
/// @param termAuctionBidLocker New TermAuctionBidLocker to be paired for reopening
function emitPairReopeningBidLocker(
bytes32 termRepoId,
address termRepoCollateralManager,
address termAuctionBidLocker
) external;
/// @param termRepoId A Term Repo id
/// @param borrower The address of the borrower
/// @param collateralToken The address of the collateral token locked
/// @param amount The amount of collateral being locked
function emitCollateralLocked(
bytes32 termRepoId,
address borrower,
address collateralToken,
uint256 amount
) external;
/// @param termRepoId A Term Repo id
/// @param borrower The address of the borrower
/// @param collateralToken The address of the collateral token locked
/// @param amount The amount of collateral being unlocked
function emitCollateralUnlocked(
bytes32 termRepoId,
address borrower,
address collateralToken,
uint256 amount
) external;
/// @param termRepoId A Term Repo id
/// @param borrower The address of the borrower
/// @param liquidator The address of the liquidator
/// @param closureAmount The amount of repurchase exposure covered
/// @param collateralToken The address of the collateral tokens liquidated
/// @param amountLiquidated The amount of collateral tokens liquidated
function emitLiquidation(
bytes32 termRepoId,
address borrower,
address liquidator,
uint256 closureAmount,
address collateralToken,
uint256 amountLiquidated,
uint256 protocolSeizureAmount,
bool defaultLiquidation
) external;
/// @param termRepoId The id of Term Repo where liquidations are paused
function emitLiquidationPaused(bytes32 termRepoId) external;
/// @param termRepoId The id of Term Repo where liquidation is unpaused
function emitLiquidationUnpaused(bytes32 termRepoId) external;
// ========================================================================
// = TermRepoServicer Events ===============================================
// ========================================================================
/// @param termRepoId The Term Repo id associated with TermRepoServicer being initialized
/// @param termRepoServicer The address of the TermRepoServicer contract being initialized
/// @param purchaseToken The address of the purchase token
/// @param maturityTimestamp The time at which repurchase is due
/// @param endOfRepurchaseWindow The time at which the repurchase window ends
/// @param redemptionTimestamp The time when redemption of Term Repo Tokens begins
/// @param servicingFee percentage share of bid amounts charged to bidder
/// @param version The version tag of the smart contract deployed
function emitTermRepoServicerInitialized(
bytes32 termRepoId,
address termRepoServicer,
address purchaseToken,
uint256 maturityTimestamp,
uint256 endOfRepurchaseWindow,
uint256 redemptionTimestamp,
uint256 servicingFee,
string calldata version
) external;
/// @param termRepoId The Term Repo id for the Term Repo being reopened
/// @param termRepoServicer The address of the TermRepoServicer contract for the Term Repo being reopened
/// @param termAuctionOfferLocker The TermAuctionOfferLocker to be paired for reopening
/// @param termAuction The address of the TermAuction contract to be paired for reopening
function emitReopeningOfferLockerPaired(
bytes32 termRepoId,
address termRepoServicer,
address termAuctionOfferLocker,
address termAuction
) external;
/// @param termRepoId A Term Repo id
/// @param offeror The address of the offeror
/// @param amount The offer amount to be locked
/// @notice This event is not to be confused with OfferLocked by TermOfferLocker
/// @notice Both will be triggered, this one specifically refers to corresponding action taken by Term Servicer
function emitOfferLockedByServicer(
bytes32 termRepoId,
address offeror,
uint256 amount
) external;
/// @param termRepoId A Term Repo id
/// @param offeror The address of the offeror
/// @param amount The offer amount to be unlocked
/// @notice This event is not to be confused with OfferUnlocked by TermOfferLocker
/// @notice Both will be triggered, this one specifically refers to corresponding action taken by Term Servicer
function emitOfferUnlockedByServicer(
bytes32 termRepoId,
address offeror,
uint256 amount
) external;
/// @param offerId Unique id for offer
/// @param offeror The address of the offeror
/// @param purchasePrice The offer amount fulfilled
/// @param repurchasePrice The repurchase price due to offeror at maturity
/// @param repoTokensMinted The amount of Term Repo Tokens minted to offeror
function emitOfferFulfilled(
bytes32 offerId,
address offeror,
uint256 purchasePrice,
uint256 repurchasePrice,
uint256 repoTokensMinted
) external;
/// @param termRepoId A Term Repo id
/// @param redeemer The address of the redeemer
/// @param redemptionAmount The amount of TermRepoTokens redeemed
/// @param redemptionHaircut The haircut applied to redemptions (if any) due to unrecoverable repo exposure
function emitTermRepoTokensRedeemed(
bytes32 termRepoId,
address redeemer,
uint256 redemptionAmount,
uint256 redemptionHaircut
) external;
/// @param termRepoId A Term Repo id
/// @param bidder The address of the bidder
/// @param purchasePrice The bid amount fulfilled in auction
/// @param repurchasePrice The repurchase price due at maturity
/// @param servicingFees The fees earned by the protocol
function emitBidFulfilled(
bytes32 termRepoId,
address bidder,
uint256 purchasePrice,
uint256 repurchasePrice,
uint256 servicingFees
) external;
/// @param termRepoId A Term Repo id
/// @param borrower The address of the borrower
/// @param purchasePrice The purchase price received from new TermRepo
/// @param repurchasePrice The new repurchase price due at maturity of new TermRepo
/// @param servicingFees The fees earned by the protocol
function emitExposureOpenedOnRolloverNew(
bytes32 termRepoId,
address borrower,
uint256 purchasePrice,
uint256 repurchasePrice,
uint256 servicingFees
) external;
/// @param termRepoId A Term Repo id
/// @param borrower The address of the borrower
/// @param amountRolled The repurchase exposure balance closed on old Term Repo
function emitExposureClosedOnRolloverExisting(
bytes32 termRepoId,
address borrower,
uint256 amountRolled
) external;
/// @param termRepoId A Term Repo id
/// @param borrower The address of the borrower
/// @param amount The amount submitted for repurchase
function emitRepurchasePaymentSubmitted(
bytes32 termRepoId,
address borrower,
uint256 amount
) external;
/// @param termRepoId A Term Repo id
/// @param minter The address of the minter
/// @param netTokensReceived The amount of Term Repo Tokens received by minter net of servicing fees
/// @param servicingFeeTokens The number of Term Repo Tokens retained by protocol in servicing fees
/// @param repurchasePrice The repurchase exposure opened by minter against Term Repo Token mint
function emitMintExposure(
bytes32 termRepoId,
address minter,
uint256 netTokensReceived,
uint256 servicingFeeTokens,
uint256 repurchasePrice
) external;
/// @param termRepoId A Term Repo id
/// @param borrower The address of the borrower
/// @param closeAmount The amount of repurchase exposure to close
function emitBurnCollapseExposure(
bytes32 termRepoId,
address borrower,
uint256 closeAmount
) external;
// ========================================================================
// = TermRepoRolloverManager Events ===========================================
// ========================================================================
/// @param termRepoId The Term Repo id associated with TermRepoRolloverManager being initialized
/// @param rolloverManager The address of the TermRepoRolloverManager contract being initialized
function emitTermRepoRolloverManagerInitialized(
bytes32 termRepoId,
address rolloverManager
) external;
/// @param termRepoId The Term Repo id of existing Term Repo
/// @param rolloverTermAuctionId The Term Auction Id that rollover bid will be submitted into
function emitRolloverTermApproved(
bytes32 termRepoId,
bytes32 rolloverTermAuctionId
) external;
/// @param termRepoId The Term Repo id of existing Term Repo
/// @param rolloverTermAuctionId The Term Auction Id whose rollover approval is revoked
function emitRolloverTermApprovalRevoked(
bytes32 termRepoId,
bytes32 rolloverTermAuctionId
) external;
/// @param termRepoId The Term Repo id of existing Term Repo
/// @param rolloverTermRepoId Term Repo Id of Rollover Term Repo
/// @param borrower The address of the borrower
/// @param rolloverAuction The address of the auction being rolled over to
/// @param rolloverAmount The repurchase amount being rolled over
/// @param hashedBidPrice The hash of the rollover bid price
function emitRolloverElection(
bytes32 termRepoId,
bytes32 rolloverTermRepoId,
address borrower,
address rolloverAuction,
uint256 rolloverAmount,
bytes32 hashedBidPrice
) external;
/// @param termRepoId The Term Repo id of existing Term Repo
/// @param borrower The address of the borrower
function emitRolloverCancellation(
bytes32 termRepoId,
address borrower
) external;
/// @param termRepoId The Term Repo id of existing Term Repo
/// @param borrower The address of the borrower
function emitRolloverBidLockSucceeded(
bytes32 termRepoId,
address borrower
) external;
/// @param termRepoId The Term Repo id of existing Term Repo
/// @param borrower The address of the borrower
function emitRolloverBidLockFailed(
bytes32 termRepoId,
address borrower
) external;
/// @param termRepoId The Term Repo id of existing Term Repo
/// @param borrower The address of the borrower
function emitRolloverProcessed(
bytes32 termRepoId,
address borrower
) external;
// ========================================================================
// = TermRepoLocker Events ======================================================
// ========================================================================
/// @param termRepoId The Term Repo id associated with TermRepoLocker contract being initialized
/// @param termRepoLocker The address of the TermRepoLocker contract being initialized
function emitTermRepoLockerInitialized(
bytes32 termRepoId,
address termRepoLocker
) external;
/// @param termRepoId A Term Repo id
function emitTermRepoLockerTransfersPaused(bytes32 termRepoId) external;
/// @param termRepoId A Term Repo id
function emitTermRepoLockerTransfersUnpaused(bytes32 termRepoId) external;
// ========================================================================
// = TermRepoToken Events =====================================================
// ========================================================================
/// @param termRepoId The Term Repo id associated with the TermRepoToken being initalized
/// @param termRepoToken The address of the TermRepoToken contract being initialized
/// @param redemptionRatio The number of purchase tokens redeemable per unit of Term Repo Token at par
function emitTermRepoTokenInitialized(
bytes32 termRepoId,
address termRepoToken,
uint256 redemptionRatio
) external;
/// @param termRepoId The Term Repo id associated with the TermRepoToken where minting is paused
function emitTermRepoTokenMintingPaused(bytes32 termRepoId) external;
/// @param termRepoId The Term Repo id associated with the TermRepoToken where minting is unpaused
function emitTermRepoTokenMintingUnpaused(bytes32 termRepoId) external;
/// @param termRepoId The Term Repo id associated with the TermRepoToken where burning is paused
function emitTermRepoTokenBurningPaused(bytes32 termRepoId) external;
/// @param termRepoId The Term Repo id associated with the TermRepoToken where burning is unpaused
function emitTermRepoTokenBurningUnpaused(bytes32 termRepoId) external;
// ========================================================================
// = TermEventEmitter Events ==============================================
// ========================================================================
/// @param termRepoId The id of the Term Repo being delisted
function emitDelistTermRepo(bytes32 termRepoId) external;
/// @param termAuctionId The id of the Term Auction being delisted
function emitDelistTermAuction(bytes32 termAuctionId) external;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
interface ITermEventEmitterEvents {
/// @notice Event emitted when a new Term Repo is delisted on Term Finance
/// @param termRepoId unique identifier for a Term Repo
event DelistTermRepo(bytes32 termRepoId);
/// @notice Event emitted when a new Term Auction is delisted on Term Finance
/// @param termAuctionId unique identifier for a Term Auction
event DelistTermAuction(bytes32 termAuctionId);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "../lib/ExponentialNoError.sol";
interface ITermPriceOracle {
function reOpenToNewBidLocker(address termAuctionBidLocker) external;
/// @notice A function to return current market value given a token address and an amount
/// @param token The address of the token to query
/// @param amount The amount tokens to value
/// @return The current market value of tokens at the specified amount, in USD
function usdValueOfTokens(
address token,
uint256 amount
) external view returns (ExponentialNoError.Exp memory);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermPriceOracleErrors defines all errors emitted by the PriceOracle.
interface ITermPriceOracleErrors {
error NoPriceFeed(address tokenAddress);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermPriceOracleEvents is an interface that defines all events emitted by the Term Price Oracle.
interface ITermPriceOracleEvents {
/// @notice Event emitted when a new price feed is added or updated to price oracle.
/// @param token The address of the token fee subscribe
/// @param tokenPriceAggregator The proxy price aggregator address subscribed
event SubscribePriceFeed(address token, address tokenPriceAggregator);
/// @notice Event emitted when a price feed is removed from price oracle.
/// @param token The address of the token
event UnsubscribePriceFeed(address token);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "../lib/ExponentialNoError.sol";
import "./ITermRepoLocker.sol";
/// @notice ITermManager represents a contract that manages all
interface ITermRepoCollateralManager {
// ========================================================================
// = State Variables =====================================================
// ========================================================================
function termRepoLocker() external view returns (ITermRepoLocker);
function maintenanceCollateralRatios(
address
) external view returns (uint256);
function initialCollateralRatios(address) external view returns (uint256);
function numOfAcceptedCollateralTokens() external view returns (uint8);
function collateralTokens(uint256 index) external view returns (address);
function encumberedCollateralRemaining() external view returns (bool);
// ========================================================================
// = Auction Functions ===================================================
// ========================================================================
/// @param bidder The bidder's address
/// @param collateralToken The address of the token to be used as collateral
/// @param amount The amount of the token to lock
function auctionLockCollateral(
address bidder,
address collateralToken,
uint256 amount
) external;
/// @param bidder The bidder's address
/// @param collateralToken The address of the token used as collateral
/// @param amount The amount of collateral tokens to unlock
function auctionUnlockCollateral(
address bidder,
address collateralToken,
uint256 amount
) external;
// ========================================================================
// = Rollover Functions ==================================================
// ========================================================================
/// @param borrower The borrower's address
/// @param rolloverProportion The proportion of the collateral to be unlocked, equal to the proportion of the collateral repaid
/// @param rolloverTermRepoLocker The address of the new TermRepoLocker contract to roll into
/// @return An array representing a list of accepted collateral token addresses
/// @return An array containing the amount of collateral tokens to pairoff and transfer to new TermRepoLocker to roll into
function transferRolloverCollateral(
address borrower,
uint256 rolloverProportion,
address rolloverTermRepoLocker
) external returns (address[] memory, uint256[] memory);
/// @param borrower The address of the borrower
/// @param collateralToken The address of a collateral token
/// @param amount The amount of collateral tokens to lock
function acceptRolloverCollateral(
address borrower,
address collateralToken,
uint256 amount
) external;
/// @param rolloverAuction The address of the rollover auction
function approveRolloverAuction(address rolloverAuction) external;
// ========================================================================
// = APIs ================================================================
// ========================================================================
/// @param collateralToken The address of the collateral token to lock
/// @param amount The amount of collateral token to lock
function externalLockCollateral(
address collateralToken,
uint256 amount
) external;
/// @param collateralToken The address of the collateral token to unlock
/// @param amount The amount of collateral token to unlock
function externalUnlockCollateral(
address collateralToken,
uint256 amount
) external;
/// @param borrower The address of the borrower
/// @return The market value of borrower's locked collateral denominated in USD
function getCollateralMarketValue(
address borrower
) external view returns (uint256);
// ========================================================================
// = Margin Maintenance Functions ========================================
// ========================================================================
/// @param borrower The address of the borrower
function unlockCollateralOnRepurchase(address borrower) external;
/// @param borrower The address of the borrower
/// @param collateralTokenAddresses Collateral token addresses
/// @param collateralTokenAmounts Collateral token amounts
function journalBidCollateralToCollateralManager(
address borrower,
address[] calldata collateralTokenAddresses,
uint256[] calldata collateralTokenAmounts
) external;
/// @param borrower The address of the borrower
/// @param collateralToken Collateral token addresse
/// @param amount Collateral token amount
function mintOpenExposureLockCollateral(
address borrower,
address collateralToken,
uint256 amount
) external;
/// @param collateralToken The collateral token address of tokens locked
/// @param amountToLock The amount of collateral tokens to lock
function calculateMintableExposure(
address collateralToken,
uint256 amountToLock
) external view returns (ExponentialNoError.Exp memory);
/// @param borrower The address of the borrower
/// @param collateralToken The collateral token address to query
/// @return uint256 The amount of collateralToken locked on behalf of borrower
function getCollateralBalance(
address borrower,
address collateralToken
) external view returns (uint256);
/// @param borrower The address of the borrower
/// @return An array of collateral token addresses
/// @return An array collateral token balances locked on behalf of borrower
function getCollateralBalances(
address borrower
) external view returns (address[] memory, uint256[] memory);
/// @param borrower The address of the borrower
/// @param closureAmounts An array specifying the amounts of Term Repo exposure the liquidator proposes to cover in liquidation; an amount is required to be specified for each collateral token
function batchDefault(
address borrower,
uint256[] calldata closureAmounts
) external;
/// @param borrower The address of the borrower
/// @param closureAmounts An array specifying the amounts of Term Repo exposure the liquidator proposes to cover in liquidation; an amount is required to be specified for each collateral token
function batchLiquidation(
address borrower,
uint256[] calldata closureAmounts
) external;
/// @param borrower The address of the borrower
/// @param closureRepoTokenAmounts An array specifying the amounts of Term Repo Tokens the liquidator proposes to cover borrower repo exposure in liquidation; an amount is required to be specified for each collateral token
function batchLiquidationWithRepoToken(
address borrower,
uint256[] calldata closureRepoTokenAmounts
) external;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermRepoCollateralManagerErrors defines all errors emitted by Term Repo Collateral Manager.
interface ITermRepoCollateralManagerErrors {
error AlreadyTermContractPaired();
error BorrowerNotInShortfall();
error CallerNotBorrower();
error CollateralBelowMaintenanceRatios(address borrower, address token);
error CollateralDepositClosed();
error CollateralTokenNotAllowed(address token);
error CollateralWithdrawalClosed();
error DefaultsClosed();
error InvalidParameters(string message);
error InsufficientCollateralForLiquidationRepayment(
address collateralToken
);
error InsufficientCollateralForRedemption();
error ExceedsNetExposureCapOnLiquidation();
error LiquidationsPaused();
error RepaymentAmountLargerThanAllowed();
error SelfLiquidationNotPermitted();
error ShortfallLiquidationsClosed();
error TermRepurchaseWindowOpen();
error TotalRepaymentGreaterThangetBorrowerRepurchaseObligation();
error UnlockAmountGreaterThanCollateralBalance();
error ZeroAddressContractPaired();
error ZeroBorrowerRepurchaseObligation();
error ZeroCollateralBalance();
error ZeroLiquidationNotPermitted();
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermRepoCollateralManagerEvents is an interface that defines all events emitted by Term Repo Collateral Manager.
interface ITermRepoCollateralManagerEvents {
/// @notice Event emitted when a Term Repo Collateral Manager is initialized.
/// @param termRepoId term identifier
/// @param collateralTokens addresses of accepted collateral tokens
/// @param initialCollateralRatios list of initial collateral ratios for each collateral token in the same order as collateral tokens list
/// @param maintenanceCollateralRatios list of maintenance ratios for each collateral token in the same order as collateral tokens list
/// @param liquidatedDamagesSchedule liquidation discounts for collateral tokens
event TermRepoCollateralManagerInitialized(
bytes32 termRepoId,
address termRepoCollateralManager,
address[] collateralTokens,
uint256[] initialCollateralRatios,
uint256[] maintenanceCollateralRatios,
uint256[] liquidatedDamagesSchedule
);
/// @notice Event emitted when existing Term Repo Locker is reopened to another auction group
/// @param termRepoId term identifier
/// @param termRepoCollateralManager address of collateral manager
/// @param termAuctionBidLocker address of auction bid locker paired through reopening
event PairReopeningBidLocker(
bytes32 termRepoId,
address termRepoCollateralManager,
address termAuctionBidLocker
);
/// @notice Event emitted when collateral is locked.
/// @param termRepoId term identifier
/// @param borrower address of borrower who locked collateral
/// @param collateralToken address of collateral token
/// @param amount amount of collateral token locked
event CollateralLocked(
bytes32 termRepoId,
address borrower,
address collateralToken,
uint256 amount
);
/// @notice Event emitted when collateral is locked.
/// @param termRepoId term identifier
/// @param borrower address of borrower who locked collateral
/// @param collateralToken address of collateral token
/// @param amount amount of collateral token unlocked
event CollateralUnlocked(
bytes32 termRepoId,
address borrower,
address collateralToken,
uint256 amount
);
/// @notice Event emitted when a liquidation occurs
/// @param termRepoId term identifier
/// @param borrower address of borrower being liquidated
/// @param liquidator address of liquidator
/// @param closureAmount amount of loan repaid by liquidator
/// @param collateralToken address of collateral token liquidated
/// @param amountLiquidated amount of collateral liquidated
/// @param protocolSeizureAmount amount of collateral liquidated and seized by protocol as fee
/// @param defaultLiquidation boolean indicating if liquidation is a default or not
event Liquidation(
bytes32 termRepoId,
address borrower,
address liquidator,
uint256 closureAmount,
address collateralToken,
uint256 amountLiquidated,
uint256 protocolSeizureAmount,
bool defaultLiquidation
);
/// @notice Event emitted when a Liquidations are paused for a term
/// @param termRepoId term identifier
event LiquidationsPaused(bytes32 termRepoId);
/// @notice Event emitted when a Liquidations are unpaused for a term
/// @param termRepoId term identifier
event LiquidationsUnpaused(bytes32 termRepoId);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice TermRepoLocker contracts lock collateral and purchase tokens
/// @notice Methods should only be callable from paired TermManager.
interface ITermRepoLocker {
/// @notice Locks tokens from origin wallet
/// @notice Reverts if caller doesn't have SERVICER_ROLE
/// @param originWallet Origin wallet to transfer tokens from
/// @param token Address of token being transferred
/// @param amount Amount of tokens to transfer
function transferTokenFromWallet(
address originWallet,
address token,
uint256 amount
) external;
/// @notice Unlocks tokens to destination wallet
/// @dev Reverts if caller doesn't have SERVICER_ROLE
/// @param destinationWallet Destination wallet to unlock tokens to
/// @param token Address of token being unlocked
/// @param amount Amount of tokens to unlock
function transferTokenToWallet(
address destinationWallet,
address token,
uint256 amount
) external;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermRepoLockerErrors defines all errors emitted by TermRepoLocker.
interface ITermRepoLockerErrors {
error ERC20TransferFailed();
error TermRepoLockerTransfersPaused();
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermRepoLockerEvents is an interface that defines all events emitted by the TermRepoLocker.
interface ITermRepoLockerEvents {
/// @notice Event emitted when a TermRepoLocker is initialized.
/// @param termRepoId term identifier
/// @param termRepoLocker address of initialized term repo locker
event TermRepoLockerInitialized(bytes32 termRepoId, address termRepoLocker);
/// @notice Event emitted transfers for a TermRepoLocker are paused.
/// @param termRepoId term identifier
event TermRepoLockerTransfersPaused(bytes32 termRepoId);
/// @notice Event emitted transfers for a TermRepoLocker are unpaused.
/// @param termRepoId term identifier
event TermRepoLockerTransfersUnpaused(bytes32 termRepoId);
}//SPDX-License-Identifier: Unlicense
pragma solidity ^0.8.18;
import "../lib/TermRepoRolloverElection.sol";
import "../lib/TermRepoRolloverElectionSubmission.sol";
interface ITermRepoRolloverManager {
// ========================================================================
// = APIs ================================================================
// ========================================================================
/// @notice An external function that accepted Term Repo rollover instructions
/// @param termRepoRolloverElectionSubmission A struct containing borrower rollover instructions
function electRollover(
TermRepoRolloverElectionSubmission
calldata termRepoRolloverElectionSubmission
) external;
/// @notice A view function that returns borrower rollover instructions
/// @param borrower The address of the borrower
/// @return A struct containing borrower rollover instructions
function getRolloverInstructions(
address borrower
) external view returns (TermRepoRolloverElection memory);
/// @notice An external function to cancel previously submitted rollover instructions, if it hasn't been locked into an auction
function cancelRollover() external;
/// @notice An external function that submits rollover bids given a list of borrower addresses
/// @param borrowersToRollover An array containing borrower addresses to process for rollover
function batchProcessRollovers(
address[] calldata borrowersToRollover
) external;
// ========================================================================
// = Fulfiller Functions ================================================
// ========================================================================
/// @notice An external function called by repo servicer to to mark rollover as fulfilled
/// @param borrower The address of the borrower
function fulfillRollover(address borrower) external;
}//SPDX-License-Identifier: Unlicense
pragma solidity ^0.8.18;
/// @notice ITermRepoCollateralManagerEvents is an interface that defines all events emitted by Term Repo Collateral Manager.
interface ITermRepoRolloverManagerEvents {
/// @notice Event emitted when a rollover manager is initialized
/// @param termRepoId A Term Repo id
/// @param rolloverManager Address of rollover manager
event TermRepoRolloverManagerInitialized(
bytes32 termRepoId,
address rolloverManager
);
/// @notice Event emitted when a rollover manager approves a future term as a destination for borrows
/// @param termRepoId A Term Repo id
/// @param rolloverTermAuctionId The Term Auction Id that rollover bid will be submitted into
event RolloverTermApproved(
bytes32 termRepoId,
bytes32 rolloverTermAuctionId
);
/// @notice Event emitted when a rollover manager revokes approval for a future term as a destination for borrows
/// @param termRepoId A Term Repo id
/// @param rolloverTermAuctionId The Term Auction Id that rollover bid will be submitted into
event RolloverTermApprovalRevoked(
bytes32 termRepoId,
bytes32 rolloverTermAuctionId
);
/// @notice Event emitted when a borrower elects a rollover contract
/// @param termRepoId A Term Repo id
/// @param rolloverTermRepoId Term Repo Id of Rollover Term Repo
/// @param borrower The address of the borrower
/// @param rolloverAuction The address of rollover term contract
/// @param rolloverAmount Amount of purchase currency borrower is rolling over
/// @param hashedBidPrice The hash of rollover bid price
event RolloverElection(
bytes32 termRepoId,
bytes32 rolloverTermRepoId,
address borrower,
address rolloverAuction,
uint256 rolloverAmount,
bytes32 hashedBidPrice
);
/// @notice Event emitted when a borrower cancels a rollover election
/// @param termRepoId A Term Repo id
/// @param borrower The address of the borrower
event RolloverCancellation(bytes32 termRepoId, address borrower);
/// @notice Event emitted when a bid is locked for a borrower rollover
/// @param termRepoId A Term Repo id
/// @param borrower The address of borrower
event RolloverBidLockSucceeded(bytes32 termRepoId, address borrower);
/// @notice Event emitted when a bid fails to be locked for a borrower rollover
/// @param termRepoId A Term Repo id
/// @param borrower The address of borrower
event RolloverBidLockFailed(bytes32 termRepoId, address borrower);
/// @notice Event emitted when a rollover is processed completely
/// @param termRepoId A Term Repo id
/// @param borrower The address of borrower
event RolloverProcessed(bytes32 termRepoId, address borrower);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./ITermRepoCollateralManager.sol";
import "./ITermRepoRolloverManager.sol";
import "./ITermRepoLocker.sol";
/// @notice ITermRepoServicer represents a contract that manages all
interface ITermRepoServicer {
// ========================================================================
// = State Variables =====================================================
// ========================================================================
function endOfRepurchaseWindow() external view returns (uint256);
function maturityTimestamp() external view returns (uint256);
function redemptionTimestamp() external view returns (uint256);
function purchaseToken() external view returns (address);
function servicingFee() external view returns (uint256);
function termRepoCollateralManager()
external
view
returns (ITermRepoCollateralManager);
function termRepoRolloverManager()
external
view
returns (ITermRepoRolloverManager);
function termRepoLocker() external view returns (ITermRepoLocker);
// ========================================================================
// = Auction Functions ===================================================
// ========================================================================
/// @param offeror The address of the offeror
/// @param amount The amount of purchase tokens to lock
function lockOfferAmount(address offeror, uint256 amount) external;
/// @param offeror The address of the offeror
/// @param amount The amount of purchase tokens to unlocked
function unlockOfferAmount(address offeror, uint256 amount) external;
/// @param offeror The address of the offeror
/// @param purchasePrice The offer amount to fulfill
/// @param repurchasePrice The repurchase price due to offeror at maturity
/// @param offerId A unique offer id
function fulfillOffer(
address offeror,
uint256 purchasePrice,
uint256 repurchasePrice,
bytes32 offerId
) external;
/// @param redeemer The address of redeemer
/// @param amountToRedeem The amount of TermRepoTokens to redeem
function redeemTermRepoTokens(
address redeemer,
uint256 amountToRedeem
) external;
/// @dev This method allows MINTER_ROLE to open repurchase price exposure against a TermRepoToken mint of corresponding value outside of a Term Auction to create new supply
/// @param amount The amount of Term Repo Tokens to mint
/// @param collateralAmounts An array containing an amount of collateral token for each token in collateral basket
function mintOpenExposure(
uint256 amount,
uint256[] calldata collateralAmounts
) external;
/// @param bidder The address of the bidder
/// @param purchasePrice The bid amount to fulfill
/// @param repurchasePrice The repurchase price due at maturity
/// @param collateralTokens Collateral token addresses
/// @param collateralAmounts Collateral token amounts
/// @param dayCountFractionMantissa Actual/360 day count fraction parameter from Term Auction Group
function fulfillBid(
address bidder,
uint256 purchasePrice,
uint256 repurchasePrice,
address[] calldata collateralTokens,
uint256[] calldata collateralAmounts,
uint256 dayCountFractionMantissa
) external;
// ========================================================================
// = Rollover Functions ==================================================
// ========================================================================
/// @param termAuction The address of a TermAuction contract to receive autioneer role
function approveRolloverAuction(address termAuction) external;
/// @param borrower The address of the borrower rolling into new Term Repo
/// @param purchasePrice The purchase price received from new TermRepo
/// @param repurchasePrice The new repurchase price due at maturity of new TermRepo
/// @param previousTermRepoLocker The address of the old TermRepoLocker contract
/// @param dayCountFractionMantissa Actual/360 day count fraction parameter from Term Auction Group
/// @return The net purchase price received in after deducing protocol servicing fees
function openExposureOnRolloverNew(
address borrower,
uint256 purchasePrice,
uint256 repurchasePrice,
address previousTermRepoLocker,
uint256 dayCountFractionMantissa
) external returns (uint256);
/// @param borrower The address of the borrower
/// @param rolloverSettlementAmount The amount of net proceeds received from new TermRepo to pay down existing repurchase obligation due to old Term Repo
/// @return A uint256 representing the proportion of total repurchase due to old Term Repo from borrower settled by proceeds from new TermRepo
function closeExposureOnRolloverExisting(
address borrower,
uint256 rolloverSettlementAmount
) external returns (uint256);
// ========================================================================
// = APIs ================================================================
// ========================================================================
/// @notice The max repurchase amount is the repurchase balance less any amounts earmarked for rollover
/// @param amount The amount of purchase token to submit for repurchase
function submitRepurchasePayment(uint256 amount) external;
/// @param amountToBurn The amount of TermRepoTokens to burn
function burnCollapseExposure(uint256 amountToBurn) external;
/// @param borrower The address of the borrower to query
/// @return The total repurchase price due at maturity for a given borrower
function getBorrowerRepurchaseObligation(
address borrower
) external view returns (uint256);
/// @param borrower The address of the borrower
/// @param liquidator The address of the liquidator
/// @param amountToCover The amount of repurchase exposure to cover in liquidation
function liquidatorCoverExposure(
address borrower,
address liquidator,
uint256 amountToCover
) external;
/// @param borrower The address of the borrower
/// @param liquidator The address of the liquidator
/// @param amountOfRepoToken The amount of term tokens used to cover in liquidation
/// @return A uint256 representing purchase value of repo tokens burned
function liquidatorCoverExposureWithRepoToken(
address borrower,
address liquidator,
uint256 amountOfRepoToken
) external returns (uint256);
/// @return A boolean that represents whether the term repo locker is balanced
function isTermRepoBalanced() external view returns (bool);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermRepoServicerErrors defines all errors emitted by the Term Repo Servicer.
interface ITermRepoServicerErrors {
error AfterMaturity();
error AfterRepurchaseWindow();
error AlreadyTermContractPaired();
error CallerNotBorrower();
error EncumberedCollateralRemaining();
error InsufficientgetBorrowerRepurchaseObligation();
error InsufficientCollateral();
error InsufficientTermRepoTokenBalance();
error InvalidParameters(string message);
error LockedBalanceInsufficient();
error NoMintOpenExposureAccess();
error NotMaturedYet();
error RedemptionPeriodNotOpen();
error RepurchaseAmountTooHigh();
error ZeroBorrowerRepurchaseObligation();
error ZeroTermRepoTokenBalance();
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermRepoServicerEvents is an interface that defines all events emitted by the Term Repo Servicer.
interface ITermRepoServicerEvents {
/// @notice Event emitted when a Term Loan Manager is initialized.
/// @param termRepoId A Term Repo id
/// @param purchaseToken The address of purchase token used for loans and repay
/// @param maturityTimestamp The timestamp at which term reaches maturity
/// @param endOfRepurchaseWindow The timestamp at which Term Repo is closed to repurchase
/// @param redemptionTimestamp The timestamp at which loaners can redeem term repo tokens
/// @param servicingFee percentage share of bid amounts charged to bidder
/// @param version The version tag of the smart contract deployed
event TermRepoServicerInitialized(
bytes32 termRepoId,
address termRepoServicer,
address purchaseToken,
uint256 maturityTimestamp,
uint256 endOfRepurchaseWindow,
uint256 redemptionTimestamp,
uint256 servicingFee,
string version
);
/// @notice Event emitted when a TermRepoLocker is reopened to another auction group
/// @param termRepoId A Term Repo id
/// @param termRepoServicer The address of loan manager
/// @param termAuctionOfferLocker The address of auction offer locker paired through reopening
/// @param termAuction The address of auction paired through reopening
event ReopeningOfferLockerPaired(
bytes32 termRepoId,
address termRepoServicer,
address termAuctionOfferLocker,
address termAuction
);
/// @notice Event emitted when a loan offer is locked.
/// @param termRepoId A Term Repo id
/// @param offeror The address who submitted offer
/// @param amount The amount of purchase token locked for offer
event OfferLockedByServicer(
bytes32 termRepoId,
address offeror,
uint256 amount
);
/// @notice Event emitted when a loan offer is unlocked.
/// @param termRepoId A Term Repo id
/// @param offeror The address who submitted offer
/// @param amount The amount of purchase token unlocked for offer
event OfferUnlockedByServicer(
bytes32 termRepoId,
address offeror,
uint256 amount
);
/// @notice Event emitted when a loan offer is fulfilled.
/// @param offerId A unique offer id
/// @param offeror The address whose offer is fulfilled
/// @param purchasePrice The purchasePrice of loan offer fulfilled
/// @param repurchasePrice The repurchasePrice of loan offer fulfilled
/// @param repoTokensMinted The amount of Term Repo Tokens minted to offeror
event OfferFulfilled(
bytes32 offerId,
address offeror,
uint256 purchasePrice,
uint256 repurchasePrice,
uint256 repoTokensMinted
);
/// @notice Event emitted when a term repo token is redeemed.
/// @param termRepoId A Term Repo id
/// @param redeemer The address who is redeeming term repo tokens
/// @param redemptionAmount The amount of loan offer redeemed by term repo tokens
/// @param redemptionHaircut The haircut applied to redemptions (if any) due to unrecoverable repo exposure
event TermRepoTokensRedeemed(
bytes32 termRepoId,
address redeemer,
uint256 redemptionAmount,
uint256 redemptionHaircut
);
/// @notice Event emitted when a loan is processed to a borrower
/// @param termRepoId A Term Repo id
/// @param bidder The address who is receiving the loan
/// @param purchasePrice The purchasePrice transferred to borrower
/// @param repurchasePrice The repurchasePrice owed by borrower at maturity
/// @param servicingFees The protocol fees paid for loan
event BidFulfilled(
bytes32 termRepoId,
address bidder,
uint256 purchasePrice,
uint256 repurchasePrice,
uint256 servicingFees
);
/// @notice Event emitted when a rollover from a previous loan opens a position in this new term
/// @param termRepoId A Term Repo id
/// @param borrower The borrower who has loan position opened in new term
/// @param purchasePrice The purchasePrice transferred to previous term
/// @param repurchasePrice The repurchasePrice owed by borrower at maturity
/// @param servicingFees The protocol fees paid for loan
event ExposureOpenedOnRolloverNew(
bytes32 termRepoId,
address borrower,
uint256 purchasePrice,
uint256 repurchasePrice,
uint256 servicingFees
);
/// @notice Event emitted when a rollover from a previous loan opens a position in this new term
/// @param termRepoId A Term Repo id
/// @param borrower The borrower who has loan position opened in new term
/// @param amountRolled The amount of borrower loan collapsed by rollover opening
event ExposureClosedOnRolloverExisting(
bytes32 termRepoId,
address borrower,
uint256 amountRolled
);
/// @notice Event emitted when term repo tokens are minted for a loan
/// @param termRepoId A Term Repo id
/// @param minter The address who is opening the loan
/// @param netTokensReceived The amount of Term Repo Tokens received by minter net of servicing fees
/// @param servicingFeeTokens The number of Term Repo Tokens retained by protocol in servicing fees
/// @param repurchasePrice The repurchase exposure opened by minter against Term Repo Token mint
event TermRepoTokenMint(
bytes32 termRepoId,
address minter,
uint256 netTokensReceived,
uint256 servicingFeeTokens,
uint256 repurchasePrice
);
/// @notice Event emitted when a loan is collapsed by burning term repo tokens
/// @param termRepoId A Term Repo id
/// @param borrower The address who is repaying the loan
/// @param amountToClose The amount repaid by borrower
event BurnCollapseExposure(
bytes32 termRepoId,
address borrower,
uint256 amountToClose
);
/// @notice Event emitted when a loan is repaid by borrower
/// @param termRepoId A Term Repo id
/// @param borrower The address who is repaying the loan
/// @param repurchaseAmount The amount repaid by borrower
event RepurchasePaymentSubmitted(
bytes32 termRepoId,
address borrower,
uint256 repurchaseAmount
);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
interface ITermRepoToken is IERC20Upgradeable {
// ========================================================================
// = State Variables ======================================================
// ========================================================================
/// @notice The number of purchase tokens redeemable
function redemptionValue() external view returns (uint256);
// ========================================================================
// = Interface/API ========================================================
// ========================================================================
/// @notice Calculates the total USD redemption value of all outstanding TermRepoTokens
/// @return totalRedemptionValue Total redemption value of TermRepoTokens in USD
function totalRedemptionValue() external view returns (uint256);
/// @notice Burns TermRepoTokens held by an account
/// @notice Reverts if caller does not have BURNER_ROLE
/// @param account Address of account holding TermRepoTokens to burn
/// @param amount Amount of TermRepoTokens to burn without decimal factor
function burn(address account, uint256 amount) external;
/// @notice Burns TermRepoTokens held by an account and returns purchase redemption value of tokens burned
/// @notice Reverts if caller does not have BURNER_ROLE
/// @param account Address of account holding TermRepoTokens to burn
/// @param amount Amount of TermRepoTokens to burn without decimal factor
/// @return totalRedemptionValue Total redemption value of TermRepoTokens burned
function burnAndReturnValue(
address account,
uint256 amount
) external returns (uint256);
/// @notice Mints TermRepoTokens in an amount equal to caller specified target redemption amount
/// @notice The redemptionValue is the amount of purchase tokens redeemable per unit of TermRepoToken
/// @notice Reverts if caller does not have MINTER_ROLE
/// @param account Address of account to mint TermRepoTokens to
/// @param redemptionAmount The target redemption amount to mint in TermRepoTokens
function mintRedemptionValue(
address account,
uint256 redemptionAmount
) external returns (uint256);
/// @notice Mints an exact amount of TermRepoTokens to an account
/// @notice Reverts if caller does not have MINTER_ROLE
/// @param account Theaddress of account to mint TermRepoTokens
/// @param numTokens exact number of term repo tokens to mint
function mintTokens(
address account,
uint256 numTokens
) external returns (uint256);
/// @notice Decrements the mintExposureCap
/// @notice Reverts if caller does not have MINTER_ROLE
/// @param supplyMinted Number of Tokens Minted
function decrementMintExposureCap(uint256 supplyMinted) external;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermRepoTokenErrors defines all errors emitted by Term Repo Token.
interface ITermRepoTokenErrors {
error AlreadyTermContractPaired();
error TermRepoTokenMintingPaused();
error TermRepoTokenBurningPaused();
error MintExposureCapExceeded();
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @notice ITermRepoTokenEvents is an interface that defines all events emitted by the Term Repo Token
interface ITermRepoTokenEvents {
/// @notice Event emitted when a Term Repo Servicer is initialized.
/// @param termRepoId term identifier
/// @param termRepoToken address of initialized term repo token
/// @param redemptionRatio The number of purchase tokens redeemable per unit of Term Repo Token at par
event TermRepoTokenInitialized(
bytes32 termRepoId,
address termRepoToken,
uint256 redemptionRatio
);
/// @notice Event emitted when a Term Repo Token Minting is Paused
/// @param termRepoId A Term Repo id
event TermRepoTokenMintingPaused(bytes32 termRepoId);
/// @notice Event emitted when a Term Repo Token Minting is Unpaused
/// @param termRepoId A Term Repo id
event TermRepoTokenMintingUnpaused(bytes32 termRepoId);
/// @notice Event emitted when a Term Repo Token Burning is Paused
/// @param termRepoId A Term Repo id
event TermRepoTokenBurningPaused(bytes32 termRepoId);
/// @notice Event emitted when a Term Repo Token Burning is Unpaused
/// @param termRepoId A Term Repo id
event TermRepoTokenBurningUnpaused(bytes32 termRepoId);
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev Collateral info for price oracle
struct Collateral {
address tokenAddress;
uint256 initialCollateralRatio;
uint256 maintenanceRatio;
uint256 liquidatedDamage;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev TermAuctionOffer represents an offer to lend an specific amount of tokens at a specific interest rate (or better)
struct CompleteAuctionInput {
bytes32[] revealedBidSubmissions;
bytes32[] expiredRolloverBids;
bytes32[] unrevealedBidSubmissions;
bytes32[] revealedOfferSubmissions;
bytes32[] unrevealedOfferSubmissions;
}// SPDX-License-Identifier: BSD-3-Clause
pragma solidity ^0.8.18;
// solhint-disable
/**
* @title Exponential module for storing fixed-precision decimals
* @author Compound
* @notice Exp is a struct which stores decimals with a fixed precision of 18 decimal places.
* Thus, if we wanted to store the 5.1, mantissa would store 5.1e18. That is:
* `Exp({mantissa: 5100000000000000000})`.
*/
contract ExponentialNoError {
uint256 constant expScale = 1e18;
uint256 constant doubleScale = 1e36;
struct Exp {
uint256 mantissa;
}
struct Double {
uint256 mantissa;
}
/**
* @dev Truncates the given exp to a whole number value.
* For example, truncate(Exp{mantissa: 15 * expScale}) = 15
*/
function truncate(Exp memory exp) internal pure returns (uint256) {
// Note: We are not using careful math here as we're performing a division that cannot fail
return exp.mantissa / expScale;
}
/**
* @dev Multiply an Exp by a scalar, then truncate to return an unsigned integer.
*/
function mul_ScalarTruncate(
Exp memory a,
uint256 scalar
) internal pure returns (uint256) {
Exp memory product = mul_(a, scalar);
return truncate(product);
}
/**
* @dev Multiply an Exp by a scalar, truncate, then add an to an unsigned integer, returning an unsigned integer.
*/
function mul_ScalarTruncateAddUInt(
Exp memory a,
uint256 scalar,
uint256 addend
) internal pure returns (uint256) {
Exp memory product = mul_(a, scalar);
return add_(truncate(product), addend);
}
/**
* @dev Checks if first Exp is less than second Exp.
*/
function lessThanExp(
Exp memory left,
Exp memory right
) internal pure returns (bool) {
return left.mantissa < right.mantissa;
}
/**
* @dev Checks if left Exp <= right Exp.
*/
function lessThanOrEqualExp(
Exp memory left,
Exp memory right
) internal pure returns (bool) {
return left.mantissa <= right.mantissa;
}
/**
* @dev Checks if left Exp > right Exp.
*/
function greaterThanExp(
Exp memory left,
Exp memory right
) internal pure returns (bool) {
return left.mantissa > right.mantissa;
}
/**
* @dev returns true if Exp is exactly zero
*/
function isZeroExp(Exp memory value) internal pure returns (bool) {
return value.mantissa == 0;
}
function safe224(
uint256 n,
string memory errorMessage
) internal pure returns (uint224) {
require(n < 2 ** 224, errorMessage);
return uint224(n);
}
function safe32(
uint256 n,
string memory errorMessage
) internal pure returns (uint32) {
require(n < 2 ** 32, errorMessage);
return uint32(n);
}
function add_(
Exp memory a,
Exp memory b
) internal pure returns (Exp memory) {
return Exp({mantissa: add_(a.mantissa, b.mantissa)});
}
function add_(
Double memory a,
Double memory b
) internal pure returns (Double memory) {
return Double({mantissa: add_(a.mantissa, b.mantissa)});
}
function add_(uint256 a, uint256 b) internal pure returns (uint256) {
return a + b;
}
function sub_(
Exp memory a,
Exp memory b
) internal pure returns (Exp memory) {
return Exp({mantissa: sub_(a.mantissa, b.mantissa)});
}
function sub_(
Double memory a,
Double memory b
) internal pure returns (Double memory) {
return Double({mantissa: sub_(a.mantissa, b.mantissa)});
}
function sub_(uint256 a, uint256 b) internal pure returns (uint256) {
return a - b;
}
function mul_(
Exp memory a,
Exp memory b
) internal pure returns (Exp memory) {
return Exp({mantissa: mul_(a.mantissa, b.mantissa) / expScale});
}
function mul_(Exp memory a, uint256 b) internal pure returns (Exp memory) {
return Exp({mantissa: mul_(a.mantissa, b)});
}
function mul_(uint256 a, Exp memory b) internal pure returns (uint256) {
return mul_(a, b.mantissa) / expScale;
}
function mul_(
Double memory a,
Double memory b
) internal pure returns (Double memory) {
return Double({mantissa: mul_(a.mantissa, b.mantissa) / doubleScale});
}
function mul_(
Double memory a,
uint256 b
) internal pure returns (Double memory) {
return Double({mantissa: mul_(a.mantissa, b)});
}
function mul_(uint256 a, Double memory b) internal pure returns (uint256) {
return mul_(a, b.mantissa) / doubleScale;
}
function mul_(uint256 a, uint256 b) internal pure returns (uint256) {
return a * b;
}
function div_(
Exp memory a,
Exp memory b
) internal pure returns (Exp memory) {
return Exp({mantissa: div_(mul_(a.mantissa, expScale), b.mantissa)});
}
function div_(Exp memory a, uint256 b) internal pure returns (Exp memory) {
return Exp({mantissa: div_(a.mantissa, b)});
}
function div_(uint256 a, Exp memory b) internal pure returns (uint256) {
return div_(mul_(a, expScale), b.mantissa);
}
function div_(
Double memory a,
Double memory b
) internal pure returns (Double memory) {
return
Double({mantissa: div_(mul_(a.mantissa, doubleScale), b.mantissa)});
}
function div_(
Double memory a,
uint256 b
) internal pure returns (Double memory) {
return Double({mantissa: div_(a.mantissa, b)});
}
function div_(uint256 a, Double memory b) internal pure returns (uint256) {
return div_(mul_(a, doubleScale), b.mantissa);
}
function div_(uint256 a, uint256 b) internal pure returns (uint256) {
return a / b;
}
function fraction(
uint256 a,
uint256 b
) internal pure returns (Double memory) {
return Double({mantissa: div_(mul_(a, doubleScale), b)});
}
}
// solhint-enable//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev TermAuctionBid represents a bid to borrow a specific amount of tokens at a specific interest rate (or better)
struct TermAuctionBid {
/// @dev Unique identifier for this bid
bytes32 id;
/// @dev The address of the bidder
address bidder;
/// @dev Hash of the offered price as a percentage of the initial loaned amount vs amount returned at maturity. This stores 9 decimal places
bytes32 bidPriceHash;
/// @dev Revealed bid price; this is only a valid value if isRevealed is true; this stores 18 decimal places
uint256 bidPriceRevealed;
/// @dev The maximum amount of purchase tokens that can be borrowed
uint256 amount;
/// @dev The amount of collateral tokens initially locked
uint256[] collateralAmounts;
/// @dev The address of the ERC20 purchase token
address purchaseToken;
/// @dev The addresses of the collateral ERC20 tokens in the bid
address[] collateralTokens;
/// @dev A boolean indicating if bid was submitted as rollover from previous term
bool isRollover;
/// @dev The address of term repo servicer whose bid is being rolled over
address rolloverPairOffTermRepoServicer;
/// @dev A boolean that is true if bid has been revealed
bool isRevealed;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev TermAuctionBidSubmission represents a bid submission to borrow an amount of money for a specific interest rate
struct TermAuctionBidSubmission {
/// @dev For an existing bid this is the unique onchain identifier for this bid. For a new bid this is a randomized input that will be used to generate the unique onchain identifier.
bytes32 id;
/// @dev The address of the bidder
address bidder;
/// @dev Hash of the offered price as a percentage of the initial loaned amount vs amount returned at maturity. This stores 9 decimal places
bytes32 bidPriceHash;
/// @dev The maximum amount of purchase tokens that can be borrowed
uint256 amount;
/// @dev The amount of collateral tokens initially locked
uint256[] collateralAmounts;
/// @dev The address of the ERC20 purchase token
address purchaseToken;
/// @dev The addresses of the collateral ERC20 tokens in the bid
address[] collateralTokens;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "../interfaces/ITermAuctionBidLocker.sol";
import "../interfaces/ITermAuctionOfferLocker.sol";
import "../TermAuction.sol";
/// @dev TermMaturityPeriod represents the contracts in a maturity period. This does not inlude auctions
struct TermAuctionGroup {
/// @dev The address of the term auction contract
TermAuction auction;
/// @dev The address of the collateral manager
ITermAuctionBidLocker termAuctionBidLocker;
/// @dev The address of the term repo locker
ITermAuctionOfferLocker termAuctionOfferLocker;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev TermAuctionOffer represents an offer to offeror an amount of money for a specific interest rate
struct TermAuctionOffer {
/// @dev Unique identifier for this bid
bytes32 id;
/// @dev The address of the offeror
address offeror;
/// @dev Hash of the offered price as a percentage of the initial loaned amount vs amount returned at maturity. This stores 9 decimal places
bytes32 offerPriceHash;
/// @dev Revealed offer price. This is not valid unless isRevealed is true. This stores 18 decimal places
uint256 offerPriceRevealed;
/// @dev The maximum amount of purchase tokens that can be lent
uint256 amount;
/// @dev The address of the ERC20 purchase token
address purchaseToken;
/// @dev Is offer price revealed
bool isRevealed;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev TermAuctionOfferSubmission represents an offer submission to offeror an amount of money for a specific interest rate
struct TermAuctionOfferSubmission {
/// @dev For an existing offer this is the unique onchain identifier for this offer. For a new offer this is a randomized input that will be used to generate the unique onchain identifier.
bytes32 id;
/// @dev The address of the offeror
address offeror;
/// @dev Hash of the offered price as a percentage of the initial loaned amount vs amount returned at maturity. This stores 9 decimal places
bytes32 offerPriceHash;
/// @dev The maximum amount of purchase tokens that can be lent
uint256 amount;
/// @dev The address of the ERC20 purchase token
address purchaseToken;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev TermAuctionBid represents a bid to borrow an amount of money for a specific interest rate
struct TermAuctionRevealedBid {
/// @dev Unique identifier for this bid
bytes32 id;
/// @dev The address of the bidder
address bidder;
/// @dev The offered price as a percentage of the initial loaned amount vs amount returned at maturity. This stores 9 decimal places
uint256 bidPriceRevealed;
/// @dev The maximum amount of TermRepoTokens borrowed. This stores 18 decimal places
uint256 amount;
/// @dev The amount of collateral tokens initially locked
uint256[] collateralAmounts;
/// @dev The purchase token address
address purchaseToken;
/// @dev The collateral token address
address[] collateralTokens;
/// @dev A boolean indicating whether bid is submitted as rollover from previous term
bool isRollover;
/// @dev The address of term repo servicer whose bid is being rolled over
address rolloverPairOffTermRepoServicer;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev TermAuctionBid represents an offer to offeror an amount of money for a specific interest rate
struct TermAuctionRevealedOffer {
/// @dev Unique identifier for this bid
bytes32 id;
/// @dev The address of the offeror
address offeror;
/// @dev The offered price as a percentage of the initial loaned amount vs amount returned at maturity. This stores 9 decimal places
uint256 offerPriceRevealed;
/// @dev The maximum amount of purchase tokens offered
uint256 amount;
/// @dev The address of the lent ERC20 token
address purchaseToken;
}//SPDX-License-Identifier: Unlicense
pragma solidity ^0.8.18;
/// @dev TermRepoRolloverElection represents an election to rollover a borrow into a future term
struct TermRepoRolloverElection {
/// @dev The address of the term auction bidlocker that loan is being rolled into
address rolloverAuction;
/// @dev The amount of loan being rolled over
uint256 rolloverAmount;
/// @dev The hashed value of the rollover bid price to place in the rollover auction
bytes32 rolloverBidPriceHash;
/// @dev A boolean that is true if rollover is successfully locked into auction
bool locked;
/// @dev A boolean testing whether rollover has been successfully processsed: false if bid fails to lock or is not successful in rollover auction
bool processed;
}//SPDX-License-Identifier: Unlicense
pragma solidity ^0.8.18;
/// @dev TermRepoRolloverElectionSubmission represents a user submission for a rollover election to a future term
struct TermRepoRolloverElectionSubmission {
/// @dev The address of the term auction bidlocker that loan is being rolled into
address rolloverAuction;
/// @dev The amount of loan being rolled over
uint256 rolloverAmount;
///@dev The hashed value of the rollover bid price to place in the rollover auction
bytes32 rolloverBidPriceHash;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
/// @dev TermRepoTokenConfig represents key metadata associated with a Term Repo Token
struct TermRepoTokenConfig {
/// @dev The date and time at which the Term Repo associated with this Term Repo Token comes due
uint256 redemptionTimestamp;
/// @dev The purchase token in which this Term Repo Token is denominated and is redeemable for
address purchaseToken;
/// @dev A list of collateral token addresses backing a Term Repo associated with this Term Repo Token
address[] collateralTokens;
/// @dev A list of the maintenance margin ratios applied to each eligible collateral token
uint256[] maintenanceCollateralRatios;
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./interfaces/ITermAuctionBidLocker.sol";
import "./interfaces/ITermAuctionErrors.sol";
import "./interfaces/ITermAuctionOfferLocker.sol";
import "./interfaces/ITermEventEmitter.sol";
import "./interfaces/ITermRepoCollateralManager.sol";
import "./interfaces/ITermRepoServicer.sol";
import "./lib/CompleteAuctionInput.sol";
import "./lib/ExponentialNoError.sol";
import "./lib/TermAuctionRevealedBid.sol";
import "./lib/TermAuctionRevealedOffer.sol";
import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/interfaces/IERC20MetadataUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
/// @author TermLabs
/// @title Term Auction
/// @notice This contract calculates a clearing price in a blind double auction and manages auction clearing and settlement
/// @dev This contract belongs to the Term Auction group of contracts and is specific to a Term Repo deployment
contract TermAuction is
ITermAuctionErrors,
UUPSUpgradeable,
AccessControlUpgradeable,
ReentrancyGuardUpgradeable,
ExponentialNoError
{
// ========================================================================
// = Structs =============================================================
// ========================================================================
/// State used during the `calculateClearingPrice` function
/// @dev Used to reduce the number of stack variables
struct ClearingPriceState {
// Variables describing current loop iteration
uint256 offerPrice; // p^o_i
uint256 offerIndex; // idxo(p^o_i)
uint256 bidIndex; // idxb(p^o_i)
uint256 cumSumOffers; // cso(p^o_i)
uint256 cumSumBids; // csb(p^o_i)
uint256 maxClearingVolume; // maxcv_i
// Variables describing next loop iteration
uint256 nextOfferIndex;
uint256 nextBidIndex;
uint256 nextCumSumOffers;
uint256 nextCumSumBids;
uint256 nextOfferPrice;
uint256 nextMaxClearingVolume;
// Auxiliary variables
bool minCumSumCorrection; // Minimisation correction indicator
uint256 nextBidPrice; // Next bid price in minimisation
// Principal quantities of interest
uint256 clearingPrice; // p_c
}
// ========================================================================
// = Constants ===========================================================
// ========================================================================
uint256 public constant CLEARING_PRICE_POST_PROCESSING_OFFSET = uint256(1);
uint256 public constant THREESIXTY_DAYCOUNT_SECONDS = 360 days;
// ========================================================================
// = Access Roles ========================================================
// ========================================================================
bytes32 public constant INITIALIZER_ROLE = keccak256("INITIALIZER_ROLE");
// ========================================================================
// = State Variables =====================================================
// ========================================================================
// Auction configuration.
bytes32 public termRepoId;
bytes32 public termAuctionId;
uint256 public auctionEndTime;
uint256 public dayCountFractionMantissa;
ITermRepoServicer public termRepoServicer;
ITermAuctionBidLocker public termAuctionBidLocker;
ITermAuctionOfferLocker public termAuctionOfferLocker;
IERC20MetadataUpgradeable public purchaseToken;
ITermEventEmitter internal emitter;
// Completed auction state
uint256 public clearingPrice;
bool public auctionCompleted;
bool public auctionCancelledForWithdrawal;
bool public completeAuctionPaused;
bool internal termContractPaired;
// ========================================================================
// = Modifiers ===========================================================
// ========================================================================
/// @notice This only runs if the auction is closed (after auction end time)
/// @dev This uses the block timestamp to determine if the auction is closed
modifier onlyWhileAuctionClosed() {
// solhint-disable-next-line not-rely-on-time
if (block.timestamp <= auctionEndTime) {
revert AuctionNotClosed();
}
_;
}
modifier whenCompleteAuctionNotPaused() {
if (completeAuctionPaused) {
revert CompleteAuctionPaused();
}
_;
}
modifier notTermContractPaired() {
if (termContractPaired) {
revert AlreadyTermContractPaired();
}
termContractPaired = true;
_;
}
// ========================================================================
// = Deploy (https://docs.openzeppelin.com/contracts/4.x/upgradeable) =
// ========================================================================
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
/// Initializes the contract
/// @dev See: https://docs.openzeppelin.com/contracts/4.x/upgradeable
function initialize(
string calldata termRepoId_,
string calldata auctionId_,
uint256 auctionEndTime_,
uint256 termStart_,
uint256 redemptionTimestamp_,
IERC20MetadataUpgradeable purchaseToken_
) external initializer {
UUPSUpgradeable.__UUPSUpgradeable_init();
AccessControlUpgradeable.__AccessControl_init();
ReentrancyGuardUpgradeable.__ReentrancyGuard_init();
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(INITIALIZER_ROLE, msg.sender);
termRepoId = keccak256(abi.encodePacked(termRepoId_));
termAuctionId = keccak256(abi.encodePacked(auctionId_));
auctionEndTime = auctionEndTime_;
dayCountFractionMantissa =
((redemptionTimestamp_ - termStart_) * expScale) /
THREESIXTY_DAYCOUNT_SECONDS;
purchaseToken = purchaseToken_;
auctionCompleted = false;
termContractPaired = false;
auctionCancelledForWithdrawal = false;
}
function pairTermContracts(
ITermEventEmitter emitter_,
ITermRepoServicer termRepoServicer_,
ITermAuctionBidLocker termAuctionBidLocker_,
ITermAuctionOfferLocker termAuctionOfferLocker_,
string calldata version_
) external onlyRole(INITIALIZER_ROLE) notTermContractPaired {
emitter = emitter_;
termRepoServicer = termRepoServicer_;
termAuctionBidLocker = termAuctionBidLocker_;
termAuctionOfferLocker = termAuctionOfferLocker_;
emitter.emitTermAuctionInitialized(
termRepoId,
termAuctionId,
address(this),
auctionEndTime,
version_
);
}
// ========================================================================
// = Interface/API ========================================================
// ========================================================================
/// @notice Calculates an auction's clearing price, assigns bids/offers, and returns unassigned funds
/// @param completeAuctionInput A struct containing all revealed and unrevealed bids and offers and expired rollover bids
function completeAuction(
CompleteAuctionInput calldata completeAuctionInput
) external onlyWhileAuctionClosed whenCompleteAuctionNotPaused {
if (auctionCompleted) {
revert AuctionAlreadyCompleted();
}
if (auctionCancelledForWithdrawal) {
revert AuctionCancelledForWithdrawal();
}
auctionCompleted = true;
// Sort bids/offers by price. Orders right on the price
// edge will be partially filled.
if (!hasRole(DEFAULT_ADMIN_ROLE, msg.sender)) {
if (
completeAuctionInput.unrevealedBidSubmissions.length > 0 ||
completeAuctionInput.unrevealedOfferSubmissions.length > 0
) {
revert InvalidParameters(
"All tender prices must be revealed for auction to be complete"
);
}
}
(
TermAuctionRevealedBid[] memory sortedBids,
TermAuctionBid[] memory unrevealedBids
) = termAuctionBidLocker.getAllBids(
completeAuctionInput.revealedBidSubmissions,
completeAuctionInput.expiredRolloverBids,
completeAuctionInput.unrevealedBidSubmissions
);
(
TermAuctionRevealedOffer[] memory sortedOffers,
TermAuctionOffer[] memory unrevealedOffers
) = termAuctionOfferLocker.getAllOffers(
completeAuctionInput.revealedOfferSubmissions,
completeAuctionInput.unrevealedOfferSubmissions
);
// Calculate a clearing price only if both bids and offers exist and market intersects
if (
sortedBids.length > 0 &&
sortedOffers.length > 0 &&
sortedBids[sortedBids.length - 1].bidPriceRevealed >=
sortedOffers[0].offerPriceRevealed
) {
(
,
// uint256 clearingPrice_
uint256 maxAssignable
) = _calculateAndStoreClearingPrice(sortedBids, sortedOffers);
uint256 purchaseTokenDecimals = purchaseToken.decimals();
// Process revealed bids/offers
uint256 totalAssignedBids = _assignBids(
sortedBids,
maxAssignable,
purchaseTokenDecimals
);
uint256 totalAssignedOffers = _assignOffers(
sortedOffers,
maxAssignable,
purchaseTokenDecimals
);
emitter.emitAuctionCompleted(
termAuctionId, // solhint-disable-next-line not-rely-on-time
block.timestamp,
block.number,
totalAssignedBids,
totalAssignedOffers,
clearingPrice
);
} else {
// Return sorted bid funds.
for (uint256 i = 0; i < sortedBids.length; ++i) {
if (sortedBids[i].isRollover) {
_markRolloverAsProcessed(
sortedBids[i].rolloverPairOffTermRepoServicer,
sortedBids[i].bidder
);
} else {
termAuctionBidLocker.auctionUnlockBid(
sortedBids[i].id,
sortedBids[i].bidder,
sortedBids[i].collateralTokens,
sortedBids[i].collateralAmounts
);
}
}
// Return sorted offer funds.
for (uint256 i = 0; i < sortedOffers.length; ++i) {
termAuctionOfferLocker.unlockOfferPartial(
sortedOffers[i].id,
sortedOffers[i].offeror,
sortedOffers[i].amount
);
}
if (
sortedBids.length > 0 &&
sortedOffers.length > 0 &&
sortedBids[sortedBids.length - 1].bidPriceRevealed <
sortedOffers[0].offerPriceRevealed
) {
emitter.emitAuctionCancelled(termAuctionId, true, false);
} else {
emitter.emitAuctionCancelled(termAuctionId, false, false);
}
}
// Return unrevealed bid funds.
for (uint256 i = 0; i < unrevealedBids.length; ++i) {
if (unrevealedBids[i].isRollover) {
_markRolloverAsProcessed(
unrevealedBids[i].rolloverPairOffTermRepoServicer,
unrevealedBids[i].bidder
);
} else {
termAuctionBidLocker.auctionUnlockBid(
unrevealedBids[i].id,
unrevealedBids[i].bidder,
unrevealedBids[i].collateralTokens,
unrevealedBids[i].collateralAmounts
);
}
}
// Return unrevealed offer funds.
for (uint256 i = 0; i < unrevealedOffers.length; ++i) {
termAuctionOfferLocker.unlockOfferPartial(
unrevealedOffers[i].id,
unrevealedOffers[i].offeror,
unrevealedOffers[i].amount
);
}
assert(termRepoServicer.isTermRepoBalanced());
}
// ========================================================================
// = Admin ================================================================
// ========================================================================
/// @notice Cancels an auction and returns all funds to bidders and fulfillBiders
/// @param completeAuctionInput A struct containing all revealed and unrevealed bids and offers and expired rollover bids
function cancelAuction(
CompleteAuctionInput calldata completeAuctionInput
) public onlyWhileAuctionClosed onlyRole(DEFAULT_ADMIN_ROLE) {
// Sort bids/offers by price. Orders right on the price
// edge will be partially filled.
(
TermAuctionRevealedBid[] memory sortedBids,
TermAuctionBid[] memory unrevealedBids
) = termAuctionBidLocker.getAllBids(
completeAuctionInput.revealedBidSubmissions,
completeAuctionInput.expiredRolloverBids,
completeAuctionInput.unrevealedBidSubmissions
);
(
TermAuctionRevealedOffer[] memory sortedOffers,
TermAuctionOffer[] memory unrevealedOffers
) = termAuctionOfferLocker.getAllOffers(
completeAuctionInput.revealedOfferSubmissions,
completeAuctionInput.unrevealedOfferSubmissions
);
// Return revealed bid funds.
uint256 i = 0;
for (i = 0; i < sortedBids.length; ++i) {
if (sortedBids[i].isRollover) {
_markRolloverAsProcessed(
sortedBids[i].rolloverPairOffTermRepoServicer,
sortedBids[i].bidder
);
} else {
termAuctionBidLocker.auctionUnlockBid(
sortedBids[i].id,
sortedBids[i].bidder,
sortedBids[i].collateralTokens,
sortedBids[i].collateralAmounts
);
}
}
// Return revealed offer funds.
for (i = 0; i < sortedOffers.length; ++i) {
termAuctionOfferLocker.unlockOfferPartial(
sortedOffers[i].id,
sortedOffers[i].offeror,
sortedOffers[i].amount
);
}
// Return unrevealed bid funds.
for (i = 0; i < unrevealedBids.length; ++i) {
if (unrevealedBids[i].isRollover) {
_markRolloverAsProcessed(
unrevealedBids[i].rolloverPairOffTermRepoServicer,
unrevealedBids[i].bidder
);
} else {
termAuctionBidLocker.auctionUnlockBid(
unrevealedBids[i].id,
unrevealedBids[i].bidder,
unrevealedBids[i].collateralTokens,
unrevealedBids[i].collateralAmounts
);
}
}
// Return unrevealed offer funds.
for (i = 0; i < unrevealedOffers.length; ++i) {
termAuctionOfferLocker.unlockOfferPartial(
unrevealedOffers[i].id,
unrevealedOffers[i].offeror,
unrevealedOffers[i].amount
);
}
emitter.emitAuctionCancelled(termAuctionId, false, false);
assert(termRepoServicer.isTermRepoBalanced());
}
/// @notice Cancels an auction and sets auctionCancelledForWithdrawal to true to open unlocking tenders
function cancelAuctionForWithdrawal(
address[] calldata rolloverBorrowers,
address[] calldata rolloverPairOffTermRepoServicer
) public onlyWhileAuctionClosed onlyRole(DEFAULT_ADMIN_ROLE) {
for (uint256 i = 0; i < rolloverBorrowers.length; ++i) {
_markRolloverAsProcessed(
rolloverPairOffTermRepoServicer[i],
rolloverBorrowers[i]
);
}
auctionCancelledForWithdrawal = true;
emitter.emitAuctionCancelled(
termAuctionId,
false,
auctionCancelledForWithdrawal
);
}
// ========================================================================
// = Helpers ==============================================================
// ========================================================================
function _increaseCumSumBids(
TermAuctionRevealedBid[] memory sortedBids,
uint256 startIndex,
uint256 previousCumSumBids,
uint256 currentPrice
) internal pure returns (uint256, uint256) {
uint256 cumsumBids = previousCumSumBids;
uint256 i;
for (
i = startIndex;
sortedBids[i].bidPriceRevealed >= currentPrice;
--i
) {
cumsumBids += sortedBids[i].amount;
if (i == 0) break;
}
return (
cumsumBids,
sortedBids[i].bidPriceRevealed < currentPrice ? i + 1 : i
);
}
function _decreaseCumSumBids(
TermAuctionRevealedBid[] memory sortedBids,
uint256 startIndex,
uint256 previousCumSumBids,
uint256 currentPrice
) internal pure returns (uint256, uint256) {
uint256 cumsumBids = previousCumSumBids;
uint256 i;
for (
i = startIndex;
i < sortedBids.length &&
sortedBids[i].bidPriceRevealed < currentPrice;
i++
) cumsumBids -= sortedBids[i].amount;
return (cumsumBids, i);
}
/// Returns the min of two `uint256` values
/// @param a The first value to compare
/// @param b The second value to compare
/// @return The min of the two values
function _minUint256(uint256 a, uint256 b) internal pure returns (uint256) {
if (a >= b) {
return b;
} else {
return a;
}
}
/// Calculates the intersection between bid/offer schedules to arrive at a clearing price
/// @dev Imagine a graph with price along the X-axis and cumsum(bid/offerAmount*price) along the Y-axis. This function finds the point where the supply line crosses the demand line using binary search
/// @param sortedBids A sorted array of bids used to arrive at a demand schedule
/// @param sortedOffers A sorted array of offers used to arrive at a supply schedule
/// @param clearingOffset The offset to apply to the marginal bid and offer indexes when calculating the final clearing price
/// @return clearingPrice The price at which Term Auction will be cleared
function _calculateClearingPrice(
TermAuctionRevealedBid[] memory sortedBids,
TermAuctionRevealedOffer[] memory sortedOffers,
uint256 clearingOffset
) internal pure returns (uint256, uint256) {
if (clearingOffset != 1 && clearingOffset != 0) {
revert ClearingOffsetNot0Or1(clearingOffset);
}
// Local function variables are kept in memory
ClearingPriceState memory state = ClearingPriceState({
offerPrice: sortedOffers[0].offerPriceRevealed, // p^o_i
offerIndex: 1, // idxo(offerPrice)
cumSumOffers: sortedOffers[0].amount, // cso(offerPrice)
bidIndex: sortedBids.length,
cumSumBids: 0,
maxClearingVolume: 0,
nextOfferIndex: 0,
nextBidIndex: 0,
nextCumSumOffers: 0,
nextCumSumBids: 0,
nextOfferPrice: 0,
nextMaxClearingVolume: 0,
minCumSumCorrection: false,
nextBidPrice: 0,
clearingPrice: 0
});
// Calculate bidIndex = idxb(offerPrice) and cumSumBids = csb(offerPrice)
(state.cumSumBids, state.bidIndex) = _increaseCumSumBids(
sortedBids,
state.bidIndex - 1,
0,
state.offerPrice
);
// Calculate initial maximal clearing volume
state.maxClearingVolume = _minUint256(
state.cumSumBids,
state.cumSumOffers
);
// Calculate the pre-clearance price: maximise the clearing volume
while (
state.offerIndex < sortedOffers.length &&
state.bidIndex < sortedBids.length
) {
// Initialise the next iteration of the relevant variables
state.nextOfferIndex = state.offerIndex;
state.nextBidIndex = state.bidIndex;
state.nextCumSumOffers = state.cumSumOffers;
state.nextCumSumBids = state.cumSumBids;
state.nextOfferPrice = sortedOffers[state.offerIndex]
.offerPriceRevealed;
// Obtain next offer index, increase cumulative sum
while (
state.nextOfferIndex < sortedOffers.length &&
sortedOffers[state.nextOfferIndex].offerPriceRevealed ==
state.nextOfferPrice
)
state.nextCumSumOffers += sortedOffers[state.nextOfferIndex++]
.amount;
// Obtain next bid index, decrease cumulative sum
(state.nextCumSumBids, state.nextBidIndex) = _decreaseCumSumBids(
sortedBids,
state.nextBidIndex,
state.nextCumSumBids,
state.nextOfferPrice
);
state.nextMaxClearingVolume = _minUint256(
state.nextCumSumBids,
state.nextCumSumOffers
);
if (state.nextMaxClearingVolume > state.maxClearingVolume) {
state.offerIndex = state.nextOfferIndex;
state.bidIndex = state.nextBidIndex;
state.cumSumOffers = state.nextCumSumOffers;
state.cumSumBids = state.nextCumSumBids;
state.offerPrice = state.nextOfferPrice;
state.maxClearingVolume = state.nextMaxClearingVolume;
} else {
break;
}
}
// Get next offer price: first offer price higher than the pre-clearance price
state.nextOfferPrice = (state.offerIndex < sortedOffers.length)
? sortedOffers[state.offerIndex].offerPriceRevealed
: type(uint256).max;
// Minimise css by minimising csb as long as bid price is smaller than next offer price
while (state.bidIndex < sortedBids.length) {
state.nextBidIndex = state.bidIndex;
state.nextBidPrice = sortedBids[state.bidIndex].bidPriceRevealed;
state.nextCumSumBids = state.cumSumBids;
if (state.nextBidPrice < state.nextOfferPrice) {
while (
state.nextBidIndex < sortedBids.length &&
sortedBids[state.nextBidIndex].bidPriceRevealed ==
state.nextBidPrice
) {
state.nextCumSumBids -= sortedBids[state.nextBidIndex++]
.amount;
}
if (state.nextCumSumBids >= state.cumSumOffers) {
state.minCumSumCorrection = true;
state.cumSumBids = state.nextCumSumBids;
state.bidIndex = state.nextBidIndex;
} else {
break;
}
} else {
break;
}
}
// Calculate clearing price: bid price if minimum correction was made and offer price otherwise
if (state.minCumSumCorrection)
state.clearingPrice = (state.bidIndex == sortedBids.length)
? sortedBids[state.bidIndex - 1].bidPriceRevealed
: sortedBids[state.bidIndex].bidPriceRevealed;
else state.clearingPrice = state.offerPrice;
// The main loop positions `offerIndex` at the first index greater than the price.
// It needs to be shifted back to get the last index smaller than or equal to the price.
state.offerIndex--;
// If non-zero clearing offset, find the offset tender prices and then average them to find the final clearing price.
if (clearingOffset == 1) {
uint256 nextOfferPriceIndex = state.offerIndex;
while (
nextOfferPriceIndex > 0 &&
sortedOffers[nextOfferPriceIndex].offerPriceRevealed ==
sortedOffers[state.offerIndex].offerPriceRevealed
) {
nextOfferPriceIndex -= 1;
}
uint256 nextBidPriceIndex = state.bidIndex;
// In the case that there is no clear, bid index is past end of array, so decrement it to last element.
if (state.bidIndex == sortedBids.length) {
nextBidPriceIndex -= 1;
}
while (
nextBidPriceIndex < sortedBids.length - 1 &&
sortedBids[nextBidPriceIndex].bidPriceRevealed ==
sortedBids[state.bidIndex].bidPriceRevealed
) {
nextBidPriceIndex += 1;
}
state.clearingPrice =
(sortedOffers[nextOfferPriceIndex].offerPriceRevealed +
sortedBids[nextBidPriceIndex].bidPriceRevealed) /
2;
} else {
// In the case that there is no clear, bid index is past end of array, so decrement it to last element.
if (state.bidIndex == sortedBids.length) {
state.bidIndex -= 1;
}
state.clearingPrice =
(sortedOffers[state.offerIndex].offerPriceRevealed +
sortedBids[state.bidIndex].bidPriceRevealed) /
2;
}
//update state.cumSumOffers
if (
sortedOffers[state.offerIndex].offerPriceRevealed <=
state.clearingPrice
) {
state.offerIndex++;
while (
state.offerIndex < sortedOffers.length &&
sortedOffers[state.offerIndex].offerPriceRevealed <=
state.clearingPrice
) {
state.cumSumOffers += sortedOffers[state.offerIndex].amount;
state.offerIndex++;
}
} else {
while (
sortedOffers[state.offerIndex].offerPriceRevealed >
state.clearingPrice
) {
state.cumSumOffers -= sortedOffers[state.offerIndex].amount;
if (state.offerIndex == 0) break;
state.offerIndex--;
}
}
//update state.cumSumBids
if (
state.bidIndex < sortedBids.length &&
sortedBids[state.bidIndex].bidPriceRevealed < state.clearingPrice
) {
(state.cumSumBids, state.bidIndex) = _decreaseCumSumBids(
sortedBids,
state.bidIndex,
state.cumSumBids,
state.clearingPrice
);
} else if (state.bidIndex > 0) {
(state.cumSumBids, state.bidIndex) = _increaseCumSumBids(
sortedBids,
state.bidIndex - 1,
state.cumSumBids,
state.clearingPrice
);
}
return (
state.clearingPrice,
_minUint256(state.cumSumBids, state.cumSumOffers)
);
}
/// Finds the index of the first bid with a bidPrice of `price` and calculate the cumsum of the bid amounts up to that index
/// @param price The price to search for
/// @param sortedBids An array of sorted bids to search
/// @param startIndex The index to start searching from
/// @return i The index of the first bid with a bidPrice of `price`
/// @return totalAmount The cumsum of the bid amounts up to return index i
function _findFirstIndexForPrice(
uint256 price,
TermAuctionRevealedBid[] memory sortedBids,
uint256 startIndex
) internal pure returns (uint256 i, uint256 totalAmount) {
i = startIndex;
totalAmount = sortedBids[i].amount;
while (true) {
if (i == 0 || sortedBids[i - 1].bidPriceRevealed != price) {
break;
}
totalAmount += sortedBids[i - 1].amount;
--i;
}
return (i, totalAmount);
}
/// Finds the index of the last offer with a offerPrice of `price` and calculate the cumsum of the offer amounts up to that index
/// @param price The price to search for
/// @param sortedOffers An array of offers to search
/// @param startIndex The index to start searching from
/// @return i The index of the last offer with a offerPrice of `price`
/// @return totalAmount The cumsum of the offer amounts up to return index i
function _findLastIndexForPrice(
uint256 price,
TermAuctionRevealedOffer[] memory sortedOffers,
uint256 startIndex
) internal pure returns (uint256 i, uint256 totalAmount) {
i = startIndex;
totalAmount = sortedOffers[i].amount;
while (i < (sortedOffers.length - 1)) {
if (sortedOffers[i + 1].offerPriceRevealed != price) {
break;
}
totalAmount += sortedOffers[i + 1].amount;
++i;
}
return (i, totalAmount);
}
/// Fully assigns a bid
/// @param bid The bid to assign
/// @return The amount that was assigned
function _fullyAssignBid(
TermAuctionRevealedBid memory bid
) internal nonReentrant returns (uint256) {
uint256 repurchaseAmount = _calculateRepurchasePrice(bid.amount);
if (!bid.isRollover) {
termRepoServicer.fulfillBid(
bid.bidder,
bid.amount,
repurchaseAmount,
bid.collateralTokens,
bid.collateralAmounts,
dayCountFractionMantissa
);
} else {
_assignRolloverBid(
bid.bidder,
bid.amount,
repurchaseAmount,
bid.rolloverPairOffTermRepoServicer
);
}
emitter.emitBidAssigned(termAuctionId, bid.id, bid.amount);
return bid.amount;
}
/// Fully assigns an offer
/// @param offer The offer to assign
/// @return The amount that was assigned
function _fullyAssignOffer(
TermAuctionRevealedOffer memory offer
) internal nonReentrant returns (uint256) {
uint256 repurchaseAmount = _calculateRepurchasePrice(offer.amount);
termRepoServicer.fulfillOffer(
offer.offeror,
offer.amount,
repurchaseAmount,
offer.id
);
emitter.emitOfferAssigned(termAuctionId, offer.id, offer.amount);
return offer.amount;
}
/// Partially assigns a bid
/// @param bid The bid to assign
/// @param assignedAmount The amount to assign
/// @return The amount that was assigned
function _partiallyAssignBid(
TermAuctionRevealedBid memory bid,
uint256 assignedAmount
) internal nonReentrant returns (uint256) {
uint256 repurchaseAmount = _calculateRepurchasePrice(assignedAmount);
if (!bid.isRollover) {
termRepoServicer.fulfillBid(
bid.bidder,
assignedAmount,
repurchaseAmount,
bid.collateralTokens,
bid.collateralAmounts,
dayCountFractionMantissa
);
} else {
_assignRolloverBid(
bid.bidder,
assignedAmount,
repurchaseAmount,
bid.rolloverPairOffTermRepoServicer
);
}
emitter.emitBidAssigned(termAuctionId, bid.id, assignedAmount);
return assignedAmount;
}
/// Partially assigns an offer
/// @param offer The offer to assign
/// @param assignedAmount The amount to assign
/// @return The amount that was assigned
function _partiallyAssignOffer(
TermAuctionRevealedOffer memory offer,
uint256 assignedAmount
) internal nonReentrant returns (uint256) {
uint256 repurchaseAmount = _calculateRepurchasePrice(assignedAmount);
termRepoServicer.fulfillOffer(
offer.offeror,
assignedAmount,
repurchaseAmount,
offer.id
);
// Unlock remaining.
termAuctionOfferLocker.unlockOfferPartial(
offer.id,
offer.offeror,
offer.amount - assignedAmount
);
emitter.emitOfferAssigned(termAuctionId, offer.id, assignedAmount);
return assignedAmount;
}
function _assignRolloverBid(
address borrower,
uint256 purchasePrice,
uint256 repurchasePrice,
address rolloverPairOffTermRepoServicer
) internal {
ITermRepoServicer previousTermRepoServicer = ITermRepoServicer(
rolloverPairOffTermRepoServicer
);
uint256 rolloverPaymentToCollapseBorrower = termRepoServicer
.openExposureOnRolloverNew(
borrower,
purchasePrice,
repurchasePrice,
address(previousTermRepoServicer.termRepoLocker()),
dayCountFractionMantissa
);
uint256 proportionPreviousLoanPaid = previousTermRepoServicer
.closeExposureOnRolloverExisting(
borrower,
rolloverPaymentToCollapseBorrower
);
ITermRepoCollateralManager previousTermRepoCollateralManager = ITermRepoCollateralManager(
previousTermRepoServicer.termRepoCollateralManager()
);
(
address[] memory collateralTypes,
uint256[] memory collateralAmounts
) = previousTermRepoCollateralManager.transferRolloverCollateral(
borrower,
proportionPreviousLoanPaid,
address(termRepoServicer.termRepoLocker())
);
ITermRepoCollateralManager currentTermRepoCollateralManager = termRepoServicer
.termRepoCollateralManager();
for (uint256 i = 0; i < collateralTypes.length; ++i) {
if (collateralAmounts[i] > 0) {
currentTermRepoCollateralManager.acceptRolloverCollateral(
borrower,
collateralTypes[i],
collateralAmounts[i]
);
}
}
}
function _markRolloverAsProcessed(
address rolloverPairOffTermRepoServicer,
address borrower
) internal {
ITermRepoServicer termRepoServicer_ = ITermRepoServicer(
rolloverPairOffTermRepoServicer
);
ITermRepoRolloverManager rolloverManager = termRepoServicer_
.termRepoRolloverManager();
rolloverManager.fulfillRollover(borrower);
}
/// Assigns bids up to `maxAssignable`
/// @dev This method allocates pro-rata across an the marginal price group (pro-rata on the margin) and attempts to prevent residuals from accumulating to a single bid
/// @param sortedBids An array of sorted bids to process
/// @param maxAssignable The maximum bid amount that can be assigned across all bidders
/// @param purchaseTokenDecimals The number of decimals of the purchase token
/// @return The total amount assigned
function _assignBids(
TermAuctionRevealedBid[] memory sortedBids,
uint256 maxAssignable,
uint256 purchaseTokenDecimals
) internal returns (uint256) {
// Process revealed bids.
uint256 totalAssignedBids = 0;
uint256 innerIndex = 0;
uint256 i = 0;
for (uint256 j = sortedBids.length; j > 0; --j) {
i = j - 1;
// First, find the sub-range that contains the current price.
(uint256 k, uint256 priceGroupAmount) = _findFirstIndexForPrice(
sortedBids[i].bidPriceRevealed,
sortedBids,
i
);
// NOTE: priceGroupAmount gets changed later on in this function and is used as the "remaining" priceGroupAmount during partial assignment.
if (
sortedBids[i].bidPriceRevealed >= clearingPrice &&
totalAssignedBids < maxAssignable &&
priceGroupAmount <= (maxAssignable - totalAssignedBids)
) {
// Full assignment for entire price group.
innerIndex = 0;
for (; (i - innerIndex) >= k; ++innerIndex) {
// NOTE: This loop is actually decrementing!
totalAssignedBids += _fullyAssignBid(
sortedBids[i - innerIndex]
);
if (i == innerIndex) {
++innerIndex;
break;
}
}
if (innerIndex > 0) {
j -= (innerIndex - 1);
}
} else if (
sortedBids[i].bidPriceRevealed >= clearingPrice &&
totalAssignedBids < maxAssignable
) {
// Partial assignment for entire price group.
innerIndex = 0;
for (; (i - innerIndex) >= k; ++innerIndex) {
if ((i - innerIndex) == k) {
// Last iteration of loop. Assign remaining amount left to assign.
totalAssignedBids += _partiallyAssignBid(
sortedBids[i - innerIndex],
maxAssignable - totalAssignedBids
);
priceGroupAmount -= maxAssignable - totalAssignedBids;
} else {
// Assign an amount based upon the partial assignment ratio.
uint256 bidAmount = sortedBids[i - innerIndex].amount;
Exp memory partialAssignmentRatio = div_(
Exp({
mantissa: (maxAssignable - totalAssignedBids) *
10 ** (18 - purchaseTokenDecimals)
}),
Exp({
mantissa: priceGroupAmount *
10 ** (18 - purchaseTokenDecimals)
})
);
uint256 assignedAmount = mul_(
partialAssignmentRatio,
Exp({
mantissa: bidAmount *
10 ** (18 - purchaseTokenDecimals)
})
).mantissa / 10 ** (18 - purchaseTokenDecimals);
totalAssignedBids += _partiallyAssignBid(
sortedBids[i - innerIndex],
assignedAmount
);
priceGroupAmount -= sortedBids[i - innerIndex].amount;
}
if (i == innerIndex) {
++innerIndex;
break;
}
}
if (innerIndex > 0) {
j -= (innerIndex - 1);
}
} else {
// No assignment.
if (sortedBids[i].isRollover) {
_markRolloverAsProcessed(
sortedBids[i].rolloverPairOffTermRepoServicer,
sortedBids[i].bidder
);
} else {
termAuctionBidLocker.auctionUnlockBid(
sortedBids[i].id,
sortedBids[i].bidder,
sortedBids[i].collateralTokens,
sortedBids[i].collateralAmounts
);
}
}
}
return totalAssignedBids;
}
/// Assigns offers up to `maxAssignable`
/// @dev This method allocates pro-rata across an the marginal price group (pro-rata on the margin) and attempts to prevent residuals from accumulating to a single offer
/// @param sortedOffers An array of sorted offers to process
/// @param maxAssignable The maximum offer amount that can be assigned across all offers
/// @param purchaseTokenDecimals The number of decimals of the purchase token
/// @return The total amount assigned
function _assignOffers(
TermAuctionRevealedOffer[] memory sortedOffers,
uint256 maxAssignable,
uint256 purchaseTokenDecimals
) internal returns (uint256) {
// Process revealed offers.
uint256 totalAssignedOffers = 0;
uint256 innerIndex = 0;
uint256 i = 0;
for (i = 0; i < sortedOffers.length; ++i) {
// First, find the sub-range that contains the current price.
(uint256 k, uint256 priceGroupAmount) = _findLastIndexForPrice(
sortedOffers[i].offerPriceRevealed,
sortedOffers,
i
);
// NOTE: priceGroupAmount gets changed later on in this function and is used as the "remaining" priceGroupAmount during partial assignment.
if (
sortedOffers[i].offerPriceRevealed <= clearingPrice &&
totalAssignedOffers < maxAssignable &&
priceGroupAmount <= (maxAssignable - totalAssignedOffers)
) {
// Full assignment.
innerIndex = 0;
for (; (innerIndex + i) <= k; ++innerIndex) {
totalAssignedOffers += _fullyAssignOffer(
sortedOffers[innerIndex + i]
);
}
if (innerIndex > 0) {
i += innerIndex - 1;
}
} else if (
sortedOffers[i].offerPriceRevealed <= clearingPrice &&
totalAssignedOffers < maxAssignable
) {
// Partial assignment.
innerIndex = 0;
for (; (innerIndex + i) <= k; innerIndex++) {
if ((innerIndex + i) == k) {
// Last iteration of loop. Assign remaining amount left to assign.
totalAssignedOffers += _partiallyAssignOffer(
sortedOffers[innerIndex + i],
maxAssignable - totalAssignedOffers
);
priceGroupAmount -= maxAssignable - totalAssignedOffers;
} else {
// Assign an amount based upon the partial assignment ratio.
uint256 offerAmount = sortedOffers[innerIndex + i]
.amount;
Exp memory partialAssignmentRatio = div_(
Exp({
mantissa: (maxAssignable -
totalAssignedOffers) *
10 ** (18 - purchaseTokenDecimals)
}),
Exp({
mantissa: priceGroupAmount *
10 ** (18 - purchaseTokenDecimals)
})
);
uint256 assignedAmount = (innerIndex + i) != k
? mul_(
partialAssignmentRatio,
Exp({
mantissa: offerAmount *
10 ** (18 - purchaseTokenDecimals)
})
).mantissa / 10 ** (18 - purchaseTokenDecimals)
: maxAssignable - totalAssignedOffers;
totalAssignedOffers += _partiallyAssignOffer(
sortedOffers[innerIndex + i],
assignedAmount
);
priceGroupAmount -= sortedOffers[innerIndex + i].amount;
}
}
if (innerIndex > 0) {
i += innerIndex - 1;
}
} else {
// No assignment.
// Return purchase tokens to offeror.
termAuctionOfferLocker.unlockOfferPartial(
sortedOffers[i].id,
sortedOffers[i].offeror,
sortedOffers[i].amount
);
}
}
return totalAssignedOffers;
}
/// Calculates repurchase price given a purchase price (equivalent to principal plus interest)
/// @param purchasePrice The purchase price
/// @return The repurchase price obtained by applying the clearing rate on an Actual/360 day-count convention
function _calculateRepurchasePrice(
uint256 purchasePrice
) internal view returns (uint256) {
Exp memory repurchaseFactor = add_(
Exp({mantissa: expScale}),
mul_(
Exp({mantissa: dayCountFractionMantissa}),
Exp({mantissa: clearingPrice})
)
);
return
truncate(
mul_(
Exp({mantissa: purchasePrice * expScale}),
repurchaseFactor
)
);
}
function _calculateAndStoreClearingPrice(
TermAuctionRevealedBid[] memory sortedBids,
TermAuctionRevealedOffer[] memory sortedOffers
) internal nonReentrant returns (uint256, uint256) {
(
uint256 clearingPrice_,
uint256 maxAssignable
) = _calculateClearingPrice(
sortedBids,
sortedOffers,
CLEARING_PRICE_POST_PROCESSING_OFFSET
);
clearingPrice = clearingPrice_;
return (clearingPrice_, maxAssignable);
}
// ========================================================================
// = Pausable =============================================================
// ========================================================================
/// @dev This function pauses the TermAuction contract preventing public state changes
/// @dev See {Pausable-_pause}.
function pauseCompleteAuction() external onlyRole(DEFAULT_ADMIN_ROLE) {
completeAuctionPaused = true;
emitter.emitCompleteAuctionPaused(termAuctionId, termRepoId);
}
/// Unpuses the TermAuction contract allowing public state changes
/// @dev See {Pausable-_unpause}.
function unpauseCompleteAuction() external onlyRole(DEFAULT_ADMIN_ROLE) {
completeAuctionPaused = false;
emitter.emitCompleteAuctionUnpaused(termAuctionId, termRepoId);
}
// solhint-disable no-empty-blocks
///@dev required override by the OpenZeppelin UUPS module
function _authorizeUpgrade(
address
) internal view override onlyRole(DEFAULT_ADMIN_ROLE) {}
// solhint-enable no-empty-blocks
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./interfaces/ITermPriceOracle.sol";
import "./interfaces/ITermPriceOracleErrors.sol";
import "./interfaces/ITermPriceOracleEvents.sol";
import "./interfaces/ITermEventEmitter.sol";
import "./lib/Collateral.sol";
import "./lib/ExponentialNoError.sol";
import "@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
/// @author TermLabs
/// @title Term Price Consumer V3
/// @notice This contract is a centralized price oracle contract that feeds pricing data to all Term Repos
/// @dev This contract operates at the protocol level and governs all instances of a Term Repo
contract TermPriceConsumerV3 is
ITermPriceOracle,
ITermPriceOracleErrors,
ITermPriceOracleEvents,
Initializable,
UUPSUpgradeable,
AccessControlUpgradeable,
ExponentialNoError
{
// ========================================================================
// = Access Role ======================================================
// ========================================================================
bytes32 public constant AUCTIONEER_ROLE = keccak256("AUCTIONEER_ROLE");
bytes32 public constant AUCTION_SCHEDULER = keccak256("TERM_REOPENER_ROLE");
bytes32 public constant TERM_CONTRACT = keccak256("TERM_CONTRACT");
mapping(address => AggregatorV3Interface) internal priceFeeds;
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
/// @notice Intializes with an array of token addresses, followed with an array of Chainlink aggregator addresses
/// @notice https://docs.chain.link/docs/ethereum-addresses/
function initialize() external initializer {
UUPSUpgradeable.__UUPSUpgradeable_init();
AccessControlUpgradeable.__AccessControl_init();
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(AUCTION_SCHEDULER, msg.sender);
_grantRole(AUCTIONEER_ROLE, msg.sender);
}
/// @param token The address of the token to add a price feed for
/// @param tokenPriceAggregator The proxy price aggregator address for token to be added
function addNewTokenPriceFeed(
address token,
address tokenPriceAggregator
) external onlyRole(DEFAULT_ADMIN_ROLE) {
priceFeeds[token] = AggregatorV3Interface(tokenPriceAggregator);
emit SubscribePriceFeed(token, tokenPriceAggregator);
}
/// @param token The address of the token whose price feed needs to be removed
function removeTokenPriceFeed(
address token
) external onlyRole(DEFAULT_ADMIN_ROLE) {
delete priceFeeds[token];
emit UnsubscribePriceFeed(token);
}
/// @param termRepoCollateralManager The address of the TermRepoCollateralManager contract
function reOpenToNewTerm(
address termRepoCollateralManager
) external onlyRole(AUCTION_SCHEDULER) {
_grantRole(TERM_CONTRACT, termRepoCollateralManager);
_grantRole(AUCTIONEER_ROLE, termRepoCollateralManager);
}
/// @param termAuctionBidLocker The address of the TermAuctionBidLocker contract
function reOpenToNewBidLocker(
address termAuctionBidLocker
) external onlyRole(AUCTIONEER_ROLE) {
_grantRole(TERM_CONTRACT, termAuctionBidLocker);
}
/// @notice A function to return current market value given a token address and an amount
/// @param token The address of the token to query
/// @param amount The amount tokens to value
/// @return The current market value of tokens at the specified amount, in USD
function usdValueOfTokens(
address token,
uint256 amount
) external view returns (Exp memory) {
if (address(priceFeeds[token]) == address(0)) {
revert NoPriceFeed(token);
}
uint256 latestPrice = uint256(_getLatestPrice(token));
uint8 priceDecimals = _getDecimals(token);
IERC20MetadataUpgradeable tokenInstance = IERC20MetadataUpgradeable(
token
);
uint8 tokenDecimals = tokenInstance.decimals();
return
mul_(
Exp({mantissa: (amount * expScale) / 10 ** tokenDecimals}),
Exp({mantissa: (latestPrice * expScale) / 10 ** priceDecimals})
);
}
/// @return The latest price from price aggregator
function _getLatestPrice(address token) internal view returns (int256) {
(
,
// uint80 roundID
int256 price, // uint startedAt // //uint timeStamp// //uint80 answeredInRound//
,
,
) = priceFeeds[token].latestRoundData();
return price;
}
/// @return The decimal places in price feed
function _getDecimals(address token) internal view returns (uint8) {
return priceFeeds[token].decimals();
}
// ========================================================================
// = Upgrades =============================================================
// ========================================================================
// solhint-disable no-empty-blocks
/// @dev required override by the OpenZeppelin UUPS module
function _authorizeUpgrade(
address
) internal view override onlyRole(DEFAULT_ADMIN_ROLE) {}
// solhint-enable no-empty-blocks
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./interfaces/ITermRepoLocker.sol";
import "./interfaces/ITermRepoLockerErrors.sol";
import "./interfaces/ITermEventEmitter.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
/// @author TermLabs
/// @title Term Repo Locker
/// @notice This is the contract in which Term Servicer locks collateral and purchase tokens
/// @dev This contract belongs to the Term Servicer group of contracts and is specific to a Term Repo deployment
contract TermRepoLocker is
ITermRepoLocker,
ITermRepoLockerErrors,
Initializable,
UUPSUpgradeable,
AccessControlUpgradeable
{
using SafeERC20Upgradeable for IERC20Upgradeable;
// ========================================================================
// = Access Roles =========================================================
// ========================================================================
bytes32 public constant SERVICER_ROLE = keccak256("SERVICER_ROLE");
bytes32 public constant INITIALIZER_ROLE = keccak256("INITIALIZER_ROLE");
// ========================================================================
// = State Variables ======================================================
// ========================================================================
bytes32 public termRepoId;
bool public transfersPaused;
ITermEventEmitter internal emitter;
// ========================================================================
// = Modifiers ===========================================================
// ========================================================================
modifier whileTransfersNotPaused() {
if (transfersPaused) {
revert TermRepoLockerTransfersPaused();
}
_;
}
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
function initialize(
string calldata termRepoId_,
address termRepoCollateralManager_,
address termRepoServicer_
) external initializer {
UUPSUpgradeable.__UUPSUpgradeable_init();
AccessControlUpgradeable.__AccessControl_init();
termRepoId = keccak256(abi.encodePacked(termRepoId_));
transfersPaused = false;
_grantRole(SERVICER_ROLE, termRepoCollateralManager_);
_grantRole(SERVICER_ROLE, termRepoServicer_);
_setupRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(INITIALIZER_ROLE, msg.sender);
}
function pairTermContracts(
ITermEventEmitter emitter_
) external onlyRole(INITIALIZER_ROLE) {
emitter = emitter_;
emitter.emitTermRepoLockerInitialized(termRepoId, address(this));
}
/// @notice Locks tokens from origin wallet
/// @notice Reverts if caller doesn't have SERVICER_ROLE
/// @param originWallet The wallet from which to transfer tokens
/// @param token The address of token being transferred
/// @param amount The amount of tokens to transfer
function transferTokenFromWallet(
address originWallet,
address token,
uint256 amount
) external override whileTransfersNotPaused onlyRole(SERVICER_ROLE) {
IERC20Upgradeable tokenInstance = IERC20Upgradeable(token);
// slither-disable-start arbitrary-send-erc20
/// @dev This function is permissioned to be only callable by other term contracts. The entry points of calls that end up utilizing this function all use Authenticator to
/// authenticate that the caller is the owner of the token whose approved this contract to spend the tokens. Therefore there is no risk of another wallet using this function
/// to transfer somebody else's tokens.
tokenInstance.safeTransferFrom(originWallet, address(this), amount);
// slither-disable-end arbitrary-send-erc20
}
/// @notice Unlocks tokens to destination wallet
/// @dev Reverts if caller doesn't have SERVICER_ROLE
/// @param destinationWallet The wallet to unlock tokens into
/// @param token The address of token being unlocked
/// @param amount The amount of tokens to unlock
function transferTokenToWallet(
address destinationWallet,
address token,
uint256 amount
) external override whileTransfersNotPaused onlyRole(SERVICER_ROLE) {
IERC20Upgradeable tokenInstance = IERC20Upgradeable(token);
tokenInstance.safeTransfer(destinationWallet, amount);
}
// ========================================================================
// = Pause Functions ======================================================
// ========================================================================
function pauseTransfers() external onlyRole(DEFAULT_ADMIN_ROLE) {
transfersPaused = true;
emitter.emitTermRepoLockerTransfersPaused(termRepoId);
}
function unpauseTransfers() external onlyRole(DEFAULT_ADMIN_ROLE) {
transfersPaused = false;
emitter.emitTermRepoLockerTransfersUnpaused(termRepoId);
}
// solhint-disable no-empty-blocks
/// @dev Required override by the OpenZeppelin UUPS module
function _authorizeUpgrade(
address
) internal view override onlyRole(DEFAULT_ADMIN_ROLE) {}
// solhint-enable no-empty-blocks
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./interfaces/ITermEventEmitter.sol";
import "./interfaces/ITermRepoServicer.sol";
import "./interfaces/ITermRepoServicerErrors.sol";
import "./interfaces/ITermController.sol";
import "./interfaces/ITermRepoCollateralManager.sol";
import "./interfaces/ITermRepoLocker.sol";
import "./interfaces/ITermRepoRolloverManager.sol";
import "./interfaces/ITermRepoToken.sol";
import "./lib/ExponentialNoError.sol";
import "./lib/TermAuctionGroup.sol";
import "./lib/TermRepoRolloverElection.sol";
import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
/// @author TermLabs
/// @title Term Repo Servicer
/// @notice This contract maintains records, collects and disburse repurchase payments
/// @dev This contract belongs to the Term Servicer group of contracts and is specific to a Term Repo deployment
contract TermRepoServicer is
ITermRepoServicer,
ITermRepoServicerErrors,
Initializable,
UUPSUpgradeable,
AccessControlUpgradeable,
ExponentialNoError
{
// ========================================================================
// = Constants ===========================================================
// ========================================================================
uint256 public constant YEAR_SECONDS = 60 * 60 * 24 * 360;
// ========================================================================
// = Access Roles ========================================================
// ========================================================================
bytes32 public constant AUCTION_LOCKER = keccak256("AUCTION_LOCKER");
bytes32 public constant AUCTIONEER = keccak256("AUCTIONEER");
bytes32 public constant COLLATERAL_MANAGER =
keccak256("COLLATERAL_MANAGER");
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
bytes32 public constant ROLLOVER_MANAGER = keccak256("ROLLOVER_MANAGER");
bytes32 public constant ROLLOVER_TARGET_AUCTIONEER_ROLE =
keccak256("ROLLOVER_TARGET_AUCTIONEER_ROLE");
bytes32 public constant INITIALIZER_ROLE = keccak256("INITIALIZER_ROLE");
// ========================================================================
// = State Variables =====================================================
// ========================================================================
bytes32 public termRepoId;
// Total Repurchase Price Owed by all borrowers
uint256 public totalOutstandingRepurchaseExposure;
// Total Repurchase Currency locked by TermLocker
uint256 public totalRepurchaseCollected;
// block timestamp at which repurchase is due
uint256 public maturityTimestamp;
//block timestamp at which repurchase period ends
uint256 public endOfRepurchaseWindow;
/// block timestamp at which term repo tokens can be redeemed
uint256 public redemptionTimestamp;
/// percentage share of bid amounts charged to bidder
uint256 public servicingFee;
/// proportion of redemption value for redemption
uint256 public shortfallHaircutMantissa;
// token used for purchase/loans
address public purchaseToken;
// collateral manager in same term
ITermRepoCollateralManager public termRepoCollateralManager;
// rollover manager in same term
ITermRepoRolloverManager public termRepoRolloverManager;
// TermRepoLocker for term funds
ITermRepoLocker public termRepoLocker;
// TermRepoToken for current term
ITermRepoToken public termRepoToken;
// global term controller contract
ITermController internal termController;
// global term event emitter
ITermEventEmitter internal emitter;
// Repurchase Exposure Ledger
// For each borrower wallet address, keep ledger of repurchase obligations
mapping(address => uint256) internal repurchaseExposureLedger;
bool internal termContractPaired;
// ========================================================================
// = Modifiers ===========================================================
// ========================================================================
modifier notTermContractPaired() {
if (termContractPaired) {
revert AlreadyTermContractPaired();
}
termContractPaired = true;
_;
}
// ========================================================================
// = Deploy ==============================================================
// ========================================================================
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
function initialize(
string calldata termRepoId_,
uint256 maturityTimestamp_,
uint256 repurchaseWindow_,
uint256 redemptionBuffer_,
uint256 servicingFee_,
address purchaseToken_,
ITermController termController_,
ITermEventEmitter emitter_
) external initializer {
UUPSUpgradeable.__UUPSUpgradeable_init();
AccessControlUpgradeable.__AccessControl_init();
termRepoId = keccak256(abi.encodePacked(termRepoId_));
totalOutstandingRepurchaseExposure = 0;
totalRepurchaseCollected = 0;
maturityTimestamp = maturityTimestamp_;
endOfRepurchaseWindow = maturityTimestamp_ + repurchaseWindow_;
redemptionTimestamp =
maturityTimestamp_ +
repurchaseWindow_ +
redemptionBuffer_;
servicingFee = servicingFee_;
require(purchaseToken_ != address(0), "Zero address purchase token");
purchaseToken = purchaseToken_;
termController = termController_;
emitter = emitter_;
termContractPaired = false;
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(INITIALIZER_ROLE, msg.sender);
}
function pairTermContracts(
address termRepoLocker_,
address termRepoCollateralManager_,
address termRepoToken_,
address termAuctionOfferLocker_,
address termAuction_,
address rolloverManager_,
string calldata version_
) external onlyRole(INITIALIZER_ROLE) notTermContractPaired {
termRepoLocker = ITermRepoLocker(termRepoLocker_);
termRepoCollateralManager = ITermRepoCollateralManager(
termRepoCollateralManager_
);
termRepoRolloverManager = ITermRepoRolloverManager(rolloverManager_);
termRepoToken = ITermRepoToken(termRepoToken_);
_grantRole(AUCTION_LOCKER, termAuctionOfferLocker_);
_grantRole(AUCTIONEER, termAuction_);
_grantRole(COLLATERAL_MANAGER, termRepoCollateralManager_);
_grantRole(ROLLOVER_MANAGER, rolloverManager_);
emitter.emitTermRepoServicerInitialized(
termRepoId,
address(this),
purchaseToken,
maturityTimestamp,
endOfRepurchaseWindow,
redemptionTimestamp,
servicingFee,
version_
);
}
// ========================================================================
// = APIs ================================================================
// ========================================================================
/// @notice The max repurchase amount is the repurchase balance less any amounts earmarked for rollover
/// @param amount The amount of purchase token to submit for repurchase
function submitRepurchasePayment(uint256 amount) external {
address borrower = msg.sender;
// solhint-disable-next-line not-rely-on-time
if (block.timestamp < maturityTimestamp) {
revert NotMaturedYet();
}
// solhint-disable-next-line not-rely-on-time
if (block.timestamp >= endOfRepurchaseWindow) {
revert AfterRepurchaseWindow();
}
if (repurchaseExposureLedger[borrower] == 0) {
revert ZeroBorrowerRepurchaseObligation();
}
if (amount == type(uint256).max) {
revert InvalidParameters("repurchase amount cannot be uint max");
}
uint256 maxRepurchaseAmount = _getMaxRepaymentAroundRollover(borrower);
if (amount > maxRepurchaseAmount) {
revert RepurchaseAmountTooHigh();
}
_repay(borrower, borrower, amount);
if (repurchaseExposureLedger[borrower] == 0) {
termRepoCollateralManager.unlockCollateralOnRepurchase(borrower);
}
emitter.emitRepurchasePaymentSubmitted(termRepoId, borrower, amount);
}
/// @param amountToBurn The amount of TermRepoTokens to burn
function burnCollapseExposure(uint256 amountToBurn) external {
// solhint-disable-next-line not-rely-on-time
if (block.timestamp >= endOfRepurchaseWindow) {
revert AfterRepurchaseWindow();
}
address borrower = msg.sender;
if (repurchaseExposureLedger[borrower] == 0) {
revert ZeroBorrowerRepurchaseObligation();
}
IERC20MetadataUpgradeable purchaseTokenInstance = IERC20MetadataUpgradeable(
purchaseToken
);
uint256 purchaseTokenDecimals = uint256(
purchaseTokenInstance.decimals()
);
uint256 maxRepurchaseAmount = _getMaxRepaymentAroundRollover(borrower);
uint256 termRepoTokenValueOfRepurchase = div_(
Exp({
mantissa: maxRepurchaseAmount *
10 ** (18 - purchaseTokenDecimals)
}),
Exp({mantissa: termRepoToken.redemptionValue()})
).mantissa / 10 ** (18 - purchaseTokenDecimals);
if (amountToBurn < termRepoTokenValueOfRepurchase) {
uint256 repayAmount = termRepoToken.burnAndReturnValue(
borrower,
amountToBurn
);
// slither-disable-start reentrancy-no-eth
repurchaseExposureLedger[borrower] -= repayAmount;
totalOutstandingRepurchaseExposure -= repayAmount;
// slither-disable-end reentrancy-no-eth
assert(_isTermRepoBalanced());
emitter.emitBurnCollapseExposure(termRepoId, borrower, repayAmount);
} else {
// slither-disable-start reentrancy-no-eth
totalOutstandingRepurchaseExposure -= maxRepurchaseAmount;
repurchaseExposureLedger[borrower] -= maxRepurchaseAmount;
// slither-disable-end reentrancy-no-eth
termRepoToken.burn(borrower, termRepoTokenValueOfRepurchase);
assert(_isTermRepoBalanced());
emitter.emitBurnCollapseExposure(
termRepoId,
borrower,
maxRepurchaseAmount
);
termRepoCollateralManager.unlockCollateralOnRepurchase(borrower);
}
}
/// @param borrower The address of the borrower to query
/// @return The total repurchase price due at maturity for a given borrower
function getBorrowerRepurchaseObligation(
address borrower
) external view returns (uint256) {
return repurchaseExposureLedger[borrower];
}
/// @dev This method allows MINTER_ROLE to open repurchase price exposure against a TermRepoToken mint of corresponding value outside of a Term Auction to create new supply
/// @param amount The amount of Term Repo Tokens to mint
/// @param collateralAmounts An array containing an amount of collateral token for each token in collateral basket
function mintOpenExposure(
uint256 amount,
uint256[] calldata collateralAmounts
) external {
address borrower = msg.sender;
if (!hasRole(MINTER_ROLE, borrower)) {
revert NoMintOpenExposureAccess();
}
// solhint-disable-next-line not-rely-on-time
if (block.timestamp > maturityTimestamp) {
revert AfterMaturity();
}
if (
collateralAmounts.length !=
termRepoCollateralManager.numOfAcceptedCollateralTokens()
) {
revert InvalidParameters(
"Collateral Amounts array not same length as collateral tokens list"
);
}
uint256 maxMintValue = 0;
for (uint256 i = 0; i < collateralAmounts.length; ++i) {
termRepoCollateralManager.mintOpenExposureLockCollateral(
borrower,
termRepoCollateralManager.collateralTokens(i),
collateralAmounts[i]
);
uint256 maxTokensFromCollateral = truncate(
div_(
termRepoCollateralManager.calculateMintableExposure(
termRepoCollateralManager.collateralTokens(i),
collateralAmounts[i]
),
Exp({mantissa: termRepoToken.redemptionValue()})
)
);
maxMintValue += maxTokensFromCollateral;
}
if (amount > maxMintValue) {
revert InsufficientCollateral();
}
Exp memory proRate = div_(
// solhint-disable-next-line not-rely-on-time
Exp({mantissa: (maturityTimestamp - block.timestamp)}),
Exp({mantissa: (YEAR_SECONDS)})
);
Exp memory protocolShareProRated = mul_(
Exp({mantissa: servicingFee}),
proRate
);
uint256 protocolMintTokens = mul_ScalarTruncate(
protocolShareProRated,
amount
);
uint256 minterTokens = amount - protocolMintTokens;
uint256 protocolMintTokensValue = termRepoToken.mintTokens(
termController.getTreasuryAddress(),
protocolMintTokens
);
uint256 minterTokensValue = termRepoToken.mintTokens(
borrower,
minterTokens
);
termRepoToken.decrementMintExposureCap(amount);
uint256 totalMintValue = protocolMintTokensValue + minterTokensValue;
// slither-disable-start reentrancy-benign
repurchaseExposureLedger[borrower] += totalMintValue;
totalOutstandingRepurchaseExposure += totalMintValue;
// slither-disable-end reentrancy-benign
assert(_isTermRepoBalanced());
emitter.emitBidFulfilled(
termRepoId,
borrower,
minterTokensValue,
totalMintValue,
protocolMintTokensValue
);
emitter.emitMintExposure(
termRepoId,
borrower,
minterTokens,
protocolMintTokens,
totalMintValue
);
}
/// @param redeemer The address of redeemer
/// @param amountToRedeem The amount of TermRepoTokens to redeem
function redeemTermRepoTokens(
address redeemer,
uint256 amountToRedeem
) external {
// solhint-disable-next-line not-rely-on-time
if (block.timestamp <= redemptionTimestamp) {
revert RedemptionPeriodNotOpen();
}
if (termRepoToken.balanceOf(redeemer) == 0) {
revert ZeroTermRepoTokenBalance();
}
if (
termRepoToken.totalRedemptionValue() <=
totalRepurchaseCollected + 10 ** 4
) {
_parRedemption(redeemer, amountToRedeem);
} else if (!termRepoCollateralManager.encumberedCollateralRemaining()) {
_proRataRedemption(redeemer, amountToRedeem);
} else {
revert EncumberedCollateralRemaining();
}
}
/// @return A boolean that represents whether the term repo locker is balanced
function isTermRepoBalanced() external view returns (bool) {
return _isTermRepoBalanced();
}
// ========================================================================
// = Auction Functions ===================================================
// ========================================================================
/// @param offeror The address of the offeror
/// @param amount The amount of purchase tokens to lock
function lockOfferAmount(
address offeror,
uint256 amount
) external onlyRole(AUCTION_LOCKER) {
termRepoLocker.transferTokenFromWallet(offeror, purchaseToken, amount);
emitter.emitOfferLockedByServicer(termRepoId, offeror, amount);
}
/// @param offeror The address of the offeror
/// @param amount The amount of purchase tokens to unlocked
function unlockOfferAmount(
address offeror,
uint256 amount
) external onlyRole(AUCTION_LOCKER) {
termRepoLocker.transferTokenToWallet(offeror, purchaseToken, amount);
emitter.emitOfferUnlockedByServicer(termRepoId, offeror, amount);
}
/// @param offeror The address of the offeror
/// @param purchasePrice The offer amount to fulfill
/// @param repurchasePrice The repurchase price due to offeror at maturity
/// @param offerId Unique identifier for this offer
function fulfillOffer(
address offeror,
uint256 purchasePrice,
uint256 repurchasePrice,
bytes32 offerId
) external onlyRole(AUCTIONEER) {
uint256 repoTokensMinted = termRepoToken.mintRedemptionValue(
offeror,
repurchasePrice
);
emitter.emitOfferFulfilled(
offerId,
offeror,
purchasePrice,
repurchasePrice,
repoTokensMinted
);
}
/// @param bidder The address of the bidder
/// @param purchasePrice The bid amount to fulfill
/// @param repurchasePrice The repurchase price due at maturity
/// @param collateralTokens Collateral token addresses
/// @param collateralAmounts Collateral token amounts
/// @param dayCountFractionMantissa Actual/360 day count fraction parameter from Term Auction Group
function fulfillBid(
address bidder,
uint256 purchasePrice,
uint256 repurchasePrice,
address[] calldata collateralTokens,
uint256[] calldata collateralAmounts,
uint256 dayCountFractionMantissa
) external onlyRole(AUCTIONEER) {
// solhint-disable-next-line not-rely-on-time
if (block.timestamp >= maturityTimestamp) {
revert AfterMaturity();
}
repurchaseExposureLedger[bidder] += repurchasePrice;
totalOutstandingRepurchaseExposure += repurchasePrice;
termRepoCollateralManager.journalBidCollateralToCollateralManager(
bidder,
collateralTokens,
collateralAmounts
);
uint256 protocolShare = mul_ScalarTruncate(
mul_(
Exp({mantissa: dayCountFractionMantissa}),
Exp({mantissa: servicingFee})
),
purchasePrice
);
termRepoLocker.transferTokenToWallet(
termController.getTreasuryAddress(),
purchaseToken,
protocolShare
);
termRepoLocker.transferTokenToWallet(
bidder,
purchaseToken,
purchasePrice - protocolShare
);
emitter.emitBidFulfilled(
termRepoId,
bidder,
purchasePrice,
repurchasePrice,
protocolShare
);
}
// ========================================================================
// = Rollover Functions ==================================================
// ========================================================================
/// @param termAuction The address of a TermAuction contract to receive autioneer role
function approveRolloverAuction(
address termAuction
) external onlyRole(ROLLOVER_MANAGER) {
_grantRole(ROLLOVER_TARGET_AUCTIONEER_ROLE, termAuction);
}
/// @param borrower The address of the borrower rolling into new Term Repo
/// @param purchasePrice The purchase price received from new TermRepo
/// @param repurchasePrice The new repurchase price due at maturity of new TermRepo
/// @param previousTermRepoLocker The address of the old TermRepoLocker contract
/// @param dayCountFractionMantissa Actual/360 day count fraction parameter from Term Auction Group
/// @return The net purchase price received in after deducing protocol servicing fees
function openExposureOnRolloverNew(
address borrower,
uint256 purchasePrice,
uint256 repurchasePrice,
address previousTermRepoLocker,
uint256 dayCountFractionMantissa
) external onlyRole(AUCTIONEER) returns (uint256) {
// solhint-disable-next-line not-rely-on-time
if (block.timestamp >= maturityTimestamp) {
revert AfterMaturity();
}
repurchaseExposureLedger[borrower] += repurchasePrice;
totalOutstandingRepurchaseExposure += repurchasePrice;
uint256 protocolShare = mul_ScalarTruncate(
mul_(
Exp({mantissa: dayCountFractionMantissa}),
Exp({mantissa: servicingFee})
),
purchasePrice
);
termRepoLocker.transferTokenToWallet(
termController.getTreasuryAddress(),
purchaseToken,
protocolShare
);
uint256 netPurchasePrice = purchasePrice - protocolShare;
termRepoLocker.transferTokenToWallet(
previousTermRepoLocker,
purchaseToken,
netPurchasePrice
);
emitter.emitExposureOpenedOnRolloverNew(
termRepoId,
borrower,
netPurchasePrice,
repurchasePrice,
protocolShare
);
return netPurchasePrice;
}
/// @param borrower The address of the borrower
/// @param rolloverSettlementAmount The amount of net proceeds received from new TermRepo to pay down existing repurchase obligation due to old Term Repo
/// @return A uint256 representing the proportion of total repurchase due to old Term Repo from borrower settled by proceeds from new TermRepo
function closeExposureOnRolloverExisting(
address borrower,
uint256 rolloverSettlementAmount
) external onlyRole(ROLLOVER_TARGET_AUCTIONEER_ROLE) returns (uint256) {
// solhint-disable-next-line not-rely-on-time
if (block.timestamp < maturityTimestamp) {
revert NotMaturedYet();
}
// solhint-disable-next-line not-rely-on-time
if (block.timestamp >= endOfRepurchaseWindow) {
revert AfterRepurchaseWindow();
}
uint256 proportionPaid;
if (rolloverSettlementAmount >= repurchaseExposureLedger[borrower]) {
proportionPaid = expScale;
} else {
proportionPaid =
(rolloverSettlementAmount * expScale) /
repurchaseExposureLedger[borrower];
}
//NOTE: Prevent overflow errors in the case purchasePrice > remaining borrow balance
if (rolloverSettlementAmount > repurchaseExposureLedger[borrower]) {
totalOutstandingRepurchaseExposure -= repurchaseExposureLedger[
borrower
];
totalRepurchaseCollected += repurchaseExposureLedger[borrower];
emitter.emitExposureClosedOnRolloverExisting(
termRepoId,
borrower,
repurchaseExposureLedger[borrower]
);
// slither-disable-start reentrancy-no-eth
repurchaseExposureLedger[borrower] = 0;
// slither-disable-end reentrancy-no-eth
} else {
repurchaseExposureLedger[borrower] -= rolloverSettlementAmount;
totalOutstandingRepurchaseExposure -= rolloverSettlementAmount;
totalRepurchaseCollected += rolloverSettlementAmount;
emitter.emitExposureClosedOnRolloverExisting(
termRepoId,
borrower,
rolloverSettlementAmount
);
}
assert(_isTermRepoBalanced());
termRepoRolloverManager.fulfillRollover(borrower);
return proportionPaid;
}
// ========================================================================
// = Collateral Functions ================================================
// ========================================================================
/// @param borrower The address of the borrower
/// @param liquidator The address of the liquidator
/// @param amountToCover The amount of repurchase exposure to cover in liquidation
function liquidatorCoverExposure(
address borrower,
address liquidator,
uint256 amountToCover
) external onlyRole(COLLATERAL_MANAGER) {
_repay(borrower, liquidator, amountToCover);
}
/// @param borrower The address of the borrower
/// @param liquidator The address of the liquidator
/// @param amountOfRepoToken The amount of term tokens used to cover in liquidation
/// @return A uint256 representing purchase value of repo tokens burned
function liquidatorCoverExposureWithRepoToken(
address borrower,
address liquidator,
uint256 amountOfRepoToken
) external onlyRole(COLLATERAL_MANAGER) returns (uint256) {
uint256 burnValue = termRepoToken.burnAndReturnValue(
liquidator,
amountOfRepoToken
);
if (burnValue > repurchaseExposureLedger[borrower]) {
revert RepurchaseAmountTooHigh();
}
repurchaseExposureLedger[borrower] -= burnValue;
totalOutstandingRepurchaseExposure -= burnValue;
assert(_isTermRepoBalanced());
return burnValue;
}
// ========================================================================
// = Admin Functions ======================================================
// ========================================================================
/// @param authedUser The address of user granted acces to create mint exposure
function grantMintExposureAccess(
address authedUser
) external onlyRole(DEFAULT_ADMIN_ROLE) {
_grantRole(MINTER_ROLE, authedUser);
}
/// @param termAuctionGroup A struct containing contract addresses of a Term Auction deployment to pair for a reopening of a TermRepo
function reopenToNewAuction(
TermAuctionGroup calldata termAuctionGroup
) external onlyRole(INITIALIZER_ROLE) {
_grantRole(
AUCTION_LOCKER,
address(termAuctionGroup.termAuctionOfferLocker)
);
_grantRole(AUCTIONEER, address(termAuctionGroup.auction));
emitter.emitReopeningOfferLockerPaired(
termRepoId,
address(this),
address(termAuctionGroup.termAuctionOfferLocker),
address(termAuctionGroup.auction)
);
}
// ========================================================================
// = Internal Functions ==================================================
// ========================================================================
/// @notice Truncation is by 4 decimal places due to the assumption that number of participants < 10000
function _isTermRepoBalanced() internal view returns (bool) {
if (shortfallHaircutMantissa == 0) {
return
(totalOutstandingRepurchaseExposure +
totalRepurchaseCollected) /
(10 ** 4) ==
termRepoToken.totalRedemptionValue() / (10 ** 4);
}
// @note in the case of shortfall, purchase currency in termRepoLocker must balance the pro rata redemption value of remaining term repo tokens
return
(totalRepurchaseCollected) / (10 ** 4) ==
mul_ScalarTruncate(
Exp({mantissa: shortfallHaircutMantissa}),
termRepoToken.totalRedemptionValue()
) /
(10 ** 4);
}
function _getMaxRepaymentAroundRollover(
address borrower
) internal view returns (uint256) {
uint256 outstandingRolloverAmount;
TermRepoRolloverElection
memory rolloverElection = termRepoRolloverManager
.getRolloverInstructions(borrower);
if (
rolloverElection.rolloverAmount == 0 || rolloverElection.processed
) {
outstandingRolloverAmount = 0;
} else {
outstandingRolloverAmount = rolloverElection.rolloverAmount;
}
return repurchaseExposureLedger[borrower] - outstandingRolloverAmount;
}
// Reentrancy risk
function _repay(
address _borrower,
address repayer_,
uint256 amount_
) internal {
if (amount_ > repurchaseExposureLedger[_borrower]) {
revert RepurchaseAmountTooHigh();
}
repurchaseExposureLedger[_borrower] -= amount_;
totalOutstandingRepurchaseExposure -= amount_;
totalRepurchaseCollected += amount_;
termRepoLocker.transferTokenFromWallet(
repayer_,
purchaseToken,
amount_
);
assert(_isTermRepoBalanced());
}
function _parRedemption(address redeemer_, uint256 amount_) internal {
uint256 redemptionValue = termRepoToken.burnAndReturnValue(
redeemer_,
amount_
);
if (redemptionValue <= totalRepurchaseCollected) {
totalRepurchaseCollected -= redemptionValue;
termRepoLocker.transferTokenToWallet(
redeemer_,
purchaseToken,
redemptionValue
);
emitter.emitTermRepoTokensRedeemed(
termRepoId,
redeemer_,
redemptionValue,
0
);
} else {
uint256 repurchaseRedeemed = totalRepurchaseCollected;
totalRepurchaseCollected = 0;
termRepoLocker.transferTokenToWallet(
redeemer_,
purchaseToken,
repurchaseRedeemed
);
emitter.emitTermRepoTokensRedeemed(
termRepoId,
redeemer_,
repurchaseRedeemed,
0
);
}
assert(_isTermRepoBalanced());
}
function _proRataRedemption(address redeemer_, uint256 amount_) internal {
if (shortfallHaircutMantissa == 0) {
shortfallHaircutMantissa = div_(
Exp({mantissa: totalRepurchaseCollected * expScale}),
Exp({
mantissa: (totalRepurchaseCollected +
totalOutstandingRepurchaseExposure) * expScale
})
).mantissa;
}
// slither-disable-start reentrancy-no-eth
uint256 redemptionAmount = termRepoToken.burnAndReturnValue(
redeemer_,
amount_
);
uint256 proRataRedemptionAmount = mul_ScalarTruncate(
Exp({mantissa: shortfallHaircutMantissa}),
redemptionAmount
);
if (proRataRedemptionAmount <= totalRepurchaseCollected) {
totalRepurchaseCollected -= proRataRedemptionAmount;
termRepoLocker.transferTokenToWallet(
redeemer_,
purchaseToken,
proRataRedemptionAmount
);
emitter.emitTermRepoTokensRedeemed(
termRepoId,
redeemer_,
proRataRedemptionAmount,
expScale - shortfallHaircutMantissa
);
} else {
uint256 repurchaseRedeemed = totalRepurchaseCollected;
totalRepurchaseCollected = 0;
termRepoLocker.transferTokenToWallet(
redeemer_,
purchaseToken,
repurchaseRedeemed
);
emitter.emitTermRepoTokensRedeemed(
termRepoId,
redeemer_,
repurchaseRedeemed,
expScale - shortfallHaircutMantissa
);
}
assert(_isTermRepoBalanced());
}
// solhint-disable no-empty-blocks
///@dev required override by the OpenZeppelin UUPS module
function _authorizeUpgrade(
address
) internal override onlyRole(DEFAULT_ADMIN_ROLE) {}
// solhint-enable no-empty-blocks
}//SPDX-License-Identifier: CC-BY-NC-ND-4.0
pragma solidity ^0.8.18;
import "./lib/ExponentialNoError.sol";
import "./lib/TermRepoTokenConfig.sol";
import "./interfaces/ITermRepoToken.sol";
import "./interfaces/ITermRepoTokenErrors.sol";
import "./interfaces/ITermEventEmitter.sol";
import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
/// @author TermLabs
/// @title Term Repo Token
/// @notice This is an ERC-20 contract to track claims to the aggregate repurchase obligations due on the repurchase date across all borrowers to a Term Repo
/// @dev This contract belongs to the Term Servicer group of contracts and is specific to a Term Repo deployment
contract TermRepoToken is
Initializable,
ERC20Upgradeable,
UUPSUpgradeable,
AccessControlUpgradeable,
ExponentialNoError,
ITermRepoTokenErrors,
ITermRepoToken
{
// ========================================================================
// = Access Roles ========================================================
// ========================================================================
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
bytes32 public constant BURNER_ROLE = keccak256("BURNER_ROLE");
bytes32 public constant INITIALIZER_ROLE = keccak256("INITIALIZER_ROLE");
// ========================================================================
// = State Variables ======================================================
// ========================================================================
uint8 internal decimalPlaces; // NOTE: aligned with purchase token
bool internal termContractPaired;
bool public mintingPaused;
bool public burningPaused;
uint256 public redemptionValue; // NOTE: number of purchase tokens per unit
bytes32 public termRepoId;
uint256 public mintExposureCap;
TermRepoTokenConfig public config;
ITermEventEmitter internal emitter;
// ========================================================================
// = Modifiers ===========================================================
// ========================================================================
modifier whileMintingNotPaused() {
if (mintingPaused) {
revert TermRepoTokenMintingPaused();
}
_;
}
modifier whileBurningNotPaused() {
if (burningPaused) {
revert TermRepoTokenBurningPaused();
}
_;
}
modifier notTermContractPaired() {
if (termContractPaired) {
revert AlreadyTermContractPaired();
}
termContractPaired = true;
_;
}
// ========================================================================
// = Deploy (https://docs.openzeppelin.com/contracts/4.x/upgradeable) =====
// ========================================================================
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
function initialize(
string calldata termRepoId_,
string calldata name_,
string calldata symbol_,
address termRepoServicer_,
uint8 decimalPlaces_,
uint256 redemptionValue_,
uint256 mintExposureCap_,
TermRepoTokenConfig calldata config_
) external initializer {
ERC20Upgradeable.__ERC20_init(name_, symbol_);
UUPSUpgradeable.__UUPSUpgradeable_init();
AccessControlUpgradeable.__AccessControl_init();
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(MINTER_ROLE, termRepoServicer_);
_grantRole(BURNER_ROLE, termRepoServicer_);
_grantRole(INITIALIZER_ROLE, msg.sender);
// slither-disable-start reentrancy-no-eth events-maths
decimalPlaces = decimalPlaces_;
redemptionValue = redemptionValue_;
config = config_;
// slither-disable-end reentrancy-no-eth events-maths
termRepoId = keccak256(abi.encodePacked(termRepoId_));
mintExposureCap = mintExposureCap_;
mintingPaused = false;
termContractPaired = false;
}
function pairTermContracts(
ITermEventEmitter emitter_
) external onlyRole(INITIALIZER_ROLE) notTermContractPaired {
emitter = emitter_;
emitter.emitTermRepoTokenInitialized(
termRepoId,
address(this),
redemptionValue
);
}
function resetMintExposureCap(
uint256 mintExposureCap_
) external onlyRole(DEFAULT_ADMIN_ROLE) {
mintExposureCap = mintExposureCap_;
}
// ========================================================================
// = Interface/API ========================================================
// ========================================================================
/// @notice Calculates the total USD redemption value of all outstanding TermRepoTokens
/// @return totalRedemptionValue The total redemption value of TermRepoTokens in USD
function totalRedemptionValue() external view returns (uint256) {
uint256 totalValue = truncate(
mul_(
Exp({mantissa: totalSupply() * expScale}),
Exp({mantissa: redemptionValue})
)
);
return totalValue;
}
/// @notice Burns TermRepoTokens held by an account
/// @notice Reverts if caller does not have BURNER_ROLE
/// @param account The address of account holding TermRepoTokens to burn
/// @param amount The amount of TermRepoTokens to burn without decimal factor
function burn(
address account,
uint256 amount
) external override onlyRole(BURNER_ROLE) whileBurningNotPaused {
_burn(account, amount);
mintExposureCap += amount;
}
/// @notice Burns TermRepoTokens held by an account and returns purchase redemption value of tokens burned
/// @notice Reverts if caller does not have BURNER_ROLE
/// @param account The address of account holding TermRepoTokens to burn
/// @param amount The amount of TermRepoTokens to burn without decimal factor
/// @return totalRedemptionValue Total redemption value of TermRepoTokens burned
function burnAndReturnValue(
address account,
uint256 amount
)
external
override
onlyRole(BURNER_ROLE)
whileBurningNotPaused
returns (uint256)
{
_burn(account, amount);
mintExposureCap += amount;
uint256 valueBurned = truncate(
mul_(
Exp({mantissa: amount * expScale}),
Exp({mantissa: redemptionValue})
)
);
return valueBurned;
}
/// @notice Mints TermRepoTokens in an amount equal to caller specified target redemption amount
/// @notice The redemptionValue is the amount of purchase tokens redeemable per unit of TermRepoToken
/// @notice Reverts if caller does not have MINTER_ROLE
/// @param account The address of account to mint TermRepoTokens to
/// @param redemptionAmount The target redemption amount to mint in TermRepoTokens
/// @return numTokens The amount of Term Repo Tokens minted
function mintRedemptionValue(
address account,
uint256 redemptionAmount
)
external
override
whileMintingNotPaused
onlyRole(MINTER_ROLE)
returns (uint256)
{
uint256 numTokens = truncate(
div_(
Exp({mantissa: redemptionAmount * expScale}),
Exp({mantissa: redemptionValue})
)
);
_mint(account, numTokens);
return numTokens;
}
/// @notice Mints an exact amount of TermRepoTokens
/// @notice Reverts if caller does not have MINTER_ROLE
/// @param account The address of account to mint TermRepoTokens to
/// @param numTokens The exact number of term repo tokens to mint
function mintTokens(
address account,
uint256 numTokens
)
external
override
whileMintingNotPaused
onlyRole(MINTER_ROLE)
returns (uint256)
{
_mint(account, numTokens);
uint256 redemptionValueMinted = truncate(
mul_(
Exp({mantissa: numTokens * expScale}),
Exp({mantissa: redemptionValue})
)
);
return redemptionValueMinted;
}
/// @notice Decrements the mintExposureCap
/// @notice Reverts if caller does not have MINTER_ROLE
/// @param supplyMinted The number of Tokens Minted
function decrementMintExposureCap(
uint256 supplyMinted
) external override onlyRole(MINTER_ROLE) {
if (supplyMinted > mintExposureCap) {
revert MintExposureCapExceeded();
}
mintExposureCap -= supplyMinted;
}
/// @return uint8 A uint8 that specifies how many decimal places a token has
function decimals() public view virtual override returns (uint8) {
return decimalPlaces;
}
// ========================================================================
// = Pause Functions ======================================================
// ========================================================================
function pauseMinting() external onlyRole(DEFAULT_ADMIN_ROLE) {
mintingPaused = true;
emitter.emitTermRepoTokenMintingPaused(termRepoId);
}
function unpauseMinting() external onlyRole(DEFAULT_ADMIN_ROLE) {
mintingPaused = false;
emitter.emitTermRepoTokenMintingUnpaused(termRepoId);
}
function pauseBurning() external onlyRole(DEFAULT_ADMIN_ROLE) {
burningPaused = true;
emitter.emitTermRepoTokenBurningPaused(termRepoId);
}
function unpauseBurning() external onlyRole(DEFAULT_ADMIN_ROLE) {
burningPaused = false;
emitter.emitTermRepoTokenBurningUnpaused(termRepoId);
}
// solhint-disable no-empty-blocks
///@dev Required override by the OpenZeppelin UUPS module
function _authorizeUpgrade(
address
) internal view override onlyRole(DEFAULT_ADMIN_ROLE) {}
// solhint-enable no-empty-blocks
}{
"optimizer": {
"enabled": true,
"runs": 50
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"libraries": {}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"AlreadyTermContractPaired","type":"error"},{"inputs":[],"name":"BorrowerNotInShortfall","type":"error"},{"inputs":[],"name":"CallerNotBorrower","type":"error"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"address","name":"token","type":"address"}],"name":"CollateralBelowMaintenanceRatios","type":"error"},{"inputs":[],"name":"CollateralDepositClosed","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"CollateralTokenNotAllowed","type":"error"},{"inputs":[],"name":"CollateralWithdrawalClosed","type":"error"},{"inputs":[],"name":"DefaultsClosed","type":"error"},{"inputs":[],"name":"ExceedsNetExposureCapOnLiquidation","type":"error"},{"inputs":[{"internalType":"address","name":"collateralToken","type":"address"}],"name":"InsufficientCollateralForLiquidationRepayment","type":"error"},{"inputs":[],"name":"InsufficientCollateralForRedemption","type":"error"},{"inputs":[{"internalType":"string","name":"message","type":"string"}],"name":"InvalidParameters","type":"error"},{"inputs":[],"name":"LiquidationsPaused","type":"error"},{"inputs":[],"name":"RepaymentAmountLargerThanAllowed","type":"error"},{"inputs":[],"name":"SelfLiquidationNotPermitted","type":"error"},{"inputs":[],"name":"ShortfallLiquidationsClosed","type":"error"},{"inputs":[],"name":"TermRepurchaseWindowOpen","type":"error"},{"inputs":[],"name":"TotalRepaymentGreaterThangetBorrowerRepurchaseObligation","type":"error"},{"inputs":[],"name":"UnlockAmountGreaterThanCollateralBalance","type":"error"},{"inputs":[],"name":"ZeroAddressContractPaired","type":"error"},{"inputs":[],"name":"ZeroBorrowerRepurchaseObligation","type":"error"},{"inputs":[],"name":"ZeroCollateralBalance","type":"error"},{"inputs":[],"name":"ZeroLiquidationNotPermitted","type":"error"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"previousAdmin","type":"address"},{"indexed":false,"internalType":"address","name":"newAdmin","type":"address"}],"name":"AdminChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"beacon","type":"address"}],"name":"BeaconUpgraded","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint8","name":"version","type":"uint8"}],"name":"Initialized","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":true,"internalType":"address","name":"implementation","type":"address"}],"name":"Upgraded","type":"event"},{"inputs":[],"name":"AUCTION_LOCKER","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"DEFAULT_ADMIN_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"INITIALIZER_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"ROLLOVER_MANAGER","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"ROLLOVER_TARGET_AUCTIONEER_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"SERVICER_ROLE","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"address","name":"collateralToken","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"acceptRolloverCollateral","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"rolloverAuction","type":"address"}],"name":"approveRolloverAuction","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"bidder","type":"address"},{"internalType":"address","name":"collateralToken","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"auctionLockCollateral","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"bidder","type":"address"},{"internalType":"address","name":"collateralToken","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"auctionUnlockCollateral","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"uint256[]","name":"closureAmounts","type":"uint256[]"}],"name":"batchDefault","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"uint256[]","name":"closureAmounts","type":"uint256[]"}],"name":"batchLiquidation","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"uint256[]","name":"closureRepoTokenAmounts","type":"uint256[]"}],"name":"batchLiquidationWithRepoToken","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"collateralToken","type":"address"},{"internalType":"uint256","name":"amountToLock","type":"uint256"}],"name":"calculateMintableExposure","outputs":[{"components":[{"internalType":"uint256","name":"mantissa","type":"uint256"}],"internalType":"struct ExponentialNoError.Exp","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"collateralTokens","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"deMinimisMarginThreshold","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"encumberedCollateralRemaining","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"collateralToken","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"externalLockCollateral","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"collateralToken","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"externalUnlockCollateral","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"address","name":"collateralToken","type":"address"}],"name":"getCollateralBalance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"}],"name":"getCollateralBalances","outputs":[{"internalType":"address[]","name":"","type":"address[]"},{"internalType":"uint256[]","name":"","type":"uint256[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"}],"name":"getCollateralMarketValue","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":"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":[{"internalType":"address","name":"","type":"address"}],"name":"initialCollateralRatios","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"string","name":"termRepoId_","type":"string"},{"internalType":"uint256","name":"liquidateDamangesDueToProtocol_","type":"uint256"},{"internalType":"uint256","name":"netExposureCapOnLiquidation_","type":"uint256"},{"internalType":"uint256","name":"deMinimisMarginThreshold_","type":"uint256"},{"internalType":"address","name":"purchaseToken_","type":"address"},{"components":[{"internalType":"address","name":"tokenAddress","type":"address"},{"internalType":"uint256","name":"initialCollateralRatio","type":"uint256"},{"internalType":"uint256","name":"maintenanceRatio","type":"uint256"},{"internalType":"uint256","name":"liquidatedDamage","type":"uint256"}],"internalType":"struct Collateral[]","name":"collateralTokens_","type":"tuple[]"},{"internalType":"contract ITermEventEmitter","name":"emitter_","type":"address"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"}],"name":"isBorrowerInShortfall","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"address[]","name":"collateralTokenAddresses","type":"address[]"},{"internalType":"uint256[]","name":"collateralTokenAmounts","type":"uint256[]"}],"name":"journalBidCollateralToCollateralManager","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"liquidateDamangesDueToProtocol","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"liquidatedDamages","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"liquidationsPaused","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"maintenanceCollateralRatios","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"address","name":"collateralToken","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"mintOpenExposureLockCollateral","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"netExposureCapOnLiquidation","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"numOfAcceptedCollateralTokens","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"termRepoLocker_","type":"address"},{"internalType":"address","name":"termRepoServicer_","type":"address"},{"internalType":"address","name":"termAuctionBidLocker_","type":"address"},{"internalType":"address","name":"termAuction_","type":"address"},{"internalType":"address","name":"termController_","type":"address"},{"internalType":"address","name":"termPriceOracle_","type":"address"},{"internalType":"address","name":"termRepoRolloverManager_","type":"address"}],"name":"pairTermContracts","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"pauseLiquidations","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"proxiableUUID","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"purchaseToken","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"role","type":"bytes32"},{"internalType":"address","name":"account","type":"address"}],"name":"renounceRole","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"contract TermAuction","name":"auction","type":"address"},{"internalType":"contract ITermAuctionBidLocker","name":"termAuctionBidLocker","type":"address"},{"internalType":"contract ITermAuctionOfferLocker","name":"termAuctionOfferLocker","type":"address"}],"internalType":"struct TermAuctionGroup","name":"termAuctionGroup","type":"tuple"}],"name":"reopenToNewAuction","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":"termRepoId","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"termRepoLocker","outputs":[{"internalType":"contract ITermRepoLocker","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"},{"internalType":"uint256","name":"rolloverProportion","type":"uint256"},{"internalType":"address","name":"rolloverTermRepoLocker","type":"address"}],"name":"transferRolloverCollateral","outputs":[{"internalType":"address[]","name":"","type":"address[]"},{"internalType":"uint256[]","name":"","type":"uint256[]"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"borrower","type":"address"}],"name":"unlockCollateralOnRepurchase","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"unpauseLiquidations","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newImplementation","type":"address"}],"name":"upgradeTo","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newImplementation","type":"address"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"upgradeToAndCall","outputs":[],"stateMutability":"payable","type":"function"}]Contract Creation Code
60a0604052306080523480156200001557600080fd5b506200002062000026565b620000e7565b600054610100900460ff1615620000935760405162461bcd60e51b815260206004820152602760248201527f496e697469616c697a61626c653a20636f6e747261637420697320696e697469604482015266616c697a696e6760c81b606482015260840160405180910390fd5b60005460ff90811614620000e5576000805460ff191660ff9081179091556040519081527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15b565b6080516157246200011f60003960008181610e0401528181610e44015281816115370152818161157701526115ef01526157246000f3fe6080604052600436106102745760003560e01c8063578db95711610150578063a217fddf116100bc578063a217fddf14610795578063a95c4d62146107aa578063b7d5820b146107cb578063c066bc0e14610812578063c180ead114610827578063c526c45c14610847578063cc5b6e4a14610867578063cdae1ee01461087d578063d547741f1461089d578063de7f872e146108bd578063e1cdd058146108dd578063fd5d357a146108f3578063fe05281a1461091357600080fd5b8063578db9571461060b5780635c4b440e1461062b57806367af01d01461064c5780636a509f551461067b57806378c2b2c614610690578063790cb491146106a657806382f049ab146106c65780638f6d0f11146106e657806391d14854146107005780639210632f1461072057806394a7cfe8146107405780639c3e2e0e14610760578063a11d52f51461078057600080fd5b80632f2ff15d116101ef5780632f2ff15d1461046f57806336568abe1461048f5780633659cfe6146104af5780633718373f146104cf57806337843bc6146104f157806337cb26f5146105115780633d0dda78146105275780634055008a1461055557806343551d0d1461057557806348717eb7146105a35780634f1ef286146105c357806352d1902d146105d6578063559e4fad146105eb57600080fd5b806301ffc9a71461027957806302b65fb0146102ae57806309a01608146102de57806312a9006914610300578063172c48c714610322578063190e80121461034f57806320db25d5146103815780632391281c146103af578063248a9ca3146103cf57806327df3d3e146103ff5780632a1e8cdb146104215780632b56d95e1461044f575b600080fd5b34801561028557600080fd5b50610299610294366004614a71565b610935565b60405190151581526020015b60405180910390f35b3480156102ba57600080fd5b506102d06000805160206156cf83398151915281565b6040519081526020016102a5565b3480156102ea57600080fd5b506102d060008051602061560883398151915281565b34801561030c57600080fd5b5061032061031b366004614ac0565b61096c565b005b34801561032e57600080fd5b5061034261033d366004614add565b610a08565b6040516102a59190614af6565b34801561035b57600080fd5b5060fc5461036f9062010000900460ff1681565b60405160ff90911681526020016102a5565b34801561038d57600080fd5b506102d061039c366004614ac0565b6101086020526000908152604090205481565b3480156103bb57600080fd5b506103206103ca366004614b0a565b610a33565b3480156103db57600080fd5b506102d06103ea366004614add565b600090815260c9602052604090206001015490565b34801561040b57600080fd5b506102d060008051602061562883398151915281565b34801561042d57600080fd5b506102d061043c366004614ac0565b6101096020526000908152604090205481565b34801561045b57600080fd5b5061032061046a366004614b4b565b610ab8565b34801561047b57600080fd5b5061032061048a366004614b77565b610d57565b34801561049b57600080fd5b506103206104aa366004614b77565b610d7c565b3480156104bb57600080fd5b506103206104ca366004614ac0565b610dfa565b3480156104db57600080fd5b506102d06000805160206156af83398151915281565b3480156104fd57600080fd5b5061032061050c366004614beb565b610ec2565b34801561051d57600080fd5b506102d060fd5481565b34801561053357600080fd5b50610547610542366004614c3f565b6112ef565b6040516102a5929190614cbc565b34801561056157600080fd5b50610320610570366004614d12565b61137d565b34801561058157600080fd5b506102d0610590366004614ac0565b61010a6020526000908152604090205481565b3480156105af57600080fd5b506103206105be366004614b0a565b6114e0565b6103206105d1366004614d70565b61152d565b3480156105e257600080fd5b506102d06115e2565b3480156105f757600080fd5b50610320610606366004614beb565b611690565b34801561061757600080fd5b50610320610626366004614e17565b61189c565b34801561063757600080fd5b5061010354610342906001600160a01b031681565b34801561065857600080fd5b5061066c610667366004614b4b565b611a91565b604051905181526020016102a5565b34801561068757600080fd5b50610320611bcc565b34801561069c57600080fd5b506102d060fe5481565b3480156106b257600080fd5b506103206106c1366004614b0a565b611c45565b3480156106d257600080fd5b506103206106e1366004614beb565b611d00565b3480156106f257600080fd5b5060fc546102999060ff1681565b34801561070c57600080fd5b5061029961071b366004614b77565b611fd7565b34801561072c57600080fd5b5061032061073b366004614b0a565b612002565b34801561074c57600080fd5b5061029961075b366004614ac0565b61202b565b34801561076c57600080fd5b5061032061077b366004614edd565b612259565b34801561078c57600080fd5b50610299612707565b3480156107a157600080fd5b506102d0600081565b3480156107b657600080fd5b5061010154610342906001600160a01b031681565b3480156107d757600080fd5b506102d06107e6366004614fb5565b6001600160a01b03918216600090815261010b6020908152604080832093909416825291909152205490565b34801561081e57600080fd5b5061032061277c565b34801561083357600080fd5b506102d0610842366004614ac0565b6127ca565b34801561085357600080fd5b50610320610862366004614b4b565b6127ec565b34801561087357600080fd5b506102d060fb5481565b34801561088957600080fd5b50610320610898366004614fe3565b612940565b3480156108a957600080fd5b506103206108b8366004614b77565b612ce9565b3480156108c957600080fd5b506105476108d8366004614ac0565b612d0e565b3480156108e957600080fd5b506102d060ff5481565b3480156108ff57600080fd5b5061032061090e366004614ac0565b612e75565b34801561091f57600080fd5b506102d060008051602061566883398151915281565b60006001600160e01b03198216637965db0b60e01b148061096657506301ffc9a760e01b6001600160e01b03198316145b92915050565b60008051602061560883398151915261098481612ea5565b60005b61010654811015610a0357600061010682815481106109a8576109a8615079565b60009182526020808320909101546001600160a01b03878116845261010b835260408085209190921680855292529091205490915080156109f0576109f08583836001612eaf565b5050806109fc906150a5565b9050610987565b505050565b6101068181548110610a1957600080fd5b6000918252602090912001546001600160a01b0316905081565b6000805160206156af833981519152610a4b81612ea5565b6101035460405163049f2a5160e21b81526001600160a01b039091169063127ca94490610a80908790879087906004016150be565b600060405180830381600087803b158015610a9a57600080fd5b505af1158015610aae573d6000803e3d6000fd5b5050505050505050565b81610ac281613007565b610aea5780604051634428dc3160e01b8152600401610ae19190614af6565b60405180910390fd5b336000839003610b2b5760405163dd23c3ad60e01b815260206004820152600b60248201526a16995c9bc8185b5bdd5b9d60aa1b6044820152606401610ae1565b6001600160a01b03808216600090815261010b602090815260408083209388168352929052908120549003610b73576040516314605b7760e01b815260040160405180910390fd5b61010060009054906101000a90046001600160a01b03166001600160a01b0316631320834f6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610bc7573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610beb91906150e2565b4210158015610c70575061010060009054906101000a90046001600160a01b03166001600160a01b0316631b2354376040518163ffffffff1660e01b8152600401602060405180830381865afa158015610c49573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c6d91906150e2565b42105b15610c8e57604051633f5a890f60e01b815260040160405180910390fd5b61010054604051632762697d60e01b81526000916001600160a01b031690632762697d90610cc0908590600401614af6565b602060405180830381865afa158015610cdd573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d0191906150e2565b15610d0a575060015b610d1682868684612eaf565b610d1f8261202b565b15610d5057604051632263ff6560e11b81526001600160a01b03808416600483015286166024820152604401610ae1565b5050505050565b600082815260c96020526040902060010154610d7281612ea5565b610a038383613037565b6001600160a01b0381163314610dec5760405162461bcd60e51b815260206004820152602f60248201527f416363657373436f6e74726f6c3a2063616e206f6e6c792072656e6f756e636560448201526e103937b632b9903337b91039b2b63360891b6064820152608401610ae1565b610df682826130bd565b5050565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000163003610e425760405162461bcd60e51b8152600401610ae1906150fb565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316610e74613124565b6001600160a01b031614610e9a5760405162461bcd60e51b8152600401610ae190615147565b610ea381613140565b60408051600080825260208201909252610ebf9183919061314b565b50565b60fc5460ff1615610ee657604051637d8d0e2160e01b815260040160405180910390fd5b61010060009054906101000a90046001600160a01b03166001600160a01b0316631320834f6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610f3a573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610f5e91906150e2565b4211610f7d57604051633daab04760e21b815260040160405180910390fd5b6001600160a01b0383163303610fa65760405163ae957a1d60e01b815260040160405180910390fd5b610106548114610fc95760405163dd23c3ad60e01b8152600401610ae190615193565b61010054604051632762697d60e01b815260009182916001600160a01b0390911690632762697d90610fff908890600401614af6565b602060405180830381865afa15801561101c573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061104091906150e2565b9050806000036110635760405163baca79c960e01b815260040160405180910390fd5b60008060005b858110156112425786868281811061108357611083615079565b9050602002013560000315611232576000198787838181106110a7576110a7615079565b90506020020135036110cc5760405163dd23c3ad60e01b8152600401610ae1906151f0565b8686828181106110de576110de615079565b90506020020135856110f09190615231565b94508385111561111357604051634fbeca4960e01b815260040160405180910390fd5b610100546001600160a01b031663ec9477e189338a8a8681811061113957611139615079565b905060200201356040518463ffffffff1660e01b815260040161115e939291906150be565b600060405180830381600087803b15801561117857600080fd5b505af115801561118c573d6000803e3d6000fd5b505050506111da8787838181106111a5576111a5615079565b9050602002013561010683815481106111c0576111c0615079565b6000918252602090912001546001600160a01b03166132b6565b8093508194505050611232883361010684815481106111fb576111fb615079565b6000918252602090912001546001600160a01b03168a8a8681811061122257611222615079565b9050602002013587876001613579565b61123b816150a5565b9050611069565b508360000361126457604051630cabf09b60e01b815260040160405180910390fd5b61010054604051632762697d60e01b81526001600160a01b0390911690632762697d90611295908a90600401614af6565b602060405180830381865afa1580156112b2573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906112d691906150e2565b6000036112e6576112e68761380b565b50505050505050565b60608060008051602061566883398151915261130a81612ea5565b6101066113188787876138ec565b81546040805160208084028201810190925282815291849183018282801561136957602002820191906000526020600020905b81546001600160a01b0316815260019091019060200180831161134b575b505050505091509250925050935093915050565b60008051602061562883398151915261139581612ea5565b6113bc6000805160206156af8339815191526113b76040850160208601614ac0565b613037565b6113db6000805160206156af8339815191526113b76020850185614ac0565b610102546001600160a01b0316634f9ff9396113fd6040850160208601614ac0565b6040518263ffffffff1660e01b81526004016114199190614af6565b600060405180830381600087803b15801561143357600080fd5b505af1158015611447573d6000803e3d6000fd5b50506101055460fb546001600160a01b03909116925063f3782f219150306114756040870160208801614ac0565b6040516001600160e01b031960e086901b16815260048101939093526001600160a01b039182166024840152166044820152606401600060405180830381600087803b1580156114c457600080fd5b505af11580156114d8573d6000803e3d6000fd5b505050505050565b6000805160206156af8339815191526114f881612ea5565b6101035460405163109c8cf960e11b81526001600160a01b039091169063213919f290610a80908790879087906004016150be565b6001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001630036115755760405162461bcd60e51b8152600401610ae1906150fb565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166115a7613124565b6001600160a01b0316146115cd5760405162461bcd60e51b8152600401610ae190615147565b6115d682613140565b610df68282600161314b565b6000306001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000161461167d5760405162461bcd60e51b815260206004820152603860248201527f555550535570677261646561626c653a206d757374206e6f742062652063616c6044820152771b1959081d1a1c9bdd59da0819195b1959d85d1958d85b1b60421b6064820152608401610ae1565b5060008051602061564883398151915290565b60fc5460ff16156116b457604051637d8d0e2160e01b815260040160405180910390fd5b60006116c284338585613caf565b90506000808060005b8581101561184f578686828181106116e5576116e5615079565b905060200201356000031561183f5760001987878381811061170957611709615079565b905060200201350361172e5760405163dd23c3ad60e01b8152600401610ae1906151f0565b86868281811061174057611740615079565b90506020020135846117529190615231565b610100549094506001600160a01b031663ec9477e189338a8a8681811061177b5761177b615079565b905060200201356040518463ffffffff1660e01b81526004016117a0939291906150be565b600060405180830381600087803b1580156117ba57600080fd5b505af11580156117ce573d6000803e3d6000fd5b505050506117e78787838181106111a5576111a5615079565b809350819450505061183f8833610106848154811061180857611808615079565b6000918252602090912001546001600160a01b03168a8a8681811061182f5761182f615079565b9050602002013587876000613579565b611848816150a5565b90506116cb565b508260000361187157604051630cabf09b60e01b815260040160405180910390fd5b836112645761187f87613efe565b611264576040516316a0371d60e11b815260040160405180910390fd5b6000805160206156088339815191526118b481612ea5565b60005b848110156112e6578383828181106118d1576118d1615079565b9050602002013561010b6000896001600160a01b03166001600160a01b03168152602001908152602001600020600088888581811061191257611912615079565b90506020020160208101906119279190614ac0565b6001600160a01b03166001600160a01b0316815260200190815260200160002060008282546119569190615231565b90915550849050838281811061196e5761196e615079565b90506020020135610107600088888581811061198c5761198c615079565b90506020020160208101906119a19190614ac0565b6001600160a01b03166001600160a01b0316815260200190815260200160002060008282546119d09190615231565b90915550506101055460fb546001600160a01b039091169063ee9e68bb9089898986818110611a0157611a01615079565b9050602002016020810190611a169190614ac0565b888887818110611a2857611a28615079565b905060200201356040518563ffffffff1660e01b8152600401611a4e9493929190615244565b600060405180830381600087803b158015611a6857600080fd5b505af1158015611a7c573d6000803e3d6000fd5b5050505080611a8a906150a5565b90506118b7565b60408051602081018252600081526101025491516303d3c9db60e21b81529091611bc591611b46916001600160a01b031690630f4f276c90611ad99088908890600401615269565b602060405180830381865afa158015611af6573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611b1a9190615282565b60408051602080820183526001600160a01b038916600090815261010990915291909120548152614184565b61010254610101546040516303d3c9db60e21b81526001600160a01b0392831692630f4f276c92611b7f92911690600190600401615269565b602060405180830381865afa158015611b9c573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611bc09190615282565b614184565b9392505050565b6000611bd781612ea5565b60fc805460ff191690556101055460fb546040516302ddfefd60e51b81526001600160a01b0390921691635bbfdfa091611c179160040190815260200190565b600060405180830381600087803b158015611c3157600080fd5b505af1158015610d50573d6000803e3d6000fd5b6000805160206156af833981519152611c5d81612ea5565b6001600160a01b03808516600090815261010b6020908152604080832093871683529290529081208054849290611c95908490615231565b90915550506001600160a01b0383166000908152610107602052604081208054849290611cc3908490615231565b90915550506101055460fb5460405163ee9e68bb60e01b81526001600160a01b039092169163ee9e68bb91610a8091889088908890600401615244565b60fc5460ff1615611d2457604051637d8d0e2160e01b815260040160405180910390fd5b6000611d3284338585613caf565b90506000808080805b86811015611f0857878782818110611d5557611d55615079565b9050602002013560000315611ef857600019888883818110611d7957611d79615079565b9050602002013503611de15760405163dd23c3ad60e01b815260206004820152602a60248201527f636c6f737572655265706f546f6b656e416d6f756e74732063616e6e6f7420626044820152690ca40ead2dce840dac2f60b31b6064820152608401610ae1565b878782818110611df357611df3615079565b9050602002013585611e059190615231565b610100549095506001600160a01b03166309aa80fc8a338b8b86818110611e2e57611e2e615079565b905060200201356040518463ffffffff1660e01b8152600401611e53939291906150be565b6020604051808303816000875af1158015611e72573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611e9691906150e2565b9350611eb08461010683815481106111c0576111c0615079565b8093508194505050611ef889336101068481548110611ed157611ed1615079565b6000918252602090912001546001600160a01b03168b8b8681811061182f5761182f615079565b611f01816150a5565b9050611d3b565b5083600003611f2a57604051630cabf09b60e01b815260040160405180910390fd5b84611f5557611f3888613efe565b611f55576040516316a0371d60e11b815260040160405180910390fd5b61010054604051632762697d60e01b81526001600160a01b0390911690632762697d90611f86908b90600401614af6565b602060405180830381865afa158015611fa3573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611fc791906150e2565b600003610aae57610aae8861380b565b600091825260c9602090815260408084206001600160a01b0393909316845291905290205460ff1690565b60008051602061560883398151915261201a81612ea5565b6120258484846141c7565b50505050565b610102546101015461010054604051632762697d60e01b815260009384936001600160a01b0391821693630f4f276c93918316921690632762697d90612075908990600401614af6565b602060405180830381865afa158015612092573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906120b691906150e2565b6040518363ffffffff1660e01b81526004016120d3929190615269565b602060405180830381865afa1580156120f0573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906121149190615282565b60408051602081019091526000808252919250905b6101065481101561223a576000610106828154811061214a5761214a615079565b6000918252602080832090910154610102546001600160a01b038a8116855261010b84526040808620938216808752939094528385205493516303d3c9db60e21b815292955061221993911691630f4f276c916121ac91879190600401615269565b602060405180830381865afa1580156121c9573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906121ed9190615282565b60408051602080820183526001600160a01b038716600090815261010890915291909120548152614184565b905061222581856142ff565b9350505080612233906150a5565b9050612129565b5081518151101561224f575060019392505050565b5060009392505050565b600054610100900460ff16158080156122795750600054600160ff909116105b8061229a57506122883061432b565b15801561229a575060005460ff166001145b6122fd5760405162461bcd60e51b815260206004820152602e60248201527f496e697469616c697a61626c653a20636f6e747261637420697320616c72656160448201526d191e481a5b9a5d1a585b1a5e995960921b6064820152608401610ae1565b6000805460ff191660011790558015612320576000805461ff0019166101001790555b61232861433a565b61233061433a565b89896040516020016123439291906152c3565b60408051601f19818403018152919052805160209091012060fb5560fc805460ff1916905560fe88905560ff87905560fd8690556001600160a01b0385166123cb5760405162461bcd60e51b815260206004820152601b60248201527a2d32b9379030b2323932b9b990383ab931b430b9b2903a37b5b2b760291b6044820152606401610ae1565b61010180546001600160a01b0319166001600160a01b03871617905560fc805462ff000019166201000060ff861602179055826001600160401b0381111561241557612415614d2a565b60405190808252806020026020018201604052801561243e578160200160208202803683370190505b50805161245491610106916020909101906149f7565b5060005b838110156126755784848281811061247257612472615079565b6124889260206080909202019081019150614ac0565b610106828154811061249c5761249c615079565b9060005260206000200160006101000a8154816001600160a01b0302191690836001600160a01b031602179055508484828181106124dc576124dc615079565b9050608002016040013561010860008787858181106124fd576124fd615079565b6125139260206080909202019081019150614ac0565b6001600160a01b0316815260208101919091526040016000205584848281811061253f5761253f615079565b90506080020160200135610109600087878581811061256057612560615079565b6125769260206080909202019081019150614ac0565b6001600160a01b031681526020810191909152604001600020558484828181106125a2576125a2615079565b905060800201606001356000036125f75760405162461bcd60e51b81526020600482015260196024820152784c6971756964617465642064616d616765206973207a65726f60381b6044820152606401610ae1565b84848281811061260957612609615079565b9050608002016060013561010a600087878581811061262a5761262a615079565b6126409260206080909202019081019150614ac0565b6001600160a01b0316815260208101919091526040016000205560fc805461ff001916905561266e816150a5565b9050612458565b5061010580546001600160a01b0319166001600160a01b03841617905561269d600033613037565b6126b560008051602061562883398151915233613037565b80156126fb576000805461ff0019169055604051600181527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15b50505050505050505050565b6000805b610106548110156127745760006101076000610106848154811061273157612731615079565b60009182526020808320909101546001600160a01b03168352820192909252604001902054111561276457600191505090565b61276d816150a5565b905061270b565b506000905090565b600061278781612ea5565b60fc805460ff191660011790556101055460fb5460405163c8df617960e01b81526001600160a01b039092169163c8df617991611c179160040190815260200190565b6001600160a01b038116600090815261010b60205260408120610966906143a7565b816127f681613007565b6128155780604051634428dc3160e01b8152600401610ae19190614af6565b6101005460408051631320834f60e01b8152905133926001600160a01b031691631320834f9160048083019260209291908290030181865afa15801561285f573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061288391906150e2565b4211156128a35760405163c5e2992f60e01b815260040160405180910390fd5b61010054604051632762697d60e01b81526001600160a01b0390911690632762697d906128d4908490600401614af6565b602060405180830381865afa1580156128f1573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061291591906150e2565b6000036129355760405163baca79c960e01b815260040160405180910390fd5b6120258185856141c7565b60008051602061562883398151915261295881612ea5565b60fc54610100900460ff161561298157604051634ce377bb60e11b815260040160405180910390fd5b60fc805461ff00191661010090811790915561010380546001600160a01b03808c166001600160a01b03199283161790925582548a83169082161790925561010280548683169084161790556101048054918716919092161790556129f46000805160206156af83398151915287613037565b612a0c6000805160206156af83398151915286613037565b612a246000805160206156af83398151915288613037565b612a3c60008051602061560883398151915288613037565b612a546000805160206156cf83398151915283613037565b610106546000906001600160401b03811115612a7257612a72614d2a565b604051908082528060200260200182016040528015612a9b578160200160208202803683370190505b50610106549091506000906001600160401b03811115612abd57612abd614d2a565b604051908082528060200260200182016040528015612ae6578160200160208202803683370190505b50610106549091506000906001600160401b03811115612b0857612b08614d2a565b604051908082528060200260200182016040528015612b31578160200160208202803683370190505b50905060005b61010654811015612c6b5761010860006101068381548110612b5b57612b5b615079565b60009182526020808320909101546001600160a01b031683528201929092526040019020548451859083908110612b9457612b94615079565b60200260200101818152505061010960006101068381548110612bb957612bb9615079565b60009182526020808320909101546001600160a01b031683528201929092526040019020548351849083908110612bf257612bf2615079565b60200260200101818152505061010a60006101068381548110612c1757612c17615079565b60009182526020808320909101546001600160a01b031683528201929092526040019020548251839083908110612c5057612c50615079565b6020908102919091010152612c64816150a5565b9050612b37565b506101055460fb546040516329b35d4760e21b81526001600160a01b039092169163a6cd751c91612caa9130906101069088908a9089906004016152d3565b600060405180830381600087803b158015612cc457600080fd5b505af1158015612cd8573d6000803e3d6000fd5b505050505050505050505050505050565b600082815260c96020526040902060010154612d0481612ea5565b610a0383836130bd565b6060806000610106805490506001600160401b03811115612d3157612d31614d2a565b604051908082528060200260200182016040528015612d5a578160200160208202803683370190505b50610106549091506000906001600160401b03811115612d7c57612d7c614d2a565b604051908082528060200260200182016040528015612da5578160200160208202803683370190505b50905060005b61010654811015612e6a5760006101068281548110612dcc57612dcc615079565b60009182526020808320909101546001600160a01b038a8116845261010b83526040808520919092168085529252909120548551919250908290869085908110612e1857612e18615079565b60200260200101906001600160a01b031690816001600160a01b03168152505080848481518110612e4b57612e4b615079565b602002602001018181525050505080612e63906150a5565b9050612dab565b509094909350915050565b6000805160206156cf833981519152612e8d81612ea5565b610df660008051602061566883398151915283613037565b610ebf81336144d5565b6001600160a01b03808516600090815261010b6020908152604080832093871683529290522054821115612ef65760405163380984fd60e21b815260040160405180910390fd5b6001600160a01b03808516600090815261010b6020908152604080832093871683529290529081208054849290612f2e908490615376565b90915550508015612f68576001600160a01b0383166000908152610107602052604081208054849290612f62908490615376565b90915550505b6101035460405163109c8cf960e11b81526001600160a01b039091169063213919f290612f9d908790879087906004016150be565b600060405180830381600087803b158015612fb757600080fd5b505af1158015612fcb573d6000803e3d6000fd5b50506101055460fb54604051633b8d409b60e01b81526001600160a01b039092169350633b8d409b9250610a8091889088908890600401615244565b6001600160a01b038116600090815261010a6020526040812054810361302f57506000919050565b506001919050565b6130418282611fd7565b610df657600082815260c9602090815260408083206001600160a01b03851684529091529020805460ff191660011790556130793390565b6001600160a01b0316816001600160a01b0316837f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a45050565b6130c78282611fd7565b15610df657600082815260c9602090815260408083206001600160a01b0385168085529252808320805460ff1916905551339285917ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b9190a45050565b600080516020615648833981519152546001600160a01b031690565b6000610df681612ea5565b7f4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd91435460ff161561317e57610a038361452e565b826001600160a01b03166352d1902d6040518163ffffffff1660e01b8152600401602060405180830381865afa9250505080156131d8575060408051601f3d908101601f191682019092526131d5918101906150e2565b60015b61323b5760405162461bcd60e51b815260206004820152602e60248201527f45524331393637557067726164653a206e657720696d706c656d656e7461746960448201526d6f6e206973206e6f74205555505360901b6064820152608401610ae1565b60008051602061564883398151915281146132aa5760405162461bcd60e51b815260206004820152602960248201527f45524331393637557067726164653a20756e737570706f727465642070726f786044820152681a58589b195555525160ba1b6064820152608401610ae1565b50610a038383836145c8565b61010254610101546040516303d3c9db60e21b81526000928392859284926001600160a01b0390811692630f4f276c926132f892909116908a90600401615269565b602060405180830381865afa158015613315573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906133399190615282565b905060006133f18261010260009054906101000a90046001600160a01b03166001600160a01b0316630f4f276c89876001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa1580156133a5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906133c99190615389565b6133d490600a615490565b6040518363ffffffff1660e01b8152600401611b7f929190615269565b6040805160208082018352670de0b6b3a76400008252825180820184526001600160a01b038b16600090815261010a90925292812054835292935061344091849161343b916142ff565b6145ed565b9050600061345e83604051806020016040528060fe548152506145ed565b9050846001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa15801561349e573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906134c29190615389565b6134cd90601261549f565b6134d890600a615490565b82516134e491906154b8565b856001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa158015613522573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906135469190615389565b61355190601261549f565b61355c90600a615490565b825161356891906154b8565b9650965050505050505b9250929050565b6001600160a01b03808816600090815261010b60209081526040808320938916835292905220548311156135c257846040516398de333560e01b8152600401610ae19190614af6565b6001600160a01b03808816600090815261010b60209081526040808320938916835292905290812080548592906135fa908490615376565b90915550506001600160a01b0385166000908152610107602052604081208054859290613628908490615376565b909155505061010354610104546040805163012f8d2f60e11b815290516001600160a01b039384169363213919f293169163025f1a5e9160048083019260209291908290030181865afa158015613683573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906136a791906154da565b87856040518463ffffffff1660e01b81526004016136c7939291906150be565b600060405180830381600087803b1580156136e157600080fd5b505af11580156136f5573d6000803e3d6000fd5b5050610103546001600160a01b0316915063213919f2905087876137198688615376565b6040518463ffffffff1660e01b8152600401613737939291906150be565b600060405180830381600087803b15801561375157600080fd5b505af1158015613765573d6000803e3d6000fd5b50506101055460fb54604051639cc487d760e01b815260048101919091526001600160a01b038b811660248301528a8116604483015260648201899052898116608483015260a4820188905260c4820187905285151560e48301529091169250639cc487d7915061010401600060405180830381600087803b1580156137ea57600080fd5b505af11580156137fe573d6000803e3d6000fd5b5050505050505050505050565b60005b61010654811015610df6576001600160a01b038216600090815261010b6020526040812061010680549192918490811061384a5761384a615079565b9060005260206000200160009054906101000a90046001600160a01b03166001600160a01b03166001600160a01b0316815260200190815260200160002054610107600061010684815481106138a2576138a2615079565b60009182526020808320909101546001600160a01b03168352820192909252604001812080549091906138d6908490615376565b909155506138e59050816150a5565b905061380e565b610106546060906000906001600160401b0381111561390d5761390d614d2a565b604051908082528060200260200182016040528015613936578160200160208202803683370190505b50905060005b61010654811015613ca6576000610106828154811061395d5761395d615079565b60009182526020808320909101546001600160a01b038a8116845261010b83526040808520919092168085529252909120549091508015613c9357670de0b6b3a76400008703613b08576001600160a01b03888116600090815261010b6020908152604080832093861683529290529081208054919055845181908690869081106139ea576139ea615079565b602002602001018181525050806101076000856001600160a01b03166001600160a01b031681526020019081526020016000206000828254613a2c9190615376565b90915550506101035460405163109c8cf960e11b81526001600160a01b039091169063213919f290613a66908a90879086906004016150be565b600060405180830381600087803b158015613a8057600080fd5b505af1158015613a94573d6000803e3d6000fd5b50506101055460fb54604051633b8d409b60e01b81526001600160a01b039092169350633b8d409b9250613ad0918d9088908790600401615244565b600060405180830381600087803b158015613aea57600080fd5b505af1158015613afe573d6000803e3d6000fd5b5050505050613c93565b6000613b2260405180602001604052808a8152508361462c565b6001600160a01b03808b16600090815261010b60209081526040808320938816835292905290812080549293508392909190613b5f908490615376565b9250508190555080858581518110613b7957613b79615079565b602002602001018181525050806101076000856001600160a01b03166001600160a01b031681526020019081526020016000206000828254613bbb9190615376565b90915550506101035460405163109c8cf960e11b81526001600160a01b039091169063213919f290613bf5908a90879086906004016150be565b600060405180830381600087803b158015613c0f57600080fd5b505af1158015613c23573d6000803e3d6000fd5b50506101055460fb54604051633b8d409b60e01b81526001600160a01b039092169350633b8d409b9250613c5f918d9088908790600401615244565b600060405180830381600087803b158015613c7957600080fd5b505af1158015613c8d573d6000803e3d6000fd5b50505050505b505080613c9f906150a5565b905061393c565b50949350505050565b6101005460408051631320834f60e01b815290516000926001600160a01b031691631320834f9160048083019260209291908290030181865afa158015613cfa573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190613d1e91906150e2565b421115613d3e576040516321f8431560e01b815260040160405180910390fd5b846001600160a01b0316846001600160a01b031603613d705760405163ae957a1d60e01b815260040160405180910390fd5b610106548214613d935760405163dd23c3ad60e01b8152600401610ae190615193565b61010054604051632762697d60e01b81526000916001600160a01b031690632762697d90613dc5908990600401614af6565b602060405180830381865afa158015613de2573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190613e0691906150e2565b905080600003613e295760405163baca79c960e01b815260040160405180910390fd5b60fd5461010254610101546040516303d3c9db60e21b8152600093926001600160a01b0390811692630f4f276c92613e6992909116908790600401615269565b602060405180830381865afa158015613e86573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190613eaa9190615282565b51613eb59190615231565b613ebe886127ca565b109050801581613ed45750613ed28761202b565b155b15613ef25760405163e94a979360e01b815260040160405180910390fd5b9150505b949350505050565b61010054604051632762697d60e01b815260009182916001600160a01b0390911690632762697d90613f34908690600401614af6565b602060405180830381865afa158015613f51573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190613f7591906150e2565b905080600003613f885750600092915050565b604080516020810190915260008082525b610106548110156140aa5760006101068281548110613fba57613fba615079565b6000918252602080832090910154610102546001600160a01b038a8116855261010b84526040808620938216808752939094528385205493516303d3c9db60e21b815292955061408993911691630f4f276c9161401c91879190600401615269565b602060405180830381865afa158015614039573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061405d9190615282565b60408051602080820183526001600160a01b038716600090815261010990915291909120548152614184565b905061409581856142ff565b93505050806140a3906150a5565b9050613f99565b5061010254610101546040516303d3c9db60e21b81526000926001600160a01b0390811692630f4f276c926140e792909116908790600401615269565b602060405180830381865afa158015614104573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906141289190615282565b905061413682825190511090565b1561414657506001949350505050565b60006141528383614644565b905061417a6141618284614184565b604051806020016040528060ff54815250519051111590565b9695505050505050565b60408051602081019091526000815260405180602001604052806141be6141b78660000151670de0b6b3a7640000614670565b855161467c565b90529392505050565b6001600160a01b03808416600090815261010b60209081526040808320938616835292905290812080548392906141ff908490615231565b90915550506001600160a01b038216600090815261010760205260408120805483929061422d908490615231565b90915550506101035460405163049f2a5160e21b81526001600160a01b039091169063127ca94490614267908690869086906004016150be565b600060405180830381600087803b15801561428157600080fd5b505af1158015614295573d6000803e3d6000fd5b50506101055460fb5460405163ee9e68bb60e01b81526001600160a01b03909216935063ee9e68bb92506142d191879087908790600401615244565b600060405180830381600087803b1580156142eb57600080fd5b505af11580156112e6573d6000803e3d6000fd5b60408051602081019091526000815260405180602001604052806141be85600001518560000151614688565b6001600160a01b03163b151590565b600054610100900460ff166143a55760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201526a6e697469616c697a696e6760a81b6064820152608401610ae1565b565b6040805160208101909152600080825290815b610106548110156144cd576101025461010680546144bb9285926001600160a01b0390911691630f4f276c9190869081106143f7576143f7615079565b9060005260206000200160009054906101000a90046001600160a01b0316886000610106888154811061442c5761442c615079565b60009182526020808320909101546001600160a01b0316835282019290925260409081019091205490516001600160e01b031960e085901b168152614475929190600401615269565b602060405180830381865afa158015614492573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906144b69190615282565b6142ff565b91506144c6816150a5565b90506143ba565b505192915050565b6144df8282611fd7565b610df6576144ec81614694565b6144f78360206146a6565b60405160200161450892919061551b565b60408051601f198184030181529082905262461bcd60e51b8252610ae19160040161558a565b6145378161432b565b6145995760405162461bcd60e51b815260206004820152602d60248201527f455243313936373a206e657720696d706c656d656e746174696f6e206973206e60448201526c1bdd08184818dbdb9d1c9858dd609a1b6064820152608401610ae1565b60008051602061564883398151915280546001600160a01b0319166001600160a01b0392909216919091179055565b6145d183614841565b6000825111806145de5750805b15610a03576120258383614881565b6040805160208101909152600081526040518060200160405280670de0b6b3a764000061462286600001518660000151614670565b6141be91906154b8565b60008061463984846148a6565b9050613ef6816148ce565b60408051602081019091526000815260405180602001604052806141be856000015185600001516148e6565b6000611bc582846155bd565b6000611bc582846154b8565b6000611bc58284615231565b60606109666001600160a01b03831660145b606060006146b58360026155bd565b6146c0906002615231565b6001600160401b038111156146d7576146d7614d2a565b6040519080825280601f01601f191660200182016040528015614701576020820181803683370190505b509050600360fc1b8160008151811061471c5761471c615079565b60200101906001600160f81b031916908160001a905350600f60fb1b8160018151811061474b5761474b615079565b60200101906001600160f81b031916908160001a905350600061476f8460026155bd565b61477a906001615231565b90505b60018111156147f2576f181899199a1a9b1b9c1cb0b131b232b360811b85600f16601081106147ae576147ae615079565b1a60f81b8282815181106147c4576147c4615079565b60200101906001600160f81b031916908160001a90535060049490941c936147eb816155d4565b905061477d565b508315611bc55760405162461bcd60e51b815260206004820181905260248201527f537472696e67733a20686578206c656e67746820696e73756666696369656e746044820152606401610ae1565b61484a8161452e565b6040516001600160a01b038216907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b90600090a250565b6060611bc58383604051806060016040528060278152602001615688602791396148f2565b60408051602081019091526000815260405180602001604052806141be856000015185614670565b805160009061096690670de0b6b3a7640000906154b8565b6000611bc58284615376565b6060600080856001600160a01b03168560405161490f91906155eb565b600060405180830381855af49150503d806000811461494a576040519150601f19603f3d011682016040523d82523d6000602084013e61494f565b606091505b509150915061417a86838387606083156149c85782516000036149c1576149758561432b565b6149c15760405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606401610ae1565b5081613ef6565b613ef683838151156149dd5781518083602001fd5b8060405162461bcd60e51b8152600401610ae1919061558a565b828054828255906000526020600020908101928215614a4c579160200282015b82811115614a4c57825182546001600160a01b0319166001600160a01b03909116178255602090920191600190910190614a17565b50614a58929150614a5c565b5090565b5b80821115614a585760008155600101614a5d565b600060208284031215614a8357600080fd5b81356001600160e01b031981168114611bc557600080fd5b6001600160a01b0381168114610ebf57600080fd5b8035614abb81614a9b565b919050565b600060208284031215614ad257600080fd5b8135611bc581614a9b565b600060208284031215614aef57600080fd5b5035919050565b6001600160a01b0391909116815260200190565b600080600060608486031215614b1f57600080fd5b8335614b2a81614a9b565b92506020840135614b3a81614a9b565b929592945050506040919091013590565b60008060408385031215614b5e57600080fd5b8235614b6981614a9b565b946020939093013593505050565b60008060408385031215614b8a57600080fd5b823591506020830135614b9c81614a9b565b809150509250929050565b60008083601f840112614bb957600080fd5b5081356001600160401b03811115614bd057600080fd5b6020830191508360208260051b850101111561357257600080fd5b600080600060408486031215614c0057600080fd5b8335614c0b81614a9b565b925060208401356001600160401b03811115614c2657600080fd5b614c3286828701614ba7565b9497909650939450505050565b600080600060608486031215614c5457600080fd5b8335614c5f81614a9b565b9250602084013591506040840135614c7681614a9b565b809150509250925092565b600081518084526020808501945080840160005b83811015614cb157815187529582019590820190600101614c95565b509495945050505050565b604080825283519082018190526000906020906060840190828701845b82811015614cfe5781516001600160a01b031684529284019290840190600101614cd9565b5050508381038285015261417a8186614c81565b600060608284031215614d2457600080fd5b50919050565b634e487b7160e01b600052604160045260246000fd5b604051601f8201601f191681016001600160401b0381118282101715614d6857614d68614d2a565b604052919050565b60008060408385031215614d8357600080fd5b8235614d8e81614a9b565b91506020838101356001600160401b0380821115614dab57600080fd5b818601915086601f830112614dbf57600080fd5b813581811115614dd157614dd1614d2a565b614de3601f8201601f19168501614d40565b91508082528784828501011115614df957600080fd5b80848401858401376000848284010152508093505050509250929050565b600080600080600060608688031215614e2f57600080fd5b8535614e3a81614a9b565b945060208601356001600160401b0380821115614e5657600080fd5b614e6289838a01614ba7565b90965094506040880135915080821115614e7b57600080fd5b50614e8888828901614ba7565b969995985093965092949392505050565b60008083601f840112614eab57600080fd5b5081356001600160401b03811115614ec257600080fd5b6020830191508360208260071b850101111561357257600080fd5b600080600080600080600080600060e08a8c031215614efb57600080fd5b89356001600160401b0380821115614f1257600080fd5b818c0191508c601f830112614f2657600080fd5b813581811115614f3557600080fd5b8d6020828501011115614f4757600080fd5b60208381019c50909a508c0135985060408c0135975060608c01359650614f7060808d01614ab0565b955060a08c0135915080821115614f8657600080fd5b50614f938c828d01614e99565b9094509250614fa6905060c08b01614ab0565b90509295985092959850929598565b60008060408385031215614fc857600080fd5b8235614fd381614a9b565b91506020830135614b9c81614a9b565b600080600080600080600060e0888a031215614ffe57600080fd5b873561500981614a9b565b9650602088013561501981614a9b565b9550604088013561502981614a9b565b9450606088013561503981614a9b565b9350608088013561504981614a9b565b925060a088013561505981614a9b565b915060c088013561506981614a9b565b8091505092959891949750929550565b634e487b7160e01b600052603260045260246000fd5b634e487b7160e01b600052601160045260246000fd5b6000600182016150b7576150b761508f565b5060010190565b6001600160a01b039384168152919092166020820152604081019190915260600190565b6000602082840312156150f457600080fd5b5051919050565b6020808252602c908201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060408201526b19195b1959d85d1958d85b1b60a21b606082015260800190565b6020808252602c908201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060408201526b6163746976652070726f787960a01b606082015260800190565b6020808252603f908201527f436c6f7375726520616d6f756e7473206172726179206e6f742073616d65206c60408201527f656e67746820617320636f6c6c61746572616c20746f6b656e73206c69737400606082015260800190565b60208082526021908201527f636c6f73757265416d6f756e74732063616e6e6f742062652075696e74206d616040820152600f60fb1b606082015260800190565b808201808211156109665761096661508f565b9384526001600160a01b03928316602085015291166040830152606082015260800190565b6001600160a01b03929092168252602082015260400190565b60006020828403121561529457600080fd5b604051602081018181106001600160401b03821117156152b6576152b6614d2a565b6040529151825250919050565b8183823760009101908152919050565b600060c08201888352602060018060a01b03808a168286015260c0604086015282895480855260e0870191508a60005283600020945060005b8181101561532a57855484168352600195860195928501920161530c565b5050858103606087015261533e818a614c81565b935050505082810360808401526153558186614c81565b905082810360a08401526153698185614c81565b9998505050505050505050565b818103818111156109665761096661508f565b60006020828403121561539b57600080fd5b815160ff81168114611bc557600080fd5b600181815b808511156153e75781600019048211156153cd576153cd61508f565b808516156153da57918102915b93841c93908002906153b1565b509250929050565b6000826153fe57506001610966565b8161540b57506000610966565b8160018114615421576002811461542b57615447565b6001915050610966565b60ff84111561543c5761543c61508f565b50506001821b610966565b5060208310610133831016604e8410600b841016171561546a575081810a610966565b61547483836153ac565b80600019048211156154885761548861508f565b029392505050565b6000611bc560ff8416836153ef565b60ff82811682821603908111156109665761096661508f565b6000826154d557634e487b7160e01b600052601260045260246000fd5b500490565b6000602082840312156154ec57600080fd5b8151611bc581614a9b565b60005b838110156155125781810151838201526020016154fa565b50506000910152565b76020b1b1b2b9b9a1b7b73a3937b61d1030b1b1b7bab73a1604d1b81526000835161554d8160178501602088016154f7565b7001034b99036b4b9b9b4b733903937b6329607d1b601791840191820152835161557e8160288401602088016154f7565b01602801949350505050565b60208152600082518060208401526155a98160408501602087016154f7565b601f01601f19169190910160400192915050565b80820281158282048414176109665761096661508f565b6000816155e3576155e361508f565b506000190190565b600082516155fd8184602087016154f7565b919091019291505056fe250b76734a070a69c7b3930477dd35007ad9c9d0952e97903fdafb2db698053730d41a597cac127d8249d31298b50e481ee82c3f4a49ff93c76a22735aa9f3ad360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbcf4b6b486426e3c004413defb7013cd482f29189a98e074f1c202b2ac26536bb2416464726573733a206c6f772d6c6576656c2064656c65676174652063616c6c206661696c65646e14a979b95b01beecd617807f3738f4e067938da99755b16afdcf7148d313b76e3cc031d23d7153f72e87cbfd113a0351c60d8ce52b8a31c944d543a384b7c9a2646970667358221220eee64a56f1e2ebc92aca0b098e1e920d6ca9670b051b1909d8f94c7cb1773dc064736f6c63430008120033
Deployed Bytecode
0x6080604052600436106102745760003560e01c8063578db95711610150578063a217fddf116100bc578063a217fddf14610795578063a95c4d62146107aa578063b7d5820b146107cb578063c066bc0e14610812578063c180ead114610827578063c526c45c14610847578063cc5b6e4a14610867578063cdae1ee01461087d578063d547741f1461089d578063de7f872e146108bd578063e1cdd058146108dd578063fd5d357a146108f3578063fe05281a1461091357600080fd5b8063578db9571461060b5780635c4b440e1461062b57806367af01d01461064c5780636a509f551461067b57806378c2b2c614610690578063790cb491146106a657806382f049ab146106c65780638f6d0f11146106e657806391d14854146107005780639210632f1461072057806394a7cfe8146107405780639c3e2e0e14610760578063a11d52f51461078057600080fd5b80632f2ff15d116101ef5780632f2ff15d1461046f57806336568abe1461048f5780633659cfe6146104af5780633718373f146104cf57806337843bc6146104f157806337cb26f5146105115780633d0dda78146105275780634055008a1461055557806343551d0d1461057557806348717eb7146105a35780634f1ef286146105c357806352d1902d146105d6578063559e4fad146105eb57600080fd5b806301ffc9a71461027957806302b65fb0146102ae57806309a01608146102de57806312a9006914610300578063172c48c714610322578063190e80121461034f57806320db25d5146103815780632391281c146103af578063248a9ca3146103cf57806327df3d3e146103ff5780632a1e8cdb146104215780632b56d95e1461044f575b600080fd5b34801561028557600080fd5b50610299610294366004614a71565b610935565b60405190151581526020015b60405180910390f35b3480156102ba57600080fd5b506102d06000805160206156cf83398151915281565b6040519081526020016102a5565b3480156102ea57600080fd5b506102d060008051602061560883398151915281565b34801561030c57600080fd5b5061032061031b366004614ac0565b61096c565b005b34801561032e57600080fd5b5061034261033d366004614add565b610a08565b6040516102a59190614af6565b34801561035b57600080fd5b5060fc5461036f9062010000900460ff1681565b60405160ff90911681526020016102a5565b34801561038d57600080fd5b506102d061039c366004614ac0565b6101086020526000908152604090205481565b3480156103bb57600080fd5b506103206103ca366004614b0a565b610a33565b3480156103db57600080fd5b506102d06103ea366004614add565b600090815260c9602052604090206001015490565b34801561040b57600080fd5b506102d060008051602061562883398151915281565b34801561042d57600080fd5b506102d061043c366004614ac0565b6101096020526000908152604090205481565b34801561045b57600080fd5b5061032061046a366004614b4b565b610ab8565b34801561047b57600080fd5b5061032061048a366004614b77565b610d57565b34801561049b57600080fd5b506103206104aa366004614b77565b610d7c565b3480156104bb57600080fd5b506103206104ca366004614ac0565b610dfa565b3480156104db57600080fd5b506102d06000805160206156af83398151915281565b3480156104fd57600080fd5b5061032061050c366004614beb565b610ec2565b34801561051d57600080fd5b506102d060fd5481565b34801561053357600080fd5b50610547610542366004614c3f565b6112ef565b6040516102a5929190614cbc565b34801561056157600080fd5b50610320610570366004614d12565b61137d565b34801561058157600080fd5b506102d0610590366004614ac0565b61010a6020526000908152604090205481565b3480156105af57600080fd5b506103206105be366004614b0a565b6114e0565b6103206105d1366004614d70565b61152d565b3480156105e257600080fd5b506102d06115e2565b3480156105f757600080fd5b50610320610606366004614beb565b611690565b34801561061757600080fd5b50610320610626366004614e17565b61189c565b34801561063757600080fd5b5061010354610342906001600160a01b031681565b34801561065857600080fd5b5061066c610667366004614b4b565b611a91565b604051905181526020016102a5565b34801561068757600080fd5b50610320611bcc565b34801561069c57600080fd5b506102d060fe5481565b3480156106b257600080fd5b506103206106c1366004614b0a565b611c45565b3480156106d257600080fd5b506103206106e1366004614beb565b611d00565b3480156106f257600080fd5b5060fc546102999060ff1681565b34801561070c57600080fd5b5061029961071b366004614b77565b611fd7565b34801561072c57600080fd5b5061032061073b366004614b0a565b612002565b34801561074c57600080fd5b5061029961075b366004614ac0565b61202b565b34801561076c57600080fd5b5061032061077b366004614edd565b612259565b34801561078c57600080fd5b50610299612707565b3480156107a157600080fd5b506102d0600081565b3480156107b657600080fd5b5061010154610342906001600160a01b031681565b3480156107d757600080fd5b506102d06107e6366004614fb5565b6001600160a01b03918216600090815261010b6020908152604080832093909416825291909152205490565b34801561081e57600080fd5b5061032061277c565b34801561083357600080fd5b506102d0610842366004614ac0565b6127ca565b34801561085357600080fd5b50610320610862366004614b4b565b6127ec565b34801561087357600080fd5b506102d060fb5481565b34801561088957600080fd5b50610320610898366004614fe3565b612940565b3480156108a957600080fd5b506103206108b8366004614b77565b612ce9565b3480156108c957600080fd5b506105476108d8366004614ac0565b612d0e565b3480156108e957600080fd5b506102d060ff5481565b3480156108ff57600080fd5b5061032061090e366004614ac0565b612e75565b34801561091f57600080fd5b506102d060008051602061566883398151915281565b60006001600160e01b03198216637965db0b60e01b148061096657506301ffc9a760e01b6001600160e01b03198316145b92915050565b60008051602061560883398151915261098481612ea5565b60005b61010654811015610a0357600061010682815481106109a8576109a8615079565b60009182526020808320909101546001600160a01b03878116845261010b835260408085209190921680855292529091205490915080156109f0576109f08583836001612eaf565b5050806109fc906150a5565b9050610987565b505050565b6101068181548110610a1957600080fd5b6000918252602090912001546001600160a01b0316905081565b6000805160206156af833981519152610a4b81612ea5565b6101035460405163049f2a5160e21b81526001600160a01b039091169063127ca94490610a80908790879087906004016150be565b600060405180830381600087803b158015610a9a57600080fd5b505af1158015610aae573d6000803e3d6000fd5b5050505050505050565b81610ac281613007565b610aea5780604051634428dc3160e01b8152600401610ae19190614af6565b60405180910390fd5b336000839003610b2b5760405163dd23c3ad60e01b815260206004820152600b60248201526a16995c9bc8185b5bdd5b9d60aa1b6044820152606401610ae1565b6001600160a01b03808216600090815261010b602090815260408083209388168352929052908120549003610b73576040516314605b7760e01b815260040160405180910390fd5b61010060009054906101000a90046001600160a01b03166001600160a01b0316631320834f6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610bc7573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610beb91906150e2565b4210158015610c70575061010060009054906101000a90046001600160a01b03166001600160a01b0316631b2354376040518163ffffffff1660e01b8152600401602060405180830381865afa158015610c49573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c6d91906150e2565b42105b15610c8e57604051633f5a890f60e01b815260040160405180910390fd5b61010054604051632762697d60e01b81526000916001600160a01b031690632762697d90610cc0908590600401614af6565b602060405180830381865afa158015610cdd573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d0191906150e2565b15610d0a575060015b610d1682868684612eaf565b610d1f8261202b565b15610d5057604051632263ff6560e11b81526001600160a01b03808416600483015286166024820152604401610ae1565b5050505050565b600082815260c96020526040902060010154610d7281612ea5565b610a038383613037565b6001600160a01b0381163314610dec5760405162461bcd60e51b815260206004820152602f60248201527f416363657373436f6e74726f6c3a2063616e206f6e6c792072656e6f756e636560448201526e103937b632b9903337b91039b2b63360891b6064820152608401610ae1565b610df682826130bd565b5050565b6001600160a01b037f000000000000000000000000e0fc587e1f56b5968a7d5dc3667ba1f385fddb38163003610e425760405162461bcd60e51b8152600401610ae1906150fb565b7f000000000000000000000000e0fc587e1f56b5968a7d5dc3667ba1f385fddb386001600160a01b0316610e74613124565b6001600160a01b031614610e9a5760405162461bcd60e51b8152600401610ae190615147565b610ea381613140565b60408051600080825260208201909252610ebf9183919061314b565b50565b60fc5460ff1615610ee657604051637d8d0e2160e01b815260040160405180910390fd5b61010060009054906101000a90046001600160a01b03166001600160a01b0316631320834f6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610f3a573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610f5e91906150e2565b4211610f7d57604051633daab04760e21b815260040160405180910390fd5b6001600160a01b0383163303610fa65760405163ae957a1d60e01b815260040160405180910390fd5b610106548114610fc95760405163dd23c3ad60e01b8152600401610ae190615193565b61010054604051632762697d60e01b815260009182916001600160a01b0390911690632762697d90610fff908890600401614af6565b602060405180830381865afa15801561101c573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061104091906150e2565b9050806000036110635760405163baca79c960e01b815260040160405180910390fd5b60008060005b858110156112425786868281811061108357611083615079565b9050602002013560000315611232576000198787838181106110a7576110a7615079565b90506020020135036110cc5760405163dd23c3ad60e01b8152600401610ae1906151f0565b8686828181106110de576110de615079565b90506020020135856110f09190615231565b94508385111561111357604051634fbeca4960e01b815260040160405180910390fd5b610100546001600160a01b031663ec9477e189338a8a8681811061113957611139615079565b905060200201356040518463ffffffff1660e01b815260040161115e939291906150be565b600060405180830381600087803b15801561117857600080fd5b505af115801561118c573d6000803e3d6000fd5b505050506111da8787838181106111a5576111a5615079565b9050602002013561010683815481106111c0576111c0615079565b6000918252602090912001546001600160a01b03166132b6565b8093508194505050611232883361010684815481106111fb576111fb615079565b6000918252602090912001546001600160a01b03168a8a8681811061122257611222615079565b9050602002013587876001613579565b61123b816150a5565b9050611069565b508360000361126457604051630cabf09b60e01b815260040160405180910390fd5b61010054604051632762697d60e01b81526001600160a01b0390911690632762697d90611295908a90600401614af6565b602060405180830381865afa1580156112b2573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906112d691906150e2565b6000036112e6576112e68761380b565b50505050505050565b60608060008051602061566883398151915261130a81612ea5565b6101066113188787876138ec565b81546040805160208084028201810190925282815291849183018282801561136957602002820191906000526020600020905b81546001600160a01b0316815260019091019060200180831161134b575b505050505091509250925050935093915050565b60008051602061562883398151915261139581612ea5565b6113bc6000805160206156af8339815191526113b76040850160208601614ac0565b613037565b6113db6000805160206156af8339815191526113b76020850185614ac0565b610102546001600160a01b0316634f9ff9396113fd6040850160208601614ac0565b6040518263ffffffff1660e01b81526004016114199190614af6565b600060405180830381600087803b15801561143357600080fd5b505af1158015611447573d6000803e3d6000fd5b50506101055460fb546001600160a01b03909116925063f3782f219150306114756040870160208801614ac0565b6040516001600160e01b031960e086901b16815260048101939093526001600160a01b039182166024840152166044820152606401600060405180830381600087803b1580156114c457600080fd5b505af11580156114d8573d6000803e3d6000fd5b505050505050565b6000805160206156af8339815191526114f881612ea5565b6101035460405163109c8cf960e11b81526001600160a01b039091169063213919f290610a80908790879087906004016150be565b6001600160a01b037f000000000000000000000000e0fc587e1f56b5968a7d5dc3667ba1f385fddb381630036115755760405162461bcd60e51b8152600401610ae1906150fb565b7f000000000000000000000000e0fc587e1f56b5968a7d5dc3667ba1f385fddb386001600160a01b03166115a7613124565b6001600160a01b0316146115cd5760405162461bcd60e51b8152600401610ae190615147565b6115d682613140565b610df68282600161314b565b6000306001600160a01b037f000000000000000000000000e0fc587e1f56b5968a7d5dc3667ba1f385fddb38161461167d5760405162461bcd60e51b815260206004820152603860248201527f555550535570677261646561626c653a206d757374206e6f742062652063616c6044820152771b1959081d1a1c9bdd59da0819195b1959d85d1958d85b1b60421b6064820152608401610ae1565b5060008051602061564883398151915290565b60fc5460ff16156116b457604051637d8d0e2160e01b815260040160405180910390fd5b60006116c284338585613caf565b90506000808060005b8581101561184f578686828181106116e5576116e5615079565b905060200201356000031561183f5760001987878381811061170957611709615079565b905060200201350361172e5760405163dd23c3ad60e01b8152600401610ae1906151f0565b86868281811061174057611740615079565b90506020020135846117529190615231565b610100549094506001600160a01b031663ec9477e189338a8a8681811061177b5761177b615079565b905060200201356040518463ffffffff1660e01b81526004016117a0939291906150be565b600060405180830381600087803b1580156117ba57600080fd5b505af11580156117ce573d6000803e3d6000fd5b505050506117e78787838181106111a5576111a5615079565b809350819450505061183f8833610106848154811061180857611808615079565b6000918252602090912001546001600160a01b03168a8a8681811061182f5761182f615079565b9050602002013587876000613579565b611848816150a5565b90506116cb565b508260000361187157604051630cabf09b60e01b815260040160405180910390fd5b836112645761187f87613efe565b611264576040516316a0371d60e11b815260040160405180910390fd5b6000805160206156088339815191526118b481612ea5565b60005b848110156112e6578383828181106118d1576118d1615079565b9050602002013561010b6000896001600160a01b03166001600160a01b03168152602001908152602001600020600088888581811061191257611912615079565b90506020020160208101906119279190614ac0565b6001600160a01b03166001600160a01b0316815260200190815260200160002060008282546119569190615231565b90915550849050838281811061196e5761196e615079565b90506020020135610107600088888581811061198c5761198c615079565b90506020020160208101906119a19190614ac0565b6001600160a01b03166001600160a01b0316815260200190815260200160002060008282546119d09190615231565b90915550506101055460fb546001600160a01b039091169063ee9e68bb9089898986818110611a0157611a01615079565b9050602002016020810190611a169190614ac0565b888887818110611a2857611a28615079565b905060200201356040518563ffffffff1660e01b8152600401611a4e9493929190615244565b600060405180830381600087803b158015611a6857600080fd5b505af1158015611a7c573d6000803e3d6000fd5b5050505080611a8a906150a5565b90506118b7565b60408051602081018252600081526101025491516303d3c9db60e21b81529091611bc591611b46916001600160a01b031690630f4f276c90611ad99088908890600401615269565b602060405180830381865afa158015611af6573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611b1a9190615282565b60408051602080820183526001600160a01b038916600090815261010990915291909120548152614184565b61010254610101546040516303d3c9db60e21b81526001600160a01b0392831692630f4f276c92611b7f92911690600190600401615269565b602060405180830381865afa158015611b9c573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611bc09190615282565b614184565b9392505050565b6000611bd781612ea5565b60fc805460ff191690556101055460fb546040516302ddfefd60e51b81526001600160a01b0390921691635bbfdfa091611c179160040190815260200190565b600060405180830381600087803b158015611c3157600080fd5b505af1158015610d50573d6000803e3d6000fd5b6000805160206156af833981519152611c5d81612ea5565b6001600160a01b03808516600090815261010b6020908152604080832093871683529290529081208054849290611c95908490615231565b90915550506001600160a01b0383166000908152610107602052604081208054849290611cc3908490615231565b90915550506101055460fb5460405163ee9e68bb60e01b81526001600160a01b039092169163ee9e68bb91610a8091889088908890600401615244565b60fc5460ff1615611d2457604051637d8d0e2160e01b815260040160405180910390fd5b6000611d3284338585613caf565b90506000808080805b86811015611f0857878782818110611d5557611d55615079565b9050602002013560000315611ef857600019888883818110611d7957611d79615079565b9050602002013503611de15760405163dd23c3ad60e01b815260206004820152602a60248201527f636c6f737572655265706f546f6b656e416d6f756e74732063616e6e6f7420626044820152690ca40ead2dce840dac2f60b31b6064820152608401610ae1565b878782818110611df357611df3615079565b9050602002013585611e059190615231565b610100549095506001600160a01b03166309aa80fc8a338b8b86818110611e2e57611e2e615079565b905060200201356040518463ffffffff1660e01b8152600401611e53939291906150be565b6020604051808303816000875af1158015611e72573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611e9691906150e2565b9350611eb08461010683815481106111c0576111c0615079565b8093508194505050611ef889336101068481548110611ed157611ed1615079565b6000918252602090912001546001600160a01b03168b8b8681811061182f5761182f615079565b611f01816150a5565b9050611d3b565b5083600003611f2a57604051630cabf09b60e01b815260040160405180910390fd5b84611f5557611f3888613efe565b611f55576040516316a0371d60e11b815260040160405180910390fd5b61010054604051632762697d60e01b81526001600160a01b0390911690632762697d90611f86908b90600401614af6565b602060405180830381865afa158015611fa3573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611fc791906150e2565b600003610aae57610aae8861380b565b600091825260c9602090815260408084206001600160a01b0393909316845291905290205460ff1690565b60008051602061560883398151915261201a81612ea5565b6120258484846141c7565b50505050565b610102546101015461010054604051632762697d60e01b815260009384936001600160a01b0391821693630f4f276c93918316921690632762697d90612075908990600401614af6565b602060405180830381865afa158015612092573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906120b691906150e2565b6040518363ffffffff1660e01b81526004016120d3929190615269565b602060405180830381865afa1580156120f0573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906121149190615282565b60408051602081019091526000808252919250905b6101065481101561223a576000610106828154811061214a5761214a615079565b6000918252602080832090910154610102546001600160a01b038a8116855261010b84526040808620938216808752939094528385205493516303d3c9db60e21b815292955061221993911691630f4f276c916121ac91879190600401615269565b602060405180830381865afa1580156121c9573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906121ed9190615282565b60408051602080820183526001600160a01b038716600090815261010890915291909120548152614184565b905061222581856142ff565b9350505080612233906150a5565b9050612129565b5081518151101561224f575060019392505050565b5060009392505050565b600054610100900460ff16158080156122795750600054600160ff909116105b8061229a57506122883061432b565b15801561229a575060005460ff166001145b6122fd5760405162461bcd60e51b815260206004820152602e60248201527f496e697469616c697a61626c653a20636f6e747261637420697320616c72656160448201526d191e481a5b9a5d1a585b1a5e995960921b6064820152608401610ae1565b6000805460ff191660011790558015612320576000805461ff0019166101001790555b61232861433a565b61233061433a565b89896040516020016123439291906152c3565b60408051601f19818403018152919052805160209091012060fb5560fc805460ff1916905560fe88905560ff87905560fd8690556001600160a01b0385166123cb5760405162461bcd60e51b815260206004820152601b60248201527a2d32b9379030b2323932b9b990383ab931b430b9b2903a37b5b2b760291b6044820152606401610ae1565b61010180546001600160a01b0319166001600160a01b03871617905560fc805462ff000019166201000060ff861602179055826001600160401b0381111561241557612415614d2a565b60405190808252806020026020018201604052801561243e578160200160208202803683370190505b50805161245491610106916020909101906149f7565b5060005b838110156126755784848281811061247257612472615079565b6124889260206080909202019081019150614ac0565b610106828154811061249c5761249c615079565b9060005260206000200160006101000a8154816001600160a01b0302191690836001600160a01b031602179055508484828181106124dc576124dc615079565b9050608002016040013561010860008787858181106124fd576124fd615079565b6125139260206080909202019081019150614ac0565b6001600160a01b0316815260208101919091526040016000205584848281811061253f5761253f615079565b90506080020160200135610109600087878581811061256057612560615079565b6125769260206080909202019081019150614ac0565b6001600160a01b031681526020810191909152604001600020558484828181106125a2576125a2615079565b905060800201606001356000036125f75760405162461bcd60e51b81526020600482015260196024820152784c6971756964617465642064616d616765206973207a65726f60381b6044820152606401610ae1565b84848281811061260957612609615079565b9050608002016060013561010a600087878581811061262a5761262a615079565b6126409260206080909202019081019150614ac0565b6001600160a01b0316815260208101919091526040016000205560fc805461ff001916905561266e816150a5565b9050612458565b5061010580546001600160a01b0319166001600160a01b03841617905561269d600033613037565b6126b560008051602061562883398151915233613037565b80156126fb576000805461ff0019169055604051600181527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb38474024989060200160405180910390a15b50505050505050505050565b6000805b610106548110156127745760006101076000610106848154811061273157612731615079565b60009182526020808320909101546001600160a01b03168352820192909252604001902054111561276457600191505090565b61276d816150a5565b905061270b565b506000905090565b600061278781612ea5565b60fc805460ff191660011790556101055460fb5460405163c8df617960e01b81526001600160a01b039092169163c8df617991611c179160040190815260200190565b6001600160a01b038116600090815261010b60205260408120610966906143a7565b816127f681613007565b6128155780604051634428dc3160e01b8152600401610ae19190614af6565b6101005460408051631320834f60e01b8152905133926001600160a01b031691631320834f9160048083019260209291908290030181865afa15801561285f573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061288391906150e2565b4211156128a35760405163c5e2992f60e01b815260040160405180910390fd5b61010054604051632762697d60e01b81526001600160a01b0390911690632762697d906128d4908490600401614af6565b602060405180830381865afa1580156128f1573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061291591906150e2565b6000036129355760405163baca79c960e01b815260040160405180910390fd5b6120258185856141c7565b60008051602061562883398151915261295881612ea5565b60fc54610100900460ff161561298157604051634ce377bb60e11b815260040160405180910390fd5b60fc805461ff00191661010090811790915561010380546001600160a01b03808c166001600160a01b03199283161790925582548a83169082161790925561010280548683169084161790556101048054918716919092161790556129f46000805160206156af83398151915287613037565b612a0c6000805160206156af83398151915286613037565b612a246000805160206156af83398151915288613037565b612a3c60008051602061560883398151915288613037565b612a546000805160206156cf83398151915283613037565b610106546000906001600160401b03811115612a7257612a72614d2a565b604051908082528060200260200182016040528015612a9b578160200160208202803683370190505b50610106549091506000906001600160401b03811115612abd57612abd614d2a565b604051908082528060200260200182016040528015612ae6578160200160208202803683370190505b50610106549091506000906001600160401b03811115612b0857612b08614d2a565b604051908082528060200260200182016040528015612b31578160200160208202803683370190505b50905060005b61010654811015612c6b5761010860006101068381548110612b5b57612b5b615079565b60009182526020808320909101546001600160a01b031683528201929092526040019020548451859083908110612b9457612b94615079565b60200260200101818152505061010960006101068381548110612bb957612bb9615079565b60009182526020808320909101546001600160a01b031683528201929092526040019020548351849083908110612bf257612bf2615079565b60200260200101818152505061010a60006101068381548110612c1757612c17615079565b60009182526020808320909101546001600160a01b031683528201929092526040019020548251839083908110612c5057612c50615079565b6020908102919091010152612c64816150a5565b9050612b37565b506101055460fb546040516329b35d4760e21b81526001600160a01b039092169163a6cd751c91612caa9130906101069088908a9089906004016152d3565b600060405180830381600087803b158015612cc457600080fd5b505af1158015612cd8573d6000803e3d6000fd5b505050505050505050505050505050565b600082815260c96020526040902060010154612d0481612ea5565b610a0383836130bd565b6060806000610106805490506001600160401b03811115612d3157612d31614d2a565b604051908082528060200260200182016040528015612d5a578160200160208202803683370190505b50610106549091506000906001600160401b03811115612d7c57612d7c614d2a565b604051908082528060200260200182016040528015612da5578160200160208202803683370190505b50905060005b61010654811015612e6a5760006101068281548110612dcc57612dcc615079565b60009182526020808320909101546001600160a01b038a8116845261010b83526040808520919092168085529252909120548551919250908290869085908110612e1857612e18615079565b60200260200101906001600160a01b031690816001600160a01b03168152505080848481518110612e4b57612e4b615079565b602002602001018181525050505080612e63906150a5565b9050612dab565b509094909350915050565b6000805160206156cf833981519152612e8d81612ea5565b610df660008051602061566883398151915283613037565b610ebf81336144d5565b6001600160a01b03808516600090815261010b6020908152604080832093871683529290522054821115612ef65760405163380984fd60e21b815260040160405180910390fd5b6001600160a01b03808516600090815261010b6020908152604080832093871683529290529081208054849290612f2e908490615376565b90915550508015612f68576001600160a01b0383166000908152610107602052604081208054849290612f62908490615376565b90915550505b6101035460405163109c8cf960e11b81526001600160a01b039091169063213919f290612f9d908790879087906004016150be565b600060405180830381600087803b158015612fb757600080fd5b505af1158015612fcb573d6000803e3d6000fd5b50506101055460fb54604051633b8d409b60e01b81526001600160a01b039092169350633b8d409b9250610a8091889088908890600401615244565b6001600160a01b038116600090815261010a6020526040812054810361302f57506000919050565b506001919050565b6130418282611fd7565b610df657600082815260c9602090815260408083206001600160a01b03851684529091529020805460ff191660011790556130793390565b6001600160a01b0316816001600160a01b0316837f2f8788117e7eff1d82e926ec794901d17c78024a50270940304540a733656f0d60405160405180910390a45050565b6130c78282611fd7565b15610df657600082815260c9602090815260408083206001600160a01b0385168085529252808320805460ff1916905551339285917ff6391f5c32d9c69d2a47ea670b442974b53935d1edc7fd64eb21e047a839171b9190a45050565b600080516020615648833981519152546001600160a01b031690565b6000610df681612ea5565b7f4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd91435460ff161561317e57610a038361452e565b826001600160a01b03166352d1902d6040518163ffffffff1660e01b8152600401602060405180830381865afa9250505080156131d8575060408051601f3d908101601f191682019092526131d5918101906150e2565b60015b61323b5760405162461bcd60e51b815260206004820152602e60248201527f45524331393637557067726164653a206e657720696d706c656d656e7461746960448201526d6f6e206973206e6f74205555505360901b6064820152608401610ae1565b60008051602061564883398151915281146132aa5760405162461bcd60e51b815260206004820152602960248201527f45524331393637557067726164653a20756e737570706f727465642070726f786044820152681a58589b195555525160ba1b6064820152608401610ae1565b50610a038383836145c8565b61010254610101546040516303d3c9db60e21b81526000928392859284926001600160a01b0390811692630f4f276c926132f892909116908a90600401615269565b602060405180830381865afa158015613315573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906133399190615282565b905060006133f18261010260009054906101000a90046001600160a01b03166001600160a01b0316630f4f276c89876001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa1580156133a5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906133c99190615389565b6133d490600a615490565b6040518363ffffffff1660e01b8152600401611b7f929190615269565b6040805160208082018352670de0b6b3a76400008252825180820184526001600160a01b038b16600090815261010a90925292812054835292935061344091849161343b916142ff565b6145ed565b9050600061345e83604051806020016040528060fe548152506145ed565b9050846001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa15801561349e573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906134c29190615389565b6134cd90601261549f565b6134d890600a615490565b82516134e491906154b8565b856001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa158015613522573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906135469190615389565b61355190601261549f565b61355c90600a615490565b825161356891906154b8565b9650965050505050505b9250929050565b6001600160a01b03808816600090815261010b60209081526040808320938916835292905220548311156135c257846040516398de333560e01b8152600401610ae19190614af6565b6001600160a01b03808816600090815261010b60209081526040808320938916835292905290812080548592906135fa908490615376565b90915550506001600160a01b0385166000908152610107602052604081208054859290613628908490615376565b909155505061010354610104546040805163012f8d2f60e11b815290516001600160a01b039384169363213919f293169163025f1a5e9160048083019260209291908290030181865afa158015613683573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906136a791906154da565b87856040518463ffffffff1660e01b81526004016136c7939291906150be565b600060405180830381600087803b1580156136e157600080fd5b505af11580156136f5573d6000803e3d6000fd5b5050610103546001600160a01b0316915063213919f2905087876137198688615376565b6040518463ffffffff1660e01b8152600401613737939291906150be565b600060405180830381600087803b15801561375157600080fd5b505af1158015613765573d6000803e3d6000fd5b50506101055460fb54604051639cc487d760e01b815260048101919091526001600160a01b038b811660248301528a8116604483015260648201899052898116608483015260a4820188905260c4820187905285151560e48301529091169250639cc487d7915061010401600060405180830381600087803b1580156137ea57600080fd5b505af11580156137fe573d6000803e3d6000fd5b5050505050505050505050565b60005b61010654811015610df6576001600160a01b038216600090815261010b6020526040812061010680549192918490811061384a5761384a615079565b9060005260206000200160009054906101000a90046001600160a01b03166001600160a01b03166001600160a01b0316815260200190815260200160002054610107600061010684815481106138a2576138a2615079565b60009182526020808320909101546001600160a01b03168352820192909252604001812080549091906138d6908490615376565b909155506138e59050816150a5565b905061380e565b610106546060906000906001600160401b0381111561390d5761390d614d2a565b604051908082528060200260200182016040528015613936578160200160208202803683370190505b50905060005b61010654811015613ca6576000610106828154811061395d5761395d615079565b60009182526020808320909101546001600160a01b038a8116845261010b83526040808520919092168085529252909120549091508015613c9357670de0b6b3a76400008703613b08576001600160a01b03888116600090815261010b6020908152604080832093861683529290529081208054919055845181908690869081106139ea576139ea615079565b602002602001018181525050806101076000856001600160a01b03166001600160a01b031681526020019081526020016000206000828254613a2c9190615376565b90915550506101035460405163109c8cf960e11b81526001600160a01b039091169063213919f290613a66908a90879086906004016150be565b600060405180830381600087803b158015613a8057600080fd5b505af1158015613a94573d6000803e3d6000fd5b50506101055460fb54604051633b8d409b60e01b81526001600160a01b039092169350633b8d409b9250613ad0918d9088908790600401615244565b600060405180830381600087803b158015613aea57600080fd5b505af1158015613afe573d6000803e3d6000fd5b5050505050613c93565b6000613b2260405180602001604052808a8152508361462c565b6001600160a01b03808b16600090815261010b60209081526040808320938816835292905290812080549293508392909190613b5f908490615376565b9250508190555080858581518110613b7957613b79615079565b602002602001018181525050806101076000856001600160a01b03166001600160a01b031681526020019081526020016000206000828254613bbb9190615376565b90915550506101035460405163109c8cf960e11b81526001600160a01b039091169063213919f290613bf5908a90879086906004016150be565b600060405180830381600087803b158015613c0f57600080fd5b505af1158015613c23573d6000803e3d6000fd5b50506101055460fb54604051633b8d409b60e01b81526001600160a01b039092169350633b8d409b9250613c5f918d9088908790600401615244565b600060405180830381600087803b158015613c7957600080fd5b505af1158015613c8d573d6000803e3d6000fd5b50505050505b505080613c9f906150a5565b905061393c565b50949350505050565b6101005460408051631320834f60e01b815290516000926001600160a01b031691631320834f9160048083019260209291908290030181865afa158015613cfa573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190613d1e91906150e2565b421115613d3e576040516321f8431560e01b815260040160405180910390fd5b846001600160a01b0316846001600160a01b031603613d705760405163ae957a1d60e01b815260040160405180910390fd5b610106548214613d935760405163dd23c3ad60e01b8152600401610ae190615193565b61010054604051632762697d60e01b81526000916001600160a01b031690632762697d90613dc5908990600401614af6565b602060405180830381865afa158015613de2573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190613e0691906150e2565b905080600003613e295760405163baca79c960e01b815260040160405180910390fd5b60fd5461010254610101546040516303d3c9db60e21b8152600093926001600160a01b0390811692630f4f276c92613e6992909116908790600401615269565b602060405180830381865afa158015613e86573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190613eaa9190615282565b51613eb59190615231565b613ebe886127ca565b109050801581613ed45750613ed28761202b565b155b15613ef25760405163e94a979360e01b815260040160405180910390fd5b9150505b949350505050565b61010054604051632762697d60e01b815260009182916001600160a01b0390911690632762697d90613f34908690600401614af6565b602060405180830381865afa158015613f51573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190613f7591906150e2565b905080600003613f885750600092915050565b604080516020810190915260008082525b610106548110156140aa5760006101068281548110613fba57613fba615079565b6000918252602080832090910154610102546001600160a01b038a8116855261010b84526040808620938216808752939094528385205493516303d3c9db60e21b815292955061408993911691630f4f276c9161401c91879190600401615269565b602060405180830381865afa158015614039573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061405d9190615282565b60408051602080820183526001600160a01b038716600090815261010990915291909120548152614184565b905061409581856142ff565b93505050806140a3906150a5565b9050613f99565b5061010254610101546040516303d3c9db60e21b81526000926001600160a01b0390811692630f4f276c926140e792909116908790600401615269565b602060405180830381865afa158015614104573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906141289190615282565b905061413682825190511090565b1561414657506001949350505050565b60006141528383614644565b905061417a6141618284614184565b604051806020016040528060ff54815250519051111590565b9695505050505050565b60408051602081019091526000815260405180602001604052806141be6141b78660000151670de0b6b3a7640000614670565b855161467c565b90529392505050565b6001600160a01b03808416600090815261010b60209081526040808320938616835292905290812080548392906141ff908490615231565b90915550506001600160a01b038216600090815261010760205260408120805483929061422d908490615231565b90915550506101035460405163049f2a5160e21b81526001600160a01b039091169063127ca94490614267908690869086906004016150be565b600060405180830381600087803b15801561428157600080fd5b505af1158015614295573d6000803e3d6000fd5b50506101055460fb5460405163ee9e68bb60e01b81526001600160a01b03909216935063ee9e68bb92506142d191879087908790600401615244565b600060405180830381600087803b1580156142eb57600080fd5b505af11580156112e6573d6000803e3d6000fd5b60408051602081019091526000815260405180602001604052806141be85600001518560000151614688565b6001600160a01b03163b151590565b600054610100900460ff166143a55760405162461bcd60e51b815260206004820152602b60248201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960448201526a6e697469616c697a696e6760a81b6064820152608401610ae1565b565b6040805160208101909152600080825290815b610106548110156144cd576101025461010680546144bb9285926001600160a01b0390911691630f4f276c9190869081106143f7576143f7615079565b9060005260206000200160009054906101000a90046001600160a01b0316886000610106888154811061442c5761442c615079565b60009182526020808320909101546001600160a01b0316835282019290925260409081019091205490516001600160e01b031960e085901b168152614475929190600401615269565b602060405180830381865afa158015614492573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906144b69190615282565b6142ff565b91506144c6816150a5565b90506143ba565b505192915050565b6144df8282611fd7565b610df6576144ec81614694565b6144f78360206146a6565b60405160200161450892919061551b565b60408051601f198184030181529082905262461bcd60e51b8252610ae19160040161558a565b6145378161432b565b6145995760405162461bcd60e51b815260206004820152602d60248201527f455243313936373a206e657720696d706c656d656e746174696f6e206973206e60448201526c1bdd08184818dbdb9d1c9858dd609a1b6064820152608401610ae1565b60008051602061564883398151915280546001600160a01b0319166001600160a01b0392909216919091179055565b6145d183614841565b6000825111806145de5750805b15610a03576120258383614881565b6040805160208101909152600081526040518060200160405280670de0b6b3a764000061462286600001518660000151614670565b6141be91906154b8565b60008061463984846148a6565b9050613ef6816148ce565b60408051602081019091526000815260405180602001604052806141be856000015185600001516148e6565b6000611bc582846155bd565b6000611bc582846154b8565b6000611bc58284615231565b60606109666001600160a01b03831660145b606060006146b58360026155bd565b6146c0906002615231565b6001600160401b038111156146d7576146d7614d2a565b6040519080825280601f01601f191660200182016040528015614701576020820181803683370190505b509050600360fc1b8160008151811061471c5761471c615079565b60200101906001600160f81b031916908160001a905350600f60fb1b8160018151811061474b5761474b615079565b60200101906001600160f81b031916908160001a905350600061476f8460026155bd565b61477a906001615231565b90505b60018111156147f2576f181899199a1a9b1b9c1cb0b131b232b360811b85600f16601081106147ae576147ae615079565b1a60f81b8282815181106147c4576147c4615079565b60200101906001600160f81b031916908160001a90535060049490941c936147eb816155d4565b905061477d565b508315611bc55760405162461bcd60e51b815260206004820181905260248201527f537472696e67733a20686578206c656e67746820696e73756666696369656e746044820152606401610ae1565b61484a8161452e565b6040516001600160a01b038216907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b90600090a250565b6060611bc58383604051806060016040528060278152602001615688602791396148f2565b60408051602081019091526000815260405180602001604052806141be856000015185614670565b805160009061096690670de0b6b3a7640000906154b8565b6000611bc58284615376565b6060600080856001600160a01b03168560405161490f91906155eb565b600060405180830381855af49150503d806000811461494a576040519150601f19603f3d011682016040523d82523d6000602084013e61494f565b606091505b509150915061417a86838387606083156149c85782516000036149c1576149758561432b565b6149c15760405162461bcd60e51b815260206004820152601d60248201527f416464726573733a2063616c6c20746f206e6f6e2d636f6e74726163740000006044820152606401610ae1565b5081613ef6565b613ef683838151156149dd5781518083602001fd5b8060405162461bcd60e51b8152600401610ae1919061558a565b828054828255906000526020600020908101928215614a4c579160200282015b82811115614a4c57825182546001600160a01b0319166001600160a01b03909116178255602090920191600190910190614a17565b50614a58929150614a5c565b5090565b5b80821115614a585760008155600101614a5d565b600060208284031215614a8357600080fd5b81356001600160e01b031981168114611bc557600080fd5b6001600160a01b0381168114610ebf57600080fd5b8035614abb81614a9b565b919050565b600060208284031215614ad257600080fd5b8135611bc581614a9b565b600060208284031215614aef57600080fd5b5035919050565b6001600160a01b0391909116815260200190565b600080600060608486031215614b1f57600080fd5b8335614b2a81614a9b565b92506020840135614b3a81614a9b565b929592945050506040919091013590565b60008060408385031215614b5e57600080fd5b8235614b6981614a9b565b946020939093013593505050565b60008060408385031215614b8a57600080fd5b823591506020830135614b9c81614a9b565b809150509250929050565b60008083601f840112614bb957600080fd5b5081356001600160401b03811115614bd057600080fd5b6020830191508360208260051b850101111561357257600080fd5b600080600060408486031215614c0057600080fd5b8335614c0b81614a9b565b925060208401356001600160401b03811115614c2657600080fd5b614c3286828701614ba7565b9497909650939450505050565b600080600060608486031215614c5457600080fd5b8335614c5f81614a9b565b9250602084013591506040840135614c7681614a9b565b809150509250925092565b600081518084526020808501945080840160005b83811015614cb157815187529582019590820190600101614c95565b509495945050505050565b604080825283519082018190526000906020906060840190828701845b82811015614cfe5781516001600160a01b031684529284019290840190600101614cd9565b5050508381038285015261417a8186614c81565b600060608284031215614d2457600080fd5b50919050565b634e487b7160e01b600052604160045260246000fd5b604051601f8201601f191681016001600160401b0381118282101715614d6857614d68614d2a565b604052919050565b60008060408385031215614d8357600080fd5b8235614d8e81614a9b565b91506020838101356001600160401b0380821115614dab57600080fd5b818601915086601f830112614dbf57600080fd5b813581811115614dd157614dd1614d2a565b614de3601f8201601f19168501614d40565b91508082528784828501011115614df957600080fd5b80848401858401376000848284010152508093505050509250929050565b600080600080600060608688031215614e2f57600080fd5b8535614e3a81614a9b565b945060208601356001600160401b0380821115614e5657600080fd5b614e6289838a01614ba7565b90965094506040880135915080821115614e7b57600080fd5b50614e8888828901614ba7565b969995985093965092949392505050565b60008083601f840112614eab57600080fd5b5081356001600160401b03811115614ec257600080fd5b6020830191508360208260071b850101111561357257600080fd5b600080600080600080600080600060e08a8c031215614efb57600080fd5b89356001600160401b0380821115614f1257600080fd5b818c0191508c601f830112614f2657600080fd5b813581811115614f3557600080fd5b8d6020828501011115614f4757600080fd5b60208381019c50909a508c0135985060408c0135975060608c01359650614f7060808d01614ab0565b955060a08c0135915080821115614f8657600080fd5b50614f938c828d01614e99565b9094509250614fa6905060c08b01614ab0565b90509295985092959850929598565b60008060408385031215614fc857600080fd5b8235614fd381614a9b565b91506020830135614b9c81614a9b565b600080600080600080600060e0888a031215614ffe57600080fd5b873561500981614a9b565b9650602088013561501981614a9b565b9550604088013561502981614a9b565b9450606088013561503981614a9b565b9350608088013561504981614a9b565b925060a088013561505981614a9b565b915060c088013561506981614a9b565b8091505092959891949750929550565b634e487b7160e01b600052603260045260246000fd5b634e487b7160e01b600052601160045260246000fd5b6000600182016150b7576150b761508f565b5060010190565b6001600160a01b039384168152919092166020820152604081019190915260600190565b6000602082840312156150f457600080fd5b5051919050565b6020808252602c908201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060408201526b19195b1959d85d1958d85b1b60a21b606082015260800190565b6020808252602c908201527f46756e6374696f6e206d7573742062652063616c6c6564207468726f7567682060408201526b6163746976652070726f787960a01b606082015260800190565b6020808252603f908201527f436c6f7375726520616d6f756e7473206172726179206e6f742073616d65206c60408201527f656e67746820617320636f6c6c61746572616c20746f6b656e73206c69737400606082015260800190565b60208082526021908201527f636c6f73757265416d6f756e74732063616e6e6f742062652075696e74206d616040820152600f60fb1b606082015260800190565b808201808211156109665761096661508f565b9384526001600160a01b03928316602085015291166040830152606082015260800190565b6001600160a01b03929092168252602082015260400190565b60006020828403121561529457600080fd5b604051602081018181106001600160401b03821117156152b6576152b6614d2a565b6040529151825250919050565b8183823760009101908152919050565b600060c08201888352602060018060a01b03808a168286015260c0604086015282895480855260e0870191508a60005283600020945060005b8181101561532a57855484168352600195860195928501920161530c565b5050858103606087015261533e818a614c81565b935050505082810360808401526153558186614c81565b905082810360a08401526153698185614c81565b9998505050505050505050565b818103818111156109665761096661508f565b60006020828403121561539b57600080fd5b815160ff81168114611bc557600080fd5b600181815b808511156153e75781600019048211156153cd576153cd61508f565b808516156153da57918102915b93841c93908002906153b1565b509250929050565b6000826153fe57506001610966565b8161540b57506000610966565b8160018114615421576002811461542b57615447565b6001915050610966565b60ff84111561543c5761543c61508f565b50506001821b610966565b5060208310610133831016604e8410600b841016171561546a575081810a610966565b61547483836153ac565b80600019048211156154885761548861508f565b029392505050565b6000611bc560ff8416836153ef565b60ff82811682821603908111156109665761096661508f565b6000826154d557634e487b7160e01b600052601260045260246000fd5b500490565b6000602082840312156154ec57600080fd5b8151611bc581614a9b565b60005b838110156155125781810151838201526020016154fa565b50506000910152565b76020b1b1b2b9b9a1b7b73a3937b61d1030b1b1b7bab73a1604d1b81526000835161554d8160178501602088016154f7565b7001034b99036b4b9b9b4b733903937b6329607d1b601791840191820152835161557e8160288401602088016154f7565b01602801949350505050565b60208152600082518060208401526155a98160408501602087016154f7565b601f01601f19169190910160400192915050565b80820281158282048414176109665761096661508f565b6000816155e3576155e361508f565b506000190190565b600082516155fd8184602087016154f7565b919091019291505056fe250b76734a070a69c7b3930477dd35007ad9c9d0952e97903fdafb2db698053730d41a597cac127d8249d31298b50e481ee82c3f4a49ff93c76a22735aa9f3ad360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbcf4b6b486426e3c004413defb7013cd482f29189a98e074f1c202b2ac26536bb2416464726573733a206c6f772d6c6576656c2064656c65676174652063616c6c206661696c65646e14a979b95b01beecd617807f3738f4e067938da99755b16afdcf7148d313b76e3cc031d23d7153f72e87cbfd113a0351c60d8ce52b8a31c944d543a384b7c9a2646970667358221220eee64a56f1e2ebc92aca0b098e1e920d6ca9670b051b1909d8f94c7cb1773dc064736f6c63430008120033
Loading...
Loading
Loading...
Loading
Net Worth in USD
$0.00
Net Worth in ETH
0
Multichain Portfolio | 34 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
Loading...
Loading
Loading...
Loading
Loading...
Loading
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.