Class MarginAdminContract

MarginAdminContract class for managing admin actions.

Index

Constructors

Methods

addConfig disableDeepbookPool disableVersion enableDeepbookPool enableVersion mintMaintainerCap newCoinTypeData newPoolConfig newPoolConfigWithLeverage newPythConfig registerDeepbookPool removeConfig revokeMaintainerCap updateRiskParams

Constructors

constructor

new MarginAdminContract(config: DeepBookConfig): MarginAdminContract
Parameters
- config: DeepBookConfig
  Configuration for MarginAdminContract
Returns MarginAdminContract
- Defined in 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 deepbook-v3/src/transactions/marginAdmin.ts:160

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 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 deepbook-v3/src/transactions/marginAdmin.ts:206

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 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 deepbook-v3/src/transactions/marginAdmin.ts:190

mintMaintainerCap

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

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

newCoinTypeData

newCoinTypeData(coinKey: string): (tx: Transaction) => TransactionResult
Parameters
- coinKey: string
  The key to identify the coin
Returns (tx: Transaction) => TransactionResult
A function that takes a Transaction object

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

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 deepbook-v3/src/transactions/marginAdmin.ts:223

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 deepbook-v3/src/transactions/marginAdmin.ts:256

newPythConfig

newPythConfig(
coins: string[],
maxAgeSeconds: number,
): (tx: Transaction) => TransactionResult
Parameters
- coins: string[]
  The coins 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 deepbook-v3/src/transactions/marginAdmin.ts:293

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 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 deepbook-v3/src/transactions/marginAdmin.ts:177

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 deepbook-v3/src/transactions/marginAdmin.ts:56

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 deepbook-v3/src/transactions/marginAdmin.ts:140