@eulerxyz/euler-v2-sdk 0.2.7-beta → 0.2.8-beta

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

@@ -0,0 +1,152 @@
+import { encodePacked, erc20Abi, getAddress, hexToBigInt, keccak256, maxUint256, numberToHex, toHex, } from "viem";
+const DEFAULT_MAX_SEQUENTIAL = 20;
+const DEFAULT_EXTRA_CANDIDATES = [];
+const slotHintsCache = new Map();
+const probeAddress = (chainId, token) => `${chainId}:${getAddress(token)}`;
+/**
+ * Compute the storage slot of `balances[owner]` in a Solidity-style
+ * `mapping(address => uint256)` at base slot `slotIndex`.
+ */
+export function computeBalanceSlot(owner, slotIndex) {
+    return keccak256(encodePacked(["uint256", "uint256"], [hexToBigInt(owner), slotIndex]));
+}
+/**
+ * Compute the storage slot of `allowance[owner][spender]` in a Solidity-style
+ * `mapping(address => mapping(address => uint256))` at base slot `slotIndex`.
+ */
+export function computeAllowanceSlot(owner, spender, slotIndex) {
+    const baseSlot = keccak256(encodePacked(["uint256", "uint256"], [hexToBigInt(owner), slotIndex]));
+    return keccak256(encodePacked(["uint256", "uint256"], [hexToBigInt(spender), hexToBigInt(baseSlot)]));
+}
+/**
+ * Probe a single ERC20 token to discover its `balances` and `allowance` slot
+ * indices, by overriding sequential base-slot candidates and reading the
+ * value back.
+ *
+ * Strategy is intentionally simpler than `eth_createAccessList`-based
+ * discovery: most ERC20 layouts (OpenZeppelin, Solady, custom) use a small
+ * integer base slot. Sequential probing from 0 hits the answer in 1–3 RPC
+ * calls; access-list discovery costs an `eth_createAccessList` + per-candidate
+ * probe and isn't supported by all proxies.
+ *
+ * Results are cached module-scope by `chainId:token` (slot indices are
+ * owner-/spender-agnostic and immutable for a deployed token), so subsequent
+ * calls for the same token short-circuit to a Map lookup.
+ *
+ * @example
+ * ```ts
+ * const hints = await fetchErc20SlotHints(client, token, {
+ *   allowanceSpender: permit2Address,
+ * })
+ * // → { balanceSlotIndex: 0n, allowanceSlotIndex: 1n }
+ * ```
+ */
+export async function fetchErc20SlotHints(client, token, options = {}) {
+    const chainId = client.chain?.id;
+    if (!chainId)
+        throw new Error("Client must have a chain configured");
+    const cacheKey = probeAddress(chainId, token);
+    const cached = slotHintsCache.get(cacheKey);
+    if (cached) {
+        const stillNeedsBalance = !options.skipBalance && cached.balanceSlotIndex === undefined;
+        const stillNeedsAllowance = !options.skipAllowance && cached.allowanceSlotIndex === undefined;
+        if (!stillNeedsBalance && !stillNeedsAllowance) {
+            return cached;
+        }
+    }
+    const max = options.maxSequentialSlot ?? DEFAULT_MAX_SEQUENTIAL;
+    const extras = options.extraSlotCandidates ?? DEFAULT_EXTRA_CANDIDATES;
+    const candidates = [];
+    for (let i = 0; i <= max; i++)
+        candidates.push(BigInt(i));
+    for (const idx of extras)
+        candidates.push(idx);
+    const probeOwner = "0x1111111111111111111111111111111111111111";
+    const probeSpender = options.allowanceSpender ??
+        "0x2222222222222222222222222222222222222222";
+    const valueHex = numberToHex(maxUint256, { size: 32 });
+    const findSlotIndex = async (computeSlot, read) => {
+        for (const idx of candidates) {
+            try {
+                const slot = computeSlot(idx);
+                const value = await read(idx, slot);
+                if (value === maxUint256)
+                    return idx;
+            }
+            catch {
+                // candidate didn't decode; try next
+            }
+        }
+        return undefined;
+    };
+    const balancePromise = options.skipBalance || cached?.balanceSlotIndex !== undefined
+        ? Promise.resolve(cached?.balanceSlotIndex)
+        : findSlotIndex((idx) => computeBalanceSlot(probeOwner, idx), (_idx, slot) => client
+            .readContract({
+            abi: erc20Abi,
+            address: token,
+            functionName: "balanceOf",
+            args: [probeOwner],
+            stateOverride: [
+                {
+                    address: token,
+                    stateDiff: [{ slot, value: valueHex }],
+                },
+            ],
+        })
+            .catch(() => 0n));
+    const allowancePromise = options.skipAllowance || cached?.allowanceSlotIndex !== undefined
+        ? Promise.resolve(cached?.allowanceSlotIndex)
+        : findSlotIndex((idx) => computeAllowanceSlot(probeOwner, probeSpender, idx), (_idx, slot) => client
+            .readContract({
+            abi: erc20Abi,
+            address: token,
+            functionName: "allowance",
+            args: [probeOwner, probeSpender],
+            stateOverride: [
+                {
+                    address: token,
+                    stateDiff: [{ slot, value: valueHex }],
+                },
+            ],
+        })
+            .catch(() => 0n));
+    const [balanceSlotIndex, allowanceSlotIndex] = await Promise.all([
+        balancePromise,
+        allowancePromise,
+    ]);
+    const hints = {
+        balanceSlotIndex,
+        allowanceSlotIndex,
+    };
+    slotHintsCache.set(cacheKey, hints);
+    return hints;
+}
+/**
+ * Convenience batch wrapper for `fetchErc20SlotHints` over many tokens.
+ * Caller-side parallelism is preserved (one `Promise.all` over the inputs);
+ * the per-token cache means repeats are free.
+ */
+export async function fetchErc20SlotHintsBatch(client, tokens, options = {}) {
+    const result = {};
+    await Promise.all(tokens.map(async (rawToken) => {
+        const token = getAddress(rawToken);
+        result[token] = await fetchErc20SlotHints(client, token, options);
+    }));
+    return result;
+}
+/**
+ * Helper for callers who want to pre-seed the slot-hints cache from their own
+ * persistence layer (e.g. localStorage).
+ */
+export function primeSlotHintsCache(chainId, hints) {
+    for (const [token, h] of Object.entries(hints)) {
+        slotHintsCache.set(probeAddress(chainId, token), h);
+    }
+}
+/** Helper used by deriveStateOverrides to look up a hint without re-probing. */
+export function getCachedSlotHints(chainId, token) {
+    return slotHintsCache.get(probeAddress(chainId, token));
+}
+export { toHex };
+//# sourceMappingURL=slotHints.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"slotHints.js","sourceRoot":"","sources":["../../../../src/utils/stateOverrides/slotHints.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,WAAW,EACX,SAAS,EACT,UAAU,EACV,WAAW,EACX,KAAK,GACL,MAAM,MAAM,CAAC;AAmCd,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,wBAAwB,GAAa,EAAE,CAAC;AAE9C,MAAM,cAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;AAEzD,MAAM,YAAY,GAAG,CAAC,OAAe,EAAE,KAAc,EAAE,EAAE,CACxD,GAAG,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;AAEnC;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAc,EAAE,SAAiB;IACnE,OAAO,SAAS,CACf,YAAY,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC,CACrE,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CACnC,KAAc,EACd,OAAgB,EAChB,SAAiB;IAEjB,MAAM,QAAQ,GAAG,SAAS,CACzB,YAAY,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC,CACrE,CAAC;IACF,OAAO,SAAS,CACf,YAAY,CACX,CAAC,SAAS,EAAE,SAAS,CAAC,EACtB,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC,CAC7C,CACD,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACxC,MAAoB,EACpB,KAAc,EACd,UAAiC,EAAE;IAEnC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;IACjC,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IAErE,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC9C,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5C,IAAI,MAAM,EAAE,CAAC;QACZ,MAAM,iBAAiB,GACtB,CAAC,OAAO,CAAC,WAAW,IAAI,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAC;QAC/D,MAAM,mBAAmB,GACxB,CAAC,OAAO,CAAC,aAAa,IAAI,MAAM,CAAC,kBAAkB,KAAK,SAAS,CAAC;QACnE,IAAI,CAAC,iBAAiB,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAChD,OAAO,MAAM,CAAC;QACf,CAAC;IACF,CAAC;IAED,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,IAAI,sBAAsB,CAAC;IAChE,MAAM,MAAM,GAAG,OAAO,CAAC,mBAAmB,IAAI,wBAAwB,CAAC;IACvE,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE;QAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,KAAK,MAAM,GAAG,IAAI,MAAM;QAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE/C,MAAM,UAAU,GACf,4CAAuD,CAAC;IACzD,MAAM,YAAY,GACjB,OAAO,CAAC,gBAAgB;QACvB,4CAAwD,CAAC;IAC3D,MAAM,QAAQ,GAAG,WAAW,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAEvD,MAAM,aAAa,GAAG,KAAK,EAC1B,WAAiC,EACjC,IAAiD,EACnB,EAAE;QAChC,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC9B,IAAI,CAAC;gBACJ,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC9B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBACpC,IAAI,KAAK,KAAK,UAAU;oBAAE,OAAO,GAAG,CAAC;YACtC,CAAC;YAAC,MAAM,CAAC;gBACR,oCAAoC;YACrC,CAAC;QACF,CAAC;QACD,OAAO,SAAS,CAAC;IAClB,CAAC,CAAC;IAEF,MAAM,cAAc,GACnB,OAAO,CAAC,WAAW,IAAI,MAAM,EAAE,gBAAgB,KAAK,SAAS;QAC5D,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC;QAC3C,CAAC,CAAC,aAAa,CACb,CAAC,GAAG,EAAE,EAAE,CAAC,kBAAkB,CAAC,UAAU,EAAE,GAAG,CAAC,EAC5C,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CACd,MAAM;aACJ,YAAY,CAAC;YACb,GAAG,EAAE,QAAQ;YACb,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,WAAW;YACzB,IAAI,EAAE,CAAC,UAAU,CAAC;YAClB,aAAa,EAAE;gBACd;oBACC,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;iBACtC;aACD;SACD,CAAC;aACD,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAClB,CAAC;IAEL,MAAM,gBAAgB,GACrB,OAAO,CAAC,aAAa,IAAI,MAAM,EAAE,kBAAkB,KAAK,SAAS;QAChE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC;QAC7C,CAAC,CAAC,aAAa,CACb,CAAC,GAAG,EAAE,EAAE,CAAC,oBAAoB,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,EAC5D,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CACd,MAAM;aACJ,YAAY,CAAC;YACb,GAAG,EAAE,QAAQ;YACb,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,WAAW;YACzB,IAAI,EAAE,CAAC,UAAU,EAAE,YAAY,CAAC;YAChC,aAAa,EAAE;gBACd;oBACC,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;iBACtC;aACD;SACD,CAAC;aACD,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAClB,CAAC;IAEL,MAAM,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAChE,cAAc;QACd,gBAAgB;KAChB,CAAC,CAAC;IAEH,MAAM,KAAK,GAAmB;QAC7B,gBAAgB;QAChB,kBAAkB;KAClB,CAAC;IACF,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACpC,OAAO,KAAK,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC7C,MAAoB,EACpB,MAAiB,EACjB,UAAiC,EAAE;IAEnC,MAAM,MAAM,GAAc,EAAE,CAAC;IAC7B,MAAM,OAAO,CAAC,GAAG,CAChB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QACnC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC,CAAC,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAClC,OAAe,EACf,KAAsC;IAEtC,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,KAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;IAChE,CAAC;AACF,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,kBAAkB,CACjC,OAAe,EACf,KAAc;IAEd,OAAO,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,OAAO,EAAE,KAAK,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eulerxyz/euler-v2-sdk",
-  "version": "0.2.7-beta",
+  "version": "0.2.8-beta",
   "description": "SDK for interacting with Euler V2 Lending Platform",
   "repository": {
     "type": "git",