Variables

State Variables
The contract calculates and manages the following variables:
​StrikeReservesnStrikeReserves_nStrikeReservesn​

The total amount of strike asset balance in an instant before an action takes place. This factor allows visibility on the updated yield generating tokens that may be used as collateral. This variable is not stored on the option contract but on the ERC20 token assigned to be the strike asset.
​StrikeReservesiStrikeReserves_iStrikeReservesi​

The total amount of strike asset balance in an instant after an action takes place. This variable is not stored on the option contract but on the ERC20 token assigned to be the strike asset.
​UnderlyingReservesnUnderlyingReserves_nUnderlyingReservesn​

The total amount of underlying asset balance in an instant before an action takes place. Underlying assets can also accrue interest. nnn
 stands for "new".
​UnderlyingReservesiUnderlyingReserves_iUnderlyingReservesi​

The total underlying asset balance after the action took place in a block. 
​OwnerSharesiOwnerShares_iOwnerSharesi​

Weighted user's funds served as collateral in light of the current option contract situation. 
​OwnerSharestOwnerShares_t OwnerSharest​

This factor updates the current total amount of User Weighted Balance.
​TotalSharesiTotalShares_iTotalSharesi​

This factor represents the sum of all user's sharesishares_isharesi​
. 
​OwnerMintedOptionsOwnerMintedOptionsOwnerMintedOptions

Total of options token on the same option series minted by the same user.
Auxiliary Variables
​OptionsAmountOptionsAmountOptionsAmount
 
Parameter asked at the beginning of minting an option. Describes how many options the user wants to mint and will be used to calculate the collateral requirement further. 
​AmountToTransferAmountToTransferAmountToTransfer
 
The total amount of funds (either in strike asset or underlying asset) that will be transferred to the contract to be locked as collateral to mint the requested option amount.
​StrikeToSendStrikeToSendStrikeToSend
 
The variable that will calculate the amount of strike a user will unmint and remove from an unminting of a put. It means how much strike asset the contract will have to send to the user in the unminting process.
​UnderlyingToSendUnderlyingToSendUnderlyingToSend

The variable that calculates the amount of underlying asset a user will remove from calling the unminting function on a call option token. Meaning how much underlying asset the contract will have to send to the user in the unminting process.
​OwnerSharesToReducewOwnerSharesToReduce_wOwnerSharesToReducew​

This variable calculates how much of the collateral that a user currently holds will be removed from the process of unminting options.
Glossary Comparison
Find below the variables matching the contract names.
Documentation / Whitepaper
Code
File
 StrikeReservesnStrikeReserves_nStrikeReservesn​
​
strikeReserves
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​UnderlyingReservesnUnderlyingReserves_nUnderlyingReservesn​
 
underlyingReserves
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​OwnerSharesiOwnerShares_iOwnerSharesi​
 
ownerShares
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​TotalSharesiTotalShares_iTotalSharesi​
​
totalShares
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​OwnerMintedOptionsOwnerMintedOptionsOwnerMintedOptions
 
userMintedOptions
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​OptionsAmountOptionsAmountOptionsAmount
 
optionsAmount
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​AmountToTransferAmountToTransferAmountToTransfer
 
amountToTransfer
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​StrikeToSendStrikeToSendStrikeToSend
  
strikeToSend
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​UnderlyingToSendUnderlyingToSendUnderlyingToSend
 
underlyingToSend
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​OwnerSharesToReducewOwnerSharesToReduce_wOwnerSharesToReducew​
 
ownerSharesToReduce
(W)PodPut.sol / (W)PodCall.sol / PodOption.sol
​

Options - Previous

Options Instrument

Functions

Last modified 1yr ago

Copy link

On this page

State Variables

Auxiliary Variables

Glossary Comparison