@toruslabs/ethereum-controllers 4.2.0 → 4.3.0

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

@@ -26,7 +26,7 @@ export default abstract class AbstractMessageController<M extends AbstractMessag
         [key: string]: M;
     };
     addMessage(message: M): Promise<void>;
-    approveMessage(messageParams: P): Promise<P>;
+    approveMessage(messageId: string, messageParams: P): Promise<P>;
     setMessageStatus(messageId: string, status: MessageStatusType): void;
     waitForFinishStatus(msgParams: P, messageName: string): Promise<string>;
     protected updateMessage(message: M): void;

package/dist/types/Nfts/NftsController.d.ts

@@ -1,6 +1,5 @@
 import { BaseController, PreferencesState } from "@toruslabs/base-controllers";
 import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
-import NetworkController from "../Network/NetworkController";
 import PreferencesController from "../Preferences/PreferencesController";
 import { CustomNftInfo, EthereumNetworkState, ExtendedAddressPreferences } from "../utils/interfaces";
 import { NftsControllerConfig, NftsControllerState } from "./INftsController";
@@ -8,7 +7,6 @@ export interface INftsControllerOptions {
     config?: Partial<NftsControllerConfig>;
     state?: Partial<NftsControllerState>;
     provider: SafeEventEmitterProvider;
-    getNetworkIdentifier: NetworkController["getNetworkIdentifier"];
     getCustomNfts?: PreferencesController["getCustomNfts"];
     getSimpleHashNfts: PreferencesController["getSimpleHashNfts"];
     onPreferencesStateChange: (listener: (preferencesState: PreferencesState<ExtendedAddressPreferences>) => void) => void;
@@ -19,10 +17,9 @@ export declare class NftsController extends BaseController<NftsControllerConfig,
     private provider;
     private ethersProvider;
     private _timer;
-    private getNetworkIdentifier;
     private getCustomNfts;
     private getSimpleHashNfts;
-    constructor({ config, state, provider, getNetworkIdentifier, getCustomNfts, getSimpleHashNfts, onPreferencesStateChange, onNetworkStateChange, }: INftsControllerOptions);
+    constructor({ config, state, provider, getCustomNfts, getSimpleHashNfts, onPreferencesStateChange, onNetworkStateChange }: INftsControllerOptions);
     get userSelectedAddress(): string;
     get userNfts(): CustomNftInfo[];
     get interval(): number;

package/dist/types/Preferences/PreferencesController.d.ts

@@ -27,7 +27,7 @@ export default class PreferencesController extends BasePreferencesController<Ext
         userInfo?: UserInfo;
         rehydrate?: boolean;
         locale?: string;
-        type: string;
+        type?: string;
     }): Promise<void>;
     getSelectedAddress(): string;
     sync(address: string): Promise<boolean>;

package/dist/types/Tokens/TokensController.d.ts

@@ -8,7 +8,6 @@ export interface ITokensControllerOptions {
     config?: Partial<TokensControllerConfig>;
     state?: Partial<TokensControllerState>;
     provider: SafeEventEmitterProvider;
-    getNetworkIdentifier: NetworkController["getNetworkIdentifier"];
     getCustomTokens?: PreferencesController["getCustomTokens"];
     getEtherScanTokens: PreferencesController["getEtherScanTokens"];
     getProviderConfig: NetworkController["getProviderConfig"];
@@ -20,11 +19,10 @@ export declare class TokensController extends BaseController<TokensControllerCon
     private provider;
     private ethersProvider;
     private _timer;
-    private getNetworkIdentifier;
     private getProviderConfig;
     private getCustomTokens;
     private getEtherScanTokens;
-    constructor({ config, state, provider, getNetworkIdentifier, getCustomTokens, getEtherScanTokens, getProviderConfig, onPreferencesStateChange, onNetworkStateChange, }: ITokensControllerOptions);
+    constructor({ config, state, provider, getCustomTokens, getEtherScanTokens, getProviderConfig, onPreferencesStateChange, onNetworkStateChange, }: ITokensControllerOptions);
     get userSelectedAddress(): string;
     get userTokens(): CustomTokenInfo[];
     get interval(): number;

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

@@ -79,3 +79,6 @@ export declare const MessageStatus: {
     readonly REJECTED: "rejected";
     readonly FAILED: "failed";
 };
+export declare const MESSAGE_EVENTS: {
+    UNAPPROVED_MESSAGE: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toruslabs/ethereum-controllers",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "homepage": "https://github.com/torusresearch/controllers#readme",
   "license": "ISC",
   "main": "dist/ethereumControllers.cjs.js",
@@ -24,7 +24,7 @@
     "@ethereumjs/util": "^9.0.0",
     "@metamask/eth-sig-util": "^7.0.0",
     "@metamask/rpc-errors": "^6.0.0",
-    "@toruslabs/base-controllers": "^4.2.0",
+    "@toruslabs/base-controllers": "^4.3.0",
     "@toruslabs/http-helpers": "^5.0.0",
     "@toruslabs/openlogin-jrpc": "^5.1.0",
     "async-mutex": "^0.4.0",
@@ -64,7 +64,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bb9d5f2612ba55375a94815e328954fc8976e07b",
+  "gitHead": "42139c8f59f8f4be3e8c03bdfc3987e1df9dc1b7",
   "devDependencies": {
     "ganache": "^7.9.1"
   }

package/src/Message/AbstractMessageController.ts

@@ -75,8 +75,8 @@ export default abstract class AbstractMessageController<M extends AbstractMessag
     this.saveMessageList();
   }
 
-  approveMessage(messageParams: P): Promise<P> {
-    this.setMessageStatus(messageParams.id, MessageStatus.APPROVED);
+  approveMessage(messageId: string, messageParams: P): Promise<P> {
+    this.setMessageStatus(messageId, MessageStatus.APPROVED);
     return this.prepMessageForSigning(messageParams);
   }
 

package/src/Message/DecryptMessageController.ts

@@ -5,7 +5,7 @@ import log from "loglevel";
 
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
-import { MessageStatus, METHOD_TYPES } from "../utils/constants";
+import { MESSAGE_EVENTS, MessageStatus, METHOD_TYPES } from "../utils/constants";
 import { DecryptMessage, DecryptMessageParams, Message, UserRequestApprovalParams } from "../utils/interfaces";
 import AbstractMessageController, { MessageControllerState } from "./AbstractMessageController";
 import { normalizeMessageData, parseDecryptMessageData, validateDecryptedMessageData } from "./utils";
@@ -34,7 +34,7 @@ export class DecryptMessageController extends AbstractMessageController<DecryptM
   async processDecryptMessage(messageId: string): Promise<string> {
     try {
       const msgObject = this.getMessage(messageId);
-      const cleanMsgParams = await this.approveMessage(msgObject.messageParams);
+      const cleanMsgParams = await this.approveMessage(messageId, msgObject.messageParams);
       const parsedData = parseDecryptMessageData(cleanMsgParams.data);
       const rawSig = this.decryptMessage(parsedData, cleanMsgParams.from);
       this.updateMessage({ ...msgObject, rawSig });
@@ -69,9 +69,7 @@ export class DecryptMessageController extends AbstractMessageController<DecryptM
       type: METHOD_TYPES.ETH_DECRYPT,
     };
     await this.addMessage(messageData);
-    this.emit(`unapprovedMessage`, {
-      ...messageParams,
-    });
+    this.emit(MESSAGE_EVENTS.UNAPPROVED_MESSAGE, messageData);
     return messageId;
   }
 

package/src/Message/EncryptionPublicKeyController.ts

@@ -5,7 +5,7 @@ import log from "loglevel";
 
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
-import { MessageStatus, METHOD_TYPES } from "../utils/constants";
+import { MESSAGE_EVENTS, MessageStatus, METHOD_TYPES } from "../utils/constants";
 import { EncryptionPublicKey, EncryptionPublicKeyParams, UserRequestApprovalParams } from "../utils/interfaces";
 import AbstractMessageController, { MessageControllerState } from "./AbstractMessageController";
 import { validateEncryptionPublicKeyMessageData } from "./utils";
@@ -34,7 +34,7 @@ export class EncryptionPublicKeyController extends AbstractMessageController<Enc
   async processGetEncryptionPublicKey(messageId: string): Promise<string> {
     try {
       const msgObject = this.getMessage(messageId);
-      const cleanMsgParams = await this.approveMessage(msgObject.messageParams);
+      const cleanMsgParams = await this.approveMessage(messageId, msgObject.messageParams);
       const publicKey = this.signEncryptionPublicKey(cleanMsgParams.from);
       this.updateMessage({ ...msgObject, rawSig: publicKey });
       this.setMessageStatus(messageId, MessageStatus.SIGNED);
@@ -70,9 +70,7 @@ export class EncryptionPublicKeyController extends AbstractMessageController<Enc
       type: METHOD_TYPES.ETH_GET_ENCRYPTION_PUBLIC_KEY,
     };
     await this.addMessage(messageData);
-    this.emit(`unapprovedMessage`, {
-      ...messageParams,
-    });
+    this.emit(MESSAGE_EVENTS.UNAPPROVED_MESSAGE, messageData);
     return messageId;
   }
 

package/src/Message/MessageController.ts

@@ -4,7 +4,7 @@ import log from "loglevel";
 
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
-import { MessageStatus, METHOD_TYPES } from "../utils/constants";
+import { MESSAGE_EVENTS, MessageStatus, METHOD_TYPES } from "../utils/constants";
 import { Message, MessageParams, UserRequestApprovalParams } from "../utils/interfaces";
 import AbstractMessageController, { MessageControllerState } from "./AbstractMessageController";
 import { normalizeMessageData, validateSignMessageData } from "./utils";
@@ -33,7 +33,7 @@ export class MessageController extends AbstractMessageController<Message, Messag
   async processSignMessage(messageId: string): Promise<string> {
     try {
       const msgObject = this.getMessage(messageId);
-      const cleanMsgParams = await this.approveMessage(msgObject.messageParams);
+      const cleanMsgParams = await this.approveMessage(messageId, msgObject.messageParams);
       const rawSig = this.signMessage(cleanMsgParams.data, cleanMsgParams.from);
       this.updateMessage({ ...msgObject, rawSig });
       this.setMessageStatus(messageId, MessageStatus.SIGNED);
@@ -64,7 +64,7 @@ export class MessageController extends AbstractMessageController<Message, Messag
       type: METHOD_TYPES.ETH_SIGN,
     };
     await this.addMessage(messageData);
-    this.emit(`unapprovedMessage`, messageParams);
+    this.emit(MESSAGE_EVENTS.UNAPPROVED_MESSAGE, messageData);
     return messageId;
   }
 

package/src/Message/PersonalMessageController.ts

@@ -4,7 +4,7 @@ import log from "loglevel";
 
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
-import { MessageStatus, METHOD_TYPES } from "../utils/constants";
+import { MESSAGE_EVENTS, MessageStatus, METHOD_TYPES } from "../utils/constants";
 import { Message, MessageParams, UserRequestApprovalParams } from "../utils/interfaces";
 import AbstractMessageController, { MessageControllerState } from "./AbstractMessageController";
 import { normalizeMessageData, validateSignMessageData } from "./utils";
@@ -33,7 +33,7 @@ export class PersonalMessageController extends AbstractMessageController<Message
   async processPersonalSignMessage(messageId: string): Promise<string> {
     try {
       const msgObject = this.getMessage(messageId);
-      const cleanMsgParams = await this.approveMessage(msgObject.messageParams);
+      const cleanMsgParams = await this.approveMessage(messageId, msgObject.messageParams);
       const rawSig = await this.signPersonalMessage(cleanMsgParams.data, cleanMsgParams.from);
       this.updateMessage({ ...msgObject, rawSig });
       this.setMessageStatus(messageId, MessageStatus.SIGNED);
@@ -55,7 +55,7 @@ export class PersonalMessageController extends AbstractMessageController<Message
       messageParams.origin = req.origin;
     }
     messageParams.data = normalizeMessageData(messageParams.data);
-    const messageId = randomId();
+    const messageId = messageParams.id || randomId();
     const messageData: Message = {
       id: messageId,
       messageParams,
@@ -64,7 +64,7 @@ export class PersonalMessageController extends AbstractMessageController<Message
       type: METHOD_TYPES.PERSONAL_SIGN,
     };
     await this.addMessage(messageData);
-    this.emit(`unapprovedMessage`, messageParams);
+    this.emit(MESSAGE_EVENTS.UNAPPROVED_MESSAGE, messageData);
     return messageId;
   }
 

package/src/Message/TypedMessageController.ts

@@ -5,7 +5,7 @@ import log from "loglevel";
 
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
-import { MessageStatus, METHOD_TYPES } from "../utils/constants";
+import { MESSAGE_EVENTS, MessageStatus, METHOD_TYPES } from "../utils/constants";
 import { METHOD_TYPES_TYPE, TypedMessage, TypedMessageParams, UserRequestApprovalParams } from "../utils/interfaces";
 import AbstractMessageController, { MessageControllerState } from "./AbstractMessageController";
 import { validateTypedSignMessageDataV1, validateTypedSignMessageDataV3V4 } from "./utils";
@@ -47,7 +47,7 @@ export class TypedMessageController extends AbstractMessageController<TypedMessa
   async processPersonalSignMessage(messageId: string): Promise<string> {
     try {
       const msgObject = this.getMessage(messageId);
-      const cleanMsgParams = await this.approveMessage(msgObject.messageParams);
+      const cleanMsgParams = await this.approveMessage(messageId, msgObject.messageParams);
       const rawSig = await this.signTypedData(
         cleanMsgParams.data as TypedDataV1 | EthSigTypedMessage<MessageTypes>,
         cleanMsgParams.from,
@@ -102,7 +102,7 @@ export class TypedMessageController extends AbstractMessageController<TypedMessa
       type: getMessageType(version),
     };
     await this.addMessage(messageData);
-    this.emit(`unapprovedMessage`, messageParams);
+    this.emit(MESSAGE_EVENTS.UNAPPROVED_MESSAGE, messageData);
     return messageId;
   }
 

package/src/Nfts/NftsController.ts

@@ -4,7 +4,6 @@ import { BrowserProvider } from "ethers";
 import { merge } from "lodash";
 import log from "loglevel";
 
-import NetworkController from "../Network/NetworkController";
 import PreferencesController from "../Preferences/PreferencesController";
 import { SIMPLEHASH_SUPPORTED_CHAINS } from "../utils/constants";
 import { idleTimeTracker } from "../utils/helpers";
@@ -16,7 +15,6 @@ export interface INftsControllerOptions {
   config?: Partial<NftsControllerConfig>;
   state?: Partial<NftsControllerState>;
   provider: SafeEventEmitterProvider;
-  getNetworkIdentifier: NetworkController["getNetworkIdentifier"];
   getCustomNfts?: PreferencesController["getCustomNfts"];
   getSimpleHashNfts: PreferencesController["getSimpleHashNfts"];
   onPreferencesStateChange: (listener: (preferencesState: PreferencesState<ExtendedAddressPreferences>) => void) => void;
@@ -34,27 +32,15 @@ export class NftsController extends BaseController<NftsControllerConfig, NftsCon
 
   private _timer: number;
 
-  private getNetworkIdentifier: NetworkController["getNetworkIdentifier"];
-
   private getCustomNfts: PreferencesController["getCustomNfts"];
 
   private getSimpleHashNfts: PreferencesController["getSimpleHashNfts"];
 
-  constructor({
-    config,
-    state,
-    provider,
-    getNetworkIdentifier,
-    getCustomNfts,
-    getSimpleHashNfts,
-    onPreferencesStateChange,
-    onNetworkStateChange,
-  }: INftsControllerOptions) {
+  constructor({ config, state, provider, getCustomNfts, getSimpleHashNfts, onPreferencesStateChange, onNetworkStateChange }: INftsControllerOptions) {
     super({ config, state });
 
     this.provider = provider;
     this.ethersProvider = new BrowserProvider(this.provider, "any");
-    this.getNetworkIdentifier = getNetworkIdentifier;
 
     this.getCustomNfts = getCustomNfts;
     this.getSimpleHashNfts = getSimpleHashNfts;
@@ -133,7 +119,7 @@ export class NftsController extends BaseController<NftsControllerConfig, NftsCon
   public detectNewNfts() {
     const userAddress = this.userSelectedAddress;
     if (!userAddress) return;
-    const currentChainId = this.getNetworkIdentifier();
+    const currentChainId = this.config.chainId;
     const nftsToDetect: CustomNftInfo[] = []; // object[]
     if (!currentChainId) {
       this.update({ nfts: { [userAddress]: [...nftsToDetect] } });
@@ -186,7 +172,7 @@ export class NftsController extends BaseController<NftsControllerConfig, NftsCon
     const oldNfts = [...this.userNfts];
     const nonZeroNfts: CustomNftInfo[] = [];
     try {
-      const currentChainId = this.getNetworkIdentifier();
+      const currentChainId = this.config.chainId;
       if (SIMPLEHASH_SUPPORTED_CHAINS.includes(currentChainId)) {
         const simpleHashBalances = await this.getSimpleHashNfts(userAddress, currentChainId);
         nonZeroNfts.push(...simpleHashBalances);

package/src/Preferences/PreferencesController.ts

@@ -89,7 +89,7 @@ export default class PreferencesController
     userInfo?: UserInfo;
     rehydrate?: boolean;
     locale?: string;
-    type: string;
+    type?: string;
   }): Promise<void> {
     const { address, jwtToken, calledFromEmbed, userInfo, rehydrate, locale = "en-US", type } = params;
     await super.init(address, userInfo, jwtToken, { type, email: userInfo.email });

package/src/Tokens/TokensController.ts

@@ -17,7 +17,6 @@ export interface ITokensControllerOptions {
   config?: Partial<TokensControllerConfig>;
   state?: Partial<TokensControllerState>;
   provider: SafeEventEmitterProvider;
-  getNetworkIdentifier: NetworkController["getNetworkIdentifier"];
   getCustomTokens?: PreferencesController["getCustomTokens"];
   getEtherScanTokens: PreferencesController["getEtherScanTokens"];
   getProviderConfig: NetworkController["getProviderConfig"];
@@ -55,8 +54,6 @@ export class TokensController extends BaseController<TokensControllerConfig, Tok
 
   private _timer: number;
 
-  private getNetworkIdentifier: NetworkController["getNetworkIdentifier"];
-
   private getProviderConfig: NetworkController["getProviderConfig"];
 
   private getCustomTokens: PreferencesController["getCustomTokens"];
@@ -67,7 +64,6 @@ export class TokensController extends BaseController<TokensControllerConfig, Tok
     config,
     state,
     provider,
-    getNetworkIdentifier,
     getCustomTokens,
     getEtherScanTokens,
     getProviderConfig,
@@ -78,7 +74,6 @@ export class TokensController extends BaseController<TokensControllerConfig, Tok
 
     this.provider = provider;
     this.ethersProvider = new BrowserProvider(this.provider, "any");
-    this.getNetworkIdentifier = getNetworkIdentifier;
 
     this.getCustomTokens = getCustomTokens;
     this.getEtherScanTokens = getEtherScanTokens;
@@ -159,7 +154,7 @@ export class TokensController extends BaseController<TokensControllerConfig, Tok
   public detectNewTokens() {
     const userAddress = this.userSelectedAddress;
     if (!userAddress) return;
-    const currentChainId = this.getNetworkIdentifier();
+    const currentChainId = this.config.chainId;
     const tokens: CustomTokenInfo[] = []; // object[]
     if (!currentChainId) {
       this.update({ tokens: { [userAddress]: [...tokens] } });
@@ -209,7 +204,7 @@ export class TokensController extends BaseController<TokensControllerConfig, Tok
     const tokenAddresses = oldTokens.map((x) => x.tokenAddress);
     const nonZeroTokens: CustomTokenInfo[] = [];
     try {
-      const currentChainId = this.getNetworkIdentifier();
+      const currentChainId = this.config.chainId;
       if (ETHERSCAN_SUPPORTED_CHAINS.includes(currentChainId)) {
         const etherscanBalances = await this.getEtherScanTokens(userAddress, currentChainId);
         nonZeroTokens.push(...etherscanBalances);

package/src/Transaction/TransactionStateManager.ts

@@ -61,7 +61,7 @@ export default class TransactionStateManager
     }
 
     return {
-      id: randomId(),
+      id: opts.transaction.id || randomId(),
       time: Date.now(),
       status: TransactionStatus.unapproved,
       loadingDefaults: true,

package/src/utils/constants.ts

@@ -377,3 +377,7 @@ export const MessageStatus = {
   REJECTED: "rejected",
   FAILED: "failed",
 } as const;
+
+export const MESSAGE_EVENTS = {
+  UNAPPROVED_MESSAGE: "unapprovedMessage",
+};