Documentation
    Preparing search index...

    Class DeepBookAdminContract

    DeepBookAdminContract class for managing admin actions.

    Index

    Constructors

    constructor

    Methods

    addStableCoin adjustMinLotSize adjustTickSize authorizeMarginApp corePauseCaps createPoolAdmin deauthorizeMarginApp disableVersion disableVersionWithCorePauseCap enableEwmaState enableVersion initBalanceManagerMap mintCorePauseCap removeStableCoin revokeCorePauseCap setEwmaParams setTreasuryAddress unregisterPoolAdmin updateAllowedVersions

    Constructors

    Methods

    • Parameters

      • stableCoinKey: string

        The name of the stable coin to be added

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Add a coin to whitelist of stable coins

    • Parameters

      • poolKey: string

        The key to identify the pool

      • newLotSize: number

        The new lot size

      • newMinSize: number

        The new min size

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Adjust the lot size and min size of a pool

    • Parameters

      • poolKey: string

        The key to identify the pool

      • newTickSize: number

        The new tick size

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Adjust the tick size of a pool

    • Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Authorize the MarginApp to access protected features of DeepBook

    • Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object and returns a VecSet<ID>

      Get the set of allowed DeepbookCorePauseCap IDs from the core registry.

    • Parameters

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Create a new pool as admin

    • Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object and returns a bool

      Deauthorize the MarginApp by removing its authorization key

    • Parameters

      • version: number

        The version to be disabled

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Disable a specific version

    • Parameters

      • version: number | bigint

        The version to disable

      • pauseCapId: string

        The ID of the core pause cap to authorize the disable

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Emergency kill switch — disable any allowed core package version (including the current one) using a held DeepbookCorePauseCap. Re-enable later via enableVersion.

    • Parameters

      • poolKey: string

        The key to identify the pool

      • enable: boolean

        Whether to enable or disable the EWMA state

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Enable or disable the EWMA state for a pool

    • Parameters

      • version: number

        The version to be enabled

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Enable a specific version

    • Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Initialize the balance manager map

    • Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object and returns the new pause cap

      Mint a DeepbookCorePauseCap. The new cap's ID is recorded in the core registry so it can later disable any allowed package version via disableVersionWithCorePauseCap. Companion to the margin-side MarginAdminContract.mintPauseCap.

    • Parameters

      • stableCoinKey: string

        The name of the stable coin to be removed

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Remove a coin from whitelist of stable coins

    • Parameters

      • pauseCapId: string

        The ID of the core pause cap to revoke

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Revoke a previously minted DeepbookCorePauseCap by ID.

    • Parameters

      • poolKey: string

        The key to identify the pool

      • params: SetEwmaParams

        The parameters to set

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Set the EWMA parameters for a pool

    • Parameters

      • treasuryAddress: string

        The treasury address

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Sets the treasury address where pool creation fees will be sent

    • Parameters

      • poolKey: string

        The key of the pool to be unregistered by admin

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Unregister a pool as admin

    • Parameters

      • poolKey: string

        The key of the pool to be updated

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Update the allowed versions for a pool

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods