PoolNetwork
@centrifuge/sdk / PoolNetwork
Class: PoolNetwork
Defined in: src/PoolNetwork.ts:16
Query and interact with a pool on a specific network.
Extends
Entity
Properties
chainId
chainId:
number
Defined in: src/PoolNetwork.ts:21
pool
pool:
Pool
Defined in: src/PoolNetwork.ts:20
Methods
canTrancheBeDeployed()
canTrancheBeDeployed(
trancheId):Query<boolean>
Defined in: src/PoolNetwork.ts:269
Get whether a pool is active and the tranche token can be deployed.
Parameters
trancheId
string
The tranche ID
Returns
Query<boolean>
deployTranche()
deployTranche(
trancheId):Transaction
Defined in: src/PoolNetwork.ts:306
Deploy a tranche token for the pool.
Parameters
trancheId
string
The tranche ID
Returns
deployVault()
deployVault(
trancheId,currencyAddress):Transaction
Defined in: src/PoolNetwork.ts:330
Deploy a vault for a specific tranche x currency combination.
Parameters
trancheId
string
The tranche ID
currencyAddress
string
The investment currency address
Returns
isActive()
isActive():
Query<boolean>
Defined in: src/PoolNetwork.ts:232
Get whether the pool is active on this network. It's a prerequisite for deploying vaults, and doesn't indicate whether any vaults have been deployed.
Returns
Query<boolean>
shareCurrency()
shareCurrency(
trancheId):Query<CurrencyMetadata>
Defined in: src/PoolNetwork.ts:143
Get the details of the share token.
Parameters
trancheId
string
The tranche ID
Returns
vault()
Defined in: src/PoolNetwork.ts:215
Get a specific Vault for a given tranche and investment currency.
Parameters
trancheId
string
The tranche ID
asset
string
The investment currency address
Returns
vaults()
Defined in: src/PoolNetwork.ts:154
Get the deployed Vaults for a given tranche. There may exist one Vault for each allowed investment currency. Vaults are used to submit/claim investments and redemptions.
Parameters
trancheId
string
The tranche ID
Returns
vaultsByTranche()
Defined in: src/PoolNetwork.ts:198
Get all Vaults for all tranches in the pool.
Returns
An object of tranche ID to Vault.