Data Variables & Maps

🗝️ epoch-info

The epoch-info map holds all the data-points necessary to describe the option for one epoch. It maps the epoch-id to:

  • the epoch-expiry UNIX timestamp in milliseconds representing the expiry date of the option

  • the strike-call price for the option (see glossary)

  • he strike-put price for the option (see glossary)

  • the barrier-up price for the knock-out/in level to the upside

  • the barrier-down price for the knock-out/in level to the downside

  • the unit-pnl indicating the satoshi value of the option after expiry

  • the settlement-rate indicating the underlying price (i.e. BTCUSD) used for settling the epoch

  • the block-height-pnl indicating the Bitcoin burn-block-height of the pnl calculation

  • the block-height-settled indicating the Bitcoin burn-block-height of the settlement

  • the total-units-transacted indicating the total amount of option units bought for the epoch

  • the total-premium indicating the total amount of underlying paid by the vault for all premium payments

  • the total-underlying-active indicating the sum of all active underlying in the vault at the beginning of the epoch

  • the underlying-per-token-settled indicating the ratio between underlying and token at the end of the epoch

  • the epoch-risk indicating the maximum amount of risk the strategy took in the epoch (measured in basis point of total-underlying-active)

  • the unit-size indicating the amount of satoshis one option unit represents

The current-epoch-id variable holds a uint number representing the epoch-id of the current epoch.

🗝️ counterparty-info

Maps every counterparty principal to:

  • units-registered: the number of options registered for trading

  • price-registered: the registered option price per Bitcoin (Note: the unit price is the option-price-per-bitcoin adjusted by the unit-size)

  • block-height-registered: the Stacks block-height of the registration transaction

  • units-transacted: the units of options sold by the principal

  • amount-requested: the amount of satoshis requested if the option is in-the-money (ITM) at expiry

A list of all the principals that act as option counterparties to the contract. The list gets updated by confirm-trade and make-payment.

🗝️ delinquent-counterparty-info

Maps every delinquent counterparty principal to:

  • amount-requested: the amount of satoshis requested for the in-the-money (ITM) option

  • units-transacted: the units of options sold by the principal

  • epoch-expiry: the epoch-expiry of the epoch in which the counterparty failed to make the pnl payment

A list of all the principals that act as delinquent option counterparties to the contract. The list gets updated by add-delinquent-counterparty and make-delayed-payment.

A boolean value indicating if the current epoch is delinquent.

The amount of underlying that is available for trading (option purchases) during the upcoming epoch.

The amount is determined by multiplying epoch-risk by the total-underling-active in the vault contract, ensuring that the contract can never trade more than is defined by epoch-risk.

The amount of underlying registered to a trade.

The amount of underlying requested to be paid by the counterparties.

PreviousCoreNextFunctions

Last updated