Class AdminControlledPoolInstructions

Instructions for interacting with the example admin-controlled pool.

Hierarchy

AdminControlledPoolInstructions

Index

Methods

Methods

Static addAsset

addAsset(pool: PoolInfo, vault: PublicKey): TransactionInstruction

- Defined in admin-controlled-pool.ts:100
Adds a new asset to the pool.

Parameters
- pool: PoolInfo
- vault: PublicKey
Returns TransactionInstruction

Static approveDelegate

approveDelegate(pool: PoolInfo, vault: PublicKey, delegate: PublicKey, amount: BN): TransactionInstruction

- Defined in admin-controlled-pool.ts:85
Approves an account to spend tokens on behalf of the pool.

Parameters
- pool: PoolInfo
- vault: PublicKey
- delegate: PublicKey
- amount: BN
Returns TransactionInstruction

Static pause

pause(pool: PoolInfo): TransactionInstruction

- Defined in admin-controlled-pool.ts:64
Pauses creations and redemptions for the pool.

Parameters
- pool: PoolInfo
Returns TransactionInstruction

Static removeAsset

removeAsset(pool: PoolInfo, vault: PublicKey): TransactionInstruction

- Defined in admin-controlled-pool.ts:111
Removes an asset from the pool.

The pool must not currently own any tokens of the asset to be removed.

Parameters
- pool: PoolInfo
- vault: PublicKey
Returns TransactionInstruction

Static unpause

unpause(pool: PoolInfo): TransactionInstruction

- Defined in admin-controlled-pool.ts:72
Resumes creations and redemptions for the pool.

Pool assets must not have any outstanding delegates.

Parameters
- pool: PoolInfo
Returns TransactionInstruction

Static updateAdmin

updateAdmin(pool: PoolInfo, newAdmin: PublicKey): TransactionInstruction

- Defined in admin-controlled-pool.ts:123
Transfers admin permission for the pool to a new account.

Parameters
- pool: PoolInfo
- newAdmin: PublicKey
Returns TransactionInstruction

Static updateFee

updateFee(pool: PoolInfo, feeRate: number): TransactionInstruction

- Defined in admin-controlled-pool.ts:118
Modifies the fee rate for the pool.

Parameters
- pool: PoolInfo
- feeRate: number
Returns TransactionInstruction

Generated using TypeDoc