Documentation
    Preparing search index...

    Module @mysten/deepbook-v3

    Deepbook TypeScript SDK

    Enumerations

    OrderType
    SelfMatchingOptions

    Classes

    BalanceManagerContract
    ConfigurationError
    DeepBookAdminContract
    DeepBookClient
    DeepBookConfig
    DeepBookContract
    DeepBookError
    FlashLoanContract
    GovernanceContract
    MarginAdminContract
    MarginMaintainerContract
    MarginManagerContract
    MarginPoolContract
    MarginTPSLContract
    PoolProxyContract
    ResourceNotFoundError
    SuiPriceServiceConnection
    SuiPythClient
    ValidationError

    Interfaces

    AccountBalances
    AccountInfo
    AddConditionalOrderParams
    BalanceManager
    BaseQuantityIn
    BaseQuantityOut
    BorrowedShares
    Coin
    Config
    CreatePermissionlessPoolParams
    CreatePoolAdminParams
    DecodedOrderId
    DeepBookClientOptions
    DeepBookCompatibleClient
    DeepBookOptions
    DeepbookPackageIds
    InterestConfigParams
    Level2Range
    Level2TicksFromMid
    LockedBalances
    ManagerBalance
    MarginManager
    MarginManagerAssets
    MarginManagerBalancesResult
    MarginManagerDebts
    MarginManagerState
    MarginPool
    MarginPoolConfigParams
    MarginProposalParams
    OrderDeepRequiredResult
    PendingLimitOrderParams
    PendingMarketOrderParams
    PlaceLimitOrderParams
    PlaceMarginLimitOrderParams
    PlaceMarginMarketOrderParams
    PlaceMarketOrderParams
    Pool
    PoolBookParams
    PoolConfigParams
    PoolTradeParams
    ProposalParams
    QuantityOut
    QuoteQuantityIn
    QuoteQuantityOut
    ReferralBalances
    SetEwmaParams
    SwapParams
    VaultBalances

    Type Aliases

    CoinMap
    MarginPoolMap
    PoolDeepPrice
    PoolMap

    Variables

    Account
    Balances
    DEEP_SCALAR
    ErrorMessages
    FLOAT_SCALAR
    GAS_BUDGET
    mainnetCoins
    mainnetMarginPools
    mainnetPackageIds
    mainnetPools
    mainnetPythConfigs
    MAX_TIMESTAMP
    Order
    OrderDeepPrice
    POOL_CREATION_FEE_DEEP
    PRICE_INFO_OBJECT_MAX_AGE_MS
    testnetCoins
    testnetMarginPools
    testnetPackageIds
    testnetPools
    testnetPythConfigs

    Functions

    deepbook
    validateAddress
    validateNonEmptyArray
    validateNonNegativeNumber
    validatePositiveNumber
    validateRange
    validateRequired
    VecSet