@interest-protocol/vortex-sdk 0.0.1-alpha.0

package/dist/utils.d.ts

@@ -0,0 +1,11 @@
+export declare const BN254_FIELD_MODULUS = 21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+export declare const generateRandomNote: () => {
+    nullifier: bigint;
+    secret: bigint;
+    commitment: bigint;
+};
+export declare function bigIntToFieldElement(value: bigint): bigint;
+export declare function addressToFieldElement(address: string): bigint;
+export declare const stringToField: (s: string) => bigint;
+export declare function zeros(treeLevels: number): bigint[];
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,mBAAmB,iFACgD,CAAC;AAYjF,eAAO,MAAM,kBAAkB;;;;CAS9B,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,UAEjD;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,UAMpD;AAED,eAAO,MAAM,aAAa,GAAI,GAAG,MAAM,WAKtC,CAAC;AAEF,wBAAgB,KAAK,CAAC,UAAU,EAAE,MAAM,YAiBvC"}

package/dist/vortex.d.ts

@@ -0,0 +1,24 @@
+import { SdkConstructorArgs, DepositArgs, Pool, WithdrawArgs } from './vortex.types';
+import { Transaction } from '@mysten/sui/transactions';
+export declare class VortexSdk {
+    private client;
+    private packageId;
+    private pools;
+    TREE_HEIGHT: number;
+    BN254_FIELD_MODULUS: bigint;
+    constructor(args: SdkConstructorArgs);
+    generateRandomNote(): {
+        nullifier: bigint;
+        secret: bigint;
+        commitment: bigint;
+    };
+    poseidon1(a: bigint | number | string): bigint;
+    poseidon2(a: bigint | number | string, b: bigint | number | string): bigint;
+    addressToFieldElement(address: string): bigint;
+    bigIntToFieldElement(value: bigint): bigint;
+    zeros(): bigint[];
+    deposit({ commitment, pool, tx }: DepositArgs): Transaction;
+    withdraw({ proofPointsHex, root, nullifier, recipient, relayer, relayerFee, pool, tx, }: WithdrawArgs): Transaction;
+    root(pool: Pool): Promise<any>;
+}
+//# sourceMappingURL=vortex.d.ts.map

package/dist/vortex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vortex.d.ts","sourceRoot":"","sources":["../src/vortex.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAElB,WAAW,EAEX,IAAI,EACJ,YAAY,EACb,MAAM,gBAAgB,CAAC;AAWxB,OAAO,EAAE,WAAW,EAAmB,MAAM,0BAA0B,CAAC;AAKxE,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,KAAK,CAAc;IAEpB,WAAW,SAAM;IACjB,mBAAmB,SAAuB;gBAErC,IAAI,EAAE,kBAAkB;IAMpC,kBAAkB;;;;;IAIlB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAIrC,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAIlE,qBAAqB,CAAC,OAAO,EAAE,MAAM;IAIrC,oBAAoB,CAAC,KAAK,EAAE,MAAM;IAIlC,KAAK;IAIL,OAAO,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,EAAsB,EAAE,EAAE,WAAW;IA0BjE,QAAQ,CAAC,EACP,cAAc,EACd,IAAI,EACJ,SAAS,EACT,SAAS,EACT,OAAO,EACP,UAAU,EACV,IAAI,EACJ,EAAsB,GACvB,EAAE,YAAY;IAqCT,IAAI,CAAC,IAAI,EAAE,IAAI;CA4BtB"}

package/dist/vortex.types.d.ts

@@ -0,0 +1,69 @@
+import { SuiClient } from '@mysten/sui/client';
+import { Transaction, TransactionResult } from '@mysten/sui/transactions';
+export declare enum Pool {
+    shrimp = 100000000,
+    dolphin = 1000000000,
+    whale = 10000000000
+}
+export declare enum Modules {
+    vortex = "vortex",
+    proof = "vortex_proof",
+    merkleTree = "vortex_merkle_tree"
+}
+export interface SharedObject {
+    objectId: string;
+    initialSharedVersion: string;
+}
+export interface VortexPools {
+    [Pool.shrimp]: SharedObject;
+    [Pool.dolphin]: SharedObject;
+    [Pool.whale]: SharedObject;
+}
+export interface SdkConstructorArgs {
+    client: SuiClient;
+    packageId: string;
+    pools: VortexPools;
+}
+export interface AdminSdkConstructorArgs {
+    packageId: string;
+    adminCap: string;
+}
+export interface DepositArgs {
+    tx?: Transaction;
+    commitment: bigint;
+    pool: Pool;
+}
+export interface WithdrawArgs {
+    tx?: Transaction;
+    pool: Pool;
+    proofPointsHex: string;
+    root: bigint;
+    nullifier: bigint;
+    recipient: string;
+    relayer: string;
+    relayerFee: bigint;
+}
+export interface NewPoolArgs {
+    tx?: Transaction;
+    pool: Pool;
+}
+export interface SharePoolArgs {
+    tx: Transaction;
+    pool: TransactionResult;
+}
+export interface SetDepositFeeArgs {
+    tx?: Transaction;
+    pool: TransactionResult | string;
+    fee: bigint;
+}
+export interface SetWithdrawFeeArgs {
+    tx?: Transaction;
+    pool: TransactionResult | string;
+    fee: bigint;
+}
+export interface SetGroth16VkArgs {
+    tx?: Transaction;
+    pool: TransactionResult | string;
+    vk: string;
+}
+//# sourceMappingURL=vortex.types.d.ts.map

package/dist/vortex.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vortex.types.d.ts","sourceRoot":"","sources":["../src/vortex.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE1E,oBAAY,IAAI;IAEd,MAAM,YAAc;IAEpB,OAAO,aAAgB;IAEvB,KAAK,cAAiB;CACvB;AAED,oBAAY,OAAO;IACjB,MAAM,WAAW;IACjB,KAAK,iBAAiB;IACtB,UAAU,uBAAuB;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAC5B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAC7B,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,WAAW,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,CAAC,EAAE,WAAW,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,WAAW,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,WAAW,CAAC;IAChB,IAAI,EAAE,iBAAiB,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,CAAC,EAAE,WAAW,CAAC;IACjB,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAAC;IACjC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,WAAW,CAAC;IACjB,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAAC;IACjC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,EAAE,WAAW,CAAC;IACjB,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAAC;IACjC,EAAE,EAAE,MAAM,CAAC;CACZ"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@interest-protocol/vortex-sdk",
+  "version": "0.0.1-alpha.0",
+  "description": "",
+  "main": "index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@mysten/sui": "^1.36.2",
+    "@polymedia/suitcase-core": "^0.0.67",
+    "poseidon-hash": "^1.0.1",
+    "poseidon-lite": "^0.3.0",
+    "ramda": "^0.30.1",
+    "tiny-invariant": "^1.3.3"
+  },
+  "devDependencies": {
+    "rimraf": "^6.0.1",
+    "tsup": "^8.3.5",
+    "@interest-protocol/prettier-config": "1.0.0",
+    "@interest-protocol/typescript-config": "1.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "dependencies": {
+      "@mysten/sui": "^1.36.2",
+      "@polymedia/suitcase-core": "^0.0.67",
+      "poseidon-hash": "^1.0.1",
+      "poseidon-lite": "^0.3.0",
+      "ramda": "^0.30.1",
+      "tiny-invariant": "^1.3.3"
+    }
+  },
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "rollup -c rollup.config.js",
+    "build:types": "tsc --emitDeclarationOnly"
+  }
+}

package/rollup.config.js

@@ -0,0 +1,58 @@
+const resolve = require('@rollup/plugin-node-resolve');
+const commonjs = require('@rollup/plugin-commonjs');
+const typescript = require('@rollup/plugin-typescript');
+const pkg = require('./package.json');
+
+// Get workspace dependencies
+const workspaceDeps = Object.keys(pkg.dependencies || {}).filter((dep) =>
+  pkg.dependencies[dep].startsWith('workspace:')
+);
+
+// Get publishConfig dependencies (which will remain external)
+const publishConfigDeps = pkg.publishConfig?.dependencies
+  ? Object.keys(pkg.publishConfig.dependencies)
+  : [];
+
+// Workspace dependencies to bundle (not in publishConfig)
+const depsToBundled = workspaceDeps.filter(
+  (dep) => !publishConfigDeps.includes(dep)
+);
+
+// All external dependencies
+const allExternalDeps = [
+  ...Object.keys(pkg.dependencies || {}).filter(
+    (dep) => !depsToBundled.includes(dep)
+  ),
+];
+
+console.log('Workspace dependencies to bundle:', depsToBundled);
+console.log('External dependencies:', allExternalDeps);
+
+module.exports = {
+  input: 'src/index.ts',
+  output: [
+    {
+      file: 'dist/index.js',
+      format: 'cjs',
+      sourcemap: true,
+    },
+    {
+      file: 'dist/index.mjs',
+      format: 'esm',
+      sourcemap: true,
+    },
+  ],
+  external: allExternalDeps,
+  plugins: [
+    resolve({
+      extensions: ['.ts', '.tsx', '.js', '.jsx'],
+      // Critical for bundling workspace dependencies
+      preserveSymlinks: false,
+    }),
+    commonjs(),
+    typescript({
+      tsconfig: './tsconfig.json',
+      declaration: true,
+    }),
+  ],
+};

package/src/admin.ts

@@ -0,0 +1,124 @@
+import { AdminSdkConstructorArgs } from './vortex.types';
+import { Transaction } from '@mysten/sui/transactions';
+import { fromHex } from '@mysten/sui/utils';
+import {
+  NewPoolArgs,
+  Modules,
+  SharePoolArgs,
+  SetDepositFeeArgs,
+  SetWithdrawFeeArgs,
+  SetGroth16VkArgs,
+} from './vortex.types';
+
+export class VortexAdminSdk {
+  private packageId: string;
+  private adminCap: string;
+
+  constructor(args: AdminSdkConstructorArgs) {
+    this.packageId = args.packageId;
+    this.adminCap = args.adminCap;
+  }
+
+  newPool({ pool, tx = new Transaction() }: NewPoolArgs) {
+    const vortex = tx.moveCall({
+      package: this.packageId,
+      module: Modules.vortex,
+      function: 'new',
+      arguments: [tx.object(this.adminCap), tx.pure.u64(pool)],
+    });
+
+    return {
+      vortex,
+      tx,
+    };
+  }
+
+  sharePool({ tx, pool }: SharePoolArgs) {
+    tx.moveCall({
+      package: this.packageId,
+      module: Modules.vortex,
+      function: 'share',
+      arguments: [pool],
+    });
+
+    return tx;
+  }
+
+  setDepositFee({ tx = new Transaction(), pool, fee }: SetDepositFeeArgs) {
+    if (typeof pool === 'object') {
+      tx.moveCall({
+        package: this.packageId,
+        module: Modules.vortex,
+        function: 'set_deposit_fee',
+        arguments: [pool, tx.object(this.adminCap), tx.pure.u64(fee)],
+      });
+    } else {
+      tx.moveCall({
+        package: this.packageId,
+        module: Modules.vortex,
+        function: 'set_deposit_fee',
+        arguments: [
+          tx.object(pool),
+          tx.object(this.adminCap),
+          tx.pure.u64(fee),
+        ],
+      });
+    }
+
+    return tx;
+  }
+
+  setWithdrawFee({ tx = new Transaction(), pool, fee }: SetWithdrawFeeArgs) {
+    if (typeof pool === 'object') {
+      tx.moveCall({
+        package: this.packageId,
+        module: Modules.vortex,
+        function: 'set_withdraw_fee',
+        arguments: [pool, tx.object(this.adminCap), tx.pure.u64(fee)],
+      });
+    } else {
+      tx.moveCall({
+        package: this.packageId,
+        module: Modules.vortex,
+        function: 'set_withdraw_fee',
+        arguments: [
+          tx.object(pool),
+          tx.object(this.adminCap),
+          tx.pure.u64(fee),
+        ],
+      });
+    }
+
+    return tx;
+  }
+
+  setGroth16Vk({ tx = new Transaction(), pool, vk }: SetGroth16VkArgs) {
+    const vkBytes = fromHex(vk);
+
+    if (typeof pool === 'object') {
+      tx.moveCall({
+        package: this.packageId,
+        module: Modules.vortex,
+        function: 'set_groth16_vk',
+        arguments: [
+          pool,
+          tx.object(this.adminCap),
+          tx.pure.vector('u8', vkBytes),
+        ],
+      });
+    } else {
+      tx.moveCall({
+        package: this.packageId,
+        module: Modules.vortex,
+        function: 'set_groth16_vk',
+        arguments: [
+          tx.object(pool),
+          tx.object(this.adminCap),
+          tx.pure.vector('u8', vkBytes),
+        ],
+      });
+    }
+
+    return tx;
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './utils';
+export * from './vortex';
+export * from './admin';
+export * from './vortex.types';

package/src/utils.ts

@@ -0,0 +1,66 @@
+import { poseidon2, poseidon1 } from 'poseidon-lite';
+import invariant from 'tiny-invariant';
+
+import { isValidSuiAddress, normalizeSuiAddress } from '@mysten/sui/utils';
+
+export const BN254_FIELD_MODULUS =
+  21888242871839275222246405745257275088548364400416034343698204186575808495617n;
+
+function randomBigIntHex(byteLength: number): bigint {
+  const hexString = Array.from(
+    crypto.getRandomValues(new Uint8Array(byteLength))
+  )
+    .map((b) => b.toString(16).padStart(2, '0'))
+    .join('');
+
+  return BigInt('0x' + hexString);
+}
+
+export const generateRandomNote = () => {
+  const nullifier = randomBigIntHex(31);
+  const secret = randomBigIntHex(31);
+  const commitment = poseidon2([nullifier, secret]);
+  return {
+    nullifier,
+    secret,
+    commitment,
+  };
+};
+
+export function bigIntToFieldElement(value: bigint) {
+  return value % BN254_FIELD_MODULUS;
+}
+
+export function addressToFieldElement(address: string) {
+  invariant(isValidSuiAddress(address), 'Invalid Sui address');
+
+  const cleanAddress = normalizeSuiAddress(address, true);
+
+  return bigIntToFieldElement(BigInt(cleanAddress));
+}
+
+export const stringToField = (s: string) => {
+  const bytes = new TextEncoder().encode(s);
+  let acc = 0n;
+  for (const b of bytes) acc = (acc << 8n) | BigInt(b);
+  return acc % BN254_FIELD_MODULUS;
+};
+
+export function zeros(treeLevels: number) {
+  if (treeLevels < 1) throw new Error('treeLevels must be >= 1');
+
+  // ZERO_VALUE := Poseidon("vortex")
+  const ZERO_VALUE = poseidon1([stringToField('vortex')]);
+
+  const zeros: bigint[] = [];
+
+  let currentZero = ZERO_VALUE;
+  zeros.push(currentZero);
+
+  for (let i = 1; i < treeLevels; i++) {
+    currentZero = poseidon2([currentZero, currentZero]);
+    zeros.push(currentZero);
+  }
+
+  return zeros;
+}

package/src/vortex.ts

@@ -0,0 +1,162 @@
+import {
+  SdkConstructorArgs,
+  VortexPools,
+  DepositArgs,
+  Modules,
+  Pool,
+  WithdrawArgs,
+} from './vortex.types';
+import { SuiClient } from '@mysten/sui/client';
+import {
+  generateRandomNote,
+  zeros,
+  BN254_FIELD_MODULUS,
+  addressToFieldElement,
+  bigIntToFieldElement,
+} from './utils';
+import { poseidon2, poseidon1 } from 'poseidon-lite';
+import { devInspectAndGetReturnValues } from '@polymedia/suitcase-core';
+import { Transaction, coinWithBalance } from '@mysten/sui/transactions';
+import { fromHex, SUI_TYPE_ARG } from '@mysten/sui/utils';
+import { bcs } from '@mysten/sui/bcs';
+import invariant from 'tiny-invariant';
+
+export class VortexSdk {
+  private client: SuiClient;
+  private packageId: string;
+  private pools: VortexPools;
+
+  public TREE_HEIGHT = 26;
+  public BN254_FIELD_MODULUS = BN254_FIELD_MODULUS;
+
+  constructor(args: SdkConstructorArgs) {
+    this.client = args.client;
+    this.packageId = args.packageId;
+    this.pools = args.pools;
+  }
+
+  generateRandomNote() {
+    return generateRandomNote();
+  }
+
+  poseidon1(a: bigint | number | string) {
+    return poseidon1([a]);
+  }
+
+  poseidon2(a: bigint | number | string, b: bigint | number | string) {
+    return poseidon2([a, b]);
+  }
+
+  addressToFieldElement(address: string) {
+    return addressToFieldElement(address);
+  }
+
+  bigIntToFieldElement(value: bigint) {
+    return bigIntToFieldElement(value);
+  }
+
+  zeros() {
+    return zeros(this.TREE_HEIGHT);
+  }
+
+  deposit({ commitment, pool, tx = new Transaction() }: DepositArgs) {
+    const poolObject = this.pools[pool];
+
+    const suiCoin = coinWithBalance({
+      type: SUI_TYPE_ARG,
+      balance: pool,
+    })(tx);
+
+    tx.moveCall({
+      package: this.packageId,
+      module: Modules.vortex,
+      function: 'deposit',
+      arguments: [
+        tx.sharedObjectRef({
+          objectId: poolObject.objectId,
+          mutable: true,
+          initialSharedVersion: poolObject.initialSharedVersion,
+        }),
+        suiCoin,
+        tx.pure.u256(commitment),
+      ],
+    });
+
+    return tx;
+  }
+
+  withdraw({
+    proofPointsHex,
+    root,
+    nullifier,
+    recipient,
+    relayer,
+    relayerFee,
+    pool,
+    tx = new Transaction(),
+  }: WithdrawArgs) {
+    const poolObject = this.pools[pool];
+
+    const proof = tx.moveCall({
+      package: this.packageId,
+      module: Modules.proof,
+      function: 'new',
+      arguments: [
+        tx.pure.vector('u8', fromHex(proofPointsHex)),
+        tx.pure.vector('u8', []),
+        tx.pure.vector('u8', []),
+        tx.pure.u256(root),
+        tx.pure.u256(nullifier),
+        tx.pure.address(recipient),
+        tx.pure.u64(pool),
+        tx.pure.address(relayer),
+        tx.pure.u64(relayerFee),
+      ],
+    });
+
+    tx.moveCall({
+      package: this.packageId,
+      module: Modules.vortex,
+      function: 'withdraw',
+      arguments: [
+        tx.sharedObjectRef({
+          objectId: poolObject.objectId,
+          mutable: true,
+          initialSharedVersion: poolObject.initialSharedVersion,
+        }),
+        proof,
+      ],
+    });
+
+    return tx;
+  }
+
+  async root(pool: Pool) {
+    const tx = new Transaction();
+
+    const poolObject = this.pools[pool];
+
+    tx.moveCall({
+      package: this.packageId,
+      module: Modules.merkleTree,
+      function: 'root',
+      arguments: [
+        tx.sharedObjectRef({
+          objectId: poolObject.objectId,
+          mutable: false,
+          initialSharedVersion: poolObject.initialSharedVersion,
+        }),
+      ],
+    });
+
+    const result = await devInspectAndGetReturnValues(this.client, tx, [
+      [bcs.u256()],
+    ]);
+
+    invariant(result[0], 'Root devInspectAndGetReturnValues failed');
+
+    const [root] = result[0][0].map((value: string) => BigInt(value));
+
+    return root;
+  }
+}

package/src/vortex.types.ts

@@ -0,0 +1,84 @@
+import { SuiClient } from '@mysten/sui/client';
+import { Transaction, TransactionResult } from '@mysten/sui/transactions';
+
+export enum Pool {
+  // 0.1 Sui
+  shrimp = 100_000_000,
+  // 1 Sui
+  dolphin = 1_000_000_000,
+  // 10 Sui
+  whale = 10_000_000_000,
+}
+
+export enum Modules {
+  vortex = 'vortex',
+  proof = 'vortex_proof',
+  merkleTree = 'vortex_merkle_tree',
+}
+
+export interface SharedObject {
+  objectId: string;
+  initialSharedVersion: string;
+}
+
+export interface VortexPools {
+  [Pool.shrimp]: SharedObject;
+  [Pool.dolphin]: SharedObject;
+  [Pool.whale]: SharedObject;
+}
+
+export interface SdkConstructorArgs {
+  client: SuiClient;
+  packageId: string;
+  pools: VortexPools;
+}
+
+export interface AdminSdkConstructorArgs {
+  packageId: string;
+  adminCap: string;
+}
+
+export interface DepositArgs {
+  tx?: Transaction;
+  commitment: bigint;
+  pool: Pool;
+}
+
+export interface WithdrawArgs {
+  tx?: Transaction;
+  pool: Pool;
+  proofPointsHex: string;
+  root: bigint;
+  nullifier: bigint;
+  recipient: string;
+  relayer: string;
+  relayerFee: bigint;
+}
+
+export interface NewPoolArgs {
+  tx?: Transaction;
+  pool: Pool;
+}
+
+export interface SharePoolArgs {
+  tx: Transaction;
+  pool: TransactionResult;
+}
+
+export interface SetDepositFeeArgs {
+  tx?: Transaction;
+  pool: TransactionResult | string;
+  fee: bigint;
+}
+
+export interface SetWithdrawFeeArgs {
+  tx?: Transaction;
+  pool: TransactionResult | string;
+  fee: bigint;
+}
+
+export interface SetGroth16VkArgs {
+  tx?: Transaction;
+  pool: TransactionResult | string;
+  vk: string;
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "@interest-protocol/*": ["../*/src"],
+  "exclude": ["node_modules", "dist"]
+}