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

package/dist/entities/Pool.test.js

@@ -0,0 +1,270 @@
+import { expect } from 'chai';
+import { firstValueFrom, lastValueFrom, skipWhile } from 'rxjs';
+import { getContract } from 'viem';
+import { ABI } from '../abi/index.js';
+import { Centrifuge } from '../Centrifuge.js';
+import { NULL_ADDRESS } from '../constants.js';
+import { mockPoolMetadata } from '../tests/mocks/mockPoolMetadata.js';
+import { context } from '../tests/setup.js';
+import { randomAddress } from '../tests/utils.js';
+import { AssetId, PoolId, ShareClassId } from '../utils/types.js';
+import { Pool } from './Pool.js';
+import { PoolNetwork } from './PoolNetwork.js';
+const chainId = 11155111;
+const centId = 1;
+const poolId = PoolId.from(centId, 1);
+const scId = ShareClassId.from(poolId, 1);
+const assetId = AssetId.from(centId, 1);
+const poolManager = '0x423420Ae467df6e90291fd0252c0A8a637C1e03f';
+describe('Pool', () => {
+    let pool;
+    before(() => {
+        const { centrifuge } = context;
+        pool = new Pool(centrifuge, poolId.raw, chainId);
+    });
+    it('gets whether an address is manager', async () => {
+        const isManager = await pool.isPoolManager(poolManager);
+        expect(isManager).to.be.true;
+        const isManager2 = await pool.isPoolManager(randomAddress());
+        expect(isManager2).to.be.false;
+    });
+    it('gets active networks of a pool', async () => {
+        const networks = await pool.activeNetworks();
+        expect(networks).to.have.length.greaterThan(0);
+        expect(networks.some((n) => n.chainId === chainId)).to.equal(true);
+    });
+    it('gets share class IDs of a pool', async () => {
+        const shareClasses = await pool.shareClasses();
+        expect(shareClasses).to.have.length.greaterThan(0);
+        expect(shareClasses[0].id.raw).to.equal(scId.raw);
+    });
+    it('can query a vault', async () => {
+        const vault = await pool.vault(chainId, scId, assetId);
+        expect(vault).to.not.be.undefined;
+        expect(vault.address).to.not.equal(NULL_ADDRESS);
+    });
+    it('should return the currency of the pool', async () => {
+        const currency = await pool.currency();
+        expect(currency).to.have.property('name');
+        expect(currency).to.have.property('symbol');
+        expect(currency).to.have.property('decimals');
+    });
+    it('should return a pool with details', async () => {
+        const details = await pool.details();
+        expect(details.id.raw).to.equal(poolId.raw);
+        expect(details.metadata).to.not.be.undefined;
+        expect(details.shareClasses).to.have.length.greaterThan(0);
+        expect(details.currency).to.exist;
+    });
+    it('gets pool managers', async () => {
+        const managers = await pool.poolManagers();
+        expect(managers.some((m) => m.address === poolManager.toLowerCase())).to.be.true;
+    });
+    it('gets balance sheet managers', async () => {
+        const managers = await pool.balanceSheetManagers();
+        expect(managers).to.have.length.greaterThan(0);
+    });
+    it('updates pool managers', async () => {
+        context.tenderlyFork.impersonateAddress = poolManager;
+        context.centrifuge.setSigner(context.tenderlyFork.signer);
+        const newManager = randomAddress();
+        const result = await pool.updatePoolManagers([{ address: newManager, canManage: true }]);
+        expect(result.type).to.equal('TransactionConfirmed');
+        const { hubRegistry } = await context.centrifuge._protocolAddresses(chainId);
+        const isNewManager = await context.centrifuge.getClient(chainId).readContract({
+            address: hubRegistry,
+            abi: ABI.HubRegistry,
+            functionName: 'manager',
+            args: [poolId.raw, newManager],
+        });
+        expect(isNewManager).to.be.true;
+    });
+    it('updates oneself at the end of the batch', async () => {
+        context.tenderlyFork.impersonateAddress = poolManager;
+        context.centrifuge.setSigner(context.tenderlyFork.signer);
+        const newManager = randomAddress();
+        await context.tenderlyFork.fundAccountEth(newManager, 10n ** 18n);
+        await pool.updatePoolManagers([{ address: newManager, canManage: true }]);
+        const newManager2 = randomAddress();
+        context.tenderlyFork.impersonateAddress = newManager;
+        context.centrifuge.setSigner(context.tenderlyFork.signer);
+        const result = await lastValueFrom(pool.updatePoolManagers([
+            // If we removed ourself in the first position, we would not be able to update other manager
+            { address: newManager, canManage: false },
+            { address: newManager2, canManage: true },
+        ]));
+        expect(result.type).to.equal('TransactionConfirmed');
+    });
+    it('throws when trying to remove last manager', async () => {
+        context.tenderlyFork.impersonateAddress = poolManager;
+        context.centrifuge.setSigner(context.tenderlyFork.signer);
+        const newManager = randomAddress();
+        try {
+            await lastValueFrom(pool.updatePoolManagers([
+                // If we removed ourself in the first position, we would not be able to update other manager
+                { address: poolManager, canManage: false },
+                { address: newManager, canManage: false },
+            ]));
+        }
+        catch (error) {
+            expect(error.message).to.include('Cannot remove all pool managers');
+        }
+    });
+    it('updates balance sheet managers', async () => {
+        context.tenderlyFork.impersonateAddress = poolManager;
+        context.centrifuge.setSigner(context.tenderlyFork.signer);
+        const newManager = randomAddress();
+        const result = await pool.updateBalanceSheetManagers([{ chainId, address: newManager, canManage: true }]);
+        expect(result.type).to.equal('TransactionConfirmed');
+        const { balanceSheet } = await context.centrifuge._protocolAddresses(chainId);
+        const isNewManager = await context.centrifuge.getClient(chainId).readContract({
+            address: balanceSheet,
+            abi: ABI.BalanceSheet,
+            functionName: 'manager',
+            args: [poolId.raw, newManager],
+        });
+        expect(isNewManager).to.be.true;
+    });
+    it('updates a pool', async () => {
+        const fakeHash = 'QmPdzJkZ4PVJ21HfBXMJbGopSpUP9C9fqu3A1f9ZVhtRY2';
+        const metadataInput = {
+            poolName: 'Updated Test Pool',
+            investorType: 'Fake Investor Type',
+        };
+        const addedShareClasses = [
+            {
+                tokenName: 'Test Share Class2',
+                symbolName: 'TSC2',
+                minInvestment: 1000,
+                apyPercentage: 5,
+                apy: 'target',
+                defaultAccounts: {
+                    asset: 1000,
+                    equity: 10000,
+                    gain: 5000,
+                    loss: 500,
+                    expense: 1,
+                    liability: 2,
+                },
+            },
+        ];
+        const updatedShareClasses = [
+            {
+                id: ShareClassId.from(poolId, 1),
+                tokenName: 'Sepolia Pool One Token2',
+                symbolName: 'sep.poo.one2',
+                minInvestment: 1000,
+                apyPercentage: 6,
+                apy: 'target',
+                defaultAccounts: {
+                    asset: 3000,
+                    equity: 30000,
+                    gain: 4000,
+                    loss: 400,
+                    expense: 1,
+                    liability: 2,
+                },
+            },
+        ];
+        const expectedAccounts = [1, 2, 400, 500, 1000, 3000, 4000, 5000, 10000, 30000];
+        const centrifugeWithPin = new Centrifuge({
+            environment: 'testnet',
+            pinJson: async (data) => {
+                // Check if shareClasses data got updated correctly
+                expect(data.pool.name).to.equal('Updated Test Pool');
+                expect(data.pool.investorType).to.equal('Fake Investor Type');
+                expect(data.shareClasses['0x00010000000000010000000000000001']).to.deep.equal({
+                    minInitialInvestment: 1000,
+                    apy: 'target',
+                    apyPercentage: 6,
+                    weightedAverageMaturity: 49.42,
+                    defaultAccounts: {
+                        asset: 3000,
+                        equity: 30000,
+                        gain: 4000,
+                        loss: 400,
+                        expense: 1,
+                        liability: 2,
+                    },
+                });
+                // There is an issue with setup data, where poolDetails.shareClasses has two share classes, but poolDetails.metadata.shareClasses has only one.
+                // Until this is corrected, this count of 3 is expected.
+                expect(data.shareClasses['0x00010000000000010000000000000003']).to.deep.equal({
+                    minInitialInvestment: 1000,
+                    apy: 'target',
+                    apyPercentage: 5,
+                    defaultAccounts: {
+                        asset: 1000,
+                        equity: 10000,
+                        gain: 5000,
+                        loss: 500,
+                        expense: 1,
+                        liability: 2,
+                    },
+                });
+                return fakeHash;
+            },
+            rpcUrls: {
+                11155111: context.tenderlyFork.rpcUrl,
+            },
+        });
+        context.tenderlyFork.impersonateAddress = poolManager;
+        centrifugeWithPin.setSigner(context.tenderlyFork.signer);
+        const pool = await centrifugeWithPin.pool(poolId);
+        const result = await pool.update(metadataInput, updatedShareClasses, addedShareClasses);
+        expect(result.type).to.equal('TransactionConfirmed');
+        // await poolDetails -> check extra share class included
+        const poolDetails = await firstValueFrom(pool.details().pipe(skipWhile((details) => details.shareClasses[2]?.details == null)));
+        expect(poolDetails.shareClasses.length).to.equal(3);
+        // Check if newly added share class is present with correct data
+        expect(poolDetails.shareClasses[2].details).to.contain({
+            name: 'Test Share Class2',
+            symbol: 'TSC2',
+        });
+        const { accounting } = await context.centrifuge._protocolAddresses(chainId);
+        const network = new PoolNetwork(context.centrifuge, pool, chainId);
+        // Share Token for updated share class
+        const shareToken = await network._share(poolDetails.shareClasses[0].shareClass.id);
+        const accountsContract = getContract({
+            address: accounting,
+            abi: ABI.Accounting,
+            client: context.centrifuge.getClient(chainId),
+        });
+        // Check if all accounts got created properly
+        for (const account of expectedAccounts) {
+            const exists = await accountsContract.read.exists([poolId.raw, account]);
+            expect(exists).to.be.true;
+        }
+        // Check if existing share class got updated
+        const shareClassContract = getContract({
+            address: shareToken,
+            abi: ABI.Currency,
+            client: context.centrifuge.getClient(chainId),
+        });
+        const updateShareClassName = await shareClassContract.read.name();
+        const updatedShareClassSymbol = await shareClassContract.read.symbol();
+        expect(updateShareClassName).to.equal('Sepolia Pool One Token2');
+        expect(updatedShareClassSymbol).to.equal('sep.poo.one2');
+    });
+    it('should update the pool metadata', async () => {
+        const fakeHash = 'QmPdzJkZ4PVJ21HfBXMJbGopSpUP9C9fqu3A1f9ZVhtRY2';
+        const centrifugeWithPin = new Centrifuge({
+            environment: 'testnet',
+            pinJson: async (data) => {
+                expect(data).to.deep.equal(mockPoolMetadata);
+                return fakeHash;
+            },
+            rpcUrls: {
+                11155111: context.tenderlyFork.rpcUrl,
+            },
+        });
+        const pool = await centrifugeWithPin.pool(poolId);
+        context.tenderlyFork.impersonateAddress = poolManager;
+        centrifugeWithPin.setSigner(context.tenderlyFork.signer);
+        const result = await pool.updateMetadata(mockPoolMetadata);
+        expect(result.type).to.equal('TransactionConfirmed');
+        const details = await pool.details();
+        expect(details.metadata.pool.asset.class).to.equal('Private credit');
+    });
+});
+//# sourceMappingURL=Pool.test.js.map

package/dist/entities/Pool.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pool.test.js","sourceRoot":"","sources":["../../src/entities/Pool.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAA;AAClC,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAA;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAEjD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,MAAM,OAAO,GAAG,QAAQ,CAAA;AACxB,MAAM,MAAM,GAAG,CAAC,CAAA;AAChB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AACrC,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AACzC,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AACvC,MAAM,WAAW,GAAG,4CAA4C,CAAA;AAEhE,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IACpB,IAAI,IAAU,CAAA;IACd,MAAM,CAAC,GAAG,EAAE;QACV,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;QAC9B,IAAI,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IAClD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAA;QACvD,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAA;QAE5B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC,CAAA;QAC5D,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAA;IAChC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;QAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;QAC9C,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACpE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAA;QAC9C,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;QAClD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACpD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACjC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QACtD,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAA;QACjC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;IAClD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAA;QACtC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QACzC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAC3C,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAA;QACpC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC3C,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAA;QAC5C,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;QAC1D,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAA;QAC1C,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAA;IAClF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAA;QAClD,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;IAChD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACrC,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,WAAW,CAAA;QACrD,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;QAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QACxF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;QAEpD,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QAE5E,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC;YAC5E,OAAO,EAAE,WAAW;YACpB,GAAG,EAAE,GAAG,CAAC,WAAW;YACpB,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC;SAC/B,CAAC,CAAA;QACF,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAA;IACjC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,WAAW,CAAA;QACrD,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;QAElC,MAAM,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,UAAU,EAAE,GAAG,IAAI,GAAG,CAAC,CAAA;QAEjE,MAAM,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QAEzE,MAAM,WAAW,GAAG,aAAa,EAAE,CAAA;QAEnC,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,UAAU,CAAA;QACpD,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,MAAM,GAAG,MAAM,aAAa,CAChC,IAAI,CAAC,kBAAkB,CAAC;YACtB,4FAA4F;YAC5F,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE;YACzC,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE;SAC1C,CAAC,CACH,CAAA;QAED,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;IACtD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,WAAW,CAAA;QACrD,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;QAElC,IAAI,CAAC;YACH,MAAM,aAAa,CACjB,IAAI,CAAC,kBAAkB,CAAC;gBACtB,4FAA4F;gBAC5F,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE;gBAC1C,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE;aAC1C,CAAC,CACH,CAAA;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,iCAAiC,CAAC,CAAA;QACrE,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,WAAW,CAAA;QACrD,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAEzD,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;QAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QACzG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;QAEpD,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QAE7E,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC;YAC5E,OAAO,EAAE,YAAY;YACrB,GAAG,EAAE,GAAG,CAAC,YAAY;YACrB,YAAY,EAAE,SAAS;YACvB,IAAI,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC;SAC/B,CAAC,CAAA;QACF,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAA;IACjC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QAC9B,MAAM,QAAQ,GAAG,gDAAgD,CAAA;QAEjE,MAAM,aAAa,GAA+B;YAChD,QAAQ,EAAE,mBAAmB;YAC7B,YAAY,EAAE,oBAAoB;SACnC,CAAA;QAED,MAAM,iBAAiB,GAAsB;YAC3C;gBACE,SAAS,EAAE,mBAAmB;gBAC9B,UAAU,EAAE,MAAM;gBAClB,aAAa,EAAE,IAAI;gBACnB,aAAa,EAAE,CAAC;gBAChB,GAAG,EAAE,QAAQ;gBACb,eAAe,EAAE;oBACf,KAAK,EAAE,IAAI;oBACX,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,GAAG;oBACT,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,CAAC;iBACb;aACF;SACF,CAAA;QAED,MAAM,mBAAmB,GAA+C;YACtE;gBACE,EAAE,EAAE,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;gBAChC,SAAS,EAAE,yBAAyB;gBACpC,UAAU,EAAE,cAAc;gBAC1B,aAAa,EAAE,IAAI;gBACnB,aAAa,EAAE,CAAC;gBAChB,GAAG,EAAE,QAAQ;gBACb,eAAe,EAAE;oBACf,KAAK,EAAE,IAAI;oBACX,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,GAAG;oBACT,OAAO,EAAE,CAAC;oBACV,SAAS,EAAE,CAAC;iBACb;aACF;SACF,CAAA;QAED,MAAM,gBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;QAE/E,MAAM,iBAAiB,GAAG,IAAI,UAAU,CAAC;YACvC,WAAW,EAAE,SAAS;YACtB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBACtB,mDAAmD;gBACnD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;gBACpD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA;gBAC7D,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,oCAAoC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;oBAC5E,oBAAoB,EAAE,IAAI;oBAC1B,GAAG,EAAE,QAAQ;oBACb,aAAa,EAAE,CAAC;oBAChB,uBAAuB,EAAE,KAAK;oBAC9B,eAAe,EAAE;wBACf,KAAK,EAAE,IAAI;wBACX,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,IAAI;wBACV,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,CAAC;wBACV,SAAS,EAAE,CAAC;qBACb;iBACF,CAAC,CAAA;gBAEF,+IAA+I;gBAC/I,wDAAwD;gBACxD,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,oCAAoC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;oBAC5E,oBAAoB,EAAE,IAAI;oBAC1B,GAAG,EAAE,QAAQ;oBACb,aAAa,EAAE,CAAC;oBAChB,eAAe,EAAE;wBACf,KAAK,EAAE,IAAI;wBACX,MAAM,EAAE,KAAK;wBACb,IAAI,EAAE,IAAI;wBACV,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,CAAC;wBACV,SAAS,EAAE,CAAC;qBACb;iBACF,CAAC,CAAA;gBAEF,OAAO,QAAQ,CAAA;YACjB,CAAC;YACD,OAAO,EAAE;gBACP,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM;aACtC;SACF,CAAC,CAAA;QAEF,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,WAAW,CAAA;QACrD,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAExD,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,mBAAmB,EAAE,iBAAiB,CAAC,CAAA;QAEvF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;QAEpD,wDAAwD;QACxD,MAAM,WAAW,GAAG,MAAM,cAAc,CACtC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,OAAO,IAAI,IAAI,CAAC,CAAC,CACtF,CAAA;QAED,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAEnD,gEAAgE;QAChE,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC;YACtD,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,MAAM;SACf,CAAC,CAAA;QAEF,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QAC3E,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QAElE,sCAAsC;QACtC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;QAEnF,MAAM,gBAAgB,GAAG,WAAW,CAAC;YACnC,OAAO,EAAE,UAAU;YACnB,GAAG,EAAE,GAAG,CAAC,UAAU;YACnB,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9C,CAAC,CAAA;QAEF,6CAA6C;QAC7C,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAA;YACxE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAA;QAC3B,CAAC;QAED,4CAA4C;QAC5C,MAAM,kBAAkB,GAAG,WAAW,CAAC;YACrC,OAAO,EAAE,UAAU;YACnB,GAAG,EAAE,GAAG,CAAC,QAAQ;YACjB,MAAM,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9C,CAAC,CAAA;QAEF,MAAM,oBAAoB,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QACjE,MAAM,uBAAuB,GAAG,MAAM,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,CAAA;QAEtE,MAAM,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;QAChE,MAAM,CAAC,uBAAuB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAC1D,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,QAAQ,GAAG,gDAAgD,CAAA;QAEjE,MAAM,iBAAiB,GAAG,IAAI,UAAU,CAAC;YACvC,WAAW,EAAE,SAAS;YACtB,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBACtB,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;gBAC5C,OAAO,QAAQ,CAAA;YACjB,CAAC;YACD,OAAO,EAAE;gBACP,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM;aACtC;SACF,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEjD,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,WAAW,CAAA;QACrD,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAExD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAA;QAE1D,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;QAEpD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAA;QACpC,MAAM,CAAC,OAAO,CAAC,QAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;IACvE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/entities/PoolNetwork.d.ts

@@ -0,0 +1,73 @@
+import { HexString } from '../types/index.js';
+import { AssetId, ShareClassId } from '../utils/types.js';
+import { BalanceSheet } from './BalanceSheet.js';
+import { Entity } from './Entity.js';
+import type { Pool } from './Pool.js';
+import { ShareClass } from './ShareClass.js';
+/**
+ * Query and interact with a pool on a specific network.
+ */
+export declare class PoolNetwork extends Entity {
+    pool: Pool;
+    chainId: number;
+    /**
+     * Query the details of the pool on a network.
+     * @returns The details, including whether the pool is active, whether any of the share classes have been deployed,
+     * and any deployed vaults.
+     */
+    details(): import("../index.js").Query<{
+        isActive: boolean;
+        activeShareClasses: {
+            shareClass: ShareClass;
+            id: ShareClassId;
+            shareToken: `0x${string}`;
+            vaults: import("./Vault.js").Vault[];
+        }[];
+    }>;
+    balanceSheet(scId: ShareClassId): import("../index.js").Query<BalanceSheet>;
+    /**
+     * Get the details of the share token.
+     * @param scId - The share class ID
+     */
+    shareCurrency(scId: ShareClassId): import("../index.js").Query<import("../types/index.js").CurrencyDetails>;
+    /**
+     * Get the deployed Vaults for a given share class. There may exist one Vault for each allowed investment currency.
+     * Vaults are used to submit/claim investments and redemptions.
+     * @param scId - The share class ID
+     * @param includeUnlinked - Whether to include unlinked vaults
+     */
+    vaults(scId: ShareClassId, includeUnlinked?: boolean): import("../index.js").Query<import("./Vault.js").Vault[]>;
+    /**
+     * Get a specific Vault for a given share class and investment currency.
+     * @param scId - The share class ID
+     * @param asset - The investment currency address or asset ID
+     */
+    vault(scId: ShareClassId, asset: HexString | AssetId): import("../index.js").Query<import("./Vault.js").Vault>;
+    /**
+     * 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.
+     */
+    isActive(): import("../index.js").Query<boolean>;
+    /**
+     * Enable and deploy share classes/vaults.
+     * @param shareClasses - An array of share classes to enable
+     * @param vaults - An array of vaults to deploy
+     */
+    deploy(shareClasses?: {
+        id: ShareClassId;
+        hook: HexString;
+    }[], vaults?: {
+        shareClassId: ShareClassId;
+        assetId: AssetId;
+        kind: 'async' | 'syncDeposit';
+    }[]): import("../types/transaction.js").Transaction;
+    /**
+     * Unlink vaults.
+     * @param vaults - An array of vaults to unlink
+     */
+    unlinkVaults(vaults: {
+        shareClassId: ShareClassId;
+        assetId: AssetId;
+    }[]): import("../types/transaction.js").Transaction;
+}
+//# sourceMappingURL=PoolNetwork.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PoolNetwork.d.ts","sourceRoot":"","sources":["../../src/entities/PoolNetwork.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAK7C,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C;;GAEG;AACH,qBAAa,WAAY,SAAQ,MAAM;IAI5B,IAAI,EAAE,IAAI;IACV,OAAO,EAAE,MAAM;IAKxB;;;;OAIG;IACH,OAAO;;;;;;;;;IA8BP,YAAY,CAAC,IAAI,EAAE,YAAY;IAM/B;;;OAGG;IACH,aAAa,CAAC,IAAI,EAAE,YAAY;IAMhC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,UAAQ;IASlD;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO;IAgBpD;;;OAGG;IACH,QAAQ;IAiCR;;;;OAIG;IACH,MAAM,CACJ,YAAY,GAAE;QAAE,EAAE,EAAE,YAAY,CAAC;QAAC,IAAI,EAAE,SAAS,CAAA;KAAE,EAAO,EAC1D,MAAM,GAAE;QAAE,YAAY,EAAE,YAAY,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,OAAO,GAAG,aAAa,CAAA;KAAE,EAAO;IAuJhG;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE;QAAE,YAAY,EAAE,YAAY,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,EAAE;CA8GxE"}