STETHVault

A Vault that uses variable weekly yields to buy strangles. It uses Lido as a yield source.

src: https://github.com/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol

Public State Variables

INVESTOR_RATIO

https://github.com/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L27

function INVESTOR_RATIO() external view returns (uint256)

INVESTOR_RATIO is the proportion that the weekly yield will be split The precision of this number is set by the variable DENOMINATOR. 5000 is equivalent to 50%.

Returns

Name	Type	Description
_0	uint256	investor ratio value

investor

https://github.com/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L28

function investor() external view returns (address)

Returns the investor's wallet. Investor is the role responsible for buying weekly options.

Returns

Name	Type	Description
_0	address	investor address

sharePriceDecimals

https://github.com/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L29

function sharePriceDecimals() external view returns (uint8)

Returns

Name	Type	Description
_0	uint8	share price decimals

lastRoundAssets

https://github.com/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L30

function lastRoundAssets() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	Total assets in the end of the last round

lastSharePrice

https://github.com/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L31

function lastSharePrice() external view returns (uint256 numerator, uint256 denominator)

Returns

Name	Type	Description
numerator	uint256	Share Price in the end of the last round
denominator	uint256	undefined

View Methods

assetsOf

https://github.dev/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L63

function assetsOf(address owner) external view returns (uint256)

Outputs the amount of asset tokens of an owner are either waiting for the next round, deposited or committed.

Parameters

Name	Type	Description
owner	address	owner address

Returns

Name	Type	Description
_0	uint256	amount of assets

sharePrice

https://github.dev/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L75

function sharePrice() external view returns (uint256)

Return the stETH price per share

Each share is considered to be 10^(assets.decimals()) The share price represents the amount of stETH needed to mint one vault share. When the number of vault shares that has been minted thus far is zero, the share price should simply be the ratio of the underlying asset's decimals to the vault's decimals.

Returns

Name	Type	Description
_0	uint256	Current Share Price

Write Methods

depositWithPermit

https://github.dev/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L82

function depositWithPermit(uint256 assets, address receiver, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external nonpayable returns (uint256)

Deposit ERC20 tokens with permit, a gasless token approval.

Mints shares to receiver by depositing exactly amount of underlying tokens. For more information on the signature format, see the EIP2612 specification: https://eips.ethereum.org/EIPS/eip-2612#specification

Parameters

Name	Type	Description
assets	uint256	Amount of assets
receiver	address	Receiver address
deadline	uint256	timestamp deadline
v	uint8	transaction signature v
r	bytes32	transaction signature r
s	bytes32	transaction signature s

Returns

Name	Type	Description
_0	uint256	share amount

mintWithPermit

https://github.dev/pods-finance/yield-contracts/blob/main/contracts/vaults/STETHVault.sol#L96

function mintWithPermit(uint256 shares, address receiver, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external nonpayable returns (uint256)

Mint shares with permit, a gasless token approval.

Mints exactly shares to receiver by depositing amount of underlying tokens. For more information on the signature format, see the EIP2612 specification: https://eips.ethereum.org/EIPS/eip-2612#specification

Parameters

Name	Type	Description
assets	uint256	Amount of assets
receiver	address	Receiver address
deadline	uint256	timestamp deadline
v	uint8	transaction signature v
r	bytes32	transaction signature r
s	bytes32	transaction signature s

Returns

Name	Type	Description
_0	uint256	underlying tokens amount