Centrifuge

https://updated-docs.documentation-569.pages.dev/
Admin
Centrifuge is an onchain financial platform for real-world asset tokenization, bridging...
Tokens:23,968
Snippets:389
Trust Score:7.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Centrifuge SDK

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

Install the SDK and its required peer dependency using npm or yarn.

```bash
npm install @centrifuge/sdk viem  
  
# or  
  
yarn add @centrifuge/sdk viem  
```

--------------------------------

### Configure SDK Environments

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

Examples of initializing the SDK for mainnet and demo environments.

```javascript
const centrifuge = new Centrifuge({  
  environment: "mainnet",  
  rpcUrls: {  
    1: "https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID",  
  },  
  indexerUrl: "https://indexer.centrifuge.io",  
  ipfsUrl: "https://ipfs.centrifuge.io",  
});  
```

```javascript
const centrifuge = new Centrifuge({  
  environment: "demo",  
});  
```

--------------------------------

### shareCurrency()

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Vault

Get the details of the share token.

```APIDOC
## shareCurrency()

### Description
Get the details of the share token.

### Returns
- **Query<CurrencyMetadata>**
```

--------------------------------

### investmentCurrency()

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Vault

Get the details of the investment currency.

```APIDOC
## investmentCurrency()

### Description
Get the details of the investment currency.

### Returns
- **Query<CurrencyMetadata>**
```

--------------------------------

### allowance(owner)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Vault

Get the allowance of the investment currency for the CentrifugeRouter.

```APIDOC
## allowance(owner)

### Description
Get the allowance of the investment currency for the CentrifugeRouter, which is the contract that moves funds into the vault on behalf of the investor.

### Parameters
- **owner** (string) - Required - The address of the owner

### Returns
- **Query<Currency>**
```

--------------------------------

### investment(investor)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Vault

Get the details of the investment of an investor in the vault.

```APIDOC
## investment(investor)

### Description
Get the details of the investment of an investor in the vault and any pending investments or redemptions.

### Parameters
- **investor** (string) - Required - The address of the investor
```

--------------------------------

### Initialize and Convert Currency

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/bigint-wrappers

Create a new Currency instance and convert it to various formats like BigInt, number, string, or decimal.

```javascript
const currency = new Currency(1000n, 6);  
currency.toBigInt(); // 1000n  
currency.toNumber(); // 0.001  
currency.toString(); // '1000'  
currency.toDecimal(); // 0.001  
```

--------------------------------

### Centrifuge SDK Initialization

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

How to initialize the Centrifuge SDK instance with optional configuration for different environments.

```APIDOC
## Initialization

### Description
Initialize the Centrifuge SDK instance. You can provide a configuration object to specify the environment (mainnet, demo, dev) and custom URLs for RPC, indexer, and IPFS.

### Usage
```typescript
import { Centrifuge } from "@centrifuge/sdk";

// Default initialization
const centrifuge = new Centrifuge();

// Initialization with custom config
const centrifuge = new Centrifuge({
  environment: "mainnet",
  rpcUrls: {
    1: "https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID",
  },
  indexerUrl: "https://indexer.centrifuge.io",
  ipfsUrl: "https://ipfs.centrifuge.io",
});
```
```

--------------------------------

### Add a share class

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/create-a-pool

Registers a new share class with a name, symbol, and a unique salt for deterministic deployment.

```solidity
hub.addShareClass(poolId, "Tokenized MMF", "MMF", bytes32(bytes("1")));
```

--------------------------------

### Execute Transactions

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

Set a signer and perform transactions using await or subscription patterns.

```javascript
centrifuge.setSigner(signer);  
```

```javascript
const pool = await centrifuge.pool("1");  
try {  
  const status = await pool.closeEpoch();  
  console.log(status);  
} catch (error) {  
  console.error(error);  
}  
```

```javascript
const pool = await centrifuge.pool("1");  
const subscription = pool.closeEpoch().subscribe(  
  (status) => console.log(pool),  
  (error) => console.error(error),  
  () => console.log("complete")  
);  
```

--------------------------------

### Initialize Centrifuge SDK

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

Initialize the SDK with default settings or a custom configuration object.

```javascript
import { Centrifuge } from "@centrifuge/sdk";  
  
const centrifuge = new Centrifuge();  
```

--------------------------------

### new Centrifuge(config)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Centrifuge

Initializes a new instance of the Centrifuge SDK with the provided configuration.

```APIDOC
## new Centrifuge(config)

### Description
Creates a new instance of the Centrifuge SDK.

### Parameters
- **config** (Partial<Config>) - Optional - Configuration object for the SDK instance.
```

--------------------------------

### Querying Data

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

How to perform queries using the SDK, which return Promise-like Observables for data retrieval.

```APIDOC
## Queries

### Description
Queries return Promise-like Observables. They can be awaited for a single value or subscribed to for real-time updates when on-chain data changes.

### Usage
```typescript
// Await a query
try {
  const pool = await centrifuge.pools();
} catch (error) {
  console.error(error);
}

// Subscribe to a query
const subscription = centrifuge.pools().subscribe(
  (pool) => console.log(pool),
  (error) => console.error(error)
);
subscription.unsubscribe();
```
```

--------------------------------

### Initialize a Pool

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/pools

Initializes a pool instance using a pool ID and an optional metadata hash.

```javascript
const pool = await centrifuge.pool("<pool-id>", "<metadata-hash>");
```

--------------------------------

### deployVault(trancheId, currencyAddress)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/PoolNetwork

Initiates a transaction to deploy a vault for a specific tranche and currency combination.

```APIDOC
## deployVault(trancheId, currencyAddress)

### Description
Deploy a vault for a specific tranche x currency combination.

### Parameters
- **trancheId** (string) - Required - The tranche ID
- **currencyAddress** (string) - Required - The investment currency address

### Returns
- **Transaction** - A transaction object for the vault deployment.
```

--------------------------------

### Currency and Token Constructors

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/bigint-wrappers

Initializes a new Currency or Token object with a BigInt value and decimal precision.

```APIDOC
## new Currency(value: bigint, decimals: number)

### Description
Creates a new instance of a Currency or Token wrapper to handle numerical values with specific decimal precision.

### Methods
- **toBigInt()**: Returns the underlying BigInt value.
- **toNumber()**: Returns the value as a floating point number.
- **toString()**: Returns the string representation of the BigInt value.
- **toDecimal()**: Returns the decimal representation of the value.
```

--------------------------------

### Manage Query Caching

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

Demonstrates how query results are cached and how to potentially disable caching for fresh data.

```javascript
const report1 = await pool.reports.balanceSheet();  
const report2 = await pool.reports.balanceSheet(); // resolves immediately  
const report3 = await pool.reports.balanceSheet({ groupBy: "month" }); // also resolves immediately as it doesn't need to fetch new data  
  
sleep(5 * 60 * 1000);  
  
const report4 = await pool.reports.balanceSheet(); // will wait for fresh data  
```

```javascript
const centrifuge = new Centrifuge({ cache: false }); // TODO NOT YET IMPLEMENTED  
  
// ...  
  
const investment1 = await vault.investment("0x...");  
  
await vault.claim();  
  
const investment2 = await vault.investment("0x..."); // will fetch again  
```

--------------------------------

### Notify share class deployment

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/create-a-pool

Deploys the ERC20 share token on a target network with specific permission hooks.

```solidity
hub.notifyShareClass(poolId, scId, centrifugeId, bytes32(bytes20(hook)));
```

--------------------------------

### Retrieve a balance sheet report

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reports

Initializes a pool instance with a metadata hash and fetches the balance sheet report.

```typescript
const pool = await centrifuge.pool("<pool-id>", "<metadata-hash>");  
const balanceSheetReport = await pool.reports.balanceSheet();  
```

--------------------------------

### Currency.fromFloat()

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/bigint-wrappers

Static method to create a Currency object from a floating point number.

```APIDOC
## Currency.fromFloat(value: number, decimals: number)

### Description
Creates a Currency object from a floating point number, automatically handling the conversion based on the provided decimal precision.
```

--------------------------------

### Deploy Asynchronous Vault

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/deploy-vaults

Finalizes the deployment and linking of an asynchronous vault using the factory contract.

```solidity
hub.updateVault(poolId, scId, assetId, bytes32(bytes20(address(asyncVaultFactory))), VaultUpdateKind.DeployAndLink, 0);
```

--------------------------------

### deployTranche(trancheId)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/PoolNetwork

Initiates a transaction to deploy a tranche token for the pool.

```APIDOC
## deployTranche(trancheId)

### Description
Deploy a tranche token for the pool.

### Parameters
- **trancheId** (string) - Required - The tranche ID

### Returns
- **Transaction** - A transaction object for the deployment.
```

--------------------------------

### Define SDK Configuration Type

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

The structure of the configuration object used to initialize the SDK.

```typescript
type Config = {  
  environment: "mainnet" | "demo" | "dev";  
  rpcUrls?: Record<number | string, string>;  
  indexerUrl: string;  
  ipfsUrl: string;  
};  
```

--------------------------------

### Create Currency from Float

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/bigint-wrappers

Use the static fromFloat method to instantiate a Currency object from a floating point number.

```javascript
const currency = Currency.fromFloat(1000, 6);  
currency.toBigInt(); // 1_000_000_000n  
currency.toNumber(); // 1000  
currency.toString(); // '1000000000'  
currency.toDecimal(); // 1000  
```

--------------------------------

### Create a pool on the hub

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/create-a-pool

Registers a new pool with the hub using the derived poolId, the manager address, and the denomination currency.

```solidity
hub.createPool(poolId, msg.sender, address(840));
```

--------------------------------

### Query Data with Observables

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

Queries return observables that can be awaited for a single result or subscribed to for real-time updates.

```javascript
try {  
  const pool = await centrifuge.pools();  
} catch (error) {  
  console.error(error);  
}  
```

```javascript
const subscription = centrifuge.pools().subscribe(  
  (pool) => console.log(pool),  
  (error) => console.error(error)  
);  
subscription.unsubscribe();  
```

--------------------------------

### Deploy Synchronous Deposit Vault

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/deploy-vaults

Finalizes the deployment and linking of a synchronous deposit vault using the factory contract.

```solidity
hub.updateVault(poolId, scId, assetId, bytes32(bytes20(address(syncDepositVaultFactory))), VaultUpdateKind.DeployAndLink, 0);
```

--------------------------------

### Preview share class ID

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/create-a-pool

Retrieves the next available ID for a new share class within a specific pool.

```solidity
ShareClassId scId = shareClassManager.previewNextShareClassId(poolId);
```

--------------------------------

### networks()

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Pool

Retrieves all networks where the pool can be deployed.

```APIDOC
## networks()

### Description
Get all networks where a pool can potentially be deployed.

### Returns
- **Query<PoolNetwork[]>** - A query object resolving to an array of potential pool networks.
```

--------------------------------

### Deposit into a synchronous vault

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/invest-into-a-vault

Executes an immediate deposit of assets to receive vault shares.

```solidity
vault.deposit(assets, receiver);
```

--------------------------------

### Manage Vault Investments and Redemptions

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/pools

Interacts with vaults to check investment states, place orders, and claim tokens.

```javascript
const investment = await vault.investment("<invesor-address>");
```

```javascript
const status = await vault.increaseInvestOrder(<invest amount>);
```

```javascript
const status = await vault.claim();
```

--------------------------------

### currency(address, chainId?)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Centrifuge

Retrieves metadata for an ERC20 token.

```APIDOC
## currency(address, chainId?)

### Description
Get the metadata for an ERC20 token.

### Parameters
- **address** (string) - Required - The token address.
- **chainId** (number) - Optional - The chain ID.
```

--------------------------------

### Currency Comparison Operations

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/bigint-wrappers

Perform comparison operations on Currency objects.

```APIDOC
## Comparison Methods

### Description
Supports equals, greaterThan, and lessThan operations. These methods return a boolean result and can accept either another Currency object or a bigint.
```

--------------------------------

### Executing Transactions

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/overview

How to set a signer and execute transaction methods on the Centrifuge SDK.

```APIDOC
## Transactions

### Description
To perform transactions, a signer must be set on the centrifuge instance. The signer can be an EIP1193-compatible provider or a Viem LocalAccount.

### Usage
```typescript
// Set the signer
centrifuge.setSigner(signer);

// Execute a transaction
const pool = await centrifuge.pool("1");
try {
  const status = await pool.closeEpoch();
  console.log(status);
} catch (error) {
  console.error(error);
}
```
```

--------------------------------

### Perform Currency Comparison

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/bigint-wrappers

Use comparison methods on Currency objects to return boolean results when comparing against other Currency objects or bigints.

```javascript
const currency = new Currency(1000n, 6);  
const currency2 = new Currency(2000n, 6);  
const isEqual = currency.equals(currency2);  
const isGreaterThan = currency.greaterThan(currency2);  
const isLessThan = currency.lessThan(currency2);  
```

--------------------------------

### setSigner(signer)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Centrifuge

Sets the signer for the SDK instance.

```APIDOC
## setSigner(signer)

### Description
Updates the signer used for transactions.

### Parameters
- **signer** (null | Signer) - Required - The signer object.
```

--------------------------------

### pool(id, metadataHash?)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Centrifuge

Queries pool information by ID.

```APIDOC
## pool(id, metadataHash?)

### Description
Retrieves pool information.

### Parameters
- **id** (string | number) - Required - The pool ID.
- **metadataHash** (string) - Optional - The metadata hash.
```

--------------------------------

### hub.notifyAssetPrice(poolId, scId, assetId)

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/manage-a-pool

Pushes the asset price to the asset price oracle on each network.

```APIDOC
## hub.notifyAssetPrice(poolId, scId, assetId)

### Description
Sets and pushes the price of an asset denominated in the currency of the pool to the asset price oracle.

### Parameters
- **poolId** (uint) - Required - The identifier of the pool
- **scId** (uint) - Required - The share class identifier
- **assetId** (uint) - Required - The identifier of the asset
```

--------------------------------

### Claim a deposit in an asynchronous vault

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/invest-into-a-vault

Mints vault shares once the previously submitted deposit request has been fulfilled.

```solidity
vault.mint(vault.maxMint(user), user);
```

--------------------------------

### Request a deposit in an asynchronous vault

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/invest-into-a-vault

Queues a deposit request to be processed by the pool issuer at a later interval.

```solidity
vault.requestDeposit(assets, user, user);
```

--------------------------------

### balance(currency, owner, chainId?)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Centrifuge

Retrieves the balance of an ERC20 token for a given owner.

```APIDOC
## balance(currency, owner, chainId?)

### Description
Get the balance of an ERC20 token for a given owner.

### Parameters
- **currency** (string) - Required - The token address.
- **owner** (string) - Required - The owner address.
- **chainId** (number) - Optional - The chain ID.
```

--------------------------------

### vault.increaseInvestOrder

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/pools

Places an investment order in the vault.

```APIDOC
## vault.increaseInvestOrder(amount)

### Description
Places an order to invest a specific amount into the vault.

### Parameters
- **amount** (number) - Required - The amount to invest.
```

--------------------------------

### account(address, chainId?)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Centrifuge

Queries account information for a specific address.

```APIDOC
## account(address, chainId?)

### Description
Retrieves account details for the specified address.

### Parameters
- **address** (string) - Required - The account address.
- **chainId** (number) - Optional - The chain ID.
```

--------------------------------

### metadata()

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Pool

Retrieves the metadata associated with the pool.

```APIDOC
## metadata()

### Description
Fetches the metadata for the current pool.

### Returns
- **Query<PoolMetadata> | Query<null>** - A query object resolving to the pool metadata or null if not available.
```

--------------------------------

### Configure Synchronous Vault Manager

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/deploy-vaults

Sets the SyncManager as the Balance Sheet Manager for synchronous deposit vaults.

```solidity
hub.updateBalanceSheetManager(centrifugeId, poolId, bytes32(bytes20(address(syncManager))), true);
```

--------------------------------

### isActive()

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/PoolNetwork

Checks if the pool is active on the current network.

```APIDOC
## isActive()

### Description
Get whether the pool is active on this network. It's a prerequisite for deploying vaults.

### Returns
- **Query<boolean>** - A query object returning a boolean status.
```

--------------------------------

### Deposit assets

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/manage-assets

Approves the balance sheet contract to spend tokens and then deposits them into the pool.

```solidity
usdc.approve(balanceSheet, amount);  
balanceSheet.deposit(poolId, scId, address(usdc), 0, amount);  
```

--------------------------------

### Set pool metadata

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/create-a-pool

Assigns descriptive metadata to the pool for UI display purposes.

```solidity
hub.setPoolMetadata(poolId, bytes("Testing pool"));
```

--------------------------------

### centrifuge.pool

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/pools

Initializes a pool instance using a pool ID and an optional metadata hash.

```APIDOC
## centrifuge.pool(poolId, metadataHash)

### Description
Initializes a pool instance to interact with a specific pool.

### Parameters
- **poolId** (string) - Required - The unique identifier for the pool.
- **metadataHash** (string) - Optional - The metadata hash for pool reports.
```

--------------------------------

### Currency Arithmetic Operations

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/bigint-wrappers

Perform basic arithmetic on Currency objects.

```APIDOC
## Arithmetic Methods

### Description
Supports add, sub, mul, and div operations. Operations can be performed between two Currency objects or between a Currency object and a bigint. The result is always a new Currency object with the original decimal precision.
```

--------------------------------

### EIP1193ProviderLike

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/Type%20Aliases/EIP1193ProviderLike

The EIP1193ProviderLike interface defines the structure for an Ethereum provider, requiring a request method to facilitate communication with the blockchain.

```APIDOC
## EIP1193ProviderLike

### Description
An interface representing an EIP-1193 compatible provider. It is used to send requests to an Ethereum-compatible wallet or node.

### Method Signature
`request(args: ...any): Promise<any>`

### Parameters
- **args** (...any) - The arguments required for the specific JSON-RPC request being made.

### Returns
- **Promise<any>** - A promise that resolves with the result of the JSON-RPC request.
```

--------------------------------

### pool.reports Methods

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reports

Methods available on the pool.reports object to retrieve various financial reports.

```APIDOC
## pool.reports Methods

### Description
Retrieve financial reports for a specific pool. The following methods are available: balanceSheet, profitAndLoss, cashflow, investorTransactions, assetTransactions, tokenPrice, feeTransactions, assetList, investorList, ordersList, and assetTimeSeries.

### Usage
```javascript
const pool = await centrifuge.pool("<pool-id>", "<metadata-hash>");
const report = await pool.reports.<methodName>(filterOptions);
```

### Parameters
#### Filter Options (Optional)
- **from** (string) - Optional - Start date for the report (e.g., "2024-01-01")
- **to** (string) - Optional - End date for the report (e.g., "2024-01-31")
- **groupBy** (string) - Optional - Interval for grouping data: "day", "month", "quarter", or "year"
```

--------------------------------

### Implement ERC-7540 Deposit Request Decoder

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/managers/merkle-proof-manager

A minimal decoder implementation that extracts controller and owner addresses for validation by the Merkle Proof Manager.

```solidity
function requestDeposit(  
    uint256,   
    address controller,   
    address owner  
) external view virtual returns (bytes memory addressesFound) {  
    addressesFound = abi.encodePacked(controller, owner);  
}  
```

--------------------------------

### Configure Asynchronous Vault Contracts

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/deploy-vaults

Sets the AsyncRequestManager as the Request Manager and Balance Sheet Manager for asynchronous vaults.

```solidity
hub.setRequestManager(poolId, scId, assetId, bytes32(bytes20(address(asyncRequestManager))));  
hub.updateBalanceSheetManager(centrifugeId, poolId, bytes32(bytes20(address(asyncRequestManager))), true);
```

--------------------------------

### canTrancheBeDeployed(trancheId)

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/PoolNetwork

Checks if a pool is active and if the specified tranche token can be deployed.

```APIDOC
## canTrancheBeDeployed(trancheId)

### Description
Get whether a pool is active and the tranche token can be deployed.

### Parameters
- **trancheId** (string) - Required - The tranche ID

### Returns
- **Query<boolean>** - A query object returning a boolean status.
```

--------------------------------

### vaultsByTranche()

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/PoolNetwork

Retrieves all vaults for all tranches in the pool.

```APIDOC
## vaultsByTranche()

### Description
Get all Vaults for all tranches in the pool.

### Returns
- **Query<Record<string, Vault>>** - A query object returning an object mapping tranche IDs to Vaults.
```

--------------------------------

### Reports Methods

Source: https://updated-docs.documentation-569.pages.dev/developer/centrifuge-sdk/reference/classes/Reports

The Reports class provides several methods to fetch specific report data. Each method accepts an optional filter and returns a Query object.

```APIDOC
## assetList(filter?)
Retrieves a list of assets.

## assetTimeSeries(filter?)
Retrieves time series data for assets.

## assetTransactions(filter?)
Retrieves a list of asset transactions.

## balanceSheet(filter?)
Retrieves the balance sheet report.

## cashflow(filter?)
Retrieves the cashflow report.

## feeTransactions(filter?)
Retrieves a list of fee transactions.

## investorList(filter?)
Retrieves a list of investors.

## investorTransactions(filter?)
Retrieves a list of investor transactions.

## ordersList(filter?)
Retrieves a list of orders.

## profitAndLoss(filter?)
Retrieves the profit and loss report.

## tokenPrice(filter?)
Retrieves the token price report.
```

--------------------------------

### Approve deposit and redemption requests

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/manage-a-pool

Call these functions on the Hub to approve pending deposit or redemption requests for a specific pool and share class.

```solidity
hub.approveDeposits(poolId, scId, assetId, shareClassManager.nowDepositEpoch(scId, assetId), amount)  
hub.approveRedeems(poolId, scId, assetId, shareClassManager.nowRedeemEpoch(scId, assetId), amount)  
```

--------------------------------

### Notify asset price oracle

Source: https://updated-docs.documentation-569.pages.dev/developer/protocol/guides/manage-a-pool

Pushes the asset price to the asset price oracle on a specific network.

```solidity
hub.notifyAssetPrice(poolId, scId, assetId);
```
Tokens:
Raw