@centrifuge/sdk 0.0.0-alpha.8 → 0.1.0

package/dist/entities/OnOffRampManager.test.js

@@ -0,0 +1,170 @@
+import { expect } from 'chai';
+import { ABI } from '../abi/index.js';
+import { context } from '../tests/setup.js';
+import { randomAddress } from '../tests/utils.js';
+import { Balance } from '../utils/BigInt.js';
+import { doTransaction } from '../utils/transaction.js';
+import { AssetId, PoolId, ShareClassId } from '../utils/types.js';
+import { OnOffRampManager } from './OnOffRampManager.js';
+import { Pool } from './Pool.js';
+import { PoolNetwork } from './PoolNetwork.js';
+import { ShareClass } from './ShareClass.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 rampManager = '0x8c0E6DC2461c6190A3e5703B714942cacfCb3C14';
+const fundManager = '0x423420Ae467df6e90291fd0252c0A8a637C1e03f';
+const receiver = '0x0000000000000000000000000000a3df6c4f8fcf';
+describe('OnOffRampManager', () => {
+    let pool;
+    let poolNetwork;
+    let shareClass;
+    let onOffRampManager;
+    before(async () => {
+        const { centrifuge } = context;
+        pool = new Pool(centrifuge, poolId.raw, chainId);
+        poolNetwork = new PoolNetwork(centrifuge, pool, 11155111);
+        shareClass = new ShareClass(centrifuge, pool, scId.raw);
+        context.tenderlyFork.impersonateAddress = fundManager;
+        context.centrifuge.setSigner(context.tenderlyFork.signer);
+        onOffRampManager = new OnOffRampManager(context.centrifuge, poolNetwork, shareClass, rampManager);
+    });
+    describe('receivers', () => {
+        it.skip('should return receivers', async () => {
+            const receivers = await onOffRampManager.receivers();
+            // TODO: assert once the data is available
+            console.log({ receivers });
+        });
+        it('should set receiver', async () => {
+            const address = randomAddress();
+            const result = await onOffRampManager.setReceiver(assetId, address);
+            expect(result.type).to.equal('TransactionConfirmed');
+            const setReceiver = await context.centrifuge.getClient(chainId).readContract({
+                address: rampManager,
+                abi: ABI.OnOffRampManager,
+                functionName: 'offramp',
+                args: ['0x3aaaa86458d576bafcb1b7ed290434f0696da65c', address],
+            });
+            expect(setReceiver).to.be.true;
+        });
+    });
+    describe('relayers', () => {
+        it('should return relayers', async () => {
+            const relayers = await onOffRampManager.relayers();
+            expect(relayers.length).to.equal(1);
+            expect(relayers[0].address).to.equal('0x000000000000000000000000000ffc2d83c1400c');
+        });
+        it('should set relayer', async () => {
+            const address = randomAddress();
+            const result = await onOffRampManager.setRelayer(address);
+            expect(result.type).to.equal('TransactionConfirmed');
+            const setRelayer = await context.centrifuge.getClient(chainId).readContract({
+                address: rampManager,
+                abi: ABI.OnOffRampManager,
+                functionName: 'onramp',
+                args: ['0x3aaaa86458d576bafcb1b7ed290434f0696da65c'],
+            });
+            expect(setRelayer).to.be.true;
+        });
+    });
+    describe('assets', () => {
+        it('should return assets', async () => {
+            const result = await onOffRampManager.assets();
+            expect(result.length).to.be.equal(1);
+            expect(result[0]).to.deep.equal({
+                assetAddress: '0x3aaaa86458d576bafcb1b7ed290434f0696da65c',
+                assetId: new AssetId('0x3aaaa86458d576bafcb1b7ed290434f0696da65c'),
+            });
+        });
+        it('should set asset', async () => {
+            const result = await onOffRampManager.setAsset(assetId);
+            expect(result.type).to.equal('TransactionConfirmed');
+        });
+    });
+    describe('balances', () => {
+        it.skip('should return balances per asset', async () => {
+            const result = await onOffRampManager.balances();
+            console.log({ result });
+            // TODO: assert once the data is available, with balance greater than 0
+            // Currently it returns only one balance with 0 value, which gets filtered out
+            // balance: Balance { value: 0n, decimals: 6 },
+            // currency: {
+            // address: '0x3aaaa86458d576bafcb1b7ed290434f0696da65c',
+            // tokenId: 0n,
+            // decimals: 6,
+            // name: 'USD Coin',
+            // symbol: 'USDC',
+            // chainId: 11155111,
+            // supportsPermit: true
+            // }
+        });
+    });
+    describe('deposit and withdraw', () => {
+        it('should deposit', async () => {
+            const assetAddress = '0x3aaaa86458d576bafcb1b7ed290434f0696da65c';
+            const allowance = new Balance(100n, 6);
+            const amount = new Balance(56n, 6);
+            await pool.updateBalanceSheetManagers([{ chainId, address: onOffRampManager.onrampAddress, canManage: true }]);
+            await context.centrifuge._transact(async function* (ctx) {
+                yield* doTransaction('Approve transfer', ctx, async () => {
+                    return ctx.walletClient.writeContract({
+                        address: assetAddress,
+                        abi: ABI.Currency,
+                        functionName: 'transfer',
+                        args: [onOffRampManager.onrampAddress, allowance.toBigInt()],
+                    });
+                });
+            }, chainId);
+            const result = await onOffRampManager.deposit(assetAddress, amount, receiver);
+            expect(result.type).to.equal('TransactionConfirmed');
+            const balance = await context.centrifuge.getClient(chainId).readContract({
+                address: assetAddress,
+                abi: ABI.Currency,
+                functionName: 'balanceOf',
+                args: [onOffRampManager.onrampAddress],
+            });
+            expect(balance).to.equal(allowance.sub(amount).toBigInt());
+        });
+        it('should withdraw', async () => {
+            const assetAddress = '0x3aaaa86458d576bafcb1b7ed290434f0696da65c';
+            const allowance = new Balance(100n, 6);
+            const amount = new Balance(56n, 6);
+            const relayer = randomAddress();
+            await context.centrifuge._transact(async function* (ctx) {
+                yield* doTransaction('Approve transfer', ctx, async () => {
+                    return ctx.walletClient.writeContract({
+                        address: assetAddress,
+                        abi: ABI.Currency,
+                        functionName: 'transfer',
+                        args: [onOffRampManager.onrampAddress, allowance.toBigInt()],
+                    });
+                });
+            }, chainId);
+            await context.tenderlyFork.fundAccountEth(relayer, 10n ** 18n);
+            await pool.updateBalanceSheetManagers([{ chainId, address: onOffRampManager.onrampAddress, canManage: true }]);
+            await onOffRampManager.setReceiver(assetId, receiver);
+            await onOffRampManager.setRelayer(relayer);
+            context.tenderlyFork.impersonateAddress = relayer;
+            context.centrifuge.setSigner(context.tenderlyFork.signer);
+            const receiverBalanceBefore = await context.centrifuge.getClient(chainId).readContract({
+                address: assetAddress,
+                abi: ABI.Currency,
+                functionName: 'balanceOf',
+                args: [receiver],
+            });
+            expect(receiverBalanceBefore).to.equal(0n);
+            const result = await onOffRampManager.withdraw(assetAddress, amount, receiver);
+            expect(result.type).to.equal('TransactionConfirmed');
+            const receiverBalanceAfter = await context.centrifuge.getClient(chainId).readContract({
+                address: assetAddress,
+                abi: ABI.Currency,
+                functionName: 'balanceOf',
+                args: [receiver],
+            });
+            expect(receiverBalanceAfter).to.equal(56n);
+        });
+    });
+});
+//# sourceMappingURL=OnOffRampManager.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OnOffRampManager.test.js","sourceRoot":"","sources":["../../src/entities/OnOffRampManager.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAC7B,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,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;AAEvC,MAAM,WAAW,GAAG,4CAA4C,CAAA;AAChE,MAAM,WAAW,GAAG,4CAA4C,CAAA;AAChE,MAAM,QAAQ,GAAG,4CAA4C,CAAA;AAE7D,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,IAAU,CAAA;IACd,IAAI,WAAwB,CAAA;IAC5B,IAAI,UAAsB,CAAA;IAE1B,IAAI,gBAAkC,CAAA;IAEtC,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;QAC9B,IAAI,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAChD,WAAW,GAAG,IAAI,WAAW,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;QACzD,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;QAEvD,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,WAAW,CAAA;QACrD,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAEzD,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,CAAC,CAAA;IACnG,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,IAAI,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,SAAS,EAAE,CAAA;YAEpD,0CAA0C;YAC1C,OAAO,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;YACnC,MAAM,OAAO,GAAG,aAAa,EAAE,CAAA;YAE/B,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAEnE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;YAEpD,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC;gBAC3E,OAAO,EAAE,WAAW;gBACpB,GAAG,EAAE,GAAG,CAAC,gBAAgB;gBACzB,YAAY,EAAE,SAAS;gBACvB,IAAI,EAAE,CAAC,4CAA4C,EAAE,OAAO,CAAC;aAC9D,CAAC,CAAA;YAEF,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAA;QAChC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACxB,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YACtC,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,CAAA;YAElD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACnC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAA;QACrF,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;YAClC,MAAM,OAAO,GAAG,aAAa,EAAE,CAAA;YAE/B,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;YAEzD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;YAEpD,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC;gBAC1E,OAAO,EAAE,WAAW;gBACpB,GAAG,EAAE,GAAG,CAAC,gBAAgB;gBACzB,YAAY,EAAE,QAAQ;gBACtB,IAAI,EAAE,CAAC,4CAA4C,CAAC;aACrD,CAAC,CAAA;YAEF,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAA;QAC/B,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACtB,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;YACpC,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,CAAA;YAE9C,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YAEpC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC/B,YAAY,EAAE,4CAA4C;gBAC1D,OAAO,EAAE,IAAI,OAAO,CAAC,4CAA4C,CAAC;aACnE,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;YAChC,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YAEvD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACtD,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACxB,EAAE,CAAC,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,QAAQ,EAAE,CAAA;YAEhD,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;YAEvB,uEAAuE;YACvE,8EAA8E;YAE9E,+CAA+C;YAC/C,cAAc;YACd,yDAAyD;YACzD,eAAe;YACf,eAAe;YACf,oBAAoB;YACpB,kBAAkB;YAClB,qBAAqB;YACrB,uBAAuB;YACvB,IAAI;QACN,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,YAAY,GAAG,4CAA4C,CAAA;YACjE,MAAM,SAAS,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;YACtC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YAElC,MAAM,IAAI,CAAC,0BAA0B,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;YAE9G,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,SAAS,CAAC,EAAE,GAAG;gBACrD,KAAK,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE;oBACvD,OAAO,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC;wBACpC,OAAO,EAAE,YAAY;wBACrB,GAAG,EAAE,GAAG,CAAC,QAAQ;wBACjB,YAAY,EAAE,UAAU;wBACxB,IAAI,EAAE,CAAC,gBAAgB,CAAC,aAAa,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC;qBAC7D,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;YACJ,CAAC,EAAE,OAAO,CAAC,CAAA;YAEX,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;YAE7E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;YAEpD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC;gBACvE,OAAO,EAAE,YAAY;gBACrB,GAAG,EAAE,GAAG,CAAC,QAAQ;gBACjB,YAAY,EAAE,WAAW;gBACzB,IAAI,EAAE,CAAC,gBAAgB,CAAC,aAAa,CAAC;aACvC,CAAC,CAAA;YAEF,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC5D,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;YAC/B,MAAM,YAAY,GAAG,4CAA4C,CAAA;YACjE,MAAM,SAAS,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;YACtC,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YAClC,MAAM,OAAO,GAAG,aAAa,EAAE,CAAA;YAE/B,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,SAAS,CAAC,EAAE,GAAG;gBACrD,KAAK,CAAC,CAAC,aAAa,CAAC,kBAAkB,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE;oBACvD,OAAO,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC;wBACpC,OAAO,EAAE,YAAY;wBACrB,GAAG,EAAE,GAAG,CAAC,QAAQ;wBACjB,YAAY,EAAE,UAAU;wBACxB,IAAI,EAAE,CAAC,gBAAgB,CAAC,aAAa,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC;qBAC7D,CAAC,CAAA;gBACJ,CAAC,CAAC,CAAA;YACJ,CAAC,EAAE,OAAO,CAAC,CAAA;YAEX,MAAM,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,CAAC,CAAA;YAE9D,MAAM,IAAI,CAAC,0BAA0B,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;YAC9G,MAAM,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;YACrD,MAAM,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;YAE1C,OAAO,CAAC,YAAY,CAAC,kBAAkB,GAAG,OAAO,CAAA;YACjD,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;YAEzD,MAAM,qBAAqB,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC;gBACrF,OAAO,EAAE,YAAY;gBACrB,GAAG,EAAE,GAAG,CAAC,QAAQ;gBACjB,YAAY,EAAE,WAAW;gBACzB,IAAI,EAAE,CAAC,QAAQ,CAAC;aACjB,CAAC,CAAA;YAEF,MAAM,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;YAE1C,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;YAE9E,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;YAEpD,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC;gBACpF,OAAO,EAAE,YAAY;gBACrB,GAAG,EAAE,GAAG,CAAC,QAAQ;gBACjB,YAAY,EAAE,WAAW;gBACzB,IAAI,EAAE,CAAC,QAAQ,CAAC;aACjB,CAAC,CAAA;YAEF,MAAM,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC5C,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/entities/Pool.d.ts

@@ -0,0 +1,157 @@
+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;
+                    address: `0x${string}`;
+                }[];
+                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;
+            address: `0x${string}`;
+        }[];
+        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;IAsCR,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;IAuBd,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;IA+Q3C;;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;CAqHzE"}