Merge pull request #261 from lidofinance/vaults

Vaults

Author: Tarens2

.editorconfig

@@ -4,7 +4,7 @@ root = true
 end_of_line = lf
 insert_final_newline = true
 
-[*.{js,json,yml}]
+[*.{ts,js,json,yml}]
 charset = utf-8
 indent_style = space
 indent_size = 2

packages/sdk/.env.example

@@ -2,5 +2,7 @@
 TEST_PRIVATE_KEY=0xeeeeeee
 TEST_CHAIN_ID=560048
 TEST_RPC_URL=
+TEST_L2_RPC_URL=
+TEST_L2_CHAIN_ID=
 TEST_SKIP_SPENDING_TESTS=false
 TEST_SUBGRAPH_URL=

packages/sdk/jest.config.ts

@@ -21,6 +21,7 @@ const jestConfig: JestConfigWithTsJest = {
     ],
   },
   maxWorkers: 1,
+  setupFiles: ['<rootDir>/tests/mocks/multiformats.mock.cjs'],
   globalSetup: '<rootDir>/tests/global-setup.cjs',
   globalTeardown: '<rootDir>/tests/global-teardown.cjs',
   testTimeout: 60_000,

packages/sdk/package.json

@@ -81,6 +81,11 @@
       "default": "./dist/cjs/dual-governance/index.js",
       "types": "./dist/types/dual-governance/index.d.ts"
     },
+    "./stvault": {
+      "import": "./dist/esm/stvault/index.js",
+      "default": "./dist/cjs/stvault/index.js",
+      "types": "./dist/types/stvault/index.d.ts"
+    },
     "./package.json": "./package.json"
   },
   "typesVersions": {
@@ -120,6 +125,9 @@
       ],
       "dual-governance": [
         "./dist/types/dual-governance/index.d.ts"
+      ],
+      "stvault": [
+        "./dist/types/stvault/index.d.ts"
       ]
     }
   },
@@ -160,8 +168,12 @@
   },
   "dependencies": {
     "@ethersproject/bytes": "^5.7.0",
+    "@openzeppelin/merkle-tree": "^1.0.8",
+    "blockstore-core": "^5.0.4",
     "graphql": "^16.8.1",
-    "graphql-request": "^6.1.0"
+    "graphql-request": "^6.1.0",
+    "ipfs-unixfs-importer": "^15.4.0",
+    "multiformats": "^13.4.0"
   },
   "peerDependencies": {
     "viem": "^2.45.0"

packages/sdk/src/common/constants.ts

@@ -78,7 +78,6 @@ export enum LIDO_CONTRACT_NAMES {
   accountingOracle = 'accountingOracle',
   depositSecurityModule = 'depositSecurityModule',
   elRewardsVault = 'elRewardsVault',
-  legacyOracle = 'legacyOracle',
   lido = 'lido',
   oracleReportSanityChecker = 'oracleReportSanityChecker',
   postTokenRebaseReceiver = 'postTokenRebaseReceiver',
@@ -112,15 +111,22 @@ export const DUAL_GOVERNANCE_CONTRACT_ADDRESSES: {
 
 export const WSTETH_REFERRAL_STAKER: { [key in CHAINS]?: Address } = {
   [CHAINS.Mainnet]: '0xa88f0329C2c4ce51ba3fc619BBf44efE7120Dd0d',
-  [CHAINS.Hoodi]:   '0xf886BcC68b240316103fE8A12453Ce7831c2e835',
+  [CHAINS.Hoodi]: '0xf886BcC68b240316103fE8A12453Ce7831c2e835',
   [CHAINS.Sepolia]: '0x9E90338495FfD691bDDC680e47D94b60cF66dDad',
-}
+};
 
 export enum LIDO_L2_CONTRACT_NAMES {
   wsteth = 'wsteth',
   steth = 'steth',
 }
 
+export const VAULT_VIEWER_CONTRACT_ADDRESSES: {
+  [key in CHAINS]?: Address;
+} = {
+  [CHAINS.Hoodi]: '0xEAfD3F8DC0ABA14B81344ea0B869DdF9F7e18221',
+  [CHAINS.Mainnet]: '0x57dAb476c3E37a2410076C9568d796e429fd8418',
+} as const;
+
 export const LIDO_L2_CONTRACT_ADDRESSES: {
   [key in CHAINS]?: { [key2 in LIDO_L2_CONTRACT_NAMES]?: Address };
 } = {

packages/sdk/src/common/index.ts

@@ -1,2 +1,3 @@
 export * from './constants.js';
 export * from './utils/sdk-error.js';
+export * from './utils/get-encodable-contract.js';

packages/sdk/src/common/utils/__tests__/bigint-math.test.ts

@@ -0,0 +1,21 @@
+import { describe, expect, test } from '@jest/globals';
+import { bigIntCeilDiv } from '../bigint-math.js';
+
+describe('bigIntCeilDiv', () => {
+  test('returns exact quotient when divisible', () => {
+    expect(bigIntCeilDiv(10n, 2n)).toBe(5n);
+  });
+
+  test('rounds up when there is a remainder', () => {
+    expect(bigIntCeilDiv(11n, 2n)).toBe(6n);
+    expect(bigIntCeilDiv(15n, 4n)).toBe(4n);
+  });
+
+  test('handles zero numerator', () => {
+    expect(bigIntCeilDiv(0n, 3n)).toBe(0n);
+  });
+
+  test('throws when dividing by zero', () => {
+    expect(() => bigIntCeilDiv(1n, 0n)).toThrow('DIVISION_BY_ZERO');
+  });
+});

packages/sdk/src/common/utils/bigint-math.ts

@@ -0,0 +1,25 @@
+export const bigIntMax = (...args: bigint[]) =>
+  args.reduce((a, b) => (a > b ? a : b));
+export const bigIntMin = (...args: bigint[]) =>
+  args.reduce((a, b) => (a < b ? a : b));
+
+export const bigIntAbs = (value: bigint): bigint =>
+  value < 0n ? -value : value;
+
+export const bigIntSign = (value: bigint): 1n | -1n => {
+  return value >= 0n ? 1n : -1n;
+};
+
+export const bigIntCeilDiv = (
+  numerator: bigint,
+  denominator: bigint,
+): bigint => {
+  if (denominator === 0n) {
+    throw new Error('DIVISION_BY_ZERO');
+  }
+
+  const quotient = numerator / denominator;
+  const remainder = numerator % denominator;
+
+  return remainder === 0n ? quotient : quotient + 1n;
+};

packages/sdk/src/common/utils/get-encodable-contract.ts

@@ -0,0 +1,105 @@
+import { encodeFunctionData, type Abi, type Address, type Hex } from 'viem';
+
+// copy from view internals
+const getFunctionParameters = (values: unknown[]) => {
+  const hasArgs = values.length > 0 && Array.isArray(values[0]);
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  const args = (hasArgs ? values[0]! : []) as unknown[];
+  const options = ((hasArgs ? values[1] : values[0]) ?? {}) as any;
+  return { args, options };
+};
+
+type ContractType = {
+  address: Address;
+  abi: Abi;
+  read?: {
+    [functionName: string]: (...args: any[]) => Promise<any>;
+  };
+  simulate?: {
+    [functionName: string]: (...args: any[]) => Promise<any>;
+  };
+};
+
+export type EncodableContract<
+  TContract extends ContractType,
+  TSimulate extends
+    TContract['simulate'] = TContract['simulate'] extends undefined
+    ? never
+    : TContract['simulate'],
+  TRead extends TContract['read'] = TContract['read'] extends undefined
+    ? never
+    : TContract['read'],
+  TMethods extends TSimulate & TRead = TSimulate & TRead,
+  TFunctionName extends keyof TMethods = keyof TMethods,
+> = TContract & {
+  prepare: {
+    [K in TFunctionName]: (
+      ...args: Parameters<
+        TMethods[K] extends (...args: any[]) => any ? TMethods[K] : never
+      >
+    ) => {
+      address: TContract['address'];
+      abi: TContract['abi'];
+      functionName: K;
+      args: Parameters<
+        TMethods[K] extends (...args: any[]) => any ? TMethods[K] : never
+      >[0] extends readonly unknown[]
+        ? Parameters<
+            TMethods[K] extends (...args: any[]) => any ? TMethods[K] : never
+          >[0]
+        : undefined;
+    };
+  };
+  encode: {
+    [K in TFunctionName]: (
+      ...args: Parameters<
+        TMethods[K] extends (...args: any[]) => any ? TMethods[K] : never
+      >
+    ) => {
+      to: TContract['address'];
+      data: Hex;
+      value?: bigint;
+    };
+  };
+};
+
+export const getEncodableContract = <TContract extends ContractType>(
+  contract: TContract,
+) => {
+  (contract as any).prepare = new Proxy(
+    {},
+    {
+      get(_, functionName: string) {
+        return (...parameters: unknown[]) => {
+          const { args } = getFunctionParameters(parameters);
+          return {
+            address: contract.address,
+            abi: contract.abi,
+            functionName,
+            args,
+          };
+        };
+      },
+    },
+  );
+  (contract as any).encode = new Proxy(
+    {},
+    {
+      get(_, functionName: string) {
+        return (...parameters: unknown[]) => {
+          const { args, options } = getFunctionParameters(parameters);
+          return {
+            to: contract.address,
+            data: encodeFunctionData({
+              abi: contract.abi,
+              functionName,
+              args,
+            }),
+            value: options.value,
+          };
+        };
+      },
+    },
+  );
+  return contract as EncodableContract<TContract>;
+};

packages/sdk/src/common/utils/snake-to-camel.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts snake_case string to camelCase
+ * @param str - The snake_case string to convert
+ * @returns The camelCase version of the string
+ */
+export const snakeToCamel = (str: string): string => {
+  return str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+};