Skip to content

Latest commit

 

History

History
1024 lines (528 loc) · 19.7 KB

BasePool.md

File metadata and controls

1024 lines (528 loc) · 19.7 KB
Raw

BasePool

Methods

addLiquidity

function addLiquidity(address _onBehalfOf, uint128 _sendAmount, uint256 _deadline, uint256 _referralCode) external nonpayable

Function which adds to an LPs current position

This function will update loanIdxsWhereSharesChanged only if not the first add. If address on behalf of is not sender, then sender must have permission.

Parameters

Name Type Description
_onBehalfOf address Recipient of the LP shares
_sendAmount uint128 Amount of loan currency LP wishes to deposit
_deadline uint256 Last timestamp after which function will revert
_referralCode uint256 Will possibly be used later to reward referrals

borrow

function borrow(address _onBehalf, uint128 _sendAmount, uint128 _minLoanLimit, uint128 _maxRepayLimit, uint256 _deadline, uint256 _referralCode) external nonpayable

Parameters

Name Type Description
_onBehalf address undefined
_sendAmount uint128 undefined
_minLoanLimit uint128 undefined
_maxRepayLimit uint128 undefined
_deadline uint256 undefined
_referralCode uint256 undefined

claim

function claim(address _onBehalfOf, uint256[] _loanIdxs, bool _isReinvested, uint256 _deadline) external nonpayable

Function which handles individual claiming by LPs

This function is more expensive, but needs to be used when LP changes position size in the middle of smallest aggregation block or if LP wants to claim some of the loans before the expiry time of the last loan in the aggregation block. _loanIdxs must be increasing array. If address on behalf of is not sender, then sender must have permission to claim. As well if reinvestment ootion is chosen, sender must have permission to add liquidity

Parameters

Name Type Description
_onBehalfOf address LP address which is owner or has approved sender to claim on their behalf (and possibly reinvest)
_loanIdxs uint256[] Loan indices on which LP wants to claim
_isReinvested bool Flag for if LP wants claimed loanCcy to be re-invested
_deadline uint256 Deadline if reinvestment occurs. (If no reinvestment, this is ignored)

claimCreator

function claimCreator() external nonpayable

Function to claim proposed creator role

claimFromAggregated

function claimFromAggregated(address _onBehalfOf, uint256[] _aggIdxs, bool _isReinvested, uint256 _deadline) external nonpayable

Function which handles aggregate claiming by LPs

This function is much more efficient, but can only be used when LPs position size did not change over the entire interval LP would like to claim over. _aggIdxs must be increasing array. the first index of _aggIdxs is the from loan index to start aggregation, the rest of the indices are the end loan indexes of the intervals he wants to claim. If address on behalf of is not sender, then sender must have permission to claim. As well if reinvestment option is chosen, sender must have permission to add liquidity

Parameters

Name Type Description
_onBehalfOf address LP address which is owner or has approved sender to claim on their behalf (and possibly reinvest)
_aggIdxs uint256[] From index and end indices of the aggregation that LP wants to claim
_isReinvested bool Flag for if LP wants claimed loanCcy to be re-invested
_deadline uint256 Deadline if reinvestment occurs. (If no reinvestment, this is ignored)

getClaimsFromAggregated

function getClaimsFromAggregated(uint256 _fromLoanIdx, uint256 _toLoanIdx, uint256 _shares) external view returns (uint256 repayments, uint256 collateral)

Function which returns claims for a given aggregated from and to index and amount of sharesOverTime

This function is called internally, but also can be used by other protocols so has some checks which are unnecessary if it was solely an internal function

Parameters

Name Type Description
_fromLoanIdx uint256 Loan index on which he wants to start aggregate claim (must be mod 0 wrt 100)
_toLoanIdx uint256 End loan index of the aggregation
_shares uint256 Amount of sharesOverTime which the LP owned over this given aggregation period

Returns

Name Type Description
repayments uint256 undefined
collateral uint256 undefined

getLpInfo

function getLpInfo(address _lpAddr) external view returns (uint32 fromLoanIdx, uint32 earliestRemove, uint32 currSharePtr, uint256[] sharesOverTime, uint256[] loanIdxsWhereSharesChanged)

Function which gets all LP info

fromLoanIdx = 0 can be utilized for checking if someone had been an LP in the pool

Parameters

Name Type Description
_lpAddr address Address for which LP info is being retrieved

Returns

Name Type Description
fromLoanIdx uint32 Lower bound loan idx (incl.) from which LP is entitled to claim
earliestRemove uint32 Earliest timestamp from which LP is allowed to remove liquidity
currSharePtr uint32 Current pointer for the shares over time array
sharesOverTime uint256[] Array with elements representing number of LP shares for their past and current positions
loanIdxsWhereSharesChanged uint256[] Array with elements representing upper loan idx bounds (excl.), where LP can claim

getPoolInfo

function getPoolInfo() external view returns (address _loanCcyToken, address _collCcyToken, uint256 _maxLoanPerColl, uint256 _minLoan, uint256 _loanTenor, uint256 _totalLiquidity, uint256 _totalLpShares, uint256 _baseAggrBucketSize, uint256 _loanIdx)

Function which returns pool information

This function can be used to get pool information

Returns

Name Type Description
_loanCcyToken address Loan currency
_collCcyToken address Collateral currency
_maxLoanPerColl uint256 Maximum loan amount per pledged collateral unit
_minLoan uint256 Minimum loan size
_loanTenor uint256 Loan tenor
_totalLiquidity uint256 Total liquidity available for loans
_totalLpShares uint256 Total LP shares
_baseAggrBucketSize uint256 Base aggregation level
_loanIdx uint256 Loan index for the next incoming loan

getRateParams

function getRateParams() external view returns (uint256 _liquidityBnd1, uint256 _liquidityBnd2, uint256 _r1, uint256 _r2)

Function which returns rate parameters need for interest rate calculation

This function can be used to get parameters needed for interest rate calculations

Returns

Name Type Description
_liquidityBnd1 uint256 Amount of liquidity the pool needs to end the reciprocal (hyperbola) range and start "target" range
_liquidityBnd2 uint256 Amount of liquidity the pool needs to end the "target" range and start flat rate
_r1 uint256 Rate that is used at start of target range
_r2 uint256 Minimum rate at end of target range. This is minimum allowable rate

isApproved

function isApproved(address, address, enum IBasePool.ApprovalTypes) external view returns (bool)

Function returns if owner or beneficiary has approved a sender address for a given type

Parameters

Name Type Description
_0 address undefined
_1 address undefined
_2 enum IBasePool.ApprovalTypes undefined

Returns

Name Type Description
_0 bool True if approved, false otherwise

loanIdxToBorrower

function loanIdxToBorrower(uint256) external view returns (address)

Getter which returns the borrower for a given loan idx

Parameters

Name Type Description
_0 uint256 undefined

Returns

Name Type Description
_0 address The borrower address

loanIdxToLoanInfo

function loanIdxToLoanInfo(uint256) external view returns (uint128 repayment, uint128 collateral, uint128 totalLpShares, uint32 expiry, bool repaid)

Parameters

Name Type Description
_0 uint256 undefined

Returns

Name Type Description
repayment uint128 undefined
collateral uint128 undefined
totalLpShares uint128 undefined
expiry uint32 undefined
repaid bool undefined

loanTerms

function loanTerms(uint128 _inAmountAfterFees) external view returns (uint128 loanAmount, uint128 repaymentAmount, uint128 pledgeAmount, uint256 _creatorFee, uint256 _totalLiquidity)

Function which calculates loan terms

Parameters

Name Type Description
_inAmountAfterFees uint128 Amount of collateral currency after fees are deducted

Returns

Name Type Description
loanAmount uint128 Amount of loan currency to be trasnferred to the borrower
repaymentAmount uint128 Amount of loan currency borrower must repay to reclaim collateral
pledgeAmount uint128 Amount of collateral currency borrower retrieves upon repayment
_creatorFee uint256 Amount of collateral currency to be transferred to treasury
_totalLiquidity uint256 The total liquidity of the pool (pre-borrow) that is available for new loans

overrideSharePointer

function overrideSharePointer(uint256 _newSharePointer) external nonpayable

Function will update the share pointer for the LP

This function will allow an LP to skip his pointer ahead but caution should be used since once an LP has updated their from index they lose all rights to any outstanding claims before that from index

Parameters

Name Type Description
_newSharePointer uint256 New location of the LP's current share pointer

proposeNewCreator

function proposeNewCreator(address newAddr) external nonpayable

Parameters

Name Type Description
newAddr address undefined

removeLiquidity

function removeLiquidity(address _onBehalfOf, uint128 numShares) external nonpayable

Parameters

Name Type Description
_onBehalfOf address undefined
numShares uint128 undefined

repay

function repay(uint256 _loanIdx, address _recipient, uint128 _sendAmount) external nonpayable

Function which allows repayment of a loan

The sent amount of loan currency must be sufficient to account for any fees on transfer (if any)

Parameters

Name Type Description
_loanIdx uint256 Index of the loan to be repaid
_recipient address Address that will receive the collateral transfer
_sendAmount uint128 Amount of loan currency sent for repayment.

rollOver

function rollOver(uint256 _loanIdx, uint128 _minLoanLimit, uint128 _maxRepayLimit, uint256 _deadline, uint128 _sendAmount) external nonpayable

Function which allows repayment of a loan and roll over into new loan

The old loan gets repaid and then a new loan with a new loan Id is taken out. No actual transfers are made other than the interest

Parameters

Name Type Description
_loanIdx uint256 Index of the loan to be repaid
_minLoanLimit uint128 Minimum amount of loan currency acceptable from new loan.
_maxRepayLimit uint128 Maximum allowable loan currency amount borrower for new loan.
_deadline uint256 Timestamp after which transaction will be void
_sendAmount uint128 Amount of loan currency borrower needs to send to pay difference in repayment and loan amount

setApprovals

function setApprovals(address _approvee, uint256 _packedApprovals) external nonpayable

Function which sets approval for another to perform a certain function on sender's behalf

Parameters

Name Type Description
_approvee address This address is being given approval for the action(s) by the current sender
_packedApprovals uint256 Packed boolean flags to set which actions are approved or not approved, where e.g. "00001" refers to ApprovalTypes.Repay (=0) and "10000" to ApprovalTypes.Claim (=4)

Events

AddLiquidity

event AddLiquidity(address indexed lp, uint256 amount, uint256 newLpShares, uint256 totalLiquidity, uint256 totalLpShares, uint256 earliestRemove, uint256 indexed loanIdx, uint256 indexed referralCode)

Parameters

Name Type Description
lp indexed address undefined
amount uint256 undefined
newLpShares uint256 undefined
totalLiquidity uint256 undefined
totalLpShares uint256 undefined
earliestRemove uint256 undefined
loanIdx indexed uint256 undefined
referralCode indexed uint256 undefined

ApprovalUpdate

event ApprovalUpdate(address ownerOrBeneficiary, address sender, uint256 _packedApprovals)

Parameters

Name Type Description
ownerOrBeneficiary address undefined
sender address undefined
_packedApprovals uint256 undefined

Borrow

event Borrow(address indexed borrower, uint256 loanIdx, uint256 collateral, uint256 loanAmount, uint256 repaymentAmount, uint256 totalLpShares, uint256 indexed expiry, uint256 indexed referralCode)

Parameters

Name Type Description
borrower indexed address undefined
loanIdx uint256 undefined
collateral uint256 undefined
loanAmount uint256 undefined
repaymentAmount uint256 undefined
totalLpShares uint256 undefined
expiry indexed uint256 undefined
referralCode indexed uint256 undefined

Claim

event Claim(address indexed lp, uint256[] loanIdxs, uint256 repayments, uint256 collateral)

Parameters

Name Type Description
lp indexed address undefined
loanIdxs uint256[] undefined
repayments uint256 undefined
collateral uint256 undefined

ClaimFromAggregated

event ClaimFromAggregated(address indexed lp, uint256 fromLoanIdx, uint256 toLoanIdx, uint256 repayments, uint256 collateral)

Parameters

Name Type Description
lp indexed address undefined
fromLoanIdx uint256 undefined
toLoanIdx uint256 undefined
repayments uint256 undefined
collateral uint256 undefined

NewSubPool

event NewSubPool(address loanCcyToken, address collCcyToken, uint256 loanTenor, uint256 maxLoanPerColl, uint256 r1, uint256 r2, uint256 liquidityBnd1, uint256 liquidityBnd2, uint256 minLoan, uint256 creatorFee)

Parameters

Name Type Description
loanCcyToken address undefined
collCcyToken address undefined
loanTenor uint256 undefined
maxLoanPerColl uint256 undefined
r1 uint256 undefined
r2 uint256 undefined
liquidityBnd1 uint256 undefined
liquidityBnd2 uint256 undefined
minLoan uint256 undefined
creatorFee uint256 undefined

Reinvest

event Reinvest(address indexed lp, uint256 repayments, uint256 newLpShares, uint256 earliestRemove, uint256 indexed loanIdx)

Parameters

Name Type Description
lp indexed address undefined
repayments uint256 undefined
newLpShares uint256 undefined
earliestRemove uint256 undefined
loanIdx indexed uint256 undefined

RemoveLiquidity

event RemoveLiquidity(address indexed lp, uint256 amount, uint256 removedLpShares, uint256 totalLiquidity, uint256 totalLpShares, uint256 indexed loanIdx)

Parameters

Name Type Description
lp indexed address undefined
amount uint256 undefined
removedLpShares uint256 undefined
totalLiquidity uint256 undefined
totalLpShares uint256 undefined
loanIdx indexed uint256 undefined

Repay

event Repay(address indexed borrower, uint256 loanIdx, uint256 repaymentAmountAfterFees)

Parameters

Name Type Description
borrower indexed address undefined
loanIdx uint256 undefined
repaymentAmountAfterFees uint256 undefined

Rollover

event Rollover(address indexed borrower, uint256 loanIdx, uint256 collateral, uint256 loanAmount, uint256 repaymentAmount, uint256 totalLpShares, uint256 indexed expiry)

Parameters

Name Type Description
borrower indexed address undefined
loanIdx uint256 undefined
collateral uint256 undefined
loanAmount uint256 undefined
repaymentAmount uint256 undefined
totalLpShares uint256 undefined
expiry indexed uint256 undefined

Errors

AlreadyRepaid

error AlreadyRepaid()

BeforeEarliestRemove

error BeforeEarliestRemove()

CannotClaimWithUnsettledLoan

error CannotClaimWithUnsettledLoan()

CannotRepayAfterExpiry

error CannotRepayAfterExpiry()

CannotRepayInSameBlock

error CannotRepayInSameBlock()

ErroneousLoanTerms

error ErroneousLoanTerms()

IdenticalLoanAndCollCcy

error IdenticalLoanAndCollCcy()

InsufficientLiquidity

error InsufficientLiquidity()

Invalid

error Invalid()

InvalidAddAmount

error InvalidAddAmount()

InvalidApprovalAddress

error InvalidApprovalAddress()

InvalidBaseAggrSize

error InvalidBaseAggrSize()

InvalidFee

error InvalidFee()

InvalidLiquidityBnds

error InvalidLiquidityBnds()

InvalidLoanIdx

error InvalidLoanIdx()

InvalidLoanTenor

error InvalidLoanTenor()

InvalidMaxLoanPerColl

error InvalidMaxLoanPerColl()

InvalidMinLiquidity

error InvalidMinLiquidity()

InvalidNewSharePointer

error InvalidNewSharePointer()

InvalidRateParams

error InvalidRateParams()

InvalidRecipient

error InvalidRecipient()

InvalidRemove

error InvalidRemove()

InvalidRollOver

error InvalidRollOver()

InvalidSendAmount

error InvalidSendAmount()

InvalidSubAggregation

error InvalidSubAggregation()

InvalidZeroAddress

error InvalidZeroAddress()

LoanBelowLimit

error LoanBelowLimit()

LoanIdxsWithChangingShares

error LoanIdxsWithChangingShares()

LoanTooSmall

error LoanTooSmall()

MustBeLp

error MustBeLp()

NonAscendingLoanIdxs

error NonAscendingLoanIdxs()

NothingToClaim

error NothingToClaim()

PastDeadline

error PastDeadline()

RepaymentAboveLimit

error RepaymentAboveLimit()

UnapprovedSender

error UnapprovedSender()

UnentitledFromLoanIdx

error UnentitledFromLoanIdx()

ZeroShareClaim

error ZeroShareClaim()