Class PoolConfig

constructor

• new PoolConfig(programId, perpComposibilityProgramId, fbNftRewardProgramId, cluster, poolName, poolAddress, stakedLpTokenMint, compoundingTokenMint, stakedLpVault, compoundingLpVault, lpDecimals, compoundingLpTokenSymbol, stakedLpTokenSymbol, perpetuals, transferAuthority, multisig, addressLookupTableAddresses, backupOracle, nftCollectionAddress, rewardDistributionProgram, tokens, custodies, markets): PoolConfig

• Parameters

  • programId: PublicKey
  • perpComposibilityProgramId: PublicKey
  • fbNftRewardProgramId: PublicKey
  • cluster: Cluster
  • poolName: string
  • poolAddress: PublicKey
  • stakedLpTokenMint: PublicKey
  • compoundingTokenMint: PublicKey
  • stakedLpVault: PublicKey
  • compoundingLpVault: PublicKey
  • lpDecimals: number
  • compoundingLpTokenSymbol: string
  • stakedLpTokenSymbol: string
  • perpetuals: PublicKey
  • transferAuthority: PublicKey
  • multisig: PublicKey
  • addressLookupTableAddresses: PublicKey[]
  • backupOracle: PublicKey
  • nftCollectionAddress: PublicKey
  • rewardDistributionProgram: {
        programId: PublicKey;
        rewardMint: PublicKey;
        rewardTokenAccount: PublicKey;
        rewardVault: PublicKey;
        transferAuthority: PublicKey;
    }

    • programId: PublicKey

    • rewardMint: PublicKey

    • rewardTokenAccount: PublicKey

    • rewardVault: PublicKey

    • transferAuthority: PublicKey

  • tokens: Token[]
  • custodies: CustodyConfig[]
  • markets: MarketConfig[]

  Returns PoolConfig

addressLookupTableAddresses

backupOracle

cluster

compoundingLpTokenSymbol

compoundingLpVault

compoundingTokenMint

custodies

fbNftRewardProgramId

lpDecimals

markets

multisig

nftCollectionAddress

perpComposibilityProgramId

perpetuals

poolAddress

poolName

programId

rewardDistributionProgram

stakedLpTokenMint

stakedLpTokenSymbol

stakedLpVault

tokens

transferAuthority

doesMarketExist

• doesMarketExist(pubkey): boolean

• Parameters

  • pubkey: PublicKey

  Returns boolean

getAllCustodies

• getAllCustodies(): PublicKey[]

• Returns PublicKey[]

getAllMarketPks

• getAllMarketPks(): PublicKey[]

• Returns PublicKey[]

getAllTokenMints

• getAllTokenMints(): PublicKey[]

• Returns PublicKey[]

getCustodyAccountFromCustodyId

• getCustodyAccountFromCustodyId(custodyId): PublicKey

• Parameters

  • custodyId: number

  Returns PublicKey

getCustodyIdFromCustodyAccount

• getCustodyIdFromCustodyAccount(custodyAccountPk): number

• Parameters

  • custodyAccountPk: Address

  Returns number

getMarketConfig

• getMarketConfig(targetCustody, collateralCustody, side): MarketConfig

• Parameters

  • targetCustody: PublicKey
  • collateralCustody: PublicKey
  • side: Side

  Returns MarketConfig

getMarketConfigByPk

• getMarketConfigByPk(marketAccountPk): MarketConfig

• Parameters

  • marketAccountPk: PublicKey

  Returns MarketConfig

getMarketPk

• getMarketPk(targetCustody, collateralCustody, side): PublicKey

• Parameters

  • targetCustody: PublicKey
  • collateralCustody: PublicKey
  • side: Side

  Returns PublicKey

getNonStableCustodies

• getNonStableCustodies(): PublicKey[]

• Returns PublicKey[]

getNonStableTokens

• getNonStableTokens(): PublicKey[]

• Returns PublicKey[]

getOrderFromMarketPk

• getOrderFromMarketPk(owner, marketAccount): PublicKey

• Parameters

  • owner: PublicKey
  • marketAccount: PublicKey

  Returns PublicKey

getPositionFromCustodyPk

• getPositionFromCustodyPk(owner, targetCustody, collateralCustody, side): PublicKey

• Parameters

  • owner: PublicKey
  • targetCustody: PublicKey
  • collateralCustody: PublicKey
  • side: Side

  Returns PublicKey

getPositionFromMarketPk

• getPositionFromMarketPk(owner, marketAccount): PublicKey

• Parameters

  • owner: PublicKey
  • marketAccount: PublicKey

  Returns PublicKey

getTokenFromMintPk

• getTokenFromMintPk(mint): Token

• Parameters

  • mint: PublicKey

  Returns Token

getTokenFromMintString

• getTokenFromMintString(mint): Token

• Parameters

  • mint: string

  Returns Token

getTokenFromSymbol

• getTokenFromSymbol(symbol): Token

• Parameters

  • symbol: string

  Returns Token

Static buildPoolconfigFromJson

• buildPoolconfigFromJson(poolConfig): PoolConfig

• Parameters

  • poolConfig: {
        addressLookupTableAddresses: string[];
        backupOracle: string;
        cluster: string;
        compoundingLpTokenSymbol: string;
        compoundingLpVault: string;
        compoundingTokenMint: string;
        custodies: {
            custodyAccount: string;
            custodyId: number;
            decimals: number;
            extOracleAddress: string;
            intOracleAddress: string;
            isStable: boolean;
            isVirtual: boolean;
            mintKey: string;
            pythPriceId: string;
            pythTicker: string;
            symbol: string;
            tokenAccount: string;
            tokenPrecision: number;
            usdPrecision: number;
        }[];
        fbNftRewardProgramId: string;
        lpDecimals: number;
        markets: {
            collateralCustody: string;
            collateralCustodyId: number;
            collateralMint: string;
            marketAccount: string;
            marketId: number;
            maxLev: number;
            pool: string;
            side: string;
            targetCustody: string;
            targetCustodyId: number;
            targetMint: string;
        }[];
        metadataAccount: string;
        multisig: string;
        nftCollectionAddress: string;
        perpComposibilityProgramId: string;
        perpetuals: string;
        poolAddress: string;
        poolName: string;
        programId: string;
        rewardDistributionProgram: {
            programId: string;
            rewardMint: string;
            rewardTokenAccount: string;
            rewardVault: string;
            transferAuthority: string;
        };
        stakedLpTokenMint: string;
        stakedLpTokenSymbol: string;
        stakedLpVault: string;
        tokens: {
            decimals: number;
            isStable: boolean;
            isVirtual: boolean;
            mintKey: string;
            pythPriceId: string;
            pythTicker: string;
            symbol: string;
            tokenPrecision: number;
            usdPrecision: number;
        }[];
        transferAuthority: string;
    }

    • addressLookupTableAddresses: string[]

    • backupOracle: string

    • cluster: string

    • compoundingLpTokenSymbol: string

    • compoundingLpVault: string

    • compoundingTokenMint: string

    • custodies: {
          custodyAccount: string;
          custodyId: number;
          decimals: number;
          extOracleAddress: string;
          intOracleAddress: string;
          isStable: boolean;
          isVirtual: boolean;
          mintKey: string;
          pythPriceId: string;
          pythTicker: string;
          symbol: string;
          tokenAccount: string;
          tokenPrecision: number;
          usdPrecision: number;
      }[]

    • fbNftRewardProgramId: string

    • lpDecimals: number

    • markets: {
          collateralCustody: string;
          collateralCustodyId: number;
          collateralMint: string;
          marketAccount: string;
          marketId: number;
          maxLev: number;
          pool: string;
          side: string;
          targetCustody: string;
          targetCustodyId: number;
          targetMint: string;
      }[]

    • metadataAccount: string

    • multisig: string

    • nftCollectionAddress: string

    • perpComposibilityProgramId: string

    • perpetuals: string

    • poolAddress: string

    • poolName: string

    • programId: string

    • rewardDistributionProgram: {
          programId: string;
          rewardMint: string;
          rewardTokenAccount: string;
          rewardVault: string;
          transferAuthority: string;
      }

      • programId: string

      • rewardMint: string

      • rewardTokenAccount: string

      • rewardVault: string

      • transferAuthority: string

    • stakedLpTokenMint: string

    • stakedLpTokenSymbol: string

    • stakedLpVault: string

    • tokens: {
          decimals: number;
          isStable: boolean;
          isVirtual: boolean;
          mintKey: string;
          pythPriceId: string;
          pythTicker: string;
          symbol: string;
          tokenPrecision: number;
          usdPrecision: number;
      }[]

    • transferAuthority: string

  Returns PoolConfig

Static fromIdsByName

• fromIdsByName(name, cluster): PoolConfig

• Parameters

  • name: string
  • cluster: Cluster

  Returns PoolConfig

Static fromIdsByPk

• fromIdsByPk(poolPk, cluster): PoolConfig

• Parameters

  • poolPk: PublicKey
  • cluster: Cluster

  Returns PoolConfig

Static getCustodyConfig

• getCustodyConfig(custodyAccountPk, poolName, cluster): CustodyConfig

• Parameters

  • custodyAccountPk: Address
  • poolName: string
  • cluster: Cluster

  Returns CustodyConfig

Static getTokensInPool

• getTokensInPool(name, cluster): Token[]

• Parameters

  • name: string
  • cluster: Cluster

  Returns Token[]