@solventprotocol/strikr-core

Functions

closeOptionState

closeOptionState(provider: AnchorProvider, assetNftMint: PublicKey): Promise<string>

- Defined in actions/close-option-state.ts:11
Close the OptionState account and release lamports

Parameters
- provider: AnchorProvider
  
  Anchor provider
- assetNftMint: PublicKey
  
  Asset NFT which underlies the option
Returns Promise<string>
Promise resolving to the transaction signature

closePutOptionBuyer

closePutOptionBuyer(provider: AnchorProvider, assetNftMint: PublicKey, buyerPositionNftMint: PublicKey, assetNftTokenAccount?: PublicKey): Promise<string>

- Defined in actions/close-put-option-buyer.ts:23
Close the put option buyer position.

Parameters
- provider: AnchorProvider
  
  Anchor provider
- assetNftMint: PublicKey
  
  Asset NFT which underlies the option
- buyerPositionNftMint: PublicKey
  
  Position NFT representing option buyer position
- Optional assetNftTokenAccount: PublicKey
  
  Token account containing the asset NFT
Returns Promise<string>
Promise resolving to the transaction signature

closePutOptionSeller

closePutOptionSeller(provider: AnchorProvider, assetNftMint: PublicKey, sellerPositionNftMint: PublicKey, assetNftTokenAccount?: PublicKey): Promise<string>

- Defined in actions/close-put-option-seller.ts:23
Close the put option seller position.

Parameters
- provider: AnchorProvider
  
  Anchor provider
- assetNftMint: PublicKey
  
  Asset NFT which underlies the option
- sellerPositionNftMint: PublicKey
  
  Position NFT representing option seller position
- Optional assetNftTokenAccount: PublicKey
  
  Token account containing the asset NFT
Returns Promise<string>
Promise resolving to the transaction signature

createPutOption

createPutOption(provider: AnchorProvider, assetNftMint: PublicKey, strikePrice: BN, duration: BN, premium: BN, isGraceIncluded?: boolean, assetNftTokenAccount?: PublicKey): Promise<string>

- Defined in actions/create-put-option.ts:22
Create a put option request as an option buyer

Parameters
- provider: AnchorProvider
  
  Anchor provider
- assetNftMint: PublicKey
  
  Asset NFT which underlies the option
- strikePrice: BN
- duration: BN
- premium: BN
- isGraceIncluded: boolean = false
- Optional assetNftTokenAccount: PublicKey
  
  Token account containing the asset NFT
Returns Promise<string>
Promise resolving to the transaction signature

exercisePutOption

exercisePutOption(provider: AnchorProvider, assetNftMint: PublicKey, buyerPositionNftMint: PublicKey): Promise<string>

- Defined in actions/exercise-put-option.ts:17
Exercise the put option

Parameters
- provider: AnchorProvider
  
  Anchor provider
- assetNftMint: PublicKey
  
  Asset NFT which underlies the option
- buyerPositionNftMint: PublicKey
  
  Position NFT representing option buyer position
Returns Promise<string>
Promise resolving to the transaction signature

fillPutOption

fillPutOption(provider: AnchorProvider, assetNftMint: PublicKey): Promise<string>

- Defined in actions/fill-put-option.ts:17
Fill the put option request as a seller.

Parameters
- provider: AnchorProvider
  
  Anchor provider
- assetNftMint: PublicKey
  
  Asset NFT which underlies the option
Returns Promise<string>
Promise resolving to the transaction signature

floorClosePutOptionBuyer

floorClosePutOptionBuyer(provider: AnchorProvider, optionKey: PublicKey): Promise<Response>

- Defined in actions/floor-strikr/floor-close-put-option-buyer.ts:18
Close the put option buyer position.

Parameters
- provider: AnchorProvider
  
  Anchor provider
- optionKey: PublicKey
  
  Option key representing a unique option
Returns Promise<Response>
Promise resolving to the transaction signature

floorClosePutOptionSeller

floorClosePutOptionSeller(provider: AnchorProvider, optionKey: PublicKey, assetNftMint?: PublicKey, assetNftTokenAccount?: PublicKey): Promise<Response>

- Defined in actions/floor-strikr/floor-close-put-option-seller.ts:24
Close the put option seller position.

Parameters
- provider: AnchorProvider
  
  Anchor provider
- optionKey: PublicKey
  
  Option key representing a unique option
- Optional assetNftMint: PublicKey
  
  Asset NFT which underlies the option
- Optional assetNftTokenAccount: PublicKey
  
  Token account containing the asset NFT
Returns Promise<Response>
Promise resolving to the transaction signature

floorCreatePutOption

floorCreatePutOption(provider: AnchorProvider, collectionIdentifierKey: PublicKey, strikePrice: BN, duration: BN, premium: BN): Promise<Response>

- Defined in actions/floor-strikr/floor-create-put-option.ts:18
Create a put option request as an option buyer

Parameters
- provider: AnchorProvider
  
  Anchor provider
- collectionIdentifierKey: PublicKey
  
  CollectionIdentifier key of the NFT collection which underlies the option
- strikePrice: BN
- duration: BN
- premium: BN
Returns Promise<Response>
Promise resolving to the transaction signature

floorExercisePutOption

floorExercisePutOption(provider: AnchorProvider, optionKey: PublicKey, assetNftMint: PublicKey, whitelistProof: number[][], assetNftTokenAccount?: PublicKey): Promise<Response>

- Defined in actions/floor-strikr/floor-exercise-put-option.ts:25
Exercise the put option

Parameters
- provider: AnchorProvider
  
  Anchor provider
- optionKey: PublicKey
  
  Option key representing a unique option
- assetNftMint: PublicKey
  
  Asset NFT which underlies the option
- whitelistProof: number[][]
  
  The Merkle proof of the NFT wrt the mint list tree
- Optional assetNftTokenAccount: PublicKey
  
  Optional: The token account of the user wrt the NFT
Returns Promise<Response>
Promise resolving to the transaction signature

floorFillPutOption

floorFillPutOption(provider: AnchorProvider, optionKey: PublicKey): Promise<Response>

- Defined in actions/floor-strikr/floor-fill-put-option.ts:18
Fill the put option request as a seller.

Parameters
- provider: AnchorProvider
  
  Anchor provider
- optionKey: PublicKey
  
  Option key representing the option to be filled
Returns Promise<Response>
Promise resolving to the transaction signature

getAllFloorOptions

getAllFloorOptions(connection: Connection): Promise<ProgramAccount<TypeDef<{ name: "collectionIdentifier"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "collectionIdentifierKey"; type: "publicKey" }, { name: "collectionMetadata"; type: { defined: "CollectionMetadata" } }, { name: "isEnabled"; type: "bool" }]; kind: "struct" } } | { name: "floorOptionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isCollateralDeposited"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "optionKey"; type: "publicKey" }]; kind: "struct" } } | { name: "optionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "assetNftMint"; type: "publicKey" }, { name: "buyerPositionNftMint"; type: "publicKey" }, { name: "sellerPositionNftMint"; type: { option: "publicKey" } }]; kind: "struct" } }, IdlTypes<Strikr>>>[]>

- Defined in actions/floor-strikr/get-floor-option.ts:25
Fetch all OptionState accounts

Parameters
- connection: Connection
  
  Solana Web3 connection object
Returns Promise<ProgramAccount<TypeDef<{ name: "collectionIdentifier"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "collectionIdentifierKey"; type: "publicKey" }, { name: "collectionMetadata"; type: { defined: "CollectionMetadata" } }, { name: "isEnabled"; type: "bool" }]; kind: "struct" } } | { name: "floorOptionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isCollateralDeposited"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "optionKey"; type: "publicKey" }]; kind: "struct" } } | { name: "optionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "assetNftMint"; type: "publicKey" }, { name: "buyerPositionNftMint"; type: "publicKey" }, { name: "sellerPositionNftMint"; type: { option: "publicKey" } }]; kind: "struct" } }, IdlTypes<Strikr>>>[]>
Promise resolving to the OptionState account contents

getAllOptions

getAllOptions(connection: Connection): Promise<ProgramAccount<TypeDef<{ name: "collectionIdentifier"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "collectionIdentifierKey"; type: "publicKey" }, { name: "collectionMetadata"; type: { defined: "CollectionMetadata" } }, { name: "isEnabled"; type: "bool" }]; kind: "struct" } } | { name: "floorOptionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isCollateralDeposited"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "optionKey"; type: "publicKey" }]; kind: "struct" } } | { name: "optionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "assetNftMint"; type: "publicKey" }, { name: "buyerPositionNftMint"; type: "publicKey" }, { name: "sellerPositionNftMint"; type: { option: "publicKey" } }]; kind: "struct" } }, IdlTypes<Strikr>>>[]>

- Defined in actions/get-option.ts:25
Fetch all OptionState accounts

Parameters
- connection: Connection
  
  Solana Web3 connection object
Returns Promise<ProgramAccount<TypeDef<{ name: "collectionIdentifier"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "collectionIdentifierKey"; type: "publicKey" }, { name: "collectionMetadata"; type: { defined: "CollectionMetadata" } }, { name: "isEnabled"; type: "bool" }]; kind: "struct" } } | { name: "floorOptionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isCollateralDeposited"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "optionKey"; type: "publicKey" }]; kind: "struct" } } | { name: "optionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "assetNftMint"; type: "publicKey" }, { name: "buyerPositionNftMint"; type: "publicKey" }, { name: "sellerPositionNftMint"; type: { option: "publicKey" } }]; kind: "struct" } }, IdlTypes<Strikr>>>[]>
Promise resolving to the OptionState account contents

getCollectionIdentifier

getCollectionIdentifier(collectionIdentifierKey: PublicKey): Promise<PublicKey>

- Defined in utils/pdas.ts:25
Parameters
- collectionIdentifierKey: PublicKey
Returns Promise<PublicKey>

getFloorOption

getFloorOption(connection: Connection, optionKey: PublicKey): Promise<TypeDef<{ name: "collectionIdentifier"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "collectionIdentifierKey"; type: "publicKey" }, { name: "collectionMetadata"; type: { defined: "CollectionMetadata" } }, { name: "isEnabled"; type: "bool" }]; kind: "struct" } } | { name: "floorOptionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isCollateralDeposited"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "optionKey"; type: "publicKey" }]; kind: "struct" } } | { name: "optionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "assetNftMint"; type: "publicKey" }, { name: "buyerPositionNftMint"; type: "publicKey" }, { name: "sellerPositionNftMint"; type: { option: "publicKey" } }]; kind: "struct" } }, IdlTypes<Strikr>>>

- Defined in actions/floor-strikr/get-floor-option.ts:10
Fetch OptionState account

Parameters
- connection: Connection
  
  Solana Web3 connection object
- optionKey: PublicKey
  
  OptionKey representing an option uniquely
Returns Promise<TypeDef<{ name: "collectionIdentifier"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "collectionIdentifierKey"; type: "publicKey" }, { name: "collectionMetadata"; type: { defined: "CollectionMetadata" } }, { name: "isEnabled"; type: "bool" }]; kind: "struct" } } | { name: "floorOptionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isCollateralDeposited"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "optionKey"; type: "publicKey" }]; kind: "struct" } } | { name: "optionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "assetNftMint"; type: "publicKey" }, { name: "buyerPositionNftMint"; type: "publicKey" }, { name: "sellerPositionNftMint"; type: { option: "publicKey" } }]; kind: "struct" } }, IdlTypes<Strikr>>>
Promise resolving to the OptionState account contents

getFloorOptionState

getFloorOptionState(optionKey: PublicKey): Promise<PublicKey>

- Defined in utils/pdas.ts:9
Parameters
- optionKey: PublicKey
Returns Promise<PublicKey>

getMerkleProof

getMerkleProof(mints: PublicKey[], mint: PublicKey): number[][]

- Defined in utils/helpers.ts:16
Parameters
- mints: PublicKey[]
- mint: PublicKey
Returns number[][]

getMerkleTree

getMerkleTree(mints: PublicKey[]): { root: number[]; tree: MerkleTree }

- Defined in utils/helpers.ts:9
Parameters
- mints: PublicKey[]
Returns { root: number[]; tree: MerkleTree }
- root: number[]
- tree: MerkleTree

getOption

getOption(connection: Connection, assetNftMint: PublicKey): Promise<TypeDef<{ name: "collectionIdentifier"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "collectionIdentifierKey"; type: "publicKey" }, { name: "collectionMetadata"; type: { defined: "CollectionMetadata" } }, { name: "isEnabled"; type: "bool" }]; kind: "struct" } } | { name: "floorOptionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isCollateralDeposited"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "optionKey"; type: "publicKey" }]; kind: "struct" } } | { name: "optionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "assetNftMint"; type: "publicKey" }, { name: "buyerPositionNftMint"; type: "publicKey" }, { name: "sellerPositionNftMint"; type: { option: "publicKey" } }]; kind: "struct" } }, IdlTypes<Strikr>>>

- Defined in actions/get-option.ts:10
Fetch OptionState account

Parameters
- connection: Connection
  
  Solana Web3 connection object
- assetNftMint: PublicKey
Returns Promise<TypeDef<{ name: "collectionIdentifier"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "collectionIdentifierKey"; type: "publicKey" }, { name: "collectionMetadata"; type: { defined: "CollectionMetadata" } }, { name: "isEnabled"; type: "bool" }]; kind: "struct" } } | { name: "floorOptionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isCollateralDeposited"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "optionKey"; type: "publicKey" }]; kind: "struct" } } | { name: "optionState"; type: { fields: [{ name: "bump"; type: "u8" }, { name: "isExercised"; type: "bool" }, { name: "isExpired"; type: "bool" }, { name: "isBuyerClosed"; type: "bool" }, { name: "isSellerClosed"; type: "bool" }, { name: "assetNftMint"; type: "publicKey" }, { name: "buyerPositionNftMint"; type: "publicKey" }, { name: "sellerPositionNftMint"; type: { option: "publicKey" } }]; kind: "struct" } }, IdlTypes<Strikr>>>
Promise resolving to the OptionState account contents

getOptionState

getOptionState(assetNftMint: PublicKey): Promise<PublicKey>

- Defined in utils/pdas.ts:17
Parameters
- assetNftMint: PublicKey
Returns Promise<PublicKey>

getShellProvider

getShellProvider(connection: Connection): AnchorProvider

- Defined in utils/helpers.ts:5
Parameters
- connection: Connection
Returns AnchorProvider

getStrikr

getStrikr(provider: AnchorProvider): Program<Strikr>

- Defined in utils/programs.ts:6
Parameters
- provider: AnchorProvider
Returns Program<Strikr>

getStrikrAuthority

getStrikrAuthority(): Promise<PublicKey>

- Defined in utils/pdas.ts:33
Returns Promise<PublicKey>

Index

Functions

Functions

closeOptionState

Parameters

provider: AnchorProvider

assetNftMint: PublicKey

Returns Promise<string>

closePutOptionBuyer

Parameters

provider: AnchorProvider

assetNftMint: PublicKey

buyerPositionNftMint: PublicKey

Optional assetNftTokenAccount: PublicKey

Returns Promise<string>

closePutOptionSeller

Parameters

provider: AnchorProvider

assetNftMint: PublicKey

sellerPositionNftMint: PublicKey

Optional assetNftTokenAccount: PublicKey

Returns Promise<string>

createPutOption

Parameters

provider: AnchorProvider

assetNftMint: PublicKey

strikePrice: BN

duration: BN

premium: BN

isGraceIncluded: boolean = false

Optional assetNftTokenAccount: PublicKey

Returns Promise<string>

exercisePutOption

Parameters

provider: AnchorProvider

assetNftMint: PublicKey

buyerPositionNftMint: PublicKey

Returns Promise<string>

fillPutOption

Parameters

provider: AnchorProvider

assetNftMint: PublicKey

Returns Promise<string>

floorClosePutOptionBuyer

Parameters

provider: AnchorProvider

optionKey: PublicKey

Returns Promise<Response>

floorClosePutOptionSeller

Parameters

provider: AnchorProvider

optionKey: PublicKey

Optional assetNftMint: PublicKey

Optional assetNftTokenAccount: PublicKey

Returns Promise<Response>

floorCreatePutOption

Parameters

provider: AnchorProvider

collectionIdentifierKey: PublicKey

strikePrice: BN

duration: BN

premium: BN

Returns Promise<Response>

floorExercisePutOption

Parameters

provider: AnchorProvider

optionKey: PublicKey

assetNftMint: PublicKey

whitelistProof: number[][]

Optional assetNftTokenAccount: PublicKey

Returns Promise<Response>

floorFillPutOption

Parameters

provider: AnchorProvider

optionKey: PublicKey

Returns Promise<Response>

getAllFloorOptions

Parameters

connection: Connection

getAllOptions