Documentation
    Preparing search index...

    Class DeepBookAdminContract

    DeepBookAdminContract class for managing admin actions.

    Index

    Constructors

    constructor

    Methods

    addStableCoin adjustMinLotSize adjustTickSize createPoolAdmin disableVersion enableVersion removeStableCoin 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

    • Parameters

      • params: CreatePoolAdminParams

        Parameters for creating pool as admin

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Create a new pool as admin

    • 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

        The version to be enabled

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Enable a specific version

    • 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

      • 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