SDL Pool Secondary
The SDLPoolSecondary
performs the same functions as the SDLPoolSecondary
with a few restrictions. Performing any state changes on reSDL positions including minting, burning, and updating requires the action to be queued at which point the NFT will be non-transferrable until an update is sent to the primary chain (updates are sent periodically). If there are no queued actions for an reSDL NFT, it can be transferred as normal.
This contract is deployed on all supported chains besides the primary chain.
ERC721 Functions
All standard IERC721 and IERC721Metadata functions are implemented for SDLPoolSecondary
View Functions
tokenPools
Returns the rewards pool for a token
Parameters
Return Values
supportedTokens
Returns a list of supported tokens
Return Values
isTokenSupported
Returns true/false to whether a given token is supported
Parameters
Return Values
tokenBalances
Returns balances of supported tokens within the controller
Return Values
staked
Returns an account's staked amount for use by reward pools controlled by this contract
Parameters
Return Values
totalStaked
Returns the total staked amount for use by reward pools controlled by this contract
Return Values
withdrawableRewards
Returns a list of withdrawable rewards for an account
Parameters
Return Values
sdlToken
Returns the address of the SDL token
Return Values
boostController
Returns the address of the boost controller
Return Values
lastLockId
Returns the id of the most recently minted lock
Return Values
ccipController
Returns the address of the CCIP controller for this contract
Return Values
effectiveBalanceOf
Returns the effective stake balance of an account (the effective stake balance includes the actual amount of tokens an account has staked across all locks plus any applicable boost gained by locking)
Parameters
Return Values
totalEffectiveBalance
Returns the sum of effective balances across all accounts
Return Values
getLocks
Returns the list of locks that corresponds to _lockIds
Parameters
Return Values
getLockIdsByOwner
Returns a list of lockIds owned by an account
Parameters
Return Values
queuedNewLockLimit
Returns the maximum number of queued new locks an account can have at one time
Return Values
updateBatchIndex
Returns the index of the current update batch
Return Values
queuedRESDLSupplyChange
Returns the current queued reSDL supply change to be sent in the next update
Return Values
getQueuedNewLocksByOwner
Returns a list of queued new locks for an owner
Parameters
Return Values
getQueuedLockUpdates
Returns queued lock updates for a list of lock ids
Parameters
Return Values
shouldUpdate
Returns whether an update should be sent to the primary chain
Return Values
updateInProgress
Returns whether a cross chain update is in progress
Return Values
Write Functions
distributeTokens
Distributes token balances to their respective rewards pools
Parameters
distributeToken
Distributes a token to its respective rewards pool
Parameters
withdrawRewards
Withdraws an account's earned rewards for a list of tokens
Parameters
addToken
Adds a new token
Parameters
removeToken
Removes a supported token
Parameters
setBaseURI
Sets the base URI for all tokens
Parameters
setBoostController
Sets the boost controller
Parameters
setCCIPController
Sets the CCIP controller
Parameters
onTokenTransfer
ERC677 implementation to stake/lock SDL tokens or distribute rewards
Parameters
extendLockDuration
Extends the locking duration of a lock
Parameters
initiateUnlock
Initiates the unlock period for a lock
Parameters
withdraw
Withdraws unlocked SDL
Parameters
executeQueuedOperations
Executes queued operations for the sender
Parameters
handleOutgoingRESDL
Handles the outgoing transfer of an reSDL lock to another chain
Parameters
Return Values
handleIncomingRESDL
Handles the incoming transfer of an reSDL lock from another chain
Parameters
handleOutgoingUpdate
Handles an outgoing update to the primary chain
Return Values
handleIncomingUpdate
Handles an incoming update from the primary chain
Parameters
Last updated