@toruslabs/ethereum-controllers 9.0.0 → 9.1.0

package/dist/lib.cjs/types/Network/interfaces.d.ts

@@ -0,0 +1,58 @@
+import { InPageWalletProviderState, SwitchChainMessageParams } from "@toruslabs/base-controllers";
+import { JRPCRequest } from "@web3auth/auth";
+import { TransactionStateManager } from "../Transaction/TransactionStateManager";
+import { Eip5792SendCallsParams, TransactionBatchRequest } from "../utils/eip5792Types";
+import { AddChainMessageParams, EthereumTransactionMeta, GetEthCodeFn, MessageParams, TransactionParams, TypedMessageParams, UserOperationGas, UserRequestApprovalParams } from "../utils/interfaces";
+export interface IProviderHandlers {
+    version: string;
+    aaConfig?: {
+        bundlerUrl: string;
+        paymasterUrl?: string;
+    };
+    requestAccounts?: (req: JRPCRequest<string[]>) => Promise<string[]>;
+    getAccounts: (req: JRPCRequest<string[]>) => Promise<string[]>;
+    getPrivateKey?: (req: JRPCRequest<unknown>) => Promise<string>;
+    getPublicKey?: (req: JRPCRequest<unknown>) => Promise<string>;
+    processTransaction?: (txParams: TransactionParams, req: JRPCRequest<TransactionParams> & UserRequestApprovalParams) => Promise<string>;
+    processTransactionBatch?: (batchRequest: TransactionBatchRequest, req: JRPCRequest<Eip5792SendCallsParams>) => Promise<string>;
+    processSignTransaction?: (txParams: TransactionParams, req: JRPCRequest<TransactionParams> & UserRequestApprovalParams) => Promise<string>;
+    processEthSignMessage?: (msgParams: MessageParams, req: JRPCRequest<unknown> & UserRequestApprovalParams) => Promise<string>;
+    processTypedMessageV4?: (msgParams: TypedMessageParams, req: JRPCRequest<unknown> & UserRequestApprovalParams) => Promise<string>;
+    processPersonalMessage?: (msgParams: MessageParams, req: JRPCRequest<unknown> & UserRequestApprovalParams) => Promise<string>;
+    processSwitchEthereumChain?: (msgParams: SwitchChainMessageParams, req: JRPCRequest<unknown> & UserRequestApprovalParams) => Promise<string>;
+    processWalletSwitchChain?: (msgParams: SwitchChainMessageParams, req: JRPCRequest<unknown> & UserRequestApprovalParams) => Promise<string>;
+    processAddEthereumChain?: (msgParams: AddChainMessageParams, req: JRPCRequest<unknown> & UserRequestApprovalParams) => Promise<string>;
+    processEstimateUserOperationGas?: (txParams: TransactionParams, req: JRPCRequest<TransactionParams>) => Promise<UserOperationGas>;
+    getPendingNonce?: (nonceParams: {
+        address: string;
+        blockReference: string;
+    }, req: JRPCRequest<{
+        address: string;
+        blockReference: string;
+    }>) => Promise<string>;
+    getPendingTransactionByHash?: (hash: string, req: JRPCRequest<string>) => Promise<EthereumTransactionMeta>;
+    getTransactionByBatchId: TransactionStateManager["getTransactionByBatchId"];
+    getProviderState: () => Promise<InPageWalletProviderState>;
+    /**
+     * Query the deployment bytecode of an address. (eth_getCode)
+     */
+    getEthCode?: GetEthCodeFn;
+    /**
+     * EIP-5792 configuration for wallet capabilities and batch calls.
+     */
+    eip5792Config?: {
+        /**
+         * Get the list of supported chain IDs for EIP-5792/EIP-7702.
+         */
+        getSupportedChains: () => `0x${string}`[];
+        /**
+         * Get cached delegation addresses.
+         * Key format: `${walletAddress}-${chainId}`
+         */
+        getCachedDelegations?: () => Record<string, `0x${string}` | null>;
+        /**
+         * Update the delegation cache.
+         */
+        updateDelegationCache?: (walletAddress: `0x${string}`, chainId: `0x${string}`, delegation: `0x${string}` | null) => void;
+    };
+}

package/dist/lib.cjs/types/index.d.ts

@@ -15,9 +15,7 @@ export * from "./Message/SwitchChainController";
 export * from "./Message/TypedMessageController";
 export * from "./Message/types";
 export * from "./Message/utils";
-export * from "./Network/createEthereumMiddleware";
-export * from "./Network/createJsonRpcClient";
-export { NetworkController } from "./Network/NetworkController";
+export * from "./Network";
 export * from "./Nfts/INftsController";
 export * from "./Nfts/NftHandler";
 export * from "./Nfts/NftsController";

package/dist/lib.cjs/types/utils/eip5792Types.d.ts

@@ -51,7 +51,7 @@ export declare const GetCallsStatusCode: {
 /**
  * Response for wallet_getCallsStatus (EIP-5792)
  */
-export interface Eip5792GetCallsStatusResponse {
+export interface Eip5792GetCallsStatusResponse extends Record<string, unknown> {
     id: string;
     chainId: `0x${string}`;
     atomic: boolean;

package/dist/lib.cjs/types/utils/eip7702Types.d.ts

@@ -48,7 +48,7 @@ export interface Eip7702Params extends TransactionParams {
      */
     implementation?: Hex;
 }
-export interface Eip7702WalletGetUpgradeStatusResponse {
+export interface Eip7702WalletGetUpgradeStatusResponse extends Record<string, boolean | Hex> {
     /**
      * Whether the account is upgraded.
      */

package/dist/lib.cjs/types/utils/interfaces.d.ts

@@ -230,7 +230,7 @@ export interface TransactionReceipt {
 }
 export type BlockTag = "earliest" | "finalized" | "safe" | "latest" | "pending";
 export type BlockParams = string | BlockTag;
-export interface TransactionRPCMeta {
+export interface TransactionRPCMeta extends Record<string, unknown> {
     v: string;
     r: string;
     s: string;
@@ -504,7 +504,7 @@ export type AccountAbstractionMultiChainConfig = {
         smartAccountConfig?: SmartAccountConfig;
     }[];
 };
-export interface UserOperationGas {
+export interface UserOperationGas extends Record<string, string> {
     callGasLimit: string;
     preVerificationGas: string;
     verificationGasLimit: string;

package/dist/lib.cjs/utils/conversionUtils.js

@@ -3,8 +3,8 @@
 var _objectDestructuringEmpty = require('@babel/runtime/helpers/objectDestructuringEmpty');
 var _objectSpread = require('@babel/runtime/helpers/objectSpread2');
 var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
+var metadataHelpers = require('@toruslabs/metadata-helpers');
 var bignumber_js = require('bignumber.js');
-var hex = require('./hex.js');
 
 const _excluded = ["aBase", "bBase"],
   _excluded2 = ["aBase", "bBase"],
@@ -15,7 +15,7 @@ const BIG_NUMBER_GWEI_MULTIPLIER = new bignumber_js.BigNumber("1000000000");
 const BIG_NUMBER_ETH_MULTIPLIER = new bignumber_js.BigNumber("1");
 // Setter Maps
 const toBigNumber = {
-  hex: n => new bignumber_js.BigNumber(hex.stripHexPrefix(n), 16),
+  hex: n => new bignumber_js.BigNumber(metadataHelpers.remove0x(n), 16),
   dec: n => new bignumber_js.BigNumber(String(n), 10),
   BN: n => new bignumber_js.BigNumber(n.toString(16), 16)
 };

package/dist/lib.cjs/utils/helpers.js

@@ -2,18 +2,18 @@
 
 var _objectSpread = require('@babel/runtime/helpers/objectSpread2');
 var baseControllers = require('@toruslabs/base-controllers');
+var metadataHelpers = require('@toruslabs/metadata-helpers');
 var bignumber_js = require('bignumber.js');
 var log = require('loglevel');
 var viem = require('viem');
 var TransactionUtils = require('../Transaction/TransactionUtils.js');
 var constants = require('./constants.js');
-var hex = require('./hex.js');
 
-function hexToBn(hex$1) {
-  return new bignumber_js.BigNumber(hex.stripHexPrefix(hex$1), 16);
+function hexToBn(hex) {
+  return new bignumber_js.BigNumber(metadataHelpers.remove0x(hex), 16);
 }
 function BNToHex(bn) {
-  return hex.addHexPrefix(bn.toString(16));
+  return metadataHelpers.add0x(bn.toString(16));
 }
 function getEtherScanHashLink(txHash, chainId) {
   if (!constants.SUPPORTED_NETWORKS[chainId]) return "";

package/dist/lib.cjs/utils/transaction.js

@@ -1,9 +1,9 @@
 'use strict';
 
+var metadataHelpers = require('@toruslabs/metadata-helpers');
 var log = require('loglevel');
 var viem = require('viem');
 var constants = require('./constants.js');
-var hex = require('./hex.js');
 
 /**
  * Transaction decoder for analytics.
@@ -15,7 +15,7 @@ const transactionDecoder = async (req, chainId) => {
   try {
     if (req.method === constants.METHOD_TYPES.ETH_SEND_RAW_TRANSACTION) {
       const rawTx = req.params[0];
-      const normalizedRawTx = hex.addHexPrefix(rawTx);
+      const normalizedRawTx = metadataHelpers.add0x(rawTx);
       sender = await viem.recoverTransactionAddress({
         serializedTransaction: normalizedRawTx
       });

package/dist/lib.esm/AccountAbstraction/AccountAbstractionController.js

@@ -1,30 +1,28 @@
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import { BaseController, TransactionStatus } from '@toruslabs/base-controllers';
-import { JRPCEngine, providerFromEngine } from '@web3auth/auth';
+import { JRPCEngineV2, providerFromEngineV2 } from '@web3auth/auth';
 import log from 'loglevel';
 import { defineChain, createPublicClient, http, createWalletClient, custom, toHex, parseEther, isHex } from 'viem';
 import { createPaymasterClient, createBundlerClient } from 'viem/account-abstraction';
 
-const eoaInterceptorMiddleware = eoaAddress => (req, res, next, end) => {
-  req.isAAProviderRequest = true;
-  if (req.method === "eth_accounts" || req.method === "eth_requestAccounts") {
-    res.result = [eoaAddress];
-    end();
-    return;
+const eoaInterceptorMiddleware = eoaAddress => async ({
+  request,
+  next,
+  context
+}) => {
+  context.set("isAAProviderRequest", true);
+  if (request.method === "eth_accounts" || request.method === "eth_requestAccounts") {
+    return [eoaAddress];
   }
-  next();
+  return next();
 };
 function eoaProviderAsMiddleware(provider) {
-  return async (req, res, _next, end) => {
-    // send request to provider
-    try {
-      const providerRes = await provider.request(req);
-      res.result = providerRes;
-      return end();
-    } catch (error) {
-      return end(error);
-    }
+  return async ({
+    request
+  }) => {
+    const result = await provider.request(request);
+    return result;
   };
 }
 class AccountAbstractionController extends BaseController {
@@ -91,10 +89,10 @@ class AccountAbstractionController extends BaseController {
     });
 
     // viem wallet client using json-rpc account from eoaProvider
-    const aaEngine = new JRPCEngine();
-    aaEngine.push(eoaInterceptorMiddleware(eoaAddress));
-    aaEngine.push(eoaProviderAsMiddleware(eoaProvider));
-    const provider = providerFromEngine(aaEngine);
+    const aaEngine = JRPCEngineV2.create({
+      middleware: [eoaInterceptorMiddleware(eoaAddress), eoaProviderAsMiddleware(eoaProvider)]
+    });
+    const provider = providerFromEngineV2(aaEngine);
     // need to hoist the account address https://viem.sh/docs/clients/wallet#optional-hoist-the-account
     const eoaWalletClient = createWalletClient({
       account: eoaAddress,

package/dist/lib.esm/Eip5792/walletGetCallsStatus.js

@@ -1,7 +1,7 @@
 import { TransactionStatus } from '@toruslabs/base-controllers';
+import { add0x } from '@toruslabs/metadata-helpers';
 import { rpcErrors, JsonRpcError } from '@web3auth/auth';
 import { GetCallsStatusCode, EIP_5792_METHODS, EIP5792ErrorCode } from '../utils/eip5792Types.js';
-import { addHexPrefix } from '../utils/hex.js';
 
 /**
  * Maps a TransactionStatus to an EIP-5792 GetCallsStatusCode.
@@ -67,7 +67,7 @@ function walletGetCallsStatus(request, getTransactionByBatchId) {
   return {
     status: mapTransactionStatusToEip5792Status(batchTx.status),
     id: batchId,
-    chainId: addHexPrefix(batchTx.chainId),
+    chainId: add0x(batchTx.chainId),
     atomic: true,
     receipts: batchTx.txReceipt ? [batchTx.txReceipt] : []
   };

package/dist/lib.esm/Eip7702/eip7702Utils.js

@@ -1,8 +1,8 @@
+import { add0x } from '@toruslabs/metadata-helpers';
 import { zeroAddress, encodeAbiParameters, parseAbiParameters, encodeFunctionData } from 'viem';
 import { erc7821Abi } from '../utils/abis.js';
 import { SUPPORTED_NETWORKS } from '../utils/constants.js';
 import { EIP_7702_PREFIX } from '../utils/eip7702Types.js';
-import { addHexPrefix } from '../utils/hex.js';
 
 /**
  * The MetaMask EIP-7702 Stateless Delegator contract address.
@@ -12,10 +12,10 @@ const MetaMask_EIP7702_Stateless_Delegator = "0x63c0c19a282a1B52b07dD5a65b58948A
 async function getDelegationAddress(walletAddress, chainId, getEthCode) {
   // query eth_getCode
   const code = await getEthCode(walletAddress, chainId);
-  const normalizedCode = code ? addHexPrefix(code).toLowerCase() : "0x0";
+  const normalizedCode = code ? add0x(code).toLowerCase() : "0x0";
   const hasDelegation = normalizedCode.length === 48 && normalizedCode.startsWith(EIP_7702_PREFIX);
   if (hasDelegation) {
-    const delegationAddress = addHexPrefix(normalizedCode.slice(EIP_7702_PREFIX.length));
+    const delegationAddress = add0x(normalizedCode.slice(EIP_7702_PREFIX.length));
     return delegationAddress;
   }
   return null;

package/dist/lib.esm/Gas/GasFeeController.js

@@ -1,9 +1,8 @@
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import { BaseController, PollingManager, cloneDeep } from '@toruslabs/base-controllers';
+import { isHexString } from '@toruslabs/metadata-helpers';
 import log from 'loglevel';
-import { isHex } from 'viem';
 import { GAS_ESTIMATE_TYPES } from '../utils/constants.js';
-import { addHexPrefix } from '../utils/hex.js';
 import { fetchGasEstimates, fetchEthGasPriceEstimate, fetchLegacyGasPriceEstimates, fetchGasEstimatesViaEthFeeHistory, calculateTimeEstimate } from './gasUtil.js';
 
 const GAS_FEE_API = "https://mock-gas-server.herokuapp.com/";
@@ -120,7 +119,7 @@ class GasFeeController extends BaseController {
     const chainId = this.getNetworkIdentifier();
     if (chainId === "loading") return;
     let chainIdInt;
-    if (typeof chainId === "string" && isHex(addHexPrefix(chainId))) {
+    if (isHexString(chainId)) {
       chainIdInt = Number.parseInt(chainId, 16);
     }
     try {

package/dist/lib.esm/Keyring/KeyringController.js

@@ -1,9 +1,8 @@
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import { BaseKeyringController, ecsignature, concatSig } from '@toruslabs/base-controllers';
-import { hexToBytes } from '@toruslabs/metadata-helpers';
+import { add0x, remove0x, hexToBytes } from '@toruslabs/metadata-helpers';
 import { serializeTransaction, keccak256, parseSignature, toHex, isHex } from 'viem';
 import { privateKeyToAccount } from 'viem/accounts';
-import { addHexPrefix, stripHexPrefix } from '../utils/hex.js';
 import { prepareViemTx } from '../utils/viem.js';
 
 class KeyringController extends BaseKeyringController {
@@ -22,7 +21,7 @@ class KeyringController extends BaseKeyringController {
   }
   async signTransaction(tx, address) {
     const wallet = this._getWalletForAccount(address);
-    const account = privateKeyToAccount(addHexPrefix(wallet.privateKey));
+    const account = privateKeyToAccount(add0x(wallet.privateKey));
     const localTx = tx;
     const txToSign = prepareViemTx(localTx);
     // NOTE: don't use account.signTransaction directly because it only return signed serialized transaction
@@ -42,7 +41,7 @@ class KeyringController extends BaseKeyringController {
   }
   async signEip7702Authorization(authorization, address) {
     const wallet = this._getWalletForAccount(address);
-    const account = privateKeyToAccount(addHexPrefix(wallet.privateKey));
+    const account = privateKeyToAccount(add0x(wallet.privateKey));
 
     // Convert hex strings to proper types for RLP encoding
     // EIP-7702 authorization tuple: [chain_id_decimal, address, nonce_decimal]
@@ -67,8 +66,8 @@ class KeyringController extends BaseKeyringController {
   }
   async importAccount(accountPrivateKey) {
     try {
-      const hexPrivateKey = accountPrivateKey.padStart(64, "0");
-      const account = privateKeyToAccount(addHexPrefix(hexPrivateKey));
+      const hexPrivateKey = remove0x(accountPrivateKey).padStart(64, "0");
+      const account = privateKeyToAccount(add0x(hexPrivateKey));
       const publicKey = account.publicKey;
       const address = account.address;
       const existingWallet = this.state.wallets.find(w => w.address === address);
@@ -99,8 +98,7 @@ class KeyringController extends BaseKeyringController {
     }
   }
   getPrivateKeyBytes(privateKey) {
-    const stripped = stripHexPrefix(privateKey);
-    return hexToBytes(stripped);
+    return hexToBytes(privateKey);
   }
 
   // For eth_sign, we need to sign arbitrary data:
@@ -110,14 +108,14 @@ class KeyringController extends BaseKeyringController {
     }
     const wallet = this._getWalletForAccount(address);
     const privKey = this.getPrivateKeyBytes(wallet.privateKey);
-    const payload = hexToBytes(stripHexPrefix(data));
+    const payload = hexToBytes(data);
     const messageSig = ecsignature(payload, privKey);
     const sig = concatSig(messageSig.v, messageSig.r, messageSig.s);
     return sig;
   }
   async signPersonalMessage(data, address) {
     const wallet = this._getWalletForAccount(address);
-    const account = privateKeyToAccount(addHexPrefix(wallet.privateKey));
+    const account = privateKeyToAccount(add0x(wallet.privateKey));
     // we need to check if the data is hex or not
     // For historical reasons, you must submit the message to sign in hex-encoded UTF-8.
     // https://docs.metamask.io/wallet/how-to/sign-data/#use-personal_sign
@@ -132,7 +130,7 @@ class KeyringController extends BaseKeyringController {
   // personal_signTypedData, signs data along with the schema
   async signTypedData(typedData, address) {
     const wallet = this._getWalletForAccount(address);
-    const account = privateKeyToAccount(addHexPrefix(wallet.privateKey));
+    const account = privateKeyToAccount(add0x(wallet.privateKey));
     delete typedData.types.EIP712Domain;
     const primaryType = typedData.primaryType;
     if (!primaryType) {

package/dist/lib.esm/Message/utils.js

@@ -1,9 +1,7 @@
 import { CHAIN_NAMESPACES } from '@toruslabs/base-controllers';
-import { bytesToHex, utf8ToBytes } from '@toruslabs/metadata-helpers';
+import { isHexString, add0x, bytesToHex, utf8ToBytes } from '@toruslabs/metadata-helpers';
 import { isHex, createPublicClient, http, toHex, isAddress } from 'viem';
-import { stripHexPrefix, addHexPrefix } from '../utils/hex.js';
 
-const hexRe = /^[0-9A-Fa-f]+$/gu;
 function validateAddress(address, propertyName) {
   if (!address || typeof address !== "string" || !isAddress(address)) {
     throw new Error(`Invalid "${propertyName}" address: ${address} must be a valid string.`);
@@ -21,14 +19,13 @@ function validateSignMessageData(messageData) {
 }
 function normalizeMessageData(data) {
   try {
-    const stripped = stripHexPrefix(data);
-    if (stripped.match(hexRe)) {
-      return addHexPrefix(stripped);
+    if (isHexString(data)) {
+      return add0x(data);
     }
   } catch {
     // do nothing
   }
-  return addHexPrefix(bytesToHex(utf8ToBytes(data)));
+  return add0x(bytesToHex(utf8ToBytes(data)));
 }
 async function validateTypedSignMessageDataV4(messageData, currentChainId) {
   validateAddress(messageData.from, "from");

package/dist/lib.esm/Network/NetworkController.js

@@ -2,7 +2,7 @@ import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProper
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import { BaseController, createAnalyticsMiddleware, createSwappableProxy, createEventEmitterProxy } from '@toruslabs/base-controllers';
-import { JRPCEngine, providerFromEngine } from '@web3auth/auth';
+import { JRPCEngineV2, providerFromEngineV2 } from '@web3auth/auth';
 import { Mutex } from 'async-mutex';
 import log from 'loglevel';
 import { SUPPORTED_NETWORKS, MAINNET_CHAIN_ID } from '../utils/constants.js';
@@ -151,15 +151,13 @@ class NetworkController extends BaseController {
     networkMiddleware,
     blockTracker
   }) {
-    const ethereumMiddleware = createEthereumMiddleware(this.baseProviderHandlers, this.getProviderConfig(), this.analytics);
-    const engine = new JRPCEngine();
-    engine.push(createAnalyticsMiddleware({
-      providerConfig: this.getProviderConfig(),
-      analytics: this.analytics
-    }));
-    engine.push(ethereumMiddleware);
-    engine.push(networkMiddleware);
-    const provider = providerFromEngine(engine);
+    const engine = JRPCEngineV2.create({
+      middleware: [createAnalyticsMiddleware({
+        providerConfig: this.getProviderConfig(),
+        analytics: this.analytics
+      }), createEthereumMiddleware(this.baseProviderHandlers, this.getProviderConfig(), this.analytics), networkMiddleware]
+    });
+    const provider = providerFromEngineV2(engine);
     this.setProvider({
       provider,
       blockTracker