Class SubgraphPosition

Represents the type of option in the Valorem Clear system.

Hierarchy (view full)

Constructors

constructor

Properties

exerciseAsset optionInfo optionTypeId rawClaimFromSubgraph? rawOptionTypeFromSubgraph rawPositionFromSubgraph tokenId tokenType typeExists underlyingAsset

Accessors

amountExercised amountWritten claim exerciseIsStable exerciseTimestamp expiryTimestamp id isCall isClaim isClaimRedeemable isOptionBeforeExerciseWindow isOptionExercisable isOptionExpired isOwned magnitude optionId pair quantityOwned stableAmount stableAsset strategyTitle strike ticker tokensPerContract volatileAmount volatileAsset

Methods

createOptionType fromId fromInfo fromSubgraph fromSubgraphPosition getOptionTypeId getOptionTypeInfo getTokenType

Constructors

Private constructor

  • new SubgraphPosition(__namedParameters): SubgraphPosition

  • Parameters

    • __namedParameters: {
          optionType: OptionType;
          subgraphOptionType: SubgraphOptionType;
          subgraphPosition: Required<{
              id: string;
              token: {
                  claim: null | {
                      amountExercised: string;
                      amountWritten: string;
                      id: string;
                      optionType: {
                          exerciseAmount: string;
                          exerciseAsset: {
                              symbol: string;
                          };
                          exerciseTimestamp: string;
                          expiryTimestamp: string;
                          id: string;
                          underlyingAmount: string;
                          underlyingAsset: {
                              symbol: string;
                          };
                      };
                      redeemed: boolean;
                  };
                  id: string;
                  optionType: null | {
                      exerciseAmount: string;
                      exerciseAsset: {
                          symbol: string;
                      };
                      exerciseTimestamp: string;
                      expiryTimestamp: string;
                      id: string;
                      underlyingAmount: string;
                      underlyingAsset: {
                          symbol: string;
                      };
                  };
                  type: null | number;
              };
              valueExact: string;
          }>;
      }
      • optionType: OptionType
      • subgraphOptionType: SubgraphOptionType
      • subgraphPosition: Required<{
            id: string;
            token: {
                claim: null | {
                    amountExercised: string;
                    amountWritten: string;
                    id: string;
                    optionType: {
                        exerciseAmount: string;
                        exerciseAsset: {
                            symbol: string;
                        };
                        exerciseTimestamp: string;
                        expiryTimestamp: string;
                        id: string;
                        underlyingAmount: string;
                        underlyingAsset: {
                            symbol: string;
                        };
                    };
                    redeemed: boolean;
                };
                id: string;
                optionType: null | {
                    exerciseAmount: string;
                    exerciseAsset: {
                        symbol: string;
                    };
                    exerciseTimestamp: string;
                    expiryTimestamp: string;
                    id: string;
                    underlyingAmount: string;
                    underlyingAsset: {
                        symbol: string;
                    };
                };
                type: null | number;
            };
            valueExact: string;
        }>

    Returns SubgraphPosition

Properties

Readonly exerciseAsset

exerciseAsset: SupportedAsset

optionInfo

optionInfo: OptionTypeInfo

optionTypeId

optionTypeId: bigint

Private Optional Readonly rawClaimFromSubgraph

rawClaimFromSubgraph?: {
    amountExercised: string;
    amountWritten: string;
    id: string;
    optionType: {
        exerciseAmount: string;
        exerciseAsset: {
            symbol: string;
        };
        exerciseTimestamp: string;
        expiryTimestamp: string;
        id: string;
        underlyingAmount: string;
        underlyingAsset: {
            symbol: string;
        };
    };
    redeemed: boolean;
}

Type declaration

  • amountExercised: string
  • amountWritten: string
  • id: string
  • optionType: {
        exerciseAmount: string;
        exerciseAsset: {
            symbol: string;
        };
        exerciseTimestamp: string;
        expiryTimestamp: string;
        id: string;
        underlyingAmount: string;
        underlyingAsset: {
            symbol: string;
        };
    }
    • exerciseAmount: string
    • exerciseAsset: {
          symbol: string;
      }
      • symbol: string
    • exerciseTimestamp: string
    • expiryTimestamp: string
    • id: string
    • underlyingAmount: string
    • underlyingAsset: {
          symbol: string;
      }
      • symbol: string
  • redeemed: boolean

Private Readonly rawOptionTypeFromSubgraph

rawOptionTypeFromSubgraph: SubgraphOptionType

Private Readonly rawPositionFromSubgraph

rawPositionFromSubgraph: Required<{
    id: string;
    token: {
        claim: null | {
            amountExercised: string;
            amountWritten: string;
            id: string;
            optionType: {
                exerciseAmount: string;
                exerciseAsset: {
                    symbol: string;
                };
                exerciseTimestamp: string;
                expiryTimestamp: string;
                id: string;
                underlyingAmount: string;
                underlyingAsset: {
                    symbol: string;
                };
            };
            redeemed: boolean;
        };
        id: string;
        optionType: null | {
            exerciseAmount: string;
            exerciseAsset: {
                symbol: string;
            };
            exerciseTimestamp: string;
            expiryTimestamp: string;
            id: string;
            underlyingAmount: string;
            underlyingAsset: {
                symbol: string;
            };
        };
        type: null | number;
    };
    valueExact: string;
}>

Type declaration

  • id: string
  • token: {
        claim: null | {
            amountExercised: string;
            amountWritten: string;
            id: string;
            optionType: {
                exerciseAmount: string;
                exerciseAsset: {
                    symbol: string;
                };
                exerciseTimestamp: string;
                expiryTimestamp: string;
                id: string;
                underlyingAmount: string;
                underlyingAsset: {
                    symbol: string;
                };
            };
            redeemed: boolean;
        };
        id: string;
        optionType: null | {
            exerciseAmount: string;
            exerciseAsset: {
                symbol: string;
            };
            exerciseTimestamp: string;
            expiryTimestamp: string;
            id: string;
            underlyingAmount: string;
            underlyingAsset: {
                symbol: string;
            };
        };
        type: null | number;
    }
    • claim: null | {
          amountExercised: string;
          amountWritten: string;
          id: string;
          optionType: {
              exerciseAmount: string;
              exerciseAsset: {
                  symbol: string;
              };
              exerciseTimestamp: string;
              expiryTimestamp: string;
              id: string;
              underlyingAmount: string;
              underlyingAsset: {
                  symbol: string;
              };
          };
          redeemed: boolean;
      }
    • id: string
    • optionType: null | {
          exerciseAmount: string;
          exerciseAsset: {
              symbol: string;
          };
          exerciseTimestamp: string;
          expiryTimestamp: string;
          id: string;
          underlyingAmount: string;
          underlyingAsset: {
              symbol: string;
          };
      }
    • type: null | number
  • valueExact: string

tokenId

tokenId: undefined | bigint = undefined

tokenType

tokenType: undefined | 0 | 2 | 1 = undefined

typeExists

typeExists: boolean

Readonly underlyingAsset

underlyingAsset: SupportedAsset

Accessors

amountExercised

amountWritten

claim

  • get claim(): undefined | {
        amountExercised: string;
        amountWritten: string;
        id: string;
        optionType: {
            exerciseAmount: string;
            exerciseAsset: {
                symbol: string;
            };
            exerciseTimestamp: string;
            expiryTimestamp: string;
            id: string;
            underlyingAmount: string;
            underlyingAsset: {
                symbol: string;
            };
        };
        redeemed: boolean;
    }

  • Returns undefined | {
        amountExercised: string;
        amountWritten: string;
        id: string;
        optionType: {
            exerciseAmount: string;
            exerciseAsset: {
                symbol: string;
            };
            exerciseTimestamp: string;
            expiryTimestamp: string;
            id: string;
            underlyingAmount: string;
            underlyingAsset: {
                symbol: string;
            };
        };
        redeemed: boolean;
    }

exerciseIsStable

exerciseTimestamp

expiryTimestamp

id

isCall

isClaim

isClaimRedeemable

isOptionBeforeExerciseWindow

isOptionExercisable

isOptionExpired

isOwned

magnitude

optionId

pair

quantityOwned

Private stableAmount

stableAsset

strategyTitle

strike

ticker

tokensPerContract

Private volatileAmount

volatileAsset

Methods

createOptionType

Static fromId

Static fromInfo

Static fromSubgraph

Static fromSubgraphPosition

  • fromSubgraphPosition(__namedParameters): SubgraphPosition

  • Parameters

    • __namedParameters: {
          chainId: number;
          subgraphPosition: Required<{
              id: string;
              token: {
                  claim: null | {
                      amountExercised: string;
                      amountWritten: string;
                      id: string;
                      optionType: {
                          exerciseAmount: string;
                          exerciseAsset: {
                              symbol: string;
                          };
                          exerciseTimestamp: string;
                          expiryTimestamp: string;
                          id: string;
                          underlyingAmount: string;
                          underlyingAsset: {
                              symbol: string;
                          };
                      };
                      redeemed: boolean;
                  };
                  id: string;
                  optionType: null | {
                      exerciseAmount: string;
                      exerciseAsset: {
                          symbol: string;
                      };
                      exerciseTimestamp: string;
                      expiryTimestamp: string;
                      id: string;
                      underlyingAmount: string;
                      underlyingAsset: {
                          symbol: string;
                      };
                  };
                  type: null | number;
              };
              valueExact: string;
          }>;
      }
      • chainId: number
      • subgraphPosition: Required<{
            id: string;
            token: {
                claim: null | {
                    amountExercised: string;
                    amountWritten: string;
                    id: string;
                    optionType: {
                        exerciseAmount: string;
                        exerciseAsset: {
                            symbol: string;
                        };
                        exerciseTimestamp: string;
                        expiryTimestamp: string;
                        id: string;
                        underlyingAmount: string;
                        underlyingAsset: {
                            symbol: string;
                        };
                    };
                    redeemed: boolean;
                };
                id: string;
                optionType: null | {
                    exerciseAmount: string;
                    exerciseAsset: {
                        symbol: string;
                    };
                    exerciseTimestamp: string;
                    expiryTimestamp: string;
                    id: string;
                    underlyingAmount: string;
                    underlyingAsset: {
                        symbol: string;
                    };
                };
                type: null | number;
            };
            valueExact: string;
        }>

    Returns SubgraphPosition

Static getOptionTypeId

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.

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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc