@toruslabs/ethereum-controllers 5.11.0 → 6.0.1

package/dist/types/Transaction/PendingTransactionTracker.d.ts

@@ -1,9 +1,9 @@
 import { ITransactionController } from "@toruslabs/base-controllers";
-import { SafeEventEmitter, SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
-import { EthereumBlock, EthereumTransactionMeta } from "../utils/interfaces";
-import NonceTracker from "./NonceTracker";
-import TransactionStateManager from "./TransactionStateManager";
-export default class PendingTransactionTracker extends SafeEventEmitter {
+import { SafeEventEmitter, SafeEventEmitterProvider } from "@web3auth/auth";
+import { EthereumBlock, EthereumTransactionMeta, PendingTransactionTrackerEvents } from "../utils/interfaces";
+import { NonceTracker } from "./NonceTracker";
+import { TransactionStateManager } from "./TransactionStateManager";
+export declare class PendingTransactionTracker<S> extends SafeEventEmitter<PendingTransactionTrackerEvents<S>> {
     DROPPED_BUFFER_COUNT: number;
     private nonceTracker;
     private provider;

package/dist/types/Transaction/TransactionController.d.ts

@@ -1,20 +1,20 @@
 import { ITransactionController, TransactionConfig, TransactionState, TX_CONFIRMED_EVENT_TYPE } from "@toruslabs/base-controllers";
-import { JRPCRequest, SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
-import PollingBlockTracker from "../Block/PollingBlockTracker";
-import GasFeeController from "../Gas/GasFeeController";
-import KeyringController from "../Keyring/KeyringController";
-import NetworkController from "../Network/NetworkController";
-import PreferencesController from "../Preferences/PreferencesController";
+import { JRPCRequest, SafeEventEmitterProvider } from "@web3auth/auth";
+import { PollingBlockTracker } from "../Block/PollingBlockTracker";
+import { GasFeeController } from "../Gas/GasFeeController";
+import { KeyringController } from "../Keyring/KeyringController";
+import { NetworkController } from "../Network/NetworkController";
+import { PreferencesController } from "../Preferences/PreferencesController";
 import { EthereumTransactionMeta, TransactionParams, UserRequestApprovalParams } from "../utils/interfaces";
-import NonceTracker from "./NonceTracker";
-import PendingTransactionTracker from "./PendingTransactionTracker";
-import TransactionGasUtil from "./TransactionGasUtil";
-import TransactionStateManager from "./TransactionStateManager";
-export default class TransactionController extends TransactionStateManager implements ITransactionController<TransactionParams> {
+import { NonceTracker } from "./NonceTracker";
+import { PendingTransactionTracker } from "./PendingTransactionTracker";
+import { TransactionGasUtil } from "./TransactionGasUtil";
+import { TransactionStateManager } from "./TransactionStateManager";
+export declare class TransactionController extends TransactionStateManager implements ITransactionController<TransactionParams> {
     getSelectedAddress: PreferencesController["getSelectedAddress"];
     getEIP1559GasFeeEstimates: GasFeeController["fetchGasFeeEstimates"];
     nonceTracker: NonceTracker;
-    pendingTxTracker: PendingTransactionTracker;
+    pendingTxTracker: PendingTransactionTracker<TransactionState<TransactionParams, EthereumTransactionMeta>>;
     txGasUtil: TransactionGasUtil;
     private _getCurrentNetworkEIP1559Compatibility;
     private _getCurrentAccountEIP1559Compatibility;

package/dist/types/Transaction/TransactionGasUtil.d.ts

@@ -1,13 +1,13 @@
-import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
-import PollingBlockTracker from "../Block/PollingBlockTracker";
+import { SafeEventEmitterProvider } from "@web3auth/auth";
+import { PollingBlockTracker } from "../Block/PollingBlockTracker";
 import { EthereumTransactionMeta } from "../utils/interfaces";
-export default class TransactionGasUtil {
+export declare class TransactionGasUtil {
     provider: SafeEventEmitterProvider;
     blockTracker: PollingBlockTracker;
     constructor(provider: SafeEventEmitterProvider, blockTracker: PollingBlockTracker);
     analyzeGasUsage(txMeta: EthereumTransactionMeta): Promise<{
         blockGasLimit: string;
-        estimatedGasHex: string;
+        estimatedGasHex: `0x${string}`;
         simulationFails: Record<string, unknown>;
     }>;
     /**

package/dist/types/Transaction/TransactionStateManager.d.ts

@@ -1,7 +1,7 @@
 import { BaseTransactionStateManager, ITransactionStateManager, TransactionConfig, TransactionState, TransactionStatus } from "@toruslabs/base-controllers";
-import NetworkController from "../Network/NetworkController";
-import { EthereumTransactionMeta, TransactionParams } from "../utils/interfaces";
-export default class TransactionStateManager extends BaseTransactionStateManager<TransactionParams, EthereumTransactionMeta> implements ITransactionStateManager<TransactionParams> {
+import { NetworkController } from "../Network/NetworkController";
+import { EthereumTransactionEvents, EthereumTransactionMeta, TransactionParams } from "../utils/interfaces";
+export declare class TransactionStateManager extends BaseTransactionStateManager<TransactionParams, EthereumTransactionMeta, EthereumTransactionEvents<TransactionParams, EthereumTransactionMeta>> implements ITransactionStateManager<TransactionParams> {
     constructor({ config, state, getCurrentChainId, }: {
         config?: Partial<TransactionConfig>;
         state?: Partial<TransactionState<TransactionParams, EthereumTransactionMeta>>;

package/dist/types/Transaction/TransactionUtils.d.ts

@@ -1,5 +1,5 @@
 import { TransactionStatus } from "@toruslabs/base-controllers";
-import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
+import { SafeEventEmitterProvider } from "@web3auth/auth";
 import { EthereumTransactionMeta, TransactionParams } from "../utils/interfaces";
 type NormalizableTransactionParams = keyof Omit<TransactionParams, "accessList">;
 /**

package/dist/types/index.d.ts

@@ -1,13 +1,11 @@
-export { default as AccountTrackerController } from "./Account/AccountTrackerController";
-export { default as PollingBlockTracker } from "./Block/PollingBlockTracker";
-export { default as CurrencyController } from "./Currency/CurrencyController";
-export { default as GasFeeController } from "./Gas/GasFeeController";
+export { AccountTrackerController } from "./Account/AccountTrackerController";
+export { PollingBlockTracker } from "./Block/PollingBlockTracker";
+export { CurrencyController } from "./Currency/CurrencyController";
+export { GasFeeController } from "./Gas/GasFeeController";
 export * from "./Gas/IGasFeeController";
-export { default as KeyringController } from "./Keyring/KeyringController";
+export { KeyringController } from "./Keyring/KeyringController";
 export * from "./Message/AbstractMessageController";
 export * from "./Message/AddChainController";
-export * from "./Message/DecryptMessageController";
-export * from "./Message/EncryptionPublicKeyController";
 export * from "./Message/MessageController";
 export * from "./Message/PersonalMessageController";
 export * from "./Message/SwitchChainController";
@@ -15,21 +13,21 @@ export * from "./Message/TypedMessageController";
 export * from "./Message/utils";
 export * from "./Network/createEthereumMiddleware";
 export * from "./Network/createJsonRpcClient";
-export { default as NetworkController } from "./Network/NetworkController";
+export { NetworkController } from "./Network/NetworkController";
 export * from "./Nfts/INftsController";
 export * from "./Nfts/NftHandler";
 export * from "./Nfts/NftsController";
-export { default as PreferencesController } from "./Preferences/PreferencesController";
+export { PreferencesController } from "./Preferences/PreferencesController";
 export * from "./Tokens/ITokensController";
 export * from "./Tokens/TokenHandler";
 export * from "./Tokens/TokenRatesController";
 export * from "./Tokens/TokensController";
-export { default as NonceTracker } from "./Transaction/NonceTracker";
-export { default as PendingTransactionTracker } from "./Transaction/PendingTransactionTracker";
-export { default as TransactionController } from "./Transaction/TransactionController";
-export { default as TransactionGasUtil } from "./Transaction/TransactionGasUtil";
+export { NonceTracker } from "./Transaction/NonceTracker";
+export { PendingTransactionTracker } from "./Transaction/PendingTransactionTracker";
+export { TransactionController } from "./Transaction/TransactionController";
+export { TransactionGasUtil } from "./Transaction/TransactionGasUtil";
 export * from "./Transaction/TransactionStateHistoryHelper";
-export { default as TransactionStateManager } from "./Transaction/TransactionStateManager";
+export { TransactionStateManager } from "./Transaction/TransactionStateManager";
 export * from "./Transaction/TransactionUtils";
 export * from "./utils/abis";
 export * from "./utils/constants";

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

@@ -31,14 +31,10 @@ export declare const METHOD_TYPES: {
     readonly ETH_REQUEST_ACCOUNTS: "eth_requestAccounts";
     readonly ETH_SEND_RAW_TRANSACTION: "eth_sendRawTransaction";
     readonly ETH_SIGN: "eth_sign";
-    readonly ETH_SIGN_TYPED_DATA: "eth_signTypedData";
-    readonly ETH_SIGN_TYPED_DATA_V3: "eth_signTypedData_v3";
     readonly ETH_SIGN_TYPED_DATA_V4: "eth_signTypedData_v4";
     readonly PERSONAL_SIGN: "personal_sign";
     readonly ETH_GET_TRANSACTION_COUNT: "eth_getTransactionCount";
     readonly ETH_GET_TRANSACTION_BY_HASH: "eth_getTransactionByHash";
-    readonly ETH_GET_ENCRYPTION_PUBLIC_KEY: "eth_getEncryptionPublicKey";
-    readonly ETH_DECRYPT: "eth_decrypt";
     readonly ETH_GET_TRANSACTION_RECEIPT: "eth_getTransactionReceipt";
     readonly WATCH_ASSET: "wallet_watchAsset";
     readonly ETH_GET_BLOCK_BY_HASH: "eth_getBlockByHash";
@@ -83,5 +79,5 @@ export declare const MessageStatus: {
     readonly FAILED: "failed";
 };
 export declare const MESSAGE_EVENTS: {
-    UNAPPROVED_MESSAGE: string;
+    readonly UNAPPROVED_MESSAGE: "unapprovedMessage";
 };

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

@@ -1,5 +1,5 @@
 import { TransactionStatus } from "@toruslabs/base-controllers";
-import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
+import { SafeEventEmitterProvider } from "@web3auth/auth";
 import BigNumber from "bignumber.js";
 import { EtherscanTransaction, FormattedTransactionActivity, TransactionPayload } from "./interfaces";
 export declare function hexToBn(hex: string): BigNumber;
@@ -19,11 +19,11 @@ export declare function formatTime(time: number): string;
 export declare const idleTimeTracker: {
     checkIfIdle: () => boolean;
 };
-export declare function isAddressByChainId(address: string, _chainId: string): boolean;
+export declare function isAddressByChainId(address: string, _chainId: string): address is `0x${string}`;
 export declare function toChecksumAddressByChainId(address: string, chainId: string): string;
 export declare const GAS_LIMITS: {
-    SIMPLE: string;
-    BASE_TOKEN_ESTIMATE: string;
+    SIMPLE: `0x${string}`;
+    BASE_TOKEN_ESTIMATE: `0x${string}`;
 };
 export declare function bnLessThan(a: string | number, b: string | number): boolean;
 export declare const getIpfsEndpoint: (path: string) => string;

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

@@ -1,9 +1,9 @@
 import { type AccessList } from "@ethereumjs/common";
-import { SignTypedDataVersion } from "@metamask/eth-sig-util";
-import { AddressPreferences, BaseBlockTrackerState, NetworkConfig, NetworkState, PaymentTransaction, PollingBlockTrackerConfig, PopupWhitelabelData, ProviderConfig, TRANSACTION_TYPE, TransactionMeta, TransactionStatus, User } from "@toruslabs/base-controllers";
-import { Json } from "@toruslabs/openlogin-jrpc";
+import { AddressPreferences, BASE_TX_EVENT_TYPE, BaseBlockTrackerState, BaseControllerEvents, BaseTransactionEvents, NetworkConfig, NetworkState, PaymentTransaction, PollingBlockTrackerConfig, PopupWhitelabelData, ProviderConfig, TRANSACTION_TYPE, TransactionMeta, TransactionState, TransactionStatus, TX_CONFIRMED_EVENT_TYPE, TX_DROPPED_EVENT_TYPE, TX_EVENTS, TX_FAILED_EVENT_TYPE, TX_WARNING_EVENT_TYPE, User } from "@toruslabs/base-controllers";
+import { JRPCRequest, Json } from "@web3auth/auth";
 import { MutexInterface } from "async-mutex";
-import { MessageStatus, METHOD_TYPES, TRANSACTION_ENVELOPE_TYPES } from "./constants";
+import { TypedDataDomain, TypedDataField } from "ethers";
+import { MESSAGE_EVENTS, MessageStatus, METHOD_TYPES, TRANSACTION_ENVELOPE_TYPES } from "./constants";
 export type CustomTokenInfo = {
     tokenAddress: string;
     name: string;
@@ -83,11 +83,10 @@ export interface AbstractMessage {
 export interface Message extends AbstractMessage {
     messageParams: MessageParams;
 }
-export type SignTypedDataMessageV3V4 = {
-    types: Record<string, unknown>;
-    domain: Record<string, unknown>;
-    primaryType: string;
-    message: unknown;
+export type SignTypedDataMessageV4 = {
+    types: Record<string, TypedDataField[]>;
+    domain: TypedDataDomain;
+    message: Record<string, unknown>;
 };
 export interface SwitchChainMessageParams extends BaseRequestParams {
     chainId: string;
@@ -111,8 +110,7 @@ export interface AddChainMessage extends AbstractMessage {
     messageParams: AddChainMessageParams;
 }
 export interface TypedMessageParams extends BaseRequestParams {
-    data: Record<string, unknown>[] | string | SignTypedDataMessageV3V4;
-    version?: SignTypedDataVersion;
+    data: string | SignTypedDataMessageV4;
 }
 export interface TypedMessage extends AbstractMessage {
     messageParams: TypedMessageParams;
@@ -397,18 +395,6 @@ export interface NonceLockRes {
     releaseLock: MutexInterface.Releaser;
 }
 export type METHOD_TYPES_TYPE = (typeof METHOD_TYPES)[keyof typeof METHOD_TYPES];
-export interface EncryptionPublicKeyParams extends BaseRequestParams {
-    data: string;
-}
-export interface EncryptionPublicKey extends AbstractMessage {
-    messageParams: EncryptionPublicKeyParams;
-}
-export interface DecryptMessageParams extends BaseRequestParams {
-    data: string;
-}
-export interface DecryptMessage extends AbstractMessage {
-    messageParams: DecryptMessageParams;
-}
 export interface EtherscanTransaction {
     blockNumber: string;
     timeStamp: string;
@@ -441,3 +427,37 @@ export interface EtherscanTransaction {
     tokenValue: string;
     tokenDecimal: string;
 }
+export interface NetworkControllerEvents<S> extends BaseControllerEvents<S> {
+    networkDidChange: () => void;
+}
+export interface AbstractMessageControllerEvents<S, M> extends BaseControllerEvents<S> {
+    [event: `${string}:${MessageStatusType}`]: (message: M) => void;
+    [event: `${string}:finished`]: (message: M) => void;
+    [MESSAGE_EVENTS.UNAPPROVED_MESSAGE]: (args: {
+        messageData: M;
+        req: JRPCRequest<unknown> & UserRequestApprovalParams;
+    }) => void;
+}
+export type TX_BLOCK_EVENT_TYPE = {
+    txMeta: EthereumTransactionMeta;
+    latestBlockNumber?: string;
+} & BASE_TX_EVENT_TYPE;
+export type PendingTransactionTrackerEvents<S> = BaseControllerEvents<S> & {
+    [TX_EVENTS.TX_WARNING]: (args: TX_WARNING_EVENT_TYPE<TransactionParams, EthereumTransactionMeta>) => void;
+    [TX_EVENTS.TX_BLOCK_UPDATE]: (args: TX_BLOCK_EVENT_TYPE) => void;
+    [TX_EVENTS.TX_RETRY]: (args: {
+        txMeta: EthereumTransactionMeta;
+    } & BASE_TX_EVENT_TYPE) => void;
+    [TX_EVENTS.TX_FAILED]: (args: TX_FAILED_EVENT_TYPE) => void;
+    [TX_EVENTS.TX_DROPPED]: (args: TX_DROPPED_EVENT_TYPE) => void;
+    [TX_EVENTS.TX_CONFIRMED]: (args: TX_CONFIRMED_EVENT_TYPE) => void;
+};
+export type EthereumTransactionEvents<T, U> = BaseTransactionEvents<TransactionState<T, TransactionMeta<T>>, U> & {
+    [TX_EVENTS.TX_UNAPPROVED]: (data: {
+        txMeta: U;
+        req: JRPCRequest<TransactionParams> & UserRequestApprovalParams;
+    }) => void;
+} & {
+    [event: `${string}:unapproved`]: (txMeta: U) => void;
+    [event: `${string}:${Exclude<TransactionStatus, "unapproved">}`]: (txId: string) => void;
+};

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@toruslabs/ethereum-controllers",
-  "version": "5.11.0",
+  "version": "6.0.1",
   "homepage": "https://github.com/torusresearch/controllers#readme",
   "license": "ISC",
-  "main": "dist/ethereumControllers.cjs.js",
-  "module": "dist/ethereumControllers.esm.js",
+  "sidEffects": false,
+  "main": "dist/lib.cjs/index.js",
+  "module": "dist/lib.esm/index.js",
   "unpkg": "dist/ethereumControllers.umd.min.js",
   "jsdelivr": "dist/ethereumControllers.umd.min.js",
   "types": "dist/types/index.d.ts",
@@ -14,19 +15,19 @@
     "test-debugger": "TS_NODE_PROJECT=./tsconfig.test.json mocha --config ../../.mocharc.json --inspect-brk test/**/*.ts",
     "dev": "rimraf dist/ && cross-env NODE_ENV=development torus-scripts start",
     "build": "rimraf dist/ && cross-env NODE_ENV=production torus-scripts build",
-    "lint": "eslint --fix 'src/**/*.ts'",
+    "lint": "eslint --fix 'src/**/*.ts' 'test/**/*.ts'",
     "prepack": "npm run build",
     "pre-commit": "lint-staged --cwd ."
   },
   "dependencies": {
     "@ethereumjs/common": "^4.3.0",
-    "@ethereumjs/tx": "^5.3.0",
+    "@ethereumjs/tx": "^5.4.0",
     "@ethereumjs/util": "^9.0.3",
     "@metamask/abi-utils": "2.0.2",
     "@metamask/eth-sig-util": "7.0.2",
-    "@toruslabs/base-controllers": "^5.11.0",
-    "@toruslabs/http-helpers": "^6.1.1",
-    "@toruslabs/openlogin-jrpc": "^8.3.0",
+    "@toruslabs/base-controllers": "^6.0.1",
+    "@toruslabs/http-helpers": "^7.0.0",
+    "@web3auth/auth": "^9.1.2",
     "async-mutex": "^0.5.0",
     "bignumber.js": "^9.1.2",
     "bn.js": "^5.2.1",
@@ -64,7 +65,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26012a471db07e78c79c62672ad52e61b910d36f",
+  "gitHead": "a8477ca972d2782dc3f15ea0f5d880975290e751",
   "devDependencies": {
     "@nomicfoundation/hardhat-chai-matchers": "^2.0.7",
     "@nomicfoundation/hardhat-ethers": "^3.0.6",

package/dist/types/Message/DecryptMessageController.d.ts

@@ -1,20 +0,0 @@
-import { BaseConfig } from "@toruslabs/base-controllers";
-import { JRPCRequest } from "@toruslabs/openlogin-jrpc";
-import KeyringController from "../Keyring/KeyringController";
-import NetworkController from "../Network/NetworkController";
-import { DecryptMessage, DecryptMessageParams, UserRequestApprovalParams } from "../utils/interfaces";
-import AbstractMessageController, { MessageControllerState } from "./AbstractMessageController";
-export declare class DecryptMessageController extends AbstractMessageController<DecryptMessage, DecryptMessageParams> {
-    name: string;
-    protected decryptMessage: KeyringController["decryptMessage"];
-    constructor({ config, state, decryptMessage, getNetworkIdentifier, }: {
-        config: Partial<BaseConfig>;
-        state: Partial<MessageControllerState<DecryptMessage>>;
-        decryptMessage: KeyringController["decryptMessage"];
-        getNetworkIdentifier: NetworkController["getNetworkIdentifier"];
-    });
-    processDecryptMessage(messageId: string): Promise<string>;
-    addNewUnapprovedMessage(messageParams: DecryptMessageParams, req: JRPCRequest<unknown> & UserRequestApprovalParams): Promise<string>;
-    addUnapprovedMessage(messageParams: DecryptMessageParams, req?: JRPCRequest<unknown> & UserRequestApprovalParams): Promise<string>;
-    prepMessageForSigning(messageParams: DecryptMessageParams): Promise<DecryptMessageParams>;
-}

package/dist/types/Message/EncryptionPublicKeyController.d.ts

@@ -1,20 +0,0 @@
-import { BaseConfig } from "@toruslabs/base-controllers";
-import { JRPCRequest } from "@toruslabs/openlogin-jrpc";
-import KeyringController from "../Keyring/KeyringController";
-import NetworkController from "../Network/NetworkController";
-import { EncryptionPublicKey, EncryptionPublicKeyParams, UserRequestApprovalParams } from "../utils/interfaces";
-import AbstractMessageController, { MessageControllerState } from "./AbstractMessageController";
-export declare class EncryptionPublicKeyController extends AbstractMessageController<EncryptionPublicKey, EncryptionPublicKeyParams> {
-    name: string;
-    protected signEncryptionPublicKey: KeyringController["signEncryptionPublicKey"];
-    constructor({ config, state, signEncryptionPublicKey, getNetworkIdentifier, }: {
-        config: Partial<BaseConfig>;
-        state: Partial<MessageControllerState<EncryptionPublicKey>>;
-        signEncryptionPublicKey: KeyringController["signEncryptionPublicKey"];
-        getNetworkIdentifier: NetworkController["getNetworkIdentifier"];
-    });
-    processGetEncryptionPublicKey(messageId: string): Promise<string>;
-    addNewUnapprovedMessage(messageParams: EncryptionPublicKeyParams, req: JRPCRequest<unknown> & UserRequestApprovalParams): Promise<string>;
-    addUnapprovedMessage(messageParams: EncryptionPublicKeyParams, req?: JRPCRequest<unknown> & UserRequestApprovalParams): Promise<string>;
-    prepMessageForSigning(messageParams: EncryptionPublicKeyParams): Promise<EncryptionPublicKeyParams>;
-}