Class MarginAdminContract

MarginAdminContract class for managing admin actions.

Index

Constructors

Methods

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

Constructors

constructor

new MarginAdminContract(config: DeepBookConfig): MarginAdminContract
Parameters
- config: DeepBookConfig
  Configuration for MarginAdminContract
Returns MarginAdminContract
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:21

Methods

addConfig

addConfig(config: TransactionArgument): (tx: Transaction) => void
Parameters
- config: TransactionArgument
  The config to be added
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Add the PythConfig to the margin registry
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:163

adminWithdrawDefaultReferralFees

adminWithdrawDefaultReferralFees(
coinKey: string,
): (tx: Transaction) => TransactionResult
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

Description
Withdraw the default referral fees (admin only) The default referral at 0x0 doesn't have a SupplyReferral object
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:386

disableDeepbookPool

disableDeepbookPool(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key of the pool to be disabled
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Disable a deepbook pool from margin trading
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:118

disableVersion

disableVersion(version: number): (tx: Transaction) => void
Parameters
- version: number
  The version to be disabled
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Disable a specific version
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:209

disableVersionPauseCap

disableVersionPauseCap(
version: number,
pauseCapId: string,
): (tx: Transaction) => void
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

Description
Disable a version using pause cap
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:369

enableDeepbookPool

enableDeepbookPool(poolKey: string): (tx: Transaction) => void
Parameters
- poolKey: string
  The key of the pool to be enabled
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Enable a deepbook pool for margin trading
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:97

enableVersion

enableVersion(version: number): (tx: Transaction) => void
Parameters
- version: number
  The version to be enabled
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Enable a specific version
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:193

mintMaintainerCap

mintMaintainerCap(): (tx: Transaction) => TransactionResult
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Mint a maintainer cap
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:41

mintPauseCap

mintPauseCap(): (tx: Transaction) => TransactionResult
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

Description
Mint a pause cap
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:335

newCoinTypeData

newCoinTypeData(
    coinKey: string,
    maxConfBps: number,
    maxEwmaDifferenceBps: number,
): (tx: Transaction) => TransactionResult
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

Description
Create a new coin type data
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:281

newPoolConfig

newPoolConfig(
poolKey: string,
poolConfigParams: PoolConfigParams,
): (tx: Transaction) => TransactionResult
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

Description
Create a new pool config
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:226

newPoolConfigWithLeverage

newPoolConfigWithLeverage(
poolKey: string,
leverage: number,
): (tx: Transaction) => void
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

Description
Create a new pool config with leverage
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:259

newPythConfig

newPythConfig(
    coinSetups: {
        coinKey: string;
        maxConfBps: number;
        maxEwmaDifferenceBps: number;
    }[],
    maxAgeSeconds: number,
): (tx: Transaction) => TransactionResult
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

Description
Create a new Pyth config
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:308

registerDeepbookPool

registerDeepbookPool(
poolKey: string,
poolConfig: TransactionArgument,
): (tx: Transaction) => void
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

Description
Register a deepbook pool
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:75

removeConfig

removeConfig(): (tx: Transaction) => void
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Remove the PythConfig from the margin registry
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:180

revokeMaintainerCap

revokeMaintainerCap(maintainerCapId: string): (tx: Transaction) => void
Parameters
- maintainerCapId: string
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Revoke a maintainer cap
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:56

revokePauseCap

revokePauseCap(pauseCapId: string): (tx: Transaction) => void
Parameters
- pauseCapId: string
  The ID of the pause cap to revoke
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Revoke a pause cap
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:351

updateRiskParams

updateRiskParams(
poolKey: string,
poolConfig: TransactionArgument,
): (tx: Transaction) => void
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

Description
Update the risk parameters for a margin
- Defined in packages/deepbook-v3/src/transactions/marginAdmin.ts:140

Class MarginAdminContract

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MarginAdminContract

Methods

addConfig

Parameters

Returns (tx: Transaction) => void

Description

adminWithdrawDefaultReferralFees

Parameters

Returns (tx: Transaction) => TransactionResult

Description

disableDeepbookPool

Parameters

Returns (tx: Transaction) => void

Description

disableVersion

Parameters

Returns (tx: Transaction) => void

Description

disableVersionPauseCap

Parameters

Returns (tx: Transaction) => void

Description

enableDeepbookPool

Parameters

Returns (tx: Transaction) => void

Description

enableVersion

Parameters

Returns (tx: Transaction) => void

Description

mintMaintainerCap

Returns (tx: Transaction) => TransactionResult

Description

mintPauseCap

Returns (tx: Transaction) => TransactionResult

Description

newCoinTypeData

Parameters

Returns (tx: Transaction) => TransactionResult

Description

newPoolConfig

Parameters

Returns (tx: Transaction) => TransactionResult

Description

newPoolConfigWithLeverage

Parameters

Returns (tx: Transaction) => void

Description

newPythConfig

Parameters

Returns (tx: Transaction) => TransactionResult

Description

registerDeepbookPool

Parameters

Returns (tx: Transaction) => void

Description

removeConfig

Returns (tx: Transaction) => void

Description

revokeMaintainerCap

Parameters

Returns (tx: Transaction) => void

Description

revokePauseCap

Parameters

Returns (tx: Transaction) => void

Description

updateRiskParams

Parameters

Returns (tx: Transaction) => void

Description

Settings

On This Page