IOsTokenVaultEscrow

Git Source

Inherits: IMulticall

Author: StakeWise

Interface for OsTokenVaultEscrow contract

Functions

liqThresholdPercent

The liquidation threshold percent

function liqThresholdPercent() external view returns (uint64);

Returns

Name	Type	Description
<none>	uint64	The liquidation threshold percent starting from which the osToken shares can be liquidated

liqBonusPercent

The liquidation bonus percent

function liqBonusPercent() external view returns (uint256);

Returns

Name	Type	Description
<none>	uint256	The liquidation bonus percent paid for liquidating the osToken shares

authenticator

The address of the authenticator

function authenticator() external view returns (address);

Returns

Name	Type	Description
<none>	address	The address of the authenticator contract

getPosition

Get the position details

function getPosition(address vault, uint256 positionTicket) external view returns (address, uint256, uint256);

Parameters

Name	Type	Description
vault	address	The address of the vault
positionTicket	uint256	The exit position ticket

Returns

Name	Type	Description
<none>	address	owner The address of the assets owner
<none>	uint256	exitedAssets The amount of assets exited and ready to be claimed
<none>	uint256	osTokenShares The amount of osToken shares

register

Registers the new escrow position

function register(address owner, uint256 exitPositionTicket, uint256 osTokenShares, uint256 cumulativeFeePerShare)
    external;

Parameters

Name	Type	Description
owner	address	The address of the exited assets owner
exitPositionTicket	uint256	The exit position ticket
osTokenShares	uint256	The amount of osToken shares
cumulativeFeePerShare	uint256	The cumulative fee per share used to calculate the osToken fee

processExitedAssets

Claims exited assets from the vault to the escrow

function processExitedAssets(address vault, uint256 exitPositionTicket, uint256 timestamp, uint256 exitQueueIndex)
    external;

Parameters

Name	Type	Description
vault	address	The address of the vault
exitPositionTicket	uint256	The exit position ticket
timestamp	uint256	The timestamp of the exit
exitQueueIndex	uint256	The index of the exit in the queue

claimExitedAssets

Claims the exited assets from the escrow to the owner. Can only be called by the position owner.

function claimExitedAssets(address vault, uint256 exitPositionTicket, uint256 osTokenShares)
    external
    returns (uint256 claimedAssets);

Parameters

Name	Type	Description
vault	address	The address of the vault
exitPositionTicket	uint256	The exit position ticket
osTokenShares	uint256	The amount of osToken shares to burn

Returns

Name	Type	Description
claimedAssets	uint256	The amount of assets claimed

liquidateOsToken

Liquidates the osToken shares

function liquidateOsToken(address vault, uint256 exitPositionTicket, uint256 osTokenShares, address receiver)
    external;

Parameters

Name	Type	Description
vault	address	The address of the vault
exitPositionTicket	uint256	The exit position ticket
osTokenShares	uint256	The amount of osToken shares to liquidate
receiver	address	The address of the receiver of the liquidated assets

redeemOsToken

Redeems the osToken shares. Can only be called by the osToken redeemer.

function redeemOsToken(address vault, uint256 exitPositionTicket, uint256 osTokenShares, address receiver) external;

Parameters

Name	Type	Description
vault	address	The address of the vault
exitPositionTicket	uint256	The exit position ticket
osTokenShares	uint256	The amount of osToken shares to redeem
receiver	address	The address of the receiver of the redeemed assets

setAuthenticator

Updates the authenticator. Can only be called by the owner.

function setAuthenticator(address newAuthenticator) external;

Parameters

Name	Type	Description
newAuthenticator	address	The address of the new authenticator

updateLiqConfig

Updates the liquidation configuration. Can only be called by the owner.

function updateLiqConfig(uint64 _liqThresholdPercent, uint256 _liqBonusPercent) external;

Parameters

Name	Type	Description
_liqThresholdPercent	uint64	The liquidation threshold percent
_liqBonusPercent	uint256	The liquidation bonus percent

Events

PositionCreated

Event emitted on position creation

event PositionCreated(
    address indexed vault,
    uint256 indexed exitPositionTicket,
    address owner,
    uint256 osTokenShares,
    uint256 cumulativeFeePerShare
);

Parameters

Name	Type	Description
vault	address	The address of the vault
exitPositionTicket	uint256	The exit position ticket
owner	address	The address of the assets owner
osTokenShares	uint256	The amount of osToken shares
cumulativeFeePerShare	uint256	The cumulative fee per share used to calculate the osToken fee

ExitedAssetsProcessed

Event emitted on assets exit processing

event ExitedAssetsProcessed(
    address indexed vault, address indexed caller, uint256 indexed exitPositionTicket, uint256 exitedAssets
);

Parameters

Name	Type	Description
vault	address	The address of the vault
caller	address	The address of the caller
exitPositionTicket	uint256	The exit position ticket
exitedAssets	uint256	The amount of exited assets claimed

OsTokenLiquidated

Event emitted on osToken liquidation

event OsTokenLiquidated(
    address indexed caller,
    address indexed vault,
    uint256 indexed exitPositionTicket,
    address receiver,
    uint256 osTokenShares,
    uint256 receivedAssets
);

Parameters

Name	Type	Description
caller	address	The address of the function caller
vault	address	The address of the vault
exitPositionTicket	uint256	The exit position ticket
receiver	address	The address of the receiver of the liquidated assets
osTokenShares	uint256	The amount of osToken shares to liquidate
receivedAssets	uint256	The amount of assets received

OsTokenRedeemed

Event emitted on osToken redemption

event OsTokenRedeemed(
    address indexed caller,
    address indexed vault,
    uint256 indexed exitPositionTicket,
    address receiver,
    uint256 osTokenShares,
    uint256 receivedAssets
);

Parameters

Name	Type	Description
caller	address	The address of the function caller
vault	address	The address of the vault
exitPositionTicket	uint256	The exit position ticket
receiver	address	The address of the receiver of the redeemed assets
osTokenShares	uint256	The amount of osToken shares to redeem
receivedAssets	uint256	The amount of assets received

ExitedAssetsClaimed

Event emitted on exited assets claim

event ExitedAssetsClaimed(
    address indexed receiver,
    address indexed vault,
    uint256 indexed exitPositionTicket,
    uint256 osTokenShares,
    uint256 assets
);

Parameters

Name	Type	Description
receiver	address	The address of the receiver of the exited assets
vault	address	The address of the vault
exitPositionTicket	uint256	The exit position ticket
osTokenShares	uint256	The amount of osToken shares burned
assets	uint256	The amount of assets claimed

LiqConfigUpdated

Event emitted on liquidation configuration update

event LiqConfigUpdated(uint64 liqThresholdPercent, uint256 liqBonusPercent);

Parameters

Name	Type	Description
liqThresholdPercent	uint64	The liquidation threshold percent
liqBonusPercent	uint256	The liquidation bonus percent

AuthenticatorUpdated

Event emitted on authenticator update

event AuthenticatorUpdated(address newAuthenticator);

Parameters

Name	Type	Description
newAuthenticator	address	The address of the new authenticator

Structs

Position

Struct to store the escrow position details

struct Position {
    address owner;
    uint96 exitedAssets;
    uint128 osTokenShares;
    uint128 cumulativeFeePerShare;
}

Properties

Name	Type	Description
owner	address	The address of the assets owner
exitedAssets	uint96	The amount of assets exited and ready to be claimed
osTokenShares	uint128	The amount of osToken shares
cumulativeFeePerShare	uint128	The cumulative fee per share used to calculate the osToken fee