Source Code Docs
IUltraLRT
hasRole
HARVESTER
AffineDelegator
Delegator contract for stETH on Eigenlayer
vault
asset
onlyVaultOrHarvester
Modifier to allow function calls only from the vault or harvester
onlyVault
Modifier to allow function calls only from the vault
onlyHarvester
Modifier to allow function calls only from the harvester
delegate
Delegate & restake stETH to operator
_delegate
Delegate stETH to operator
requestWithdrawal
Request withdrawal from eigenlayer
Request withdrawal from eigenlayer
Parameters
_requestWithdrawal
Request withdrawal from eigenlayer
withdraw
Withdraw stETH from delegator to vault
totalLockedValue
Get total locked value
Return Values
withdrawableAssets
Get withdrawable assets
Return Values
queuedAssets
Get queued assets
Return Values
AffineReStaking
initialize
_authorizeUpgrade
_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}.
APPROVED_TOKEN
WETH
balance
depositPaused
whenDepositNotPaused
pauseDeposit
resumeDeposit
approveToken
revokeToken
Deposit
depositFor
depositETHFor
Withdraw
withdraw
pause
Pause the contract
unpause
Unpause the contract
IDelegatorBeacon
owner
DelegatorBeacon
Delegator Beacon contract
beacon
blueprint
constructor
Constructor
Parameters
update
Update the blueprint
Parameters
implementation
Get the implementation address
Return Values
IDelegatorFactory
createDelegator
vault
DelegatorFactory
Delegator Factory contract
vault
onlyVault
Modifier to allow function calls only from the vault
constructor
Constructor
Parameters
createDelegator
Create a new delegator
Parameters
Return Values
EigenDelegator
Delegator contract for stETH on Eigenlayer
STRATEGY_MANAGER
StrategyManager for Eigenlayer
DELEGATION_MANAGER
DelegationManager for Eigenlayer
STAKED_ETH_STRATEGY
stETH strategy on Eigenlayer
withdrawals
initialize
Initialize the contract
Parameters
currentOperator
stETH
queuedShares
_delegate
Modifier to allow function calls only from the vault or harvester
Delegate & restake stETH to operator on Eigenlayer
Parameters
_requestWithdrawal
Request withdrawal from eigenlayer
Parameters
completeWithdrawalRequest
Complete withdrawal request
Parameters
recordWithdrawalsRequest
Record withdrawal request from External requests
Parameters
withdraw
Withdraw stETH from delegator to vault
withdrawableAssets
Get withdrawable assets
Return Values
queuedAssets
Get queued assets
Return Values
_delegateToOperator
Delegate to operator
IDelegator
requestWithdrawal
checkAssetAvailability
delegate
withdraw
totalLockedValue
withdrawableAssets
queuedAssets
SymDelegatorFactory
SymDelegator Factory contract
vault
onlyVault
Modifier to allow function calls only from the vault
constructor
Constructor
Parameters
createDelegator
Create a new delegator
Parameters
Return Values
SymbioticDelegator
Delegator contract for wStETH on Symbiotic
collateral
initialize
Initialize the contract
Parameters
_delegate
Delegate & restake wStETH to operator on Symbiotic
Parameters
_requestWithdrawal
Request withdrawal from Symbiotic
Parameters
withdrawableAssets
Get the withdrawable assets
Return Values
queuedAssets
Get the queued assets
Return Values
UltraLRT
UltraLRT is a liquid staking vault that allows users to deposit staked assets and receive shares in return. The shares can be redeemed for the underlying assets at any time. Vault will delegate the assets to the delegators and harvest the profit. The vault will also distribute the profits to the holders.
initialize
Initialize the UltraLRT contract
Parameters
_authorizeUpgrade
Upgrade the UltraLRT contract
Parameters
maxDeposit
The maximum amount of assets that can be deposited into the vault
See {IERC4262-maxDeposit}.
Return Values
maxMint
The maximum amount of shares that can be minted
See {IERC4262-maxMint}.
Return Values
setDelegatorFactory
set the delegator factory
factory must have the vault set to this vault
Parameters
setMaxUnresolvedEpochs
set max unresolved epoch
delegation of assets will be stopped if the unresolved epoch is greater than the max unresolved epoch
Parameters
pause
Pause the contract
unpause
Unpause the contract
initialSharesPerAsset
The amount of shares to mint per wei of asset
at genesis.
_initialShareDecimals
Each wei of asset
at genesis is worth 10 ** (initialShareDecimals) shares.
pauseDeposit
Pause the deposit
unpauseDeposit
Unpause the deposit
deposit
Deposit assets into the vault
Parameters
Return Values
mint
mint specific amount of shares
Parameters
Return Values
withdraw
Withdraw assets from the vault
See {IERC4262-withdraw}.
Parameters
Return Values
redeem
Redeem shares from the vault
See {IERC4262-redeem}.
Parameters
Return Values
_withdraw
withdraw from the vault
Parameters
canWithdraw
Check if the withdrawal can be done
Parameters
Return Values
setWithdrawalEscrow
Set the withdrawal escrow
The escrow must have the vault set to this vault @dev existing escrow debt must be zero
Parameters
endEpoch
End the current epoch
Only the harvester can end the epoch anytime for other The epoch can only be ended if the last epoch was ended at least LOCK_INTERVAL
seconds ago
liquidationRequest
Do liquidation request to delegators
Only the harvester can do the liquidation request
Parameters
_liquidationRequest
Do liquidation request to delegators
Parameters
delegatorWithdrawRequest
Withdraw from speicific delegator
Parameters
resolveDebt
Resolve the debt
createDelegator
Create a new delegator
Parameters
dropDelegator
Drop a delegator
Parameters
harvest
Harvest the profit
collectDelegatorDebt
Collect the delegator debt
will withdraw the liquid assets from the delegators
withdrawFromDelegator
TODO check for price change on profit and loss
_getDelegatorLiquidAssets
Get the delegator liquid assets
Each time this will check the vault assets, if it meets required assets then it will stop
Parameters
delegateToDelegator
Delegate the assets to the delegator
Parameters
lockedProfit
Current locked profit amount.
Profit unlocks uniformly over LOCK_INTERVAL
seconds after the last harvest
totalAssets
Get the total assets
vaultAssets
Get the vault liquid assets
setManagementFee
Set the management fee
setWithdrawalFee
Set the withdrawal fee
getRate
returns the per share assets
UltraLRTRouter
handle deposits from native, weth, stEth, wStEth to vaults
weth
stEth
wStEth
permit2
initialize
Initialize the contract
Parameters
_authorizeUpgrade
Upgrade the contract
Parameters
pause
Pause the contract
unpause
Unpause the contract
receive
Fallback function to receive native tokens
depositNative
Deposit native tokens to vault
Parameters
_processNativeDeposit
Deposit native tokens to vault
Parameters
_receiveAssetFromThroughPermit2
Receive asset from user through permit2
Parameters
depositWeth
Deposit WETH to vault
Parameters
depositStEth
Deposit stETH to vault
Parameters
depositWStEth
Deposit wStETH to vault
Parameters
_processDepositFromStEth
Process deposit from stEth
Parameters
_depositStEthToVault
Deposit stEth to vault
Parameters
_depositWStEthToVault
Deposit wStEth to vault
Parameters
UltraLRTStorage
DelegatorInfo
GUARDIAN_ROLE
HARVESTER
MAX_BPS
MAX_DELEGATOR
ST_ETH_TRANSFER_BUFFER
depositPaused
STETH
escrow
beacon
delegatorFactory
delegatorAssets
managementFee
Fee charged to vault over a year, number is in bps
withdrawalFee
Fee charged on redemption of shares, number is in bps
lastHarvest
A timestamp representing when the most recent harvest occurred.
Since the time since the last harvest is used to calculate management fees, this is set to block.timestamp
(instead of 0) during initialization.
maxLockedProfit
The amount of profit originally locked after harvesting from a strategy
LOCK_INTERVAL
Amount of time in seconds that profit takes to fully unlock. See lockedProfit().
delegatorQueue
delegatorMap
delegatorCount
lastEpochTime
maxUnresolvedEpochs
whenDepositNotPaused
WithdrawalEscrowV2
Escrow contract for withdrawal requests
asset
The vault asset.
vault
The vault this escrow attached to.
userDebtShare
EpochInfo
currentEpoch
resolvingEpoch
totalDebt
epochInfo
constructor
Parameters
onlyVault
Modifier to allow function calls only from the vault
onlyGovernance
Modifier to allow function calls only from the governance
WithdrawalRequest
Withdrawal Request event
will makes things easy to search for each user withdrawal requests
Parameters
registerWithdrawalRequest
Register withdrawal request as debt
Parameters
endEpoch
End the epoch
will be called by the vault after closing a position
getDebtToResolve
Get the debt to resolve
Return Values
resolveDebtShares
resolve the locked shares for current epoch
This function will be triggered after closing a position will check for available shares to burn after resolving vault will send the assets to escrow and burn the share
redeemMultiEpoch
Redeem multiple epochs
Parameters
Return Values
redeem
Redeem withdrawal request
Parameters
Return Values
_epochSharesToAssets
Convert epoch shares to assets
Parameters
Return Values
canWithdraw
Check if an epoch is completed or not
Parameters
Return Values
withdrawableAssets
Get withdrawable assets of a user
Parameters
Return Values
withdrawableShares
Get withdrawable shares of a user
Parameters
Return Values
getAssets
Get total withdrawable assets of a user for multiple epochs
Parameters
Return Values
sweep
sweep the assets to governance
only use case in case of emergency
Parameters
Last updated