Class OptionRewardAPI

Represents a class for handling pool operations related to the voidnode server and the pool contracts.

Hierarchy

BaseAPI
- OptionRewardAPI

Index

Constructors

Properties

premia streamIndex

Methods

cancelAllStreams encodeClaimRewards encodeClaimRewardsSync

Constructors

constructor

new OptionRewardAPI(premia): OptionRewardAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns OptionRewardAPI
Inherited from BaseAPI.constructor
- Defined in src/api/baseAPI.ts:25

Properties

`Readonly` premia

premia: Premia

The Premia SDK instance.

`Protected` streamIndex

streamIndex: number = 0

The current index of quote streams. Used to cancel stale streams.

Methods

cancelAllStreams

cancelAllStreams(): Promise<void>
Cancels all ongoing streams.

Returns Promise<void>
Inherited from BaseAPI.cancelAllStreams
- Defined in src/api/baseAPI.ts:34

encodeClaimRewards

encodeClaimRewards(strike, maturity, provider?): Promise<ContractTransaction>
Returns a promise containing a populated transaction to claim rewards from option. Allows the user to use the SDK without providing a signer.
Parameters
- strike: bigint
  
  {bigint} strike price of the option.
- maturity: bigint
  
  {bigint} maturity of the option
- Optional provider: Provider
Returns Promise<ContractTransaction>
Promise containing the contract transaction.
- Defined in src/api/optionRewardAPI.ts:18

encodeClaimRewardsSync

encodeClaimRewardsSync(strike, maturity, provider?): TransactionData
Returns a promise containing a populated transaction to claim rewards from option. Allows the user to use the SDK without providing a signer.
Parameters
- strike: bigint
  
  {bigint} strike price of the option.
- maturity: bigint
  
  {bigint} maturity of the option
- Optional provider: Provider
Returns TransactionData
The encoded transaction data.
- Defined in src/api/optionRewardAPI.ts:33

Generated using TypeDoc