Documentation
    Preparing search index...

    Class MarginAdminContract

    MarginAdminContract class for managing admin actions.

    Index

    Constructors

    constructor

    Methods

    addConfig adminWithdrawDefaultReferralFees disableDeepbookPool disableVersion disableVersionPauseCap enableDeepbookPool enableVersion mintMaintainerCap mintPauseCap newCoinTypeData newPoolConfig newPoolConfigWithLeverage newPythConfig registerDeepbookPool removeConfig revokeMaintainerCap revokePauseCap updateRiskParams

    Constructors

    Methods

    • Parameters

      • config: TransactionArgument

        The config to be added

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Add the PythConfig to the margin registry

    • Parameters

      • coinKey: string

        The key to identify the margin pool

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object and returns a Coin

      Withdraw the default referral fees (admin only) The default referral at 0x0 doesn't have a SupplyReferral object

    • Parameters

      • poolKey: string

        The key of the pool to be disabled

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Disable a deepbook pool from margin trading

    • 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 disable

      • pauseCapId: string

        The ID of the pause cap

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Disable a version using pause cap

    • Parameters

      • poolKey: string

        The key of the pool to be enabled

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Enable a deepbook pool for margin trading

    • 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) => TransactionResult

      A function that takes a Transaction object

      Mint a maintainer cap

    • Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Mint a pause cap

    • Parameters

      • coinKey: string

        The key to identify the coin

      • maxConfBps: number

        The maximum confidence interval in basis points

      • maxEwmaDifferenceBps: number

        The maximum EWMA difference in basis points

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Create a new coin type data

    • Parameters

      • poolKey: string

        The key to identify the pool

      • poolConfigParams: PoolConfigParams

        The parameters for the pool config

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Create a new pool config

    • Parameters

      • poolKey: string

        The key to identify the pool

      • leverage: number

        The leverage for the pool

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Create a new pool config with leverage

    • Parameters

      • coinSetups: { coinKey: string; maxConfBps: number; maxEwmaDifferenceBps: number }[]

        The coins with their oracle config to be added to the Pyth config

      • maxAgeSeconds: number

        The max age in seconds for the Pyth config

      Returns (tx: Transaction) => TransactionResult

      A function that takes a Transaction object

      Create a new Pyth config

    • Parameters

      • poolKey: string

        The key of the pool to be registered

      • poolConfig: TransactionArgument

        The configuration of the pool

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Register a deepbook pool

    • Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Remove the PythConfig from the margin registry

    • Parameters

      • maintainerCapId: string

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Revoke a maintainer cap

    • Parameters

      • pauseCapId: string

        The ID of the pause cap to revoke

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Revoke a pause cap

    • Parameters

      • poolKey: string

        The key of the pool to be updated

      • poolConfig: TransactionArgument

        The configuration of the pool

      Returns (tx: Transaction) => void

      A function that takes a Transaction object

      Update the risk parameters for a margin

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods