Documentation
    Preparing search index...

    Interface DeepBookClientOptions

    interface DeepBookClientOptions {
        address: string;
        adminCap?: string;
        balanceManagers?: { [key: string]: BalanceManager };
        client: DeepBookCompatibleClient;
        coins?: CoinMap;
        marginAdminCap?: string;
        marginMaintainerCap?: string;
        marginManagers?: { [key: string]: MarginManager };
        marginPyth?: MarginPythMode;
        name?: "deepbook";
        network: Network;
        packageIds?: DeepbookPackageIds;
        pools?: PoolMap;
        pyth?: PythConfig;
        pythUpgraded?: PythConfig;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    address: string
    adminCap?: string
    balanceManagers?: { [key: string]: BalanceManager }
    client: DeepBookCompatibleClient
    coins?: CoinMap
    marginAdminCap?: string
    marginMaintainerCap?: string
    marginManagers?: { [key: string]: MarginManager }
    marginPyth?: MarginPythMode

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

    name?: "deepbook"
    network: Network
    packageIds?: DeepbookPackageIds
    pools?: PoolMap
    pyth?: PythConfig
    pythUpgraded?: PythConfig

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

    Settings

    Member Visibility

    On This Page

    Properties