TermRepoServicer.sol

This contract belongs to the Term Servicer group of contracts and is specific to a Term Repo deployment. This contract maintains records, collects and disburse repurchase payments.

TermRepoServicer

This contract maintains records, collects and disburse repurchase payments

This contract belongs to the Term Servicer group of contracts and is specific to a Term Repo deployment

YEAR_SECONDS

uint256 YEAR_SECONDS

AUCTION_LOCKER

bytes32 AUCTION_LOCKER

AUCTIONEER

bytes32 AUCTIONEER

COLLATERAL_MANAGER

bytes32 COLLATERAL_MANAGER

DEVOPS_ROLE

bytes32 DEVOPS_ROLE

ROLLOVER_MANAGER

bytes32 ROLLOVER_MANAGER

ROLLOVER_TARGET_AUCTIONEER_ROLE

bytes32 ROLLOVER_TARGET_AUCTIONEER_ROLE

INITIALIZER_ROLE

bytes32 INITIALIZER_ROLE

DIAMOND_ROLE

bytes32 DIAMOND_ROLE

termRepoId

bytes32 termRepoId

totalOutstandingRepurchaseExposure

uint256 totalOutstandingRepurchaseExposure

totalRepurchaseCollected

uint256 totalRepurchaseCollected

maturityTimestamp

uint256 maturityTimestamp

endOfRepurchaseWindow

uint256 endOfRepurchaseWindow

redemptionTimestamp

uint256 redemptionTimestamp

block timestamp at which term repo tokens can be redeemed

servicingFee

uint256 servicingFee

percentage share of bid amounts charged to bidder

shortfallHaircutMantissa

uint256 shortfallHaircutMantissa

proportion of redemption value for redemption

termRepoBalancedThreshold

uint256 termRepoBalancedThreshold

threshold for determining whether term repo is balanced

purchaseToken

address purchaseToken

termRepoCollateralManager

contract ITermRepoCollateralManager termRepoCollateralManager

termRepoRolloverManager

contract ITermRepoRolloverManager termRepoRolloverManager

termRepoLocker

contract ITermRepoLocker termRepoLocker

termRepoToken

contract ITermRepoToken termRepoToken

termController

contract ITermController termController

emitter

contract ITermEventEmitter emitter

repurchaseExposureLedger

mapping(address => uint256) repurchaseExposureLedger

termContractPaired

bool termContractPaired

notTermContractPaired

modifier notTermContractPaired()

constructor

constructor() public

initialize

function initialize(string termRepoId_, uint256 maturityTimestamp_, uint256 repurchaseWindow_, uint256 redemptionBuffer_, uint256 servicingFee_, address purchaseToken_, contract ITermController termController_, contract ITermEventEmitter emitter_, address termInitializer_) external

pairTermContracts

function pairTermContracts(address termRepoLocker_, address termRepoCollateralManager_, address termRepoToken_, address termDiamond_, address termAuctionOfferLocker_, address termAuction_, address rolloverManager_, address devopsMultisig_, address deployerWallet_, string version_) external

submitRepurchasePayment

function submitRepurchasePayment(uint256 amount) external

The max repurchase amount is the repurchase balance less any amounts earmarked for rollover

Parameters

Name	Type	Description
amount	uint256	The amount of purchase token to submit for repurchase

submitRepurchasePayment

function submitRepurchasePayment(address borrower, uint256 amount) external

Allows DIAMOND_ROLE to submit repurchase payment on behalf of a borrower

Parameters

Name	Type	Description
borrower	address	The address of the borrower making the repurchase payment
amount	uint256	The amount of purchase token to submit for repurchase

burnCollapseExposure

function burnCollapseExposure(uint256 amountToBurn) external

Parameters

Name	Type	Description
amountToBurn	uint256	The amount of TermRepoTokens to burn

burnCollapseExposure

function burnCollapseExposure(address borrower, uint256 amountToBurn) external

Allows DIAMOND_ROLE to burn and collapse exposure on behalf of a borrower

Parameters

Name	Type	Description
borrower	address	The address of the borrower whose exposure is being collapsed
amountToBurn	uint256	The amount of TermRepoTokens to burn

getBorrowerRepurchaseObligation

function getBorrowerRepurchaseObligation(address borrower) external view returns (uint256)

Parameters

Name	Type	Description
borrower	address	The address of the borrower to query

Return Values

Name	Type	Description
[0]	uint256	The total repurchase price due at maturity for a given borrower

mintOpenExposure

function mintOpenExposure(uint256 amount, uint256[] collateralAmounts) external

This method allows verified users to open repurchase price exposure against a TermRepoToken mint of corresponding value outside of a Term Auction to create new supply

Parameters

Name	Type	Description
amount	uint256	The amount of Term Repo Tokens to mint
collateralAmounts	uint256[]	An array containing an amount of collateral token for each token in collateral basket

mintOpenExposure

function mintOpenExposure(address borrower, uint256 amount, uint256[] collateralAmounts) external

This method allows DIAMOND_ROLE to open repurchase price exposure against a TermRepoToken mint on behalf of a borrower outside of a Term Auction to create new supply

Parameters

Name	Type	Description
borrower	address	The address of the borrower for whom exposure is being minted
amount	uint256	The amount of Term Repo Tokens to mint
collateralAmounts	uint256[]	An array containing an amount of collateral token for each token in collateral basket

mintOpenExposureFromIntent

function mintOpenExposureFromIntent(address borrower, address lender, uint256 purchaseTokenAmount, uint256[] collateralAmounts, uint256 offerRate, bool isRoutedCollateral) external returns (uint256)

Mint open exposure for intent-based order settlement (DIAMOND_ROLE)

This method allows DIAMOND_ROLE to open repurchase price exposure against a TermRepoToken mint for intent-based orders

Parameters

Name	Type	Description
borrower	address	The address of the borrower for whom exposure is being minted
lender	address	The address of the lender providing the purchase tokens
purchaseTokenAmount	uint256	The amount of purchase tokens being lent
collateralAmounts	uint256[]	An array containing collateral token amounts for each token in the collateral basket
offerRate	uint256	The interest rate for the position (percentage in 1e18 format)
isRoutedCollateral	bool	Whether the collateral tokens are already routed to the contract

Return Values

Name	Type	Description
[0]	uint256	Amount of Term Repo Tokens minted

redeemTermRepoTokens

function redeemTermRepoTokens(address redeemer, uint256 amountToRedeem) external

Parameters

Name	Type	Description
redeemer	address	The address of redeemer
amountToRedeem	uint256	The amount of TermRepoTokens to redeem

isTermRepoBalanced

function isTermRepoBalanced() external view returns (bool)

Return Values

Name	Type	Description
[0]	bool	A boolean that represents whether the term repo locker is balanced

lockOfferAmount

function lockOfferAmount(address sender, address offeror, uint256 amount) external

Parameters

Name	Type	Description
sender	address	The address of the sender
offeror	address	The address of the offeror
amount	uint256	The amount of purchase tokens to lock

unlockOfferAmount

function unlockOfferAmount(address offeror, uint256 amount) external

Parameters

Name	Type	Description
offeror	address	The address of the offeror
amount	uint256	The amount of purchase tokens to unlocked

fulfillOffer

function fulfillOffer(address offeror, uint256 purchasePrice, uint256 repurchasePrice, bytes32 offerId) external

Parameters

Name	Type	Description
offeror	address	The address of the offeror
purchasePrice	uint256	The offer amount to fulfill
repurchasePrice	uint256	The repurchase price due to offeror at maturity
offerId	bytes32	Unique identifier for this offer

fulfillBid

function fulfillBid(address bidder, uint256 purchasePrice, uint256 repurchasePrice, address[] collateralTokens, uint256[] collateralAmounts, uint256 dayCountFractionMantissa) external

Parameters

Name	Type	Description
bidder	address	The address of the bidder
purchasePrice	uint256	The bid amount to fulfill
repurchasePrice	uint256	The repurchase price due at maturity
collateralTokens	address[]	Collateral token addresses
collateralAmounts	uint256[]	Collateral token amounts
dayCountFractionMantissa	uint256	Actual/360 day count fraction parameter from Term Auction Group

approveRolloverAuction

function approveRolloverAuction(address termAuction) external

Parameters

Name	Type	Description
termAuction	address	The address of a TermAuction contract to receive autioneer role

openExposureOnRolloverNew

function openExposureOnRolloverNew(address borrower, uint256 purchasePrice, uint256 repurchasePrice, address previousTermRepoLocker, uint256 dayCountFractionMantissa) external returns (uint256)

Parameters

Name	Type	Description
borrower	address	The address of the borrower rolling into new Term Repo
purchasePrice	uint256	The purchase price received from new TermRepo
repurchasePrice	uint256	The new repurchase price due at maturity of new TermRepo
previousTermRepoLocker	address	The address of the old TermRepoLocker contract
dayCountFractionMantissa	uint256	Actual/360 day count fraction parameter from Term Auction Group

Return Values

Name	Type	Description
[0]	uint256	The net purchase price received in after deducing protocol servicing fees

closeExposureOnRolloverExisting

function closeExposureOnRolloverExisting(address borrower, uint256 rolloverSettlementAmount) external returns (uint256)

Parameters

Name	Type	Description
borrower	address	The address of the borrower
rolloverSettlementAmount	uint256	The amount of net proceeds received from new TermRepo to pay down existing repurchase obligation due to old Term Repo

Return Values

Name	Type	Description
[0]	uint256	A uint256 representing the proportion of total repurchase due to old Term Repo from borrower settled by proceeds from new TermRepo

liquidatorCoverExposure

function liquidatorCoverExposure(address borrower, address liquidator, uint256 amountToCover) external

Parameters

Name	Type	Description
borrower	address	The address of the borrower
liquidator	address	The address of the liquidator
amountToCover	uint256	The amount of repurchase exposure to cover in liquidation

liquidatorCoverExposureWithRepoToken

function liquidatorCoverExposureWithRepoToken(address borrower, address liquidator, uint256 amountOfRepoToken) external returns (uint256)

Parameters

Name	Type	Description
borrower	address	The address of the borrower
liquidator	address	The address of the liquidator
amountOfRepoToken	uint256	The amount of term tokens used to cover in liquidation

Return Values

Name	Type	Description
[0]	uint256	A uint256 representing purchase value of repo tokens burned

reopenToNewAuction

function reopenToNewAuction(struct TermAuctionGroup termAuctionGroup) external

Parameters

Name	Type	Description
termAuctionGroup	struct TermAuctionGroup	A struct containing contract addresses of a Term Auction deployment to pair for a reopening of a TermRepo

_submitRepurchasePaymentInternal

function _submitRepurchasePaymentInternal(address borrower, uint256 amount) internal

_burnCollapseExposureInternal

function _burnCollapseExposureInternal(address borrower, uint256 amountToBurn) internal

_mintOpenExposureInternal

function _mintOpenExposureInternal(address borrower, address sender, uint256 amount, uint256[] collateralAmounts) internal

_isTermRepoBalanced

function _isTermRepoBalanced() internal view returns (bool)

Truncation is by 4 decimal places due to the assumption that number of participants < 10000

_getMaxRepaymentAroundRollover

function _getMaxRepaymentAroundRollover(address borrower) internal view returns (uint256)

_repay

function _repay(address _borrower, address repayer_, uint256 amount_) internal

_parRedemption

function _parRedemption(address redeemer_, uint256 amount_) internal

_proRataRedemption

function _proRataRedemption(address redeemer_, uint256 amount_) internal

_authorizeUpgrade

function _authorizeUpgrade(address impl) internal

required override by the OpenZeppelin UUPS module

Parameters

Name	Type	Description
impl	address	new impl address for proxy upgrade