Class Option

Represents an exercisable option in the Valorem Clear system.

Hierarchy (view full)

OptionType
- Option

Index

Constructors

constructor

new Option(args): Option
Constructs an Option instance with the given arguments.
Parameters
- args: OptionArgs
Returns Option
Overrides OptionType.constructor
- Defined in src/entities/options/exercisable-option.ts:26

Properties

`Readonly` exerciseAsset

exerciseAsset: SupportedAsset

optionInfo

optionInfo: OptionTypeInfo

optionTypeId

optionTypeId: bigint

tokenId

tokenId: bigint

tokenType

tokenType: 0 | 1

typeExists

typeExists: boolean

`Readonly` underlyingAsset

underlyingAsset: SupportedAsset

Accessors

exerciseIsStable

get exerciseIsStable(): boolean
Returns boolean
Inherited from OptionType.exerciseIsStable
- Defined in src/entities/assets/asset-pair.ts:18

stableAsset

get stableAsset(): SupportedAsset
Returns SupportedAsset
Inherited from OptionType.stableAsset
- Defined in src/entities/assets/asset-pair.ts:22

volatileAsset

get volatileAsset(): SupportedAsset
Returns SupportedAsset
Inherited from OptionType.volatileAsset
- Defined in src/entities/assets/asset-pair.ts:26

Methods

createOptionType

createOptionType(trader): Promise<void>
Creates a new option type on-chain using the trader instance.
Parameters
- trader: Trader
  Trader instance to execute the transaction.
Returns Promise<void>
Inherited from OptionType.createOptionType
- Defined in src/entities/options/option-type.ts:59

exerciseOption

exerciseOption(__namedParameters): Promise<undefined>
Exercises the option for the specified amount using the provided trader.
Parameters
- __namedParameters: {
  amount: bigint;
  trader: Trader;
  }
  - amount: bigint
  - trader: Trader
Returns Promise<undefined>
- Defined in src/entities/options/exercisable-option.ts:37

`Static` fromId

fromId(optionId, clearinghouse): Promise<Option>
Static method to create an Option instance from a token ID.
Parameters
- optionId: bigint
  The unique identifier for the option.
- clearinghouse: ClearinghouseContract
  The ClearinghouseContract instance to interact with the blockchain.
Returns Promise<Option>
An instance of Option.
Overrides OptionType.fromId
- Defined in src/entities/options/exercisable-option.ts:73

`Static` fromInfo

fromInfo(__namedParameters): Promise<OptionType>
Static method to create an OptionType instance from option information.
Parameters
- __namedParameters: {
  clearinghouse: ClearinghouseContract;
  optionInfo: OptionTypeInfo;
  }
  - clearinghouse: ClearinghouseContract
  - optionInfo: OptionTypeInfo
Returns Promise<OptionType>
An instance of OptionType.
Inherited from OptionType.fromInfo
- Defined in src/entities/options/option-type.ts:92

`Static` fromSubgraph

fromSubgraph(__namedParameters): OptionType
Parameters
- __namedParameters: {
  chainId: 42161 | 421614 | 31337;
  subgraphOptionType: SubgraphOptionType;
  }
  - chainId: 42161 | 421614 | 31337
  - subgraphOptionType: SubgraphOptionType
Returns OptionType
Inherited from OptionType.fromSubgraph
- Defined in src/entities/options/option-type.ts:141

`Static` getOptionTypeId

getOptionTypeId(info): bigint
Generates a unique option type ID based on the provided option type information.
Parameters
- info: OptionTypeInfo
  The information detailing the option type.
Returns bigint
The generated option type ID.
Inherited from OptionType.getOptionTypeId
- Defined in src/entities/options/option-type.ts:214

`Static` `Protected` getOptionTypeInfo

getOptionTypeInfo(tokenId, clearinghouse): Promise<{
    exerciseAmount: bigint;
    exerciseAsset: `0x${string}`;
    exerciseTimestamp: number;
    expiryTimestamp: number;
    nextClaimKey: bigint;
    settlementSeed: bigint;
    underlyingAmount: bigint;
    underlyingAsset: `0x${string}`;
}>
Retrieves the option type information from the clearinghouse contract.
Parameters
- tokenId: bigint
  The unique identifier of the option or claim.
- clearinghouse: ClearinghouseContract
  The clearinghouse contract instance.
Returns Promise<{
    exerciseAmount: bigint;
    exerciseAsset: `0x${string}`;
    exerciseTimestamp: number;
    expiryTimestamp: number;
    nextClaimKey: bigint;
    settlementSeed: bigint;
    underlyingAmount: bigint;
    underlyingAsset: `0x${string}`;
}>
The option type information.
Inherited from OptionType.getOptionTypeInfo
- Defined in src/entities/options/option-type.ts:189

`Static` `Protected` getTokenType

getTokenType(tokenId, clearinghouse): Promise<0 | 2 | 1>
Determines the token type for the given ID by querying the clearinghouse.
Parameters
- tokenId: bigint
  The unique identifier of the option or claim.
- clearinghouse: ClearinghouseContract
  The clearinghouse contract instance.
Returns Promise<0 | 2 | 1>
The token type as a promise that resolves to 0, 1, or 2.
Inherited from OptionType.getTokenType
- Defined in src/entities/options/option-type.ts:202

Class Option

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

args: OptionArgs

Returns Option

Properties

Readonly exerciseAsset

optionInfo

optionTypeId

tokenId

tokenType

typeExists

Readonly underlyingAsset

Accessors

exerciseIsStable

Returns boolean

stableAsset

Returns SupportedAsset

volatileAsset

Returns SupportedAsset

Methods

createOptionType

Parameters

trader: Trader

Returns Promise<void>

exerciseOption

Parameters

__namedParameters: { amount: bigint; trader: Trader; }

amount: bigint

trader: Trader

Returns Promise<undefined>

Static fromId

Parameters

optionId: bigint

clearinghouse: ClearinghouseContract

Returns Promise<Option>

Static fromInfo

Parameters

__namedParameters: { clearinghouse: ClearinghouseContract; optionInfo: OptionTypeInfo; }

clearinghouse: ClearinghouseContract

optionInfo: OptionTypeInfo

Returns Promise<OptionType>

Static fromSubgraph

Parameters

__namedParameters: { chainId: 42161 | 421614 | 31337; subgraphOptionType: SubgraphOptionType; }

chainId: 42161 | 421614 | 31337

subgraphOptionType: SubgraphOptionType

Returns OptionType

Static getOptionTypeId

Parameters

info: OptionTypeInfo

Returns bigint

Static Protected getOptionTypeInfo

Parameters

tokenId: bigint

clearinghouse: ClearinghouseContract

Returns Promise<{ exerciseAmount: bigint; exerciseAsset: `0x${string}`; exerciseTimestamp: number; expiryTimestamp: number; nextClaimKey: bigint; settlementSeed: bigint; underlyingAmount: bigint; underlyingAsset: `0x${string}`; }>

Static Protected getTokenType

Parameters

tokenId: bigint

clearinghouse: ClearinghouseContract

Returns Promise<0 | 2 | 1>

Settings

Member Visibility

Theme

On This Page

`Readonly` exerciseAsset

`Readonly` underlyingAsset

__namedParameters: {
amount: bigint;
trader: Trader;
}

`Static` fromId

`Static` fromInfo

__namedParameters: {
clearinghouse: ClearinghouseContract;
optionInfo: OptionTypeInfo;
}

`Static` fromSubgraph

__namedParameters: {
chainId: 42161 | 421614 | 31337;
subgraphOptionType: SubgraphOptionType;
}

`Static` getOptionTypeId

`Static` `Protected` getOptionTypeInfo

Returns Promise<{
exerciseAmount: bigint;
exerciseAsset: `0x${string}`;
exerciseTimestamp: number;
expiryTimestamp: number;
nextClaimKey: bigint;
settlementSeed: bigint;
underlyingAmount: bigint;
underlyingAsset: `0x${string}`;
}>

`Static` `Protected` getTokenType