@centrifuge/sdk 0.0.0-alpha.5 → 0.0.0-alpha.51

package/dist/entities/Pool.d.ts

@@ -0,0 +1,155 @@
+import { HexString } from '../types/index.js';
+import { PoolMetadataInput, ShareClassInput } from '../types/poolInput.js';
+import { PoolMetadata } from '../types/poolMetadata.js';
+import { AssetId, PoolId, ShareClassId } from '../utils/types.js';
+import { Entity } from './Entity.js';
+import { PoolNetwork } from './PoolNetwork.js';
+import { PoolReports } from './Reports/PoolReports.js';
+import { ShareClass } from './ShareClass.js';
+export declare class Pool extends Entity {
+    chainId: number;
+    id: PoolId;
+    get reports(): PoolReports;
+    /**
+     * Query the details of the pool.
+     * @returns The pool metadata, id, shareClasses and currency.
+     */
+    details(): import("../index.js").Query<{
+        id: PoolId;
+        currency: {
+            name: string;
+            symbol: string;
+            decimals: number;
+        };
+        metadata: PoolMetadata | null;
+        shareClasses: {
+            shareClass: ShareClass;
+            details: {
+                id: ShareClassId;
+                name: string;
+                symbol: string;
+                totalIssuance: import("../index.js").Balance;
+                pricePerShare: import("../index.js").Price;
+                nav: import("../index.js").Balance;
+                navPerNetwork: {
+                    chainId: number;
+                    totalIssuance: import("../index.js").Balance;
+                    pricePerShare: import("../index.js").Price;
+                    nav: import("../index.js").Balance;
+                }[];
+                icon: import("../types/poolMetadata.js").FileType | null;
+                minInitialInvestment: number | null;
+                apyPercentage: number | null;
+                apy: "target" | "7day" | "30day" | "90day" | "ytd" | "sinceInception" | "automatic" | null;
+                defaultAccounts: {
+                    asset: number | null;
+                    equity: number | null;
+                    gain: number | null;
+                    loss: number | null;
+                    expense: number | null;
+                    liability: number | null;
+                };
+            };
+        }[];
+    }>;
+    metadata(): import("../index.js").Query<PoolMetadata | null>;
+    shareClasses(): import("../index.js").Query<ShareClass[]>;
+    shareClass(scId: ShareClassId): import("../index.js").Query<ShareClass>;
+    shareClassesDetails(): import("../index.js").Query<{
+        id: ShareClassId;
+        name: string;
+        symbol: string;
+        totalIssuance: import("../index.js").Balance;
+        pricePerShare: import("../index.js").Price;
+        nav: import("../index.js").Balance;
+        navPerNetwork: {
+            chainId: number;
+            totalIssuance: import("../index.js").Balance;
+            pricePerShare: import("../index.js").Price;
+            nav: import("../index.js").Balance;
+        }[];
+        icon: import("../types/poolMetadata.js").FileType | null;
+        minInitialInvestment: number | null;
+        apyPercentage: number | null;
+        apy: "target" | "7day" | "30day" | "90day" | "ytd" | "sinceInception" | "automatic" | null;
+        defaultAccounts: {
+            asset: number | null;
+            equity: number | null;
+            gain: number | null;
+            loss: number | null;
+            expense: number | null;
+            liability: number | null;
+        };
+    }[]>;
+    /**
+     * Get the managers on the Hub.
+     * These managers that can manage the pool, approve deposits, update prices, etc.
+     */
+    poolManagers(): import("../index.js").Query<{
+        address: `0x${string}`;
+    }[]>;
+    /**
+     * Get the managers on the Balance Sheet.
+     * These managers can transfer funds to and from the balance sheet.
+     */
+    balanceSheetManagers(): import("../index.js").Query<{
+        address: `0x${string}`;
+        chainId: number;
+    }[]>;
+    /**
+     * Check if an address is a manager of the pool.
+     * @param address - The address to check
+     */
+    isPoolManager(address: HexString): import("../index.js").Query<boolean>;
+    /**
+     * Check if an address is a Balance Sheet manager of the pool.
+     * @param chainId - The chain ID of the Spoke to check
+     * @param address - The address to check
+     */
+    isBalanceSheetManager(chainId: number, address: HexString): import("../index.js").Query<boolean>;
+    /**
+     * Get all networks where a pool can potentially be deployed.
+     */
+    networks(): import("../index.js").Query<PoolNetwork[]>;
+    /**
+     * Get a specific network where a pool can potentially be deployed.
+     */
+    network(chainId: number): import("../index.js").Query<PoolNetwork>;
+    /**
+     * Get the networks where a pool is active. It doesn't mean that any vaults are deployed there necessarily.
+     */
+    activeNetworks(): import("../index.js").Query<PoolNetwork[]>;
+    vault(chainId: number, scId: ShareClassId, asset: HexString | AssetId): import("../index.js").Query<import("./Vault.js").Vault>;
+    /**
+     * Get the currency of the pool.
+     */
+    currency(): import("../index.js").Query<{
+        name: string;
+        symbol: string;
+        decimals: number;
+    }>;
+    updateMetadata(metadata: PoolMetadata): import("../types/transaction.js").Transaction;
+    update(metadataInput: Partial<PoolMetadataInput>, updatedShareClasses: ({
+        id: ShareClassId;
+    } & ShareClassInput)[], addedShareClasses?: ShareClassInput[]): import("../types/transaction.js").Transaction;
+    /**
+     * Update pool managers.
+     */
+    updatePoolManagers(updates: {
+        address: HexString;
+        canManage: boolean;
+    }[]): import("../types/transaction.js").Transaction;
+    /**
+     * Update balance sheet managers.
+     */
+    updateBalanceSheetManagers(updates: {
+        chainId: number;
+        address: HexString;
+        canManage: boolean;
+    }[]): import("../types/transaction.js").Transaction;
+    createAccounts(accounts: {
+        accountId: number;
+        isDebitNormal: boolean;
+    }[]): import("../types/transaction.js").Transaction;
+}
+//# sourceMappingURL=Pool.d.ts.map

package/dist/entities/Pool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pool.d.ts","sourceRoot":"","sources":["../../src/entities/Pool.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAMvD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAC5C,qBAAa,IAAK,SAAQ,MAAM;IAOrB,OAAO,EAAE,MAAM;IANxB,EAAE,EAAE,MAAM,CAAA;IAYV,IAAI,OAAO,gBAEV;IAED;;;OAGG;IACH,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAkBP,QAAQ;IAuCR,YAAY;IAMZ,UAAU,CAAC,IAAI,EAAE,YAAY;IAY7B,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;IAWnB;;;OAGG;IACH,YAAY;;;IAgBZ;;;OAGG;IACH,oBAAoB;;;;IAiBpB;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,SAAS;IAWhC;;;;OAIG;IACH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS;IAWzD;;OAEG;IACH,QAAQ;IAUR;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM;IAYvB;;OAEG;IACH,cAAc;IAqBd,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO;IAIrE;;OAEG;IACH,QAAQ;;;;;IAmCR,cAAc,CAAC,QAAQ,EAAE,YAAY;IAiBrC,MAAM,CACJ,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,EACzC,mBAAmB,EAAE,CAAC;QAAE,EAAE,EAAE,YAAY,CAAA;KAAE,GAAG,eAAe,CAAC,EAAE,EAC/D,iBAAiB,GAAE,eAAe,EAAO;IA6Q3C;;OAEG;IACH,kBAAkB,CAAC,OAAO,EAAE;QAAE,OAAO,EAAE,SAAS,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,EAAE;IAmDxE;;OAEG;IACH,0BAA0B,CAAC,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,SAAS,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,EAAE;IA6BjG,cAAc,CAAC,QAAQ,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,OAAO,CAAA;KAAE,EAAE;CAsHzE"}