V2 Vaults Calculation

f (t) =

Vault.getTokenValue() at timestamp

t

t_{0} =

Timestamp at which vault was deployed or any timestamp before the first position is opened

f (t_{0}) = 1

Y e a r =

1 Year in seconds

= 31, 536, 000

S h a r e s (u) =

VaultToken.balanceOf(u) where u is the address of the user

P r i c e_{T} (t)

= Dollar value of the token

T

at timestamp

t

Vault performance

P

- Vault performance between 2 timestamps

t_{1}

and

t_{2}

P = \frac{f (t_{2})}{f (t_{1})} - 1

Vault Performance Since Inception

P

- Vault performance at timestamp

t_{1}

since inception

P = f (t_{1}) - 1

Converting Vault Performance to APR & APY

Let

P

be the vault performance between timestamps

t_{1}

and

t_{2}

and

P_{a p r}

P_{a p y}

be the corresponding APR & APY

N

- Number of periods required to complete a year

N = \frac{Y e a r}{t_{2} - t_{1}}

P_{a p r} = P N

P_{a p y} = (1 + P)^{N} - 1

User Balances & Yield Earned

Let

v_{A} (u, t)

be the total of value held by the user

u

in vault

A

at timestamp

t

in the deposit token

T

, and

V_{A} (u, t)

be its corresponding value in Dollars ($)

v_{A} (u, t) = S h a r e s_{A} (u) * f_{A} (t)

V_{A} (u, t) = v_{A} (u, t) * P r i c e_{T} (t)

Let

d_{A} (u)

be the sum of all value depositted by the user

u

to the vault

A

, and

w_{A} (u)

be the sum of all value withdrawn by the user

u

to the vault

A

Thus yield earned (in deposit token

T

) by the user

u

in vault

A

λ_{A} (u, t) = v_{A} (u, t) + w_{A} (u) - d_{A} (u)

Corresponding value in dollar terms

Λ_{A} (u, t) = λ_{A} (u, t) * P r i c e_{T} (t)

Following will give the total dollar value held by the user

u

across all vaults

\sum_{i = 1}^{n} V_{A_{i}} (u, t)

A_{1}

A_{n}

are different vaults

ROI of the User

ROI is a bit tricky to calculate

Let

t_{1}

be the timestamp in which the user

u

first deposits to the vault

A

, and user does a deposit or withdraw events in the following timestamps

t_{2}

t_{3}

,…,

t_{n}

Let

S h a r e s_{A, t_{a}, t_{b}} (u)

be the shares held by the user

u

in Vault

A

between timestamps

t_{a}

and

t_{b}

Given that, ROI of the user

u

in vault

A

can be calculated by,

R O I_{A} (u) = \frac{\sum_{i = 1}^{n - 1} (\frac{f (t_{i + 1})}{f (t_{i})} - 1) * S h a r e s_{A, t_{i}, t_{i} + 1} (u)}{\sum_{i = 1}^{n - 1} S h a r e s_{A, t_{i}, t_{i} + 1} (u)}

In the above equation

f (t_{i})

is the token value of the vault

A

at timestamp

t_{i}

Let

d_{A, t_{i}} (u)

be the total value user holds in the vault at timestamp

t_{i}

and no deposit/withdraw occurs till timestamp

t_{i + 1}

, then total yield earned by the user is

Y i e l d_{A} (u) = \sum_{i = 1}^{n - 1} (\frac{f (t_{i + 1})}{f (t_{i})} - 1) * d_{A, t_{i}} (u)

Current Deposit

Use Vault.totalFunds() + Vault.totalQueuedDeposits()

Vault.totalQueuedDeposits() is invalid for Basis Trading Vault, so use Vault.totalFunds() for Basis Trading Vault

From the contracts point of view, the vaults do not have maximum capacity. Instead this will be an off-chain value and when the vaults reach this value in deposits, it'll be paused for deposits.

Vault Transactions

All vaults have events for opening a position (OpenPosition) and closing a position (ClosePosition). Read the Natspec Documentation of these events for further details.

Further, Call Selling and Put Selling vaults have two additional events. One for adding additional collateral (AddCollateral) and one for settling options (SettleOption). Again please refer to the event documentations in the contracts repo. Example - Call Selling Vault

For the logic behind clubbing the event, please co-ordinate with Gautham and Abhishek. In my opinion, every event with the same strike ID can be clubbed together for Call Selling and Put Selling. Clubbing wouldn't make much sense for Gamma Vault and Basis Trading Vault.

Vault Positions

Vault.totalFunds() is the total funds under management.

Vault.usedFunds() is the total amount of funds being used for trading, managing etc…

Call Selling / Put Selling

Vault.liveStrikes() returns an array of strike IDs in which the vault have a position

Vault.positionDatas(strikeId) returns the position data of the strike ID strikeId. It returns the following data:

positionId - Corresponding Lyra Position ID
amount - Total amount of short position
collateral - Total collateral used for the position
premiumCollected - Total premium collected from this position, and this can be negative if the vault closes a position at a loss but not yet settled

Gamma Vault

Vault.positionData() returns the following data

strikeId - Current Strike ID being traded by the vault
positionId - Corresponding position ID
optionAmount - Amount of options held by the vault of strikeId
premiumPaid - Premium paid by the vault to purchase total amount of options
shortAmount - Amount of short position held by the vault in the underlying asset
totalMargin - Margin or collateral being used for holding the short position

Basis Trading

Vault.positionSize() will return the amount of short position in futures market held by the vault. Also vault will hold equal amount of underlying asset as well.

Margin will need to calculated from the Synthetix futures market contract. Will be included in the resolver.

Delta of the option with specific strikeId need to be calculated from the Lyra contracts. This will be included in the resolver.

One short position (

1 e 18 = 1

) will have a delta of

- 1

Total delta of the Gamma Vault can be calculated by the following

α * δ_{o p t i o n} - β

where

α =

optionAmount,

β =

shortAmount and

δ_{o p t i o n} =

delta of the option