Class PoolManager

Class that allows the creation and management of margin pools.

Hierarchy

PoolManager

Index

Constructors

constructor

new PoolManager(programs: MarginPrograms, provider: AnchorProvider): PoolManager
Parameters
- programs: MarginPrograms
- provider: AnchorProvider
Returns PoolManager
- Defined in libraries/ts/margin/src/margin/pool/poolManager.ts:34

Properties

owner

owner: PublicKey

programs

programs: MarginPrograms

provider

provider: AnchorProvider

Methods

create

create(args: IPoolCreationParams): Promise<string>
Creates a margin pool

Returns
Parameters
- args: IPoolCreationParams
  
  // TODO document interface
Returns Promise<string>
- Defined in libraries/ts/margin/src/margin/pool/poolManager.ts:98

load

load(__namedParameters: {
    programs?: MarginPrograms;
    tokenConfig: MarginTokenConfig;
    tokenMint: Address;
}): Promise<Pool>
Load a margin pool

Returns

Memberof
PoolManager
Parameters
- __namedParameters: {
      programs?: MarginPrograms;
      tokenConfig: MarginTokenConfig;
      tokenMint: Address;
  }
  - Optional programs?: MarginPrograms
  - tokenConfig: MarginTokenConfig
  - tokenMint: Address
Returns Promise<Pool>
- Defined in libraries/ts/margin/src/margin/pool/poolManager.ts:50

loadAll

loadAll(programs??: MarginPrograms): Promise<Record<string, Pool>>
Loads all margin pools bases on the config provided to the manager

Returns

Memberof
PoolManager
Parameters
- Optional programs: MarginPrograms = ...
Returns Promise<Record<string, Pool>>
- Defined in libraries/ts/margin/src/margin/pool/poolManager.ts:72

setPrograms

setPrograms(programs: MarginPrograms): void
Parameters
- programs: MarginPrograms
Returns void
- Defined in libraries/ts/margin/src/margin/pool/poolManager.ts:89

setProvider

setProvider(provider: AnchorProvider): void
Parameters
- provider: AnchorProvider
Returns void
- Defined in libraries/ts/margin/src/margin/pool/poolManager.ts:85

withConfigureMarginPool

withConfigureMarginPool(__namedParameters: {
    address: PublicKey;
    addresses: PoolAddresses;
    collateralWeight: number;
    instructions: TransactionInstruction[];
    marginPoolConfig: TypeDef<Object, Record<string, never>>;
    maxLeverage: number;
    programs?: MarginPrograms;
    pythPrice: Address;
    pythProduct: Address;
    requester: Address;
}): Promise<void>
Create a margin pool by configuring the token with the control program.

Instructions
- jet_control::configure_token - configures an SPL token and creates its pool
Parameters
- __namedParameters: {
      address: PublicKey;
      addresses: PoolAddresses;
      collateralWeight: number;
      instructions: TransactionInstruction[];
      marginPoolConfig: TypeDef<Object, Record<string, never>>;
      maxLeverage: number;
      programs?: MarginPrograms;
      pythPrice: Address;
      pythProduct: Address;
      requester: Address;
  }
  - address: PublicKey
  - addresses: PoolAddresses
  - collateralWeight: number
  - instructions: TransactionInstruction[]
  - marginPoolConfig: TypeDef<Object, Record<string, never>>
  - maxLeverage: number
  - Optional programs?: MarginPrograms
  - pythPrice: Address
  - pythProduct: Address
  - requester: Address
Returns Promise<void>
- Defined in libraries/ts/margin/src/margin/pool/poolManager.ts:206

withCreateMarginPool

withCreateMarginPool(__namedParameters: {
    address: PublicKey;
    addresses: PoolAddresses;
    instructions: TransactionInstruction[];
    programs?: MarginPrograms;
    requester: Address;
}): Promise<void>
// TODO add description
Parameters
- __namedParameters: {
      address: PublicKey;
      addresses: PoolAddresses;
      instructions: TransactionInstruction[];
      programs?: MarginPrograms;
      requester: Address;
  }
  - address: PublicKey
  - addresses: PoolAddresses
  - instructions: TransactionInstruction[]
  - Optional programs?: MarginPrograms
  - requester: Address
Returns Promise<void>
- Defined in libraries/ts/margin/src/margin/pool/poolManager.ts:149

Class PoolManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

programs: MarginPrograms

provider: AnchorProvider

Returns PoolManager

Properties

owner

programs

provider

Methods

create

Returns

Parameters

args: IPoolCreationParams

Returns Promise<string>

load

Returns

Memberof

Parameters

__namedParameters: { programs?: MarginPrograms; tokenConfig: MarginTokenConfig; tokenMint: Address; }

Optional programs?: MarginPrograms

tokenConfig: MarginTokenConfig

tokenMint: Address

Returns Promise<Pool>

loadAll

Returns

Memberof

Parameters

Optional programs: MarginPrograms = ...

Returns Promise<Record<string, Pool>>

setPrograms

Parameters

programs: MarginPrograms

Returns void

setProvider

Parameters

provider: AnchorProvider

Returns void

withConfigureMarginPool

Instructions

Parameters

address: PublicKey

addresses: PoolAddresses

collateralWeight: number

instructions: TransactionInstruction[]

marginPoolConfig: TypeDef<Object, Record<string, never>>

maxLeverage: number

Optional programs?: MarginPrograms

pythPrice: Address

pythProduct: Address

requester: Address

Returns Promise<void>

withCreateMarginPool

Parameters

__namedParameters: { address: PublicKey; addresses: PoolAddresses; instructions: TransactionInstruction[]; programs?: MarginPrograms; requester: Address; }

address: PublicKey

addresses: PoolAddresses

instructions: TransactionInstruction[]

Optional programs?: MarginPrograms

requester: Address

Returns Promise<void>

Settings

Member Visibility

Theme

__namedParameters: {
programs?: MarginPrograms;
tokenConfig: MarginTokenConfig;
tokenMint: Address;
}

`Optional` programs?: MarginPrograms

`Optional` programs: MarginPrograms = ...

`Optional` programs?: MarginPrograms

__namedParameters: {
address: PublicKey;
addresses: PoolAddresses;
instructions: TransactionInstruction[];
programs?: MarginPrograms;
requester: Address;
}

`Optional` programs?: MarginPrograms