@toruslabs/ethereum-controllers 4.1.0 → 4.2.0

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

@@ -27,12 +27,17 @@ export default class PreferencesController extends BasePreferencesController<Ext
         userInfo?: UserInfo;
         rehydrate?: boolean;
         locale?: string;
+        type: string;
     }): Promise<void>;
     getSelectedAddress(): string;
     sync(address: string): Promise<boolean>;
     patchNewTx(tx: TransactionPayload, address: string): Promise<void>;
     recalculatePastTx(address?: string): void;
     refetchEtherscanTx(address?: string): Promise<void>;
+    fetchEtherscanTx<T>(parameters: {
+        selectedAddress: string;
+        selectedNetwork: string;
+    }): Promise<T[]>;
     getEtherScanTokens(address: string, chainId: string): Promise<CustomTokenInfo[]>;
     getSimpleHashNfts(address: string, chainId: string): Promise<CustomNftInfo[]>;
     getCustomTokens(address?: string): CustomToken[];

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

@@ -229,7 +229,6 @@ export type PollingBlockTrackerState = BaseBlockTrackerState<EthereumBlock>;
 export interface EthereumProviderConfig extends ProviderConfig {
     isErc20?: boolean;
     tokenAddress?: string;
-    isTestNet?: boolean;
 }
 export interface EthereumNetworkState extends NetworkState {
     providerConfig: EthereumProviderConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toruslabs/ethereum-controllers",
-  "version": "4.1.0",
+  "version": "4.2.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.1.0",
+    "@toruslabs/base-controllers": "^4.2.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": "13b57afe21257c71e11d4e019fca62d517bfdc54",
+  "gitHead": "bb9d5f2612ba55375a94815e328954fc8976e07b",
   "devDependencies": {
     "ganache": "^7.9.1"
   }

package/src/Preferences/PreferencesController.ts

@@ -89,9 +89,10 @@ export default class PreferencesController
     userInfo?: UserInfo;
     rehydrate?: boolean;
     locale?: string;
+    type: string;
   }): Promise<void> {
-    const { address, jwtToken, calledFromEmbed, userInfo, rehydrate, locale = "en-US" } = params;
-    await super.init(address, userInfo, jwtToken);
+    const { address, jwtToken, calledFromEmbed, userInfo, rehydrate, locale = "en-US", type } = params;
+    await super.init(address, userInfo, jwtToken, { type, email: userInfo.email });
     const { aggregateVerifier, verifier, verifierId } = userInfo || {};
     const userExists = await this.sync(address);
     if (!userExists) {
@@ -218,6 +219,18 @@ export default class PreferencesController
     }
   }
 
+  async fetchEtherscanTx<T>(parameters: { selectedAddress: string; selectedNetwork: string }): Promise<T[]> {
+    try {
+      const url = new URL(`${this.config.api}/etherscan`);
+      Object.keys(parameters).forEach((key) => url.searchParams.append(key, parameters[key as keyof typeof parameters]));
+      const response = await get<{ success: boolean; data: T[] }>(url.href, this.headers(parameters.selectedAddress));
+      return response.success ? response.data : [];
+    } catch (error) {
+      log.error("unable to fetch etherscan tx", error);
+      return [];
+    }
+  }
+
   public async getEtherScanTokens(address: string, chainId: string): Promise<CustomTokenInfo[]> {
     const selectedAddress = address;
     const apiUrl = new URL(this.config.api);
@@ -258,7 +271,7 @@ export default class PreferencesController
         chain_id: network.chainId,
         symbol: network.ticker,
         block_explorer_url: network.blockExplorerUrl || undefined,
-        is_test_net: network.isTestNet || false,
+        is_test_net: network.isTestnet || false,
       };
       const res = await post<{ data: CustomNetworks }>(apiUrl.href, payload, this.headers(selectedAddress), { useAPIKey: true });
       await this.sync(selectedAddress);
@@ -296,7 +309,7 @@ export default class PreferencesController
         chain_id: network.chainId,
         symbol: network.ticker || undefined,
         block_explorer_url: network.blockExplorerUrl || undefined,
-        is_test_net: network.isTestNet || false,
+        is_test_net: network.isTestnet || false,
       };
       await patch(apiUrl.href, payload, this.headers(selectedAddress), { useAPIKey: true });
       await this.sync(selectedAddress);

package/src/utils/constants.ts

@@ -110,7 +110,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     rpcTarget: `https://goerli.infura.io/v3/${process.env.VITE_APP_INFURA_PROJECT_KEY}`,
     ticker: "ETH",
     tickerName: "Ethereum",
-    isTestNet: true,
+    isTestnet: true,
   },
   [SEPOLIA_CHAIN_ID]: {
     blockExplorerUrl: "https://sepolia.etherscan.io",
@@ -120,7 +120,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     rpcTarget: `https://sepolia.infura.io/v3/${process.env.VITE_APP_INFURA_PROJECT_KEY}`,
     ticker: "ETH",
     tickerName: "Ethereum",
-    isTestNet: true,
+    isTestnet: true,
   },
   [POLYGON_MUMBAI_CHAIN_ID]: {
     blockExplorerUrl: "https://mumbai.polygonscan.com",
@@ -130,7 +130,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     rpcTarget: `https://polygon-mumbai.infura.io/v3/${process.env.VITE_APP_INFURA_PROJECT_KEY}`,
     ticker: "MATIC",
     tickerName: "Matic Network Token",
-    isTestNet: true,
+    isTestnet: true,
   },
   [BSC_TESTNET_CHAIN_ID]: {
     blockExplorerUrl: "https://testnet.bscscan.com",
@@ -140,7 +140,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     rpcTarget: `https://data-seed-prebsc-1-s1.binance.org:8545`,
     ticker: "BNB",
     tickerName: "Binance Coin",
-    isTestNet: true,
+    isTestnet: true,
   },
   [AVALANCHE_TESTNET_CHAIN_ID]: {
     blockExplorerUrl: "https://testnet.snowtrace.io",
@@ -150,7 +150,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     rpcTarget: `https://api.avax-test.network/ext/bc/C/rpc`,
     ticker: "AVAX",
     tickerName: "Avalanche",
-    isTestNet: true,
+    isTestnet: true,
   },
   [ARBITRUM_TESTNET_CHAIN_ID]: {
     blockExplorerUrl: "https://testnet.arbiscan.io",
@@ -160,7 +160,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     rpcTarget: `https://arbitrum-rinkeby.infura.io/v3/${process.env.VITE_APP_INFURA_PROJECT_KEY}`,
     ticker: "ETH",
     tickerName: "Ethereum",
-    isTestNet: true,
+    isTestnet: true,
   },
   [OPTIMISM_TESTNET_CHAIN_ID]: {
     blockExplorerUrl: "https://goerli-optimism.etherscan.io",
@@ -170,7 +170,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     rpcTarget: `https://optimism-goerli.infura.io/v3/${process.env.VITE_APP_INFURA_PROJECT_KEY}`,
     ticker: "ETH",
     tickerName: "Ethereum",
-    isTestNet: true,
+    isTestnet: true,
   },
 };
 

package/src/utils/interfaces.ts

@@ -277,7 +277,6 @@ export type PollingBlockTrackerState = BaseBlockTrackerState<EthereumBlock>;
 export interface EthereumProviderConfig extends ProviderConfig {
   isErc20?: boolean;
   tokenAddress?: string;
-  isTestNet?: boolean;
   // infuraKey?: string;
 }
 

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

@@ -1,17 +0,0 @@
-declare class AbiDecoder {
-    state: {
-        savedABIs: any[];
-        methodIDs: Record<string, any>;
-    };
-    constructor(abi: any);
-    getABIs(): any[];
-    addABI(abiArray: any): void;
-    removeABI(abiArray: any): void;
-    getMethodIDs(): Record<string, any>;
-    decodeMethod(data: any): {
-        name: any;
-        params: any[];
-    };
-    decodeLogs(logs: any): any;
-}
-export default AbiDecoder;

package/src/utils/abiDecoder.ts

@@ -1,195 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-nocheck
-// TODO: fix this when working on transaction controller
-import BN from "bn.js";
-import { AbiCoder, keccak256 } from "ethers";
-
-class AbiDecoder {
-  // TODO: update any
-  state: {
-    savedABIs: any[];
-    methodIDs: Record<string, any>;
-  };
-
-  constructor(abi) {
-    this.state = {
-      savedABIs: [],
-      methodIDs: {},
-    };
-    this.addABI(abi);
-  }
-
-  getABIs() {
-    return this.state.savedABIs;
-  }
-
-  addABI(abiArray) {
-    if (Array.isArray(abiArray)) {
-      // Iterate new abi to generate method id's
-      abiArray.map((abi) => {
-        if (abi.name) {
-          const signature = keccak256(Buffer.from(`${abi.name}(${abi.inputs.map((input) => input.type).join(",")})`, "utf8"));
-          if (abi.type === "event") {
-            this.state.methodIDs[signature.slice(2)] = abi;
-          } else {
-            this.state.methodIDs[signature.slice(2, 10)] = abi;
-          }
-        }
-        return undefined;
-      });
-
-      this.state.savedABIs = [...this.state.savedABIs, ...abiArray];
-    } else {
-      throw new TypeError(`Expected ABI array, got ${typeof abiArray}`);
-    }
-  }
-
-  removeABI(abiArray) {
-    if (Array.isArray(abiArray)) {
-      // Iterate new abi to generate method id's
-      abiArray.map((abi) => {
-        if (abi.name) {
-          const signature = keccak256(Buffer.from(`${abi.name}(${abi.inputs.map((input) => input.type).join(",")})`, "utf8"));
-          if (abi.type === "event") {
-            if (this.state.methodIDs[signature.slice(2)]) {
-              delete this.state.methodIDs[signature.slice(2)];
-            }
-          } else if (this.state.methodIDs[signature.slice(2, 10)]) {
-            delete this.state.methodIDs[signature.slice(2, 10)];
-          }
-        }
-        return undefined;
-      });
-    } else {
-      throw new TypeError(`Expected ABI array, got ${typeof abiArray}`);
-    }
-  }
-
-  getMethodIDs() {
-    return this.state.methodIDs;
-  }
-
-  decodeMethod(data) {
-    const methodID = data.slice(2, 10);
-    const abiItem = this.state.methodIDs[methodID];
-    if (abiItem) {
-      const parameters = abiItem.inputs.map((item) => item.type);
-      const decoded = AbiCoder.defaultAbiCoder().decode(parameters, Buffer.from(data.slice(10), "hex"));
-
-      const returnValueData = {
-        name: abiItem.name,
-        params: [],
-      };
-
-      for (const [i, parameter] of decoded.entries()) {
-        let parsedParameter = parameter;
-        const isUint = abiItem.inputs[i].type.indexOf("uint") === 0;
-        const isInt = abiItem.inputs[i].type.indexOf("int") === 0;
-        const isAddress = abiItem.inputs[i].type.indexOf("address") === 0;
-
-        if (isUint || isInt) {
-          const isArray = Array.isArray(parameter);
-          if (isArray) {
-            parsedParameter = parameter.map((value) => new BN(value.toString(16), "hex").toString());
-          } else {
-            parsedParameter = new BN(parameter.toString(16), "hex").toString();
-          }
-        }
-
-        // Addresses returned by web3 are randomly cased so we need to standardize and lowercase all
-        if (isAddress) {
-          const isArray = Array.isArray(parameter);
-
-          if (isArray) {
-            parsedParameter = parameter.map((_) => _.toLowerCase());
-          } else {
-            parsedParameter = parameter.toLowerCase();
-          }
-        }
-
-        returnValueData.params.push({
-          name: abiItem.inputs[i].name,
-          value: parsedParameter,
-          type: abiItem.inputs[i].type,
-        });
-      }
-
-      return returnValueData;
-    }
-    return undefined;
-  }
-
-  decodeLogs(logs) {
-    return logs
-      .filter((log) => log.topics.length > 0)
-      .map((logItem) => {
-        const methodID = logItem.topics[0].slice(2);
-        const method = this.state.methodIDs[methodID];
-        if (method) {
-          const logData = logItem.data;
-          const decodedParameters = [];
-          let dataIndex = 0;
-          let topicsIndex = 1;
-
-          const dataTypes = [];
-          method.inputs.map((input) => {
-            if (!input.indexed) {
-              dataTypes.push(input.type);
-            }
-            return undefined;
-          });
-
-          const decodedData = AbiCoder.defaultAbiCoder().decode(dataTypes, logData.slice(2));
-
-          // Loop topic and data to get the params
-          method.inputs.map((parameter) => {
-            const decodedP = {
-              name: parameter.name,
-              type: parameter.type,
-              value: "",
-            };
-
-            if (parameter.indexed) {
-              decodedP.value = logItem.topics[topicsIndex];
-              topicsIndex += 1;
-            } else {
-              decodedP.value = decodedData[dataIndex];
-              dataIndex += 1;
-            }
-
-            if (parameter.type === "address") {
-              decodedP.value = decodedP.value.toLowerCase();
-              // 42 because len(0x) + 40
-              if (decodedP.value.length > 42) {
-                const toRemove = decodedP.value.length - 42;
-                const temporary = [...decodedP.value];
-                temporary.splice(2, toRemove);
-                decodedP.value = temporary.join("");
-              }
-            }
-
-            if (parameter.type === "uint256" || parameter.type === "uint8" || parameter.type === "int") {
-              // ensure to remove leading 0x for hex numbers
-              if (typeof decodedP.value === "string" && decodedP.value.startsWith("0x")) {
-                decodedP.value = new BN(decodedP.value.slice(2), 16).toString(10);
-              } else {
-                decodedP.value = new BN(decodedP.value).toString(10);
-              }
-            }
-
-            decodedParameters.push(decodedP);
-            return undefined;
-          });
-
-          return {
-            name: method.name,
-            events: decodedParameters,
-            address: logItem.address,
-          };
-        }
-        return undefined;
-      });
-  }
-}
-
-export default AbiDecoder;