Class DeepBookConfig

constructor

• new DeepBookConfig(
      __namedParameters: {
          address: string;
          adminCap?: string;
          balanceManagers?: { [key: string]: BalanceManager };
          coins?: CoinMap;
          marginAdminCap?: string;
          marginMaintainerCap?: string;
          marginManagers?: { [key: string]: MarginManager };
          marginPools?: MarginPoolMap;
          marginPyth?: MarginPythMode;
          network: Network;
          packageIds?: DeepbookPackageIds;
          pools?: PoolMap;
          pyth?: PythConfig;
          pythUpgraded?: PythConfig;
      },
  ): DeepBookConfig

  Parameters

  • __namedParameters: {
        address: string;
        adminCap?: string;
        balanceManagers?: { [key: string]: BalanceManager };
        coins?: CoinMap;
        marginAdminCap?: string;
        marginMaintainerCap?: string;
        marginManagers?: { [key: string]: MarginManager };
        marginPools?: MarginPoolMap;
        marginPyth?: MarginPythMode;
        network: Network;
        packageIds?: DeepbookPackageIds;
        pools?: PoolMap;
        pyth?: PythConfig;
        pythUpgraded?: PythConfig;
    }

  Returns DeepBookConfig

address

OptionaladminCap

balanceManager

balanceManagers

DEEP_TREASURY_ID

DEEPBOOK_PACKAGE_ID

LIQUIDATION_PACKAGE_ID

MARGIN_PACKAGE_ID

MARGIN_REGISTRY_ID

MARGIN_V1

OptionalmarginAdminCap

OptionalmarginMaintainerCap

marginManagers

marginPyth

network

pyth

pythUpgraded

REGISTRY_ID

activePyth

• get activePyth(): PythConfig

  The Pyth deployment margin currently prices against.

  Returns PythConfig

usesUpgradedPyth

• get usesUpgradedPyth(): boolean

  True when margin calls should use the upgraded modules and price objects.

  Returns boolean

getBalanceManager

• getBalanceManager(managerKey: string): BalanceManager

  Parameters

  • managerKey: string

    Key of the balance manager

  Returns BalanceManager

  The BalanceManager object

  Description

  Get the balance manager by key

getCoin

• getCoin(key: string): Coin

  Parameters

  • key: string

  Returns Coin

getMarginManager

• getMarginManager(managerKey: string): MarginManager

  Parameters

  • managerKey: string

    Key of the margin manager

  Returns MarginManager

  The MarginManager object

  Description

  Get the margin manager by key

getMarginPool

• getMarginPool(key: string): MarginPool

  Parameters

  • key: string

  Returns MarginPool

getPool

• getPool(key: string): Pool

  Parameters

  • key: string

  Returns Pool

getPriceInfoObjectId

• getPriceInfoObjectId(coinKey: string): string

  The PriceInfoObject id for a coin under the active Pyth deployment.

  Throws rather than passing undefined into a move call: under the upgraded deployment a feed may simply have no object yet, and the resulting on-chain abort (EPriceFeedIdMismatch) does not say which coin was at fault.

  Parameters

  • coinKey: string

  Returns string

requirePyth

• requirePyth(): void

  Returns void