@mithraic-labs/psy-american | PsyOptions Developer Documentation

Type aliases

NetworkInfo

NetworkInfo: { feeOwnerKey: PublicKey; serumReferrerId: PublicKey }

Type declaration

feeOwnerKey: PublicKey
serumReferrerId: PublicKey

OptionMarket

OptionMarket: { bumpSeed: number; exerciseFeeAccount: PublicKey; expirationUnixTimestamp: anchor.BN; expired: boolean; mintFeeAccount: PublicKey; optionMint: PublicKey; quoteAmountPerContract: anchor.BN; quoteAssetMint: PublicKey; quoteAssetPool: PublicKey; underlyingAmountPerContract: anchor.BN; underlyingAssetMint: PublicKey; underlyingAssetPool: PublicKey; writerTokenMint: PublicKey }

Type declaration

bumpSeed: number
exerciseFeeAccount: PublicKey
expirationUnixTimestamp: anchor.BN
expired: boolean
mintFeeAccount: PublicKey
optionMint: PublicKey
quoteAmountPerContract: anchor.BN
quoteAssetMint: PublicKey
quoteAssetPool: PublicKey
underlyingAmountPerContract: anchor.BN
underlyingAssetMint: PublicKey
underlyingAssetPool: PublicKey
writerTokenMint: PublicKey

OptionMarketWithKey

OptionMarketWithKey: OptionMarket & { key: PublicKey }

OrderParamsWithFeeRate

OrderParamsWithFeeRate<T>: OrderParams<T> & { feeRate?: number }

Type parameters

PsyAmerican

PsyAmerican: { accounts: [{ name: "optionMarket"; type: { fields: [{ name: "optionMint"; type: "publicKey" }, { name: "writerTokenMint"; type: "publicKey" }, { name: "underlyingAssetMint"; type: "publicKey" }, { name: "quoteAssetMint"; type: "publicKey" }, { name: "underlyingAmountPerContract"; type: "u64" }, { name: "quoteAmountPerContract"; type: "u64" }, { name: "expirationUnixTimestamp"; type: "i64" }, { name: "underlyingAssetPool"; type: "publicKey" }, { name: "quoteAssetPool"; type: "publicKey" }, { name: "mintFeeAccount"; type: "publicKey" }, { name: "exerciseFeeAccount"; type: "publicKey" }, { name: "expired"; type: "bool" }, { name: "bumpSeed"; type: "u8" }]; kind: "struct" } }]; errors: [{ code: 300; msg: "Expiration must be in the future"; name: "ExpirationIsInThePast" }, { code: 301; msg: "Same quote and underlying asset, cannot create market"; name: "QuoteAndUnderlyingAssetMustDiffer" }, { code: 302; msg: "Quote amount and underlying amount per contract must be > 0"; name: "QuoteOrUnderlyingAmountCannotBe0" }, { code: 303; msg: "OptionMarket must be the mint authority"; name: "OptionMarketMustBeMintAuthority" }, { code: 304; msg: "OptionMarket must own the underlying asset pool"; name: "OptionMarketMustOwnUnderlyingAssetPool" }, { code: 305; msg: "OptionMarket must own the quote asset pool"; name: "OptionMarketMustOwnQuoteAssetPool" }, { code: 306; msg: "Stop trying to spoof the SPL Token program! Shame on you"; name: "ExpectedSPLTokenProgramId" }, { code: 307; msg: "Mint fee account must be owned by the FEE_OWNER"; name: "MintFeeMustBeOwnedByFeeOwner" }, { code: 308; msg: "Exercise fee account must be owned by the FEE_OWNER"; name: "ExerciseFeeMustBeOwnedByFeeOwner" }, { code: 309; msg: "Mint fee token must be the same as the underlying asset"; name: "MintFeeTokenMustMatchUnderlyingAsset" }, { code: 310; msg: "Exercise fee token must be the same as the quote asset"; name: "ExerciseFeeTokenMustMatchQuoteAsset" }, { code: 311; msg: "OptionMarket is expired, can't mint"; name: "OptionMarketExpiredCantMint" }, { code: 312; msg: "Underlying pool account does not match the value on the OptionMarket"; name: "UnderlyingPoolAccountDoesNotMatchMarket" }, { code: 313; msg: "OptionToken mint does not match the value on the OptionMarket"; name: "OptionTokenMintDoesNotMatchMarket" }, { code: 314; msg: "WriterToken mint does not match the value on the OptionMarket"; name: "WriterTokenMintDoesNotMatchMarket" }, { code: 315; msg: "MintFee key does not match the value on the OptionMarket"; name: "MintFeeKeyDoesNotMatchOptionMarket" }, { code: 316; msg: "The size argument must be > 0"; name: "SizeCantBeLessThanEqZero" }, { code: 317; msg: "exerciseFee key does not match the value on the OptionMarket"; name: "ExerciseFeeKeyDoesNotMatchOptionMarket" }, { code: 318; msg: "Quote pool account does not match the value on the OptionMarket"; name: "QuotePoolAccountDoesNotMatchMarket" }, { code: 319; msg: "Underlying destination mint must match underlying asset mint address"; name: "UnderlyingDestMintDoesNotMatchUnderlyingAsset" }, { code: 320; msg: "Fee owner does not match the program's fee owner"; name: "FeeOwnerDoesNotMatchProgram" }, { code: 321; msg: "OptionMarket is expired, can't exercise"; name: "OptionMarketExpiredCantExercise" }, { code: 322; msg: "OptionMarket has not expired, can't close"; name: "OptionMarketNotExpiredCantClose" }, { code: 323; msg: "Not enough assets in the quote asset pool"; name: "NotEnoughQuoteAssetsInPool" }, { code: 324; msg: "Invalid auth token provided"; name: "InvalidAuth" }, { code: 325; msg: "Coin mint must match option mint"; name: "CoinMintIsNotOptionMint" }, { code: 326; msg: "Cannot prune the market while it's still active"; name: "CannotPruneActiveMarket" }, { code: 327; msg: "Numberical overflow"; name: "NumberOverflow" }]; instructions: [{ accounts: [{ isMut: true; isSigner: true; name: "authority" }, { isMut: false; isSigner: false; name: "underlyingAssetMint" }, { isMut: false; isSigner: false; name: "quoteAssetMint" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "quoteAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "optionMarket" }, { isMut: false; isSigner: false; name: "feeOwner" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "associatedTokenProgram" }, { isMut: false; isSigner: false; name: "rent" }, { isMut: false; isSigner: false; name: "systemProgram" }, { isMut: false; isSigner: false; name: "clock" }]; args: [{ name: "underlyingAmountPerContract"; type: "u64" }, { name: "quoteAmountPerContract"; type: "u64" }, { name: "expirationUnixTimestamp"; type: "i64" }, { name: "bumpSeed"; type: "u8" }]; name: "initializeMarket" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "underlyingAssetMint" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetSrc" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "mintedOptionDest" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "mintedWriterTokenDest" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "feeOwner" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "associatedTokenProgram" }, { isMut: false; isSigner: false; name: "clock" }, { isMut: false; isSigner: false; name: "rent" }, { isMut: false; isSigner: false; name: "systemProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "mintOption" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "underlyingAssetMint" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetSrc" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "mintedOptionDest" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "mintedWriterTokenDest" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: false; isSigner: false; name: "tokenProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "mintOptionV2" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: true; isSigner: true; name: "optionAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "exerciserOptionTokenSrc" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetDest" }, { isMut: true; isSigner: false; name: "quoteAssetPool" }, { isMut: true; isSigner: false; name: "quoteAssetSrc" }, { isMut: true; isSigner: false; name: "feeOwner" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "systemProgram" }, { isMut: false; isSigner: false; name: "clock" }]; args: [{ name: "size"; type: "u64" }]; name: "exerciseOption" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: true; isSigner: true; name: "optionAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "exerciserOptionTokenSrc" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetDest" }, { isMut: true; isSigner: false; name: "quoteAssetPool" }, { isMut: true; isSigner: false; name: "quoteAssetSrc" }, { isMut: false; isSigner: false; name: "tokenProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "exerciseOptionV2" }, { accounts: [{ isMut: false; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "writerTokenSrc" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetDest" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "clock" }]; args: [{ name: "size"; type: "u64" }]; name: "closePostExpiration" }, { accounts: [{ isMut: false; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "writerTokenSrc" }, { isMut: true; isSigner: false; name: "optionTokenMint" }, { isMut: true; isSigner: false; name: "optionTokenSrc" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetDest" }, { isMut: false; isSigner: false; name: "tokenProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "closeOptionPosition" }, { accounts: [{ isMut: false; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "writerTokenSrc" }, { isMut: true; isSigner: false; name: "quoteAssetPool" }, { isMut: true; isSigner: false; name: "writerQuoteDest" }, { isMut: false; isSigner: false; name: "tokenProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "burnWriterForQuote" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: true; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "serumMarket" }, { isMut: false; isSigner: false; name: "systemProgram" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "dexProgram" }, { isMut: false; isSigner: false; name: "rent" }, { isMut: false; isSigner: false; name: "pcMint" }, { isMut: false; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "requestQueue" }, { isMut: true; isSigner: false; name: "eventQueue" }, { isMut: true; isSigner: false; name: "bids" }, { isMut: true; isSigner: false; name: "asks" }, { isMut: true; isSigner: false; name: "coinVault" }, { isMut: true; isSigner: false; name: "pcVault" }, { isMut: false; isSigner: false; name: "vaultSigner" }, { isMut: false; isSigner: false; name: "marketAuthority" }]; args: [{ name: "marketSpace"; type: "u64" }, { name: "vaultSignerNonce"; type: "u64" }, { name: "coinLotSize"; type: "u64" }, { name: "pcLotSize"; type: "u64" }, { name: "pcDustThreshold"; type: "u64" }]; name: "initSerumMarket" }]; name: "psy_american"; version: "0.0.0" }

Type declaration

accounts: [{ name: "optionMarket"; type: { fields: [{ name: "optionMint"; type: "publicKey" }, { name: "writerTokenMint"; type: "publicKey" }, { name: "underlyingAssetMint"; type: "publicKey" }, { name: "quoteAssetMint"; type: "publicKey" }, { name: "underlyingAmountPerContract"; type: "u64" }, { name: "quoteAmountPerContract"; type: "u64" }, { name: "expirationUnixTimestamp"; type: "i64" }, { name: "underlyingAssetPool"; type: "publicKey" }, { name: "quoteAssetPool"; type: "publicKey" }, { name: "mintFeeAccount"; type: "publicKey" }, { name: "exerciseFeeAccount"; type: "publicKey" }, { name: "expired"; type: "bool" }, { name: "bumpSeed"; type: "u8" }]; kind: "struct" } }]
errors: [{ code: 300; msg: "Expiration must be in the future"; name: "ExpirationIsInThePast" }, { code: 301; msg: "Same quote and underlying asset, cannot create market"; name: "QuoteAndUnderlyingAssetMustDiffer" }, { code: 302; msg: "Quote amount and underlying amount per contract must be > 0"; name: "QuoteOrUnderlyingAmountCannotBe0" }, { code: 303; msg: "OptionMarket must be the mint authority"; name: "OptionMarketMustBeMintAuthority" }, { code: 304; msg: "OptionMarket must own the underlying asset pool"; name: "OptionMarketMustOwnUnderlyingAssetPool" }, { code: 305; msg: "OptionMarket must own the quote asset pool"; name: "OptionMarketMustOwnQuoteAssetPool" }, { code: 306; msg: "Stop trying to spoof the SPL Token program! Shame on you"; name: "ExpectedSPLTokenProgramId" }, { code: 307; msg: "Mint fee account must be owned by the FEE_OWNER"; name: "MintFeeMustBeOwnedByFeeOwner" }, { code: 308; msg: "Exercise fee account must be owned by the FEE_OWNER"; name: "ExerciseFeeMustBeOwnedByFeeOwner" }, { code: 309; msg: "Mint fee token must be the same as the underlying asset"; name: "MintFeeTokenMustMatchUnderlyingAsset" }, { code: 310; msg: "Exercise fee token must be the same as the quote asset"; name: "ExerciseFeeTokenMustMatchQuoteAsset" }, { code: 311; msg: "OptionMarket is expired, can't mint"; name: "OptionMarketExpiredCantMint" }, { code: 312; msg: "Underlying pool account does not match the value on the OptionMarket"; name: "UnderlyingPoolAccountDoesNotMatchMarket" }, { code: 313; msg: "OptionToken mint does not match the value on the OptionMarket"; name: "OptionTokenMintDoesNotMatchMarket" }, { code: 314; msg: "WriterToken mint does not match the value on the OptionMarket"; name: "WriterTokenMintDoesNotMatchMarket" }, { code: 315; msg: "MintFee key does not match the value on the OptionMarket"; name: "MintFeeKeyDoesNotMatchOptionMarket" }, { code: 316; msg: "The size argument must be > 0"; name: "SizeCantBeLessThanEqZero" }, { code: 317; msg: "exerciseFee key does not match the value on the OptionMarket"; name: "ExerciseFeeKeyDoesNotMatchOptionMarket" }, { code: 318; msg: "Quote pool account does not match the value on the OptionMarket"; name: "QuotePoolAccountDoesNotMatchMarket" }, { code: 319; msg: "Underlying destination mint must match underlying asset mint address"; name: "UnderlyingDestMintDoesNotMatchUnderlyingAsset" }, { code: 320; msg: "Fee owner does not match the program's fee owner"; name: "FeeOwnerDoesNotMatchProgram" }, { code: 321; msg: "OptionMarket is expired, can't exercise"; name: "OptionMarketExpiredCantExercise" }, { code: 322; msg: "OptionMarket has not expired, can't close"; name: "OptionMarketNotExpiredCantClose" }, { code: 323; msg: "Not enough assets in the quote asset pool"; name: "NotEnoughQuoteAssetsInPool" }, { code: 324; msg: "Invalid auth token provided"; name: "InvalidAuth" }, { code: 325; msg: "Coin mint must match option mint"; name: "CoinMintIsNotOptionMint" }, { code: 326; msg: "Cannot prune the market while it's still active"; name: "CannotPruneActiveMarket" }, { code: 327; msg: "Numberical overflow"; name: "NumberOverflow" }]
instructions: [{ accounts: [{ isMut: true; isSigner: true; name: "authority" }, { isMut: false; isSigner: false; name: "underlyingAssetMint" }, { isMut: false; isSigner: false; name: "quoteAssetMint" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "quoteAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "optionMarket" }, { isMut: false; isSigner: false; name: "feeOwner" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "associatedTokenProgram" }, { isMut: false; isSigner: false; name: "rent" }, { isMut: false; isSigner: false; name: "systemProgram" }, { isMut: false; isSigner: false; name: "clock" }]; args: [{ name: "underlyingAmountPerContract"; type: "u64" }, { name: "quoteAmountPerContract"; type: "u64" }, { name: "expirationUnixTimestamp"; type: "i64" }, { name: "bumpSeed"; type: "u8" }]; name: "initializeMarket" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "underlyingAssetMint" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetSrc" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "mintedOptionDest" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "mintedWriterTokenDest" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "feeOwner" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "associatedTokenProgram" }, { isMut: false; isSigner: false; name: "clock" }, { isMut: false; isSigner: false; name: "rent" }, { isMut: false; isSigner: false; name: "systemProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "mintOption" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "underlyingAssetMint" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetSrc" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "mintedOptionDest" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "mintedWriterTokenDest" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: false; isSigner: false; name: "tokenProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "mintOptionV2" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: true; isSigner: true; name: "optionAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "exerciserOptionTokenSrc" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetDest" }, { isMut: true; isSigner: false; name: "quoteAssetPool" }, { isMut: true; isSigner: false; name: "quoteAssetSrc" }, { isMut: true; isSigner: false; name: "feeOwner" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "systemProgram" }, { isMut: false; isSigner: false; name: "clock" }]; args: [{ name: "size"; type: "u64" }]; name: "exerciseOption" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: true; isSigner: true; name: "optionAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "exerciserOptionTokenSrc" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetDest" }, { isMut: true; isSigner: false; name: "quoteAssetPool" }, { isMut: true; isSigner: false; name: "quoteAssetSrc" }, { isMut: false; isSigner: false; name: "tokenProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "exerciseOptionV2" }, { accounts: [{ isMut: false; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "writerTokenSrc" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetDest" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "clock" }]; args: [{ name: "size"; type: "u64" }]; name: "closePostExpiration" }, { accounts: [{ isMut: false; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "writerTokenSrc" }, { isMut: true; isSigner: false; name: "optionTokenMint" }, { isMut: true; isSigner: false; name: "optionTokenSrc" }, { isMut: true; isSigner: false; name: "underlyingAssetPool" }, { isMut: true; isSigner: false; name: "underlyingAssetDest" }, { isMut: false; isSigner: false; name: "tokenProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "closeOptionPosition" }, { accounts: [{ isMut: false; isSigner: true; name: "userAuthority" }, { isMut: false; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "writerTokenMint" }, { isMut: true; isSigner: false; name: "writerTokenSrc" }, { isMut: true; isSigner: false; name: "quoteAssetPool" }, { isMut: true; isSigner: false; name: "writerQuoteDest" }, { isMut: false; isSigner: false; name: "tokenProgram" }]; args: [{ name: "size"; type: "u64" }]; name: "burnWriterForQuote" }, { accounts: [{ isMut: true; isSigner: true; name: "userAuthority" }, { isMut: true; isSigner: false; name: "optionMarket" }, { isMut: true; isSigner: false; name: "serumMarket" }, { isMut: false; isSigner: false; name: "systemProgram" }, { isMut: false; isSigner: false; name: "tokenProgram" }, { isMut: false; isSigner: false; name: "dexProgram" }, { isMut: false; isSigner: false; name: "rent" }, { isMut: false; isSigner: false; name: "pcMint" }, { isMut: false; isSigner: false; name: "optionMint" }, { isMut: true; isSigner: false; name: "requestQueue" }, { isMut: true; isSigner: false; name: "eventQueue" }, { isMut: true; isSigner: false; name: "bids" }, { isMut: true; isSigner: false; name: "asks" }, { isMut: true; isSigner: false; name: "coinVault" }, { isMut: true; isSigner: false; name: "pcVault" }, { isMut: false; isSigner: false; name: "vaultSigner" }, { isMut: false; isSigner: false; name: "marketAuthority" }]; args: [{ name: "marketSpace"; type: "u64" }, { name: "vaultSignerNonce"; type: "u64" }, { name: "coinLotSize"; type: "u64" }, { name: "pcLotSize"; type: "u64" }, { name: "pcDustThreshold"; type: "u64" }]; name: "initSerumMarket" }]
name: "psy_american"
version: "0.0.0"

Variables

Const FEE_OWNER_KEY

FEE_OWNER_KEY: PublicKey = ...

The fee owner key for the Psy American program

Const NFT_MINT_LAMPORTS

NFT_MINT_LAMPORTS: number = ...

The number of lamports the protocol takes as a fee when minting or exercising an option on an asset that cannot take a 5bps fee. E.g a minting a call option on an NFT

Const PSY_AMERICAN_PROGRAM_IDS

PSY_AMERICAN_PROGRAM_IDS: { 3KAqLcLAY8W7ZxGT1MJcFPDMNJKJsXaE1m9i1JPahfmH: ProgramVersions; AAcHauRu6eUDePN3hDDAUTbgyRq5xFbRZJCLsUdpBCJb: ProgramVersions; GDvqQy3FkDB2wyNwgZGp5YkmRMUmWbhNNWDMYKbLSZ5N: ProgramVersions } = ...

All prior Psy American programIds for all networks so clients that require backwards compatability can maintain it.

Type declaration

3KAqLcLAY8W7ZxGT1MJcFPDMNJKJsXaE1m9i1JPahfmH: ProgramVersions
AAcHauRu6eUDePN3hDDAUTbgyRq5xFbRZJCLsUdpBCJb: ProgramVersions
GDvqQy3FkDB2wyNwgZGp5YkmRMUmWbhNNWDMYKbLSZ5N: ProgramVersions

Const PsyAmericanIdl

PsyAmericanIdl: Idl = ...

The Anchor IDL for the Psy American program. Used when creating an Anchor Program.

const program = new Program(PsyAmericanIdl, psyAmericanProgramId, provider);

Functions

chunkArray

chunkArray(myArray: any[], chunkSize: number): any[][]

- Defined in dev-docs/gitmodules/psyoptions-ts/packages/psy-american/src/utils/chunkArray.ts:7
Returns an array with arrays of the given size.

Parameters
- myArray: any[]
  
  Array to split
- chunkSize: number
  
  Size of every group
Returns any[][]

deriveOptionKeyFromParams

deriveOptionKeyFromParams(__namedParameters: { expirationUnixTimestamp: BN; programId: PublicKey; quoteAmountPerContract: BN; quoteMint: PublicKey; underlyingAmountPerContract: BN; underlyingMint: PublicKey }): Promise<[PublicKey, number]>

- Defined in dev-docs/gitmodules/psyoptions-ts/packages/psy-american/src/utils/deriveOptionKeyFromParams.ts:8
Get the deterministic address for an Option based on its properties.

Parameters
- __namedParameters: { expirationUnixTimestamp: BN; programId: PublicKey; quoteAmountPerContract: BN; quoteMint: PublicKey; underlyingAmountPerContract: BN; underlyingMint: PublicKey }
  - expirationUnixTimestamp: BN
    
    The OptionMarket expiration timestamp in seconds
  - programId: PublicKey
    
    The Psy American program ID
  - quoteAmountPerContract: BN
    
    The quote asset amount per option contract
  - quoteMint: PublicKey
    
    The quote asset mint address
  - underlyingAmountPerContract: BN
    
    The underlying asset amount per option contract
  - underlyingMint: PublicKey
    
    The underlying asset mint address
Returns Promise<[PublicKey, number]>

feeAmountPerContract

feeAmountPerContract(assetQuantity: BN): BN

- Defined in dev-docs/gitmodules/psyoptions-ts/packages/psy-american/src/fees.ts:23
Get the protocol's fee amount when minting or exercising. When minting this should be the underlingAmountPerContract. When exercising this should be the quoteAmountPerContract.

Parameters
- assetQuantity: BN
  
  Quantity of the asset being used to mint or exercise
Returns BN

getAllOptionAccounts

getAllOptionAccounts(program: Program<PsyAmerican>): Promise<OptionMarketWithKey[]>

- Defined in dev-docs/gitmodules/psyoptions-ts/packages/psy-american/src/OptionMarket.ts:11
Load all OptionMarkets owned by the given program from the blockchain.

Parameters
- program: Program<PsyAmerican>
  
  Anchor Psy American program
Returns Promise<OptionMarketWithKey[]>

getOptionByKey

getOptionByKey(program: Program<PsyAmerican>, key: PublicKey): Promise<OptionMarketWithKey>

- Defined in dev-docs/gitmodules/psyoptions-ts/packages/psy-american/src/utils/getOptionByKey.ts:6
Parameters
- program: Program<PsyAmerican>
- key: PublicKey
Returns Promise<OptionMarketWithKey>

getOrAddAssociatedTokenAccountTx

getOrAddAssociatedTokenAccountTx(associatedAddress: PublicKey, mintKey: PublicKey, provider: default, owner?: PublicKey): Promise<TransactionInstruction>

- Defined in dev-docs/gitmodules/psyoptions-ts/packages/psy-american/src/utils/getOrAddAssociatedTokenAccountTx.ts:20
Returns a TransactionInstruction for creating the associated token account if one deos not exist.

Parameters
- associatedAddress: PublicKey
  
  The associated token account address
- mintKey: PublicKey
  
  The SPL token mint address
- provider: default
  
  The Anchor provider that has the wallet
- owner: PublicKey = FEE_OWNER_KEY
  
  The user's address that owns the associated token account
Returns Promise<TransactionInstruction>

getVaultOwnerAndNonce

getVaultOwnerAndNonce(marketPublicKey: PublicKey, dexProgramId: PublicKey): Promise<[PublicKey, BN]>

- Defined in dev-docs/gitmodules/psyoptions-ts/packages/psy-american/src/utils/getVaultOwnerAndNonce.ts:13
This is needed for the permissioned serum markets.

TODO can we replace this with PublicKey.findProgramAddress

Parameters
- marketPublicKey: PublicKey
- dexProgramId: PublicKey
Returns Promise<[PublicKey, BN]>

parseTransactionError

parseTransactionError(error: any): ProgramError

- Defined in dev-docs/gitmodules/psyoptions-ts/packages/psy-american/src/utils/parseTransactionErrors.ts:6
Parameters
- error: any
Returns ProgramError

Index

Namespaces

Enumerations

Type aliases

Variables

Functions

Type aliases

NetworkInfo

Type declaration

feeOwnerKey: PublicKey

serumReferrerId: PublicKey

OptionMarket

Type declaration

bumpSeed: number

exerciseFeeAccount: PublicKey

expirationUnixTimestamp: anchor.BN

expired: boolean

mintFeeAccount: PublicKey

optionMint: PublicKey

quoteAmountPerContract: anchor.BN

quoteAssetMint: PublicKey

quoteAssetPool: PublicKey

underlyingAmountPerContract: anchor.BN

underlyingAssetMint: PublicKey

underlyingAssetPool: PublicKey

writerTokenMint: PublicKey

OptionMarketWithKey

OrderParamsWithFeeRate

Type parameters

T

PsyAmerican

Type declaration

name: "psy_american"

version: "0.0.0"

Variables

Const FEE_OWNER_KEY

Const NFT_MINT_LAMPORTS

Const PSY_AMERICAN_PROGRAM_IDS

Type declaration

3KAqLcLAY8W7ZxGT1MJcFPDMNJKJsXaE1m9i1JPahfmH: ProgramVersions

AAcHauRu6eUDePN3hDDAUTbgyRq5xFbRZJCLsUdpBCJb: ProgramVersions

GDvqQy3FkDB2wyNwgZGp5YkmRMUmWbhNNWDMYKbLSZ5N: ProgramVersions

Const PsyAmericanIdl

Functions

chunkArray

Parameters

myArray: any[]

chunkSize: number

Returns any[][]

deriveOptionKeyFromParams

Parameters

__namedParameters: { expirationUnixTimestamp: BN; programId: PublicKey; quoteAmountPerContract: BN; quoteMint: PublicKey; underlyingAmountPerContract: BN; underlyingMint: PublicKey }

expirationUnixTimestamp: BN

programId: PublicKey

quoteAmountPerContract: BN

quoteMint: PublicKey

underlyingAmountPerContract: BN

underlyingMint: PublicKey

Returns Promise<[PublicKey, number]>

feeAmountPerContract

Parameters

assetQuantity: BN

Returns BN

getAllOptionAccounts

Parameters

program: Program<PsyAmerican>

Returns Promise<OptionMarketWithKey[]>

getOptionByKey

Parameters

program: Program<PsyAmerican>

key: PublicKey

Returns Promise<OptionMarketWithKey>

getOrAddAssociatedTokenAccountTx

Parameters

associatedAddress: PublicKey

mintKey: PublicKey

provider: default

owner: PublicKey = FEE_OWNER_KEY

Returns Promise<TransactionInstruction>

getVaultOwnerAndNonce