Interface DeepBookOptions<Name>

interface DeepBookOptions<Name = "deepbook"> {
    address: string;
    adminCap?: string;
    balanceManagers?: { [key: string]: BalanceManager };
    coins?: CoinMap;
    marginAdminCap?: string;
    marginMaintainerCap?: string;
    marginManagers?: { [key: string]: MarginManager };
    marginPyth?: MarginPythMode;
    name?: Name;
    packageIds?: DeepbookPackageIds;
    pools?: PoolMap;
    pyth?: PythConfig;
    pythUpgraded?: PythConfig;
}

Type Parameters

Name = "deepbook"

Hierarchy (View Summary)

DeepBookOptions
- DeepBookClientOptions

Index

Properties

address adminCap? balanceManagers? coins? marginAdminCap? marginMaintainerCap? marginManagers? marginPyth? name? packageIds? pools? pyth? pythUpgraded?

Properties

address

address: string

`Optional`adminCap

adminCap?: string

`Optional`balanceManagers

balanceManagers?: { [key: string]: BalanceManager }

`Optional`coins

coins?: CoinMap

`Optional`marginAdminCap

marginAdminCap?: string

`Optional`marginMaintainerCap

marginMaintainerCap?: string

`Optional`marginManagers

marginManagers?: { [key: string]: MarginManager }

`Optional`marginPyth

marginPyth?: MarginPythMode

Which Pyth deployment margin entrypoints price against. Defaults to the network's configured mode; set it to move ahead of that default.

`Optional`name

name?: Name

`Optional`packageIds

packageIds?: DeepbookPackageIds

`Optional`pools

pools?: PoolMap

`Optional`pyth

pyth?: PythConfig

`Optional`pythUpgraded

pythUpgraded?: PythConfig

Pyth's upgraded Core. Used by margin calls when marginPyth is 'upgraded'.