@eulerxyz/euler-v2-sdk 0.1.0-beta

package/dist/src/utils/stateOverrides/getStateOverrides.js

@@ -0,0 +1,86 @@
+import { getAddress, parseEther, } from "viem";
+import { getBalanceOverrides } from "./balanceOverrides.js";
+import { getApprovalOverrides } from "./approvalOverrides.js";
+import { mergeStateOverrides } from "./mergeStateOverrides.js";
+/**
+ * Extract token balance requirements from a TransactionPlan.
+ * Each RequiredApproval represents a deposit-like operation where the
+ * user needs tokens in their wallet. We take the max amount per token.
+ */
+function extractBalanceRequirements(plan, account) {
+    const maxPerToken = new Map();
+    for (const item of plan) {
+        if (item.type !== "requiredApproval")
+            continue;
+        if (getAddress(item.owner) !== getAddress(account))
+            continue;
+        const token = getAddress(item.token);
+        const current = maxPerToken.get(token) || 0n;
+        if (item.amount > current) {
+            maxPerToken.set(token, item.amount);
+        }
+    }
+    return Array.from(maxPerToken.entries());
+}
+/**
+ * Extract approval pairs from a TransactionPlan.
+ * Returns unique [asset, spender] pairs.
+ */
+function extractApprovalRequirements(plan, account) {
+    const seen = new Set();
+    const approvals = [];
+    for (const item of plan) {
+        if (item.type !== "requiredApproval")
+            continue;
+        if (getAddress(item.owner) !== getAddress(account))
+            continue;
+        const asset = getAddress(item.token);
+        const spender = getAddress(item.spender);
+        const key = `${asset}:${spender}`;
+        if (!seen.has(key)) {
+            seen.add(key);
+            approvals.push([asset, spender]);
+        }
+    }
+    return approvals;
+}
+/**
+ * Generate all state overrides needed to simulate a TransactionPlan
+ * for an account that may not have sufficient tokens or approvals.
+ *
+ * Combines:
+ * - Native balance override (ETH)
+ * - ERC20 balance overrides (via storage slot discovery)
+ * - ERC20 approval + Permit2 allowance overrides
+ *
+ * @param client - viem PublicClient (must support eth_createAccessList and eth_call with state overrides)
+ * @param plan - TransactionPlan from the SDK's execution service
+ * @param account - the connected wallet address
+ * @param options - Permit2 address and optional native balance override
+ *
+ * @example
+ * ```ts
+ * const plan = sdk.executionService.planDeposit({ ... })
+ * const permit2 = sdk.deploymentService.getDeployment(chainId).addresses.coreAddrs.permit2
+ * const overrides = await deriveStateOverrides(client, plan, account, { permit2Address: permit2 })
+ * // Use overrides with simulateContract or eth_call
+ * ```
+ */
+export async function deriveStateOverrides(client, plan, account, options) {
+    const { nativeBalance = parseEther("1000"), permit2Address } = options;
+    const balanceTokens = extractBalanceRequirements(plan, account);
+    const approvalPairs = extractApprovalRequirements(plan, account);
+    const [balanceOverrides, approvalOverrides] = await Promise.all([
+        getBalanceOverrides(client, account, balanceTokens),
+        getApprovalOverrides(client, account, approvalPairs, permit2Address),
+    ]);
+    const allOverrides = [];
+    // Native balance override
+    if (nativeBalance > 0n) {
+        allOverrides.push({ address: account, balance: nativeBalance });
+    }
+    allOverrides.push(...balanceOverrides);
+    allOverrides.push(...approvalOverrides);
+    return mergeStateOverrides(allOverrides);
+}
+//# sourceMappingURL=getStateOverrides.js.map

package/dist/src/utils/stateOverrides/getStateOverrides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getStateOverrides.js","sourceRoot":"","sources":["../../../../src/utils/stateOverrides/getStateOverrides.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,UAAU,EACV,UAAU,GACV,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAS/D;;;;GAIG;AACH,SAAS,0BAA0B,CAClC,IAAqB,EACrB,OAAgB;IAEhB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAC;IAE/C,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB;YAAE,SAAS;QAC/C,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,OAAO,CAAC;YAAE,SAAS;QAE7D,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC7C,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,CAAC;YAC3B,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACrC,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,SAAS,2BAA2B,CACnC,IAAqB,EACrB,OAAgB;IAEhB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,SAAS,GAAyB,EAAE,CAAC;IAE3C,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB;YAAE,SAAS;QAC/C,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,OAAO,CAAC;YAAE,SAAS;QAE7D,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,GAAG,KAAK,IAAI,OAAO,EAAE,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACpB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACd,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAClC,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACzC,MAAoB,EACpB,IAAqB,EACrB,OAAgB,EAChB,OAAoC;IAEpC,MAAM,EAAE,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;IAEvE,MAAM,aAAa,GAAG,0BAA0B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAChE,MAAM,aAAa,GAAG,2BAA2B,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEjE,MAAM,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC/D,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC;QACnD,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,CAAC;KACpE,CAAC,CAAC;IAEH,MAAM,YAAY,GAAkB,EAAE,CAAC;IAEvC,0BAA0B;IAC1B,IAAI,aAAa,GAAG,EAAE,EAAE,CAAC;QACxB,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,YAAY,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC;IACvC,YAAY,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC;IAExC,OAAO,mBAAmB,CAAC,YAAY,CAAC,CAAC;AAC1C,CAAC"}

package/dist/src/utils/stateOverrides/index.d.ts

@@ -0,0 +1,4 @@
+export { deriveStateOverrides, type DeriveStateOverridesOptions, } from "./getStateOverrides.js";
+export { getBalanceOverrides } from "./balanceOverrides.js";
+export { getApprovalOverrides, computePermit2StateDiff, } from "./approvalOverrides.js";
+export { mergeStateOverrides } from "./mergeStateOverrides.js";

package/dist/src/utils/stateOverrides/index.js

@@ -0,0 +1,5 @@
+export { deriveStateOverrides, } from "./getStateOverrides.js";
+export { getBalanceOverrides } from "./balanceOverrides.js";
+export { getApprovalOverrides, computePermit2StateDiff, } from "./approvalOverrides.js";
+export { mergeStateOverrides } from "./mergeStateOverrides.js";
+//# sourceMappingURL=index.js.map

package/dist/src/utils/stateOverrides/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/utils/stateOverrides/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,oBAAoB,GAEpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EACN,oBAAoB,EACpB,uBAAuB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/src/utils/stateOverrides/mergeStateOverrides.d.ts

@@ -0,0 +1,6 @@
+import { type StateOverride } from "viem";
+/**
+ * Merge state overrides by address, concatenating stateDiff entries
+ * and taking the last-seen balance/nonce for each address.
+ */
+export declare function mergeStateOverrides(overrides: StateOverride): StateOverride;

package/dist/src/utils/stateOverrides/mergeStateOverrides.js

@@ -0,0 +1,40 @@
+import { getAddress, } from "viem";
+/**
+ * Merge state overrides by address, concatenating stateDiff entries
+ * and taking the last-seen balance/nonce for each address.
+ */
+export function mergeStateOverrides(overrides) {
+    const merged = new Map();
+    for (const override of overrides) {
+        const key = getAddress(override.address);
+        const current = merged.get(key) || { address: key };
+        let nextStateDiff;
+        const a = current.stateDiff;
+        const b = override.stateDiff;
+        if (a && b) {
+            nextStateDiff = a.concat(b);
+        }
+        else {
+            nextStateDiff = a || b;
+        }
+        merged.set(key, {
+            address: key,
+            balance: override.balance ?? current.balance,
+            nonce: override.nonce ?? current.nonce,
+            stateDiff: nextStateDiff,
+        });
+    }
+    const out = [];
+    for (const value of merged.values()) {
+        const entry = { address: value.address };
+        if (value.balance !== undefined)
+            entry.balance = value.balance;
+        if (value.nonce !== undefined)
+            entry.nonce = value.nonce;
+        if (value.stateDiff && value.stateDiff.length > 0)
+            entry.stateDiff = value.stateDiff;
+        out.push(entry);
+    }
+    return out;
+}
+//# sourceMappingURL=mergeStateOverrides.js.map

package/dist/src/utils/stateOverrides/mergeStateOverrides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeStateOverrides.js","sourceRoot":"","sources":["../../../../src/utils/stateOverrides/mergeStateOverrides.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,UAAU,GACV,MAAM,MAAM,CAAC;AAEd;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAAwB;IAC3D,MAAM,MAAM,GAAG,IAAI,GAAG,EAQnB,CAAC;IAEJ,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;QAEpD,IAAI,aAAuC,CAAC;QAC5C,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;QAC5B,MAAM,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC;QAC7B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACZ,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;aAAM,CAAC;YACP,aAAa,GAAG,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;YACf,OAAO,EAAE,GAAG;YACZ,OAAO,EAAE,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO;YAC5C,KAAK,EAAE,QAAQ,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK;YACtC,SAAS,EAAE,aAAa;SACxB,CAAC,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAkB,EAAE,CAAC;IAC9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;QACrC,MAAM,KAAK,GAA0B,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAChE,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;YAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC/D,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;YAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QACzD,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YAChD,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACnC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC"}

package/dist/src/utils/stateOverrides/types.d.ts

@@ -0,0 +1,5 @@
+import type { Address, Hex } from "viem";
+export type StorageSlot = {
+    address: Address;
+    slot: Hex;
+};

package/dist/src/utils/stateOverrides/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/src/utils/stateOverrides/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/utils/stateOverrides/types.ts"],"names":[],"mappings":""}

package/dist/src/utils/subAccounts.d.ts

@@ -0,0 +1,6 @@
+import type { AddressPrefix } from "../entities/Account.js";
+import { type Address } from "viem";
+export declare function getSubAccountId(primary: Address, subAccount: Address): number;
+export declare function getSubAccountAddress(primary: Address, subAccountId: number): `0x${string}`;
+export declare function isSubAccount(primary: Address, subAccount: Address): boolean;
+export declare function getAddressPrefix(address: Address): AddressPrefix;

package/dist/src/utils/subAccounts.js

@@ -0,0 +1,24 @@
+import { getAddress, pad, toHex } from "viem";
+const SUB_ACCOUNT_MAX_ID = 255;
+export function getSubAccountId(primary, subAccount) {
+    const xor = Number(BigInt(primary) ^ BigInt(subAccount));
+    if (xor > SUB_ACCOUNT_MAX_ID) {
+        throw new Error("Addresses are not related");
+    }
+    return xor;
+}
+export function getSubAccountAddress(primary, subAccountId) {
+    if (subAccountId > SUB_ACCOUNT_MAX_ID) {
+        throw new Error("Sub account ID too large");
+    }
+    return getAddress(pad(toHex(BigInt(primary) ^ BigInt(subAccountId)), {
+        size: 20,
+    }));
+}
+export function isSubAccount(primary, subAccount) {
+    return Number(BigInt(primary) ^ BigInt(subAccount)) < SUB_ACCOUNT_MAX_ID;
+}
+export function getAddressPrefix(address) {
+    return address.substring(0, 40);
+}
+//# sourceMappingURL=subAccounts.js.map

package/dist/src/utils/subAccounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subAccounts.js","sourceRoot":"","sources":["../../../src/utils/subAccounts.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAE5D,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAE/B,MAAM,UAAU,eAAe,CAAC,OAAgB,EAAE,UAAmB;IACpE,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IACzD,IAAI,GAAG,GAAG,kBAAkB,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,OAAgB,EAAE,YAAoB;IAC1E,IAAI,YAAY,GAAG,kBAAkB,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,UAAU,CAChB,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE;QAClD,IAAI,EAAE,EAAE;KACR,CAAC,CACF,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,OAAgB,EAAE,UAAmB;IACjE,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,kBAAkB,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAgB;IAChD,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAkB,CAAC;AAClD,CAAC"}

package/dist/src/utils/types.d.ts

@@ -0,0 +1,20 @@
+import type { Address } from "viem";
+export interface ERC4626Data {
+    shares: Token;
+    asset: Token;
+    totalShares: bigint;
+    totalAssets: bigint;
+}
+export interface Token {
+    address: Address;
+    name: string;
+    symbol: string;
+    decimals: number;
+    logoURI?: string;
+}
+export declare enum VaultType {
+    EVault = "EVault",
+    EulerEarn = "EulerEarn",
+    SecuritizeCollateral = "SecuritizeCollateral",
+    Unknown = "Unknown"
+}

package/dist/src/utils/types.js

@@ -0,0 +1,8 @@
+export var VaultType;
+(function (VaultType) {
+    VaultType["EVault"] = "EVault";
+    VaultType["EulerEarn"] = "EulerEarn";
+    VaultType["SecuritizeCollateral"] = "SecuritizeCollateral";
+    VaultType["Unknown"] = "Unknown";
+})(VaultType || (VaultType = {}));
+//# sourceMappingURL=types.js.map

package/dist/src/utils/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/utils/types.ts"],"names":[],"mappings":"AAiBA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACpB,8BAAiB,CAAA;IACjB,oCAAuB,CAAA;IACvB,0DAA6C,CAAA;IAC7C,gCAAmB,CAAA;AACpB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@eulerxyz/euler-v2-sdk",
+  "version": "0.1.0-beta",
+  "description": "SDK for interacting with Euler V2 Lending Platform",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/euler-xyz/euler-sdks.git",
+    "directory": "packages/euler-v2-sdk"
+  },
+  "homepage": "https://github.com/euler-xyz/euler-sdks/tree/main/packages/euler-v2-sdk",
+  "bugs": {
+    "url": "https://github.com/euler-xyz/euler-sdks/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "build:watch": "tsc --project tsconfig.json --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "node --import tsx --test test/*.test.ts",
+    "format": "biome format --write src",
+    "lint": "biome lint src",
+    "lint:fix": "biome lint --write src",
+    "prepare": "cd ../.. && if command -v husky >/dev/null 2>&1; then husky packages/euler-v2-sdk/.husky; fi",
+    "clean": "rm -rf dist",
+    "release:check": "pnpm run clean && pnpm run build && pnpm run typecheck && pnpm pack --dry-run",
+    "prepublishOnly": "pnpm run release:check",
+    "publish:public": "npm publish --access public --provenance"
+  },
+  "keywords": [
+    "euler",
+    "defi",
+    "lending",
+    "ethereum",
+    "evm",
+    "sdk",
+    "typescript",
+    "viem"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  },
+  "dependencies": {
+    "viem": "2.43.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.7.8",
+    "typescript": "^5.6.3"
+  }
+}