@centrifuge/sdk 0.0.0-alpha.12 → 0.0.0-alpha.15

package/dist/entities/ShareClass.test.js

@@ -0,0 +1,72 @@
+import { expect } from 'chai';
+import { context } from '../tests/setup.js';
+import { AccountType } from '../types/holdings.js';
+import { Balance } from '../utils/BigInt.js';
+import { AssetId, PoolId, ShareClassId } from '../utils/types.js';
+import { Pool } from './Pool.js';
+import { ShareClass } from './ShareClass.js';
+const chainId = 11155111;
+const poolId = PoolId.from(1, 1);
+const scId = ShareClassId.from(poolId, 1);
+const assetId = AssetId.from(1, 1);
+// const fundManager = '0x423420Ae467df6e90291fd0252c0A8a637C1e03f'
+// const investorB = '0x54b1d961678C145a444765bB2d7aD6B029770D35'
+describe('ShareClass', () => {
+    let shareClass;
+    beforeEach(() => {
+        const { centrifuge } = context;
+        const pool = new Pool(centrifuge, poolId.raw, chainId);
+        shareClass = new ShareClass(centrifuge, pool, scId.raw);
+    });
+    it('gets the details', async () => {
+        const details = await shareClass.details();
+        expect(details.totalIssuance).to.be.instanceOf(Balance);
+        expect(details.navPerShare).to.be.instanceOf(Balance);
+        expect(details.name).to.equal('Tokenized MMF');
+        expect(details.symbol).to.equal('MMF');
+        expect(details.id.raw).to.equal(scId.raw);
+    });
+    it('gets the vaults', async () => {
+        const vaults = await shareClass.vaults(chainId);
+        expect(vaults.length).to.equal(1);
+        expect(vaults[0].shareClass.id.raw).to.equal(scId.raw);
+    });
+    it('gets a holding', async () => {
+        const holding = await shareClass.holding(assetId);
+        expect(typeof holding.valuation).to.equal('string');
+        expect(holding.assetDecimals).to.equal(6);
+        expect(holding.assetId.equals(assetId)).to.be.true;
+        expect(holding.amount.decimals).to.equal(6);
+        expect(holding.value.decimals).to.equal(18);
+        expect(holding.accounts[AccountType.Asset]).not.to.be.undefined;
+        expect(holding.accounts[AccountType.Equity]).not.to.be.undefined;
+    });
+    // Done in Vault.test.ts
+    // it('approves deposits and claims shares', async () => {
+    //   context.tenderlyFork.impersonateAddress = fundManager
+    //   context.centrifuge.setSigner(context.tenderlyFork.signer)
+    //   const result = await shareClass.approveDeposits(assetId, Balance.fromFloat(100, 6), Price.fromFloat(1))
+    //   expect(result.type).to.equal('TransactionConfirmed')
+    //   const order = await shareClass.investorOrder(assetId, investorB)
+    //   expect(order.maxDepositClaims).to.equal(1)
+    //   const result2 = await shareClass.claimDeposit(assetId, investorB)
+    //   expect(result2.type).to.equal('TransactionConfirmed')
+    // })
+});
+// const { poolManager } = await context.centrifuge._protocolAddresses(chainId)
+// const client = context.centrifuge.getClient(chainId)!
+// const poolLoc = mapLocation(6n, poolId.raw, 'uint128')
+// const scLoc = mapLocation(poolLoc + 1n, scId.raw, 'bytes16')
+// const assetLoc = mapLocation(scLoc + 3n, '0xd54864475D5b1a0F235A751b6fddc8bb28FD3b9b', 'address')
+// const priceLoc = mapLocation(assetLoc, 0n, 'uint256')
+// const data = await client.getStorageAt({
+//   address: poolManager,
+//   slot: '0xb4aaa343c87a4bd58f639be7336d06126be71acdd096ecaad93182fd909f8e59',
+// })
+// function mapLocation(slot: bigint, key: bigint | string, keyType: string) {
+//   return hexToBigInt(keccak256(encodePacked([keyType, 'uint256'], [key, slot])))
+// }
+// function arrLocation(slot: bigint, index: bigint, elementSize: bigint) {
+//   return hexToBigInt(keccak256(toHex(slot))) + index * elementSize
+// }
+//# sourceMappingURL=ShareClass.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ShareClass.test.js","sourceRoot":"","sources":["../../src/entities/ShareClass.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAC7B,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACjE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAE5C,MAAM,OAAO,GAAG,QAAQ,CAAA;AACxB,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAChC,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AACzC,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAElC,mEAAmE;AACnE,iEAAiE;AAEjE,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,IAAI,UAAsB,CAAA;IAC1B,UAAU,CAAC,GAAG,EAAE;QACd,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;QAC9B,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QACtD,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAA;IACzD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;QAChC,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,OAAO,EAAE,CAAA;QAC1C,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QACrD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,CAAA;QAC9C,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACtC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC3C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;QAC/B,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAC/C,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACjC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACzD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QAC9B,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACjD,MAAM,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QACnD,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACzC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAA;QAClD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC3C,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAC3C,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAA;QAC/D,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,wBAAwB;IACxB,0DAA0D;IAC1D,0DAA0D;IAC1D,8DAA8D;IAC9D,4GAA4G;IAC5G,yDAAyD;IAEzD,qEAAqE;IAErE,+CAA+C;IAE/C,sEAAsE;IACtE,0DAA0D;IAC1D,KAAK;AACP,CAAC,CAAC,CAAA;AAEF,+EAA+E;AAC/E,wDAAwD;AACxD,yDAAyD;AACzD,+DAA+D;AAC/D,oGAAoG;AACpG,wDAAwD;AACxD,2CAA2C;AAC3C,0BAA0B;AAC1B,gFAAgF;AAChF,KAAK;AAEL,8EAA8E;AAC9E,mFAAmF;AACnF,IAAI;AAEJ,2EAA2E;AAC3E,qEAAqE;AACrE,IAAI"}

package/dist/entities/Vault.d.ts

@@ -0,0 +1,85 @@
+import type { HexString } from '../types/index.js';
+import { Balance } from '../utils/BigInt.js';
+import { Entity } from './Entity.js';
+import type { Pool } from './Pool.js';
+import { PoolNetwork } from './PoolNetwork.js';
+import { ShareClass } from './ShareClass.js';
+/**
+ * Query and interact with a vault, which is the main entry point for investing and redeeming funds.
+ * A vault is the combination of a network, a pool, a share class and an investment currency.
+ */
+export declare class Vault extends Entity {
+    network: PoolNetwork;
+    shareClass: ShareClass;
+    pool: Pool;
+    chainId: number;
+    /**
+     * The contract address of the vault.
+     */
+    address: HexString;
+    /**
+     * Get the details of the vault.
+     */
+    details(): import("../index.js").Query<{
+        pool: Pool;
+        shareClass: ShareClass;
+        network: PoolNetwork;
+        address: `0x${string}`;
+        asset: `0x${string}`;
+        isSyncInvest: boolean;
+        isSyncRedeem: boolean;
+        investmentCurrency: import("../types/index.js").CurrencyDetails;
+        shareCurrency: import("../types/index.js").CurrencyDetails;
+    }>;
+    /**
+     * Get the details of the investment of an investor in the vault and any pending investments or redemptions.
+     * @param investor - The address of the investor
+     */
+    investment(investor: string): import("../index.js").Query<{
+        shareBalance: Balance;
+        investmentCurrencyBalance: Balance;
+        investmentCurrencyAllowance: Balance;
+        isAllowedToInvest: boolean;
+        isAllowedToRedeem: boolean;
+        isSyncInvest: boolean;
+        maxInvest: Balance;
+        claimableInvestShares: Balance;
+        claimableInvestCurrencyEquivalent: Balance;
+        claimableRedeemCurrency: Balance;
+        claimableRedeemSharesEquivalent: Balance;
+        pendingInvestCurrency: Balance;
+        pendingRedeemShares: Balance;
+        claimableCancelInvestCurrency: Balance;
+        claimableCancelRedeemShares: Balance;
+        hasPendingCancelInvestRequest: boolean;
+        hasPendingCancelRedeemRequest: boolean;
+        investmentCurrency: import("../types/index.js").CurrencyDetails;
+        shareCurrency: import("../types/index.js").CurrencyDetails;
+    }>;
+    /**
+     * Place an order to invest funds in the vault. If an order exists, it will increase the amount.
+     * @param amount - The amount to invest in the vault
+     */
+    increaseInvestOrder(amount: Balance): import("../index.js").Transaction;
+    /**
+     * Cancel an open investment order.
+     */
+    cancelInvestOrder(): import("../index.js").Transaction;
+    /**
+     * Place an order to redeem funds from the vault. If an order exists, it will increase the amount.
+     * @param sharesAmount - The amount of shares to redeem
+     */
+    increaseRedeemOrder(sharesAmount: Balance): import("../index.js").Transaction;
+    /**
+     * Cancel an open redemption order.
+     */
+    cancelRedeemOrder(): import("../index.js").Transaction;
+    /**
+     * Claim any outstanding fund shares after an investment has gone through, or funds after an redemption has gone through.
+     * @param receiver - The address that should receive the funds. If not provided, the investor's address is used.
+     * @param controller - The address of the user that has invested. Allows someone else to claim on behalf of the user
+     *  if the user has set the VaultRouter as an operator on the vault. If not provided, the investor's address is used.
+     */
+    claim(receiver?: string, controller?: string): import("../index.js").Transaction;
+}
+//# sourceMappingURL=Vault.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Vault.d.ts","sourceRoot":"","sources":["../../src/entities/Vault.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAG5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAU5C;;;GAGG;AACH,qBAAa,KAAM,SAAQ,MAAM;IAetB,OAAO,EAAE,WAAW;IACpB,UAAU,EAAE,UAAU;IAf/B,IAAI,EAAE,IAAI,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IAMf;;OAEG;IACH,OAAO,EAAE,SAAS,CAAA;IAgBlB;;OAEG;IACH,OAAO;;;;;;;;;;;IAkBP;;;OAGG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;IAsH3B;;;OAGG;IACH,mBAAmB,CAAC,MAAM,EAAE,OAAO;IA6FnC;;OAEG;IACH,iBAAiB;IAuBjB;;;OAGG;IACH,mBAAmB,CAAC,YAAY,EAAE,OAAO;IA0BzC;;OAEG;IACH,iBAAiB;IAuBjB;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;CAiI7C"}