Class DeepBookAdminContract

DeepBookAdminContract class for managing admin actions.

Index

Constructors

Methods

addStableCoin createPoolAdmin disableVersion enableVersion removeStableCoin setTreasuryAddress unregisterPoolAdmin updateAllowedVersions

Constructors

constructor

new DeepBookAdminContract(config: DeepBookConfig): DeepBookAdminContract
Parameters
- config: DeepBookConfig
  Configuration for DeepBookAdminContract
Returns DeepBookAdminContract
- Defined in deepbook-v3/src/transactions/deepbookAdmin.ts:19

Methods

addStableCoin

addStableCoin(stableCoinKey: string): (tx: Transaction) => void
Parameters
- stableCoinKey: string
  The name of the stable coin to be added
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Add a coin to whitelist of stable coins
- Defined in deepbook-v3/src/transactions/deepbookAdmin.ts:162

createPoolAdmin

createPoolAdmin(params: CreatePoolAdminParams): (tx: Transaction) => void
Parameters
- params: CreatePoolAdminParams
  Parameters for creating pool as admin
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Create a new pool as admin
- Defined in deepbook-v3/src/transactions/deepbookAdmin.ts:40

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/deepbookAdmin.ts:130

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/deepbookAdmin.ts:114

removeStableCoin

removeStableCoin(stableCoinKey: string): (tx: Transaction) => void
Parameters
- stableCoinKey: string
  The name of the stable coin to be removed
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Remove a coin from whitelist of stable coins
- Defined in deepbook-v3/src/transactions/deepbookAdmin.ts:176

setTreasuryAddress

setTreasuryAddress(treasuryAddress: string): (tx: Transaction) => void
Parameters
- treasuryAddress: string
  The treasury address
Returns (tx: Transaction) => void
A function that takes a Transaction object

Description
Sets the treasury address where pool creation fees will be sent
- Defined in deepbook-v3/src/transactions/deepbookAdmin.ts:146

unregisterPoolAdmin

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

Description
Unregister a pool as admin
- Defined in deepbook-v3/src/transactions/deepbookAdmin.ts:74

updateAllowedVersions

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

Description
Update the allowed versions for a pool
- Defined in deepbook-v3/src/transactions/deepbookAdmin.ts:94