Class OptionPSAPI

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

Hierarchy

BaseAPI
- OptionPSAPI

Index

Constructors

constructor

new OptionPSAPI(premia): OptionPSAPI
Construct a new BaseAPI object.
Parameters
- premia: Premia
  
  An instance of the Premia SDK.
Returns OptionPSAPI
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

encodeCancelExercise

encodeCancelExercise(optionPSAddress, strike, maturity, contractSize): Promise<ContractTransaction>
Returns a promise containing a populated transaction to cancel option exercise before maturity. Allows the user to use the SDK without providing a signer.
Parameters
- optionPSAddress: string
  
  {string} Contract address of the option.
- strike: bigint
  
  {bigint} strike price of the option.
- maturity: bigint
  
  {bigint} maturity of the option
- contractSize: bigint
  
  {bigint} size of the option to exercise.
Returns Promise<ContractTransaction>
Promise containing the contract transaction.
- Defined in src/api/optionPSAPI.ts:81

encodeExercise

encodeExercise(optionPSAddress, strike, maturity, contractSize): Promise<ContractTransaction>
Returns a promise containing a populated transaction to exercise an option. Allows the user to use the SDK without providing a signer.
Parameters
- optionPSAddress: string
  
  {string} Contract address of the option.
- strike: bigint
  
  {bigint} strike price of the option.
- maturity: bigint
  
  {bigint} maturity of the option
- contractSize: bigint
  
  {bigint} size of the option to exercise.
Returns Promise<ContractTransaction>
Promise containing the contract transaction.
- Defined in src/api/optionPSAPI.ts:57

encodeSettleLong

encodeSettleLong(optionPSAddress, strike, maturity, contractSize): Promise<ContractTransaction>
Returns a promise containing a populated transaction to settle the exercised long options held by the caller. Allows the user to use the SDK without providing a signer.
Parameters
- optionPSAddress: string
  
  {string} Contract address of the option.
- strike: bigint
  
  {bigint} strike price of the option.
- maturity: bigint
  
  {bigint} maturity of the option
- contractSize: bigint
  
  {bigint} size of the option to settle.
Returns Promise<ContractTransaction>
Promise containing the contract transaction.
- Defined in src/api/optionPSAPI.ts:105

encodeSettleShort

encodeSettleShort(optionPSAddress, strike, maturity, contractSize): Promise<ContractTransaction>
Returns a promise containing a populated transaction to settle the short options held by the caller. Allows the user to use the SDK without providing a signer.
Parameters
- optionPSAddress: string
  
  {string} Contract address of the option.
- strike: bigint
  
  {bigint} strike price of the option.
- maturity: bigint
  
  {bigint} maturity of the option
- contractSize: bigint
  
  {bigint} size of the option to settle.
Returns Promise<ContractTransaction>
Promise containing the contract transaction.
- Defined in src/api/optionPSAPI.ts:129

getExerciseCost

getExerciseCost(optionAddress, strike, contractSize): Promise<[bigint, bigint] & {
fee: bigint;
totalExerciseCost: bigint;
}>
get the amount of exerciseToken to pay to exercise the given amount of contracts
Parameters
- optionAddress: string
  
  The address of the option.
- strike: bigint
  
  The strike price of the option.
- contractSize: bigint
  
  The size of the option.
Returns Promise<[bigint, bigint] & {
fee: bigint;
totalExerciseCost: bigint;
}>
The amount of exerciseToken to pay to exercise the given amount of contracts
- Defined in src/api/optionPSAPI.ts:19

getExerciseValue

getExerciseValue(optionAddress, strike, contractSize): Promise<bigint>
get the amount of collateral that would be received for a given amount of long tokens
Parameters
- optionAddress: string
  
  The address of the option.
- strike: bigint
  
  The strike price of the option.
- contractSize: bigint
  
  The size of the option.
Returns Promise<bigint>
The amount of collateral that would be received for a given amount of long tokens
- Defined in src/api/optionPSAPI.ts:38

Class OptionPSAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

premia: Premia

Returns OptionPSAPI

Properties

Readonly premia

Protected streamIndex

Methods

cancelAllStreams

Returns Promise<void>

encodeCancelExercise

Parameters

optionPSAddress: string

strike: bigint

maturity: bigint

contractSize: bigint

Returns Promise<ContractTransaction>

encodeExercise

Parameters

optionPSAddress: string

strike: bigint

maturity: bigint

contractSize: bigint

Returns Promise<ContractTransaction>

encodeSettleLong

Parameters

optionPSAddress: string

strike: bigint

maturity: bigint

contractSize: bigint

Returns Promise<ContractTransaction>

encodeSettleShort

Parameters

optionPSAddress: string

strike: bigint

maturity: bigint

contractSize: bigint

Returns Promise<ContractTransaction>

getExerciseCost

Parameters

optionAddress: string

strike: bigint

contractSize: bigint

Returns Promise<[bigint, bigint] & { fee: bigint; totalExerciseCost: bigint; }>

getExerciseValue

Parameters

optionAddress: string

strike: bigint

contractSize: bigint

Returns Promise<bigint>

Settings

Member Visibility

Theme

On This Page

`Readonly` premia

`Protected` streamIndex

Returns Promise<[bigint, bigint] & {
fee: bigint;
totalExerciseCost: bigint;
}>