Skip to main content

Pool

@centrifuge/sdk

@centrifuge/sdk / Pool

Class: Pool

Defined in: src/Pool.ts:8

Extends​

  • Entity

Properties​

id​

id: string

Defined in: src/Pool.ts:12

metadataHash?​

optional metadataHash: string

Defined in: src/Pool.ts:13

Accessors​

reports​

Get Signature​

get reports(): Reports

Defined in: src/Pool.ts:18

Returns​

Reports

Methods​

activeNetworks()​

activeNetworks(): Query<PoolNetwork[]>

Defined in: src/Pool.ts:79

Get the networks where a pool is active. It doesn't mean that any vaults are deployed there necessarily.

Returns​

Query<PoolNetwork[]>

metadata()​

metadata(): Query<PoolMetadata> | Query<null>

Defined in: src/Pool.ts:22

Returns​

Query<PoolMetadata> | Query<null>

network()​

network(chainId): Query<PoolNetwork>

Defined in: src/Pool.ts:64

Get a specific network where a pool can potentially be deployed.

Parameters​

chainId​

number

Returns​

Query<PoolNetwork>

networks()​

networks(): Query<PoolNetwork[]>

Defined in: src/Pool.ts:51

Get all networks where a pool can potentially be deployed.

Returns​

Query<PoolNetwork[]>

trancheIds()​

trancheIds(): Query<string[]>

Defined in: src/Pool.ts:28

Returns​

Query<string[]>

vault()​

vault(chainId, trancheId, asset): Query<Vault>

Defined in: src/Pool.ts:100

Parameters​

chainId​

number

trancheId​

string

asset​

string

Returns​

Query<Vault>