@toruslabs/ethereum-controllers 5.3.4 → 5.3.6

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

@@ -2,7 +2,7 @@ import { BasePreferencesController, CustomNft, CustomToken, InitPreferencesParam
 import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
-import type { AddChainMessageParams, CustomNetworkPayload, CustomNftInfo, CustomTokenInfo, ExtendedAddressPreferences, TransactionPayload } from "../utils/interfaces";
+import type { AddChainMessageParams, CustomNetworkPayload, CustomNftInfo, CustomTokenInfo, EtherscanTransaction, ExtendedAddressPreferences, TransactionPayload } from "../utils/interfaces";
 export interface IPreferencesControllerOptions {
     config?: Partial<PreferencesConfig> & Pick<PreferencesConfig, "api" | "commonApiHost" | "signInPrefix">;
     state?: Partial<PreferencesState<ExtendedAddressPreferences>>;
@@ -24,7 +24,7 @@ export default class PreferencesController extends BasePreferencesController<Ext
     sync(address: string): Promise<boolean>;
     patchNewTx(tx: TransactionPayload, address: string): Promise<void>;
     recalculatePastTx(address?: string): void;
-    refetchEtherscanTx(address?: string): Promise<unknown[]>;
+    refetchEtherscanTx(address?: string): Promise<EtherscanTransaction[]>;
     fetchEtherscanTx<T>(parameters: {
         selectedAddress: string;
         chainId: string;

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

@@ -1,6 +1,6 @@
 import { TransactionStatus } from "@toruslabs/base-controllers";
 import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
-import { FormattedTransactionActivity, TransactionPayload } from "./interfaces";
+import { EtherscanTransaction, FormattedTransactionActivity, TransactionPayload } from "./interfaces";
 export declare function getEtherScanHashLink(txHash: string, chainId: string): string;
 export declare const formatPastTx: (x: TransactionPayload, lowerCaseSelectedAddress?: string) => FormattedTransactionActivity;
 /**
@@ -22,3 +22,4 @@ export declare function bnLessThan(a: string | number, b: string | number): bool
 export declare const getIpfsEndpoint: (path: string) => string;
 export declare function sanitizeNftMetdataUrl(url: string): string;
 export declare function getChainType(chainId: string): "mainnet" | "testnet" | "custom";
+export declare const addEtherscanTransactions: (txn: EtherscanTransaction[], lowerCaseSelectedAddress: string, provider: SafeEventEmitterProvider, chainId: string) => Promise<any[]>;

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

@@ -330,6 +330,10 @@ export interface TransactionPayload {
     is_cancel: boolean;
     contract_address?: string;
     from_aa_address?: string;
+    isEtherscan?: boolean;
+    token_id?: string;
+    input?: string;
+    etherscanLink?: string;
 }
 export interface FetchedTransaction extends TransactionPayload {
     id: string;
@@ -379,6 +383,7 @@ export interface ExtendedAddressPreferences extends AddressPreferences {
     formattedPastTransactions?: FormattedTransactionActivity[];
     paymentTx: FetchCommonTransaction[];
     customNetworks: CustomNetworks[];
+    etherscanTransactions?: FormattedTransactionActivity[];
 }
 export interface ProviderChangeChannelEventData {
     newNetwork: EthereumProviderConfig;
@@ -404,3 +409,32 @@ export interface DecryptMessageParams extends BaseRequestParams {
 export interface DecryptMessage extends AbstractMessage {
     messageParams: DecryptMessageParams;
 }
+export interface EtherscanTransaction {
+    blockNumber: string;
+    timeStamp: string;
+    hash: string;
+    nonce: string;
+    blockHash: string;
+    transactionIndex: string;
+    from: string;
+    to: string;
+    value: string;
+    gas: string;
+    gasPrice: string;
+    isError: string;
+    txreceipt_status: string;
+    input: string;
+    contractAddress: string;
+    cumulativeGasUsed: string;
+    gasUsed: string;
+    confirmations: string;
+    methodId: string;
+    functionName: string;
+    transaction_category: string;
+    type_name: string;
+    type: string;
+    type_image_link: string;
+    chainId: string;
+    tokenSymbol: string;
+    tokenID: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toruslabs/ethereum-controllers",
-  "version": "5.3.4",
+  "version": "5.3.6",
   "homepage": "https://github.com/torusresearch/controllers#readme",
   "license": "ISC",
   "main": "dist/ethereumControllers.cjs.js",
@@ -24,7 +24,7 @@
     "@ethereumjs/util": "^9.0.1",
     "@metamask/eth-sig-util": "^7.0.1",
     "@metamask/rpc-errors": "^6.1.0",
-    "@toruslabs/base-controllers": "^5.3.3",
+    "@toruslabs/base-controllers": "^5.3.6",
     "@toruslabs/http-helpers": "^6.0.0",
     "@toruslabs/openlogin-jrpc": "^6.2.8",
     "async-mutex": "^0.4.1",
@@ -64,7 +64,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "475a9fbc714cf8ae618673fc15719d9d73d305be",
+  "gitHead": "2e5a28f0076f491fc67f5c837ee3c0acac66aa8c",
   "devDependencies": {
     "@nomicfoundation/hardhat-toolbox": "^4.0.0",
     "hardhat": "^2.19.4"

package/src/Preferences/PreferencesController.ts

@@ -18,7 +18,7 @@ import log from "loglevel";
 import KeyringController from "../Keyring/KeyringController";
 import NetworkController from "../Network/NetworkController";
 import { ETHERSCAN_SUPPORTED_CHAINS, SUPPORTED_NETWORKS } from "../utils/constants";
-import { formatDate, formatPastTx, formatTime, getEthTxStatus } from "../utils/helpers";
+import { addEtherscanTransactions, formatDate, formatPastTx, formatTime, getEthTxStatus } from "../utils/helpers";
 import type {
   AddChainMessageParams,
   CustomNetworkPayload,
@@ -27,6 +27,7 @@ import type {
   CustomTokenInfo,
   EthereumProviderConfig,
   EthereumUser,
+  EtherscanTransaction,
   ExtendedAddressPreferences,
   FetchedTransaction,
   FormattedTransactionActivity,
@@ -57,7 +58,12 @@ export default class PreferencesController
   private provider: SafeEventEmitterProvider;
 
   constructor({ config, state, provider, signAuthMessage, getProviderConfig, setProviderConfig }: IPreferencesControllerOptions) {
-    super({ config, state, defaultPreferences: { formattedPastTransactions: [], fetchedPastTx: [], paymentTx: [] }, signAuthMessage });
+    super({
+      config,
+      state,
+      defaultPreferences: { formattedPastTransactions: [], fetchedPastTx: [], paymentTx: [], etherscanTransactions: [] },
+      signAuthMessage,
+    });
     this.provider = provider;
     this.getProviderConfig = getProviderConfig;
     this.setProviderConfig = setProviderConfig;
@@ -81,7 +87,7 @@ export default class PreferencesController
 
   public async initPreferences(params: InitPreferencesParams): Promise<void> {
     const { address, jwtToken, calledFromEmbed, userInfo, rehydrate, locale = "en-US", type, signatures, web3AuthClientId, web3AuthNetwork } = params;
-    await super.init({ address, userInfo, idToken: jwtToken, type, metadata: { email: userInfo.email, signatures } });
+    await super.init({ address, userInfo, idToken: jwtToken, type, metadata: { email: userInfo.email, signatures, network: web3AuthNetwork } });
     const { aggregateVerifier, verifier, verifierId } = userInfo || {};
     const userExists = await this.sync(address);
     if (!userExists) {
@@ -204,7 +210,13 @@ export default class PreferencesController
     if (this.getAddressState(selectedAddress)?.jwtToken) {
       const { chainId } = this.getProviderConfig();
       if (ETHERSCAN_SUPPORTED_CHAINS.includes(chainId)) {
-        return this.fetchEtherscanTx({ selectedAddress, chainId: this.getProviderConfig().chainId });
+        const etherscanTxn = await this.fetchEtherscanTx<EtherscanTransaction>({
+          selectedAddress,
+          chainId: this.getProviderConfig().chainId,
+        });
+        const finalEthScanTxn = await addEtherscanTransactions(etherscanTxn, selectedAddress, this.provider, chainId);
+        this.updateState({ etherscanTransactions: finalEthScanTxn });
+        return etherscanTxn;
       }
     }
   }
@@ -214,6 +226,7 @@ export default class PreferencesController
       const url = new URL(`${this.config.api}/etherscan`);
       url.searchParams.append("chainId", parameters.chainId);
       const response = await get<{ success: boolean; data: T[] }>(url.href, this.headers(parameters.selectedAddress));
+      log.info("Etherscan Response", response);
       return response.success ? response.data : [];
     } catch (error) {
       log.error("unable to fetch etherscan tx", error);

package/src/utils/constants.ts

@@ -63,7 +63,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     blockExplorerUrl: "https://bscscan.com",
     chainId: BSC_MAINNET_CHAIN_ID,
     displayName: "Binance Smart Chain (BSC)",
-    logo: "bnb_logo.png",
+    logo: "bnb_logo.svg",
     rpcTarget: `https://bsc-dataseed.binance.org`,
     ticker: "BNB",
     tickerName: "Binance Coin",
@@ -118,7 +118,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     blockExplorerUrl: "https://gnosis.blockscout.com",
     chainId: XDAI_CHAIN_ID,
     displayName: "xDai",
-    logo: "xdai.svg",
+    logo: "xDai.svg",
     rpcTarget: `https://rpc.gnosischain.com`,
     ticker: "DAI",
     tickerName: "xDai Token",
@@ -164,7 +164,7 @@ export const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig> = {
     blockExplorerUrl: "https://testnet.bscscan.com",
     chainId: BSC_TESTNET_CHAIN_ID,
     displayName: "Binance Smart Chain Testnet",
-    logo: "bnb_logo.png",
+    logo: "bnb_logo.svg",
     rpcTarget: `https://data-seed-prebsc-1-s1.binance.org:8545`,
     ticker: "BNB",
     tickerName: "Binance Coin",

package/src/utils/helpers.ts

@@ -9,18 +9,21 @@ import {
 } from "@toruslabs/base-controllers";
 import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
 import BigNumber from "bignumber.js";
+import { formatEther } from "ethers";
 import log from "loglevel";
 
+import { determineTransactionType } from "../Transaction/TransactionUtils";
 import {
   CONTRACT_TYPE_ERC20,
   CONTRACT_TYPE_ERC721,
   CONTRACT_TYPE_ERC1155,
+  CONTRACT_TYPE_ETH,
   MAINNET_CHAIN_ID,
   METHOD_TYPES,
   SUPPORTED_NETWORKS,
   TEST_CHAINS,
 } from "./constants";
-import { FormattedTransactionActivity, TransactionPayload, TransactionReceipt } from "./interfaces";
+import { EtherscanTransaction, FormattedTransactionActivity, TransactionParams, TransactionPayload, TransactionReceipt } from "./interfaces";
 
 export function getEtherScanHashLink(txHash: string, chainId: string) {
   if (!SUPPORTED_NETWORKS[chainId]) return "";
@@ -64,9 +67,9 @@ export const formatPastTx = (x: TransactionPayload, lowerCaseSelectedAddress?: s
     transaction_hash: x.transaction_hash,
     transaction_category: x.transaction_category,
     // TODO: // figure out how to handle these values.
-    // isEtherscan: x.isEtherscan,
-    // input: x.input || "",
-    // token_id: x.token_id || "",
+    isEtherscan: x.isEtherscan,
+    input: x.input || "",
+    token_id: x.token_id || "",
     contract_address: x.contract_address || "",
     nonce: x.nonce || "",
     is_cancel: !!x.is_cancel || false,
@@ -177,3 +180,55 @@ export function getChainType(chainId: string) {
   }
   return "custom";
 }
+
+export const addEtherscanTransactions = async (
+  txn: EtherscanTransaction[],
+  lowerCaseSelectedAddress: string,
+  provider: SafeEventEmitterProvider,
+  chainId: string
+) => {
+  const transactionPromises = await Promise.all(
+    txn.map(async (tx: EtherscanTransaction) => {
+      const { category, type } = await determineTransactionType({ ...tx, data: tx.input } as TransactionParams, provider);
+      tx.transaction_category = tx.transaction_category || category;
+      tx.type_image_link = SUPPORTED_NETWORKS[chainId]?.logo || "";
+      tx.type_name = SUPPORTED_NETWORKS[chainId]?.ticker;
+      tx.type = type;
+      return tx;
+    })
+  );
+
+  const finalTxs = transactionPromises.reduce((accumulator, x) => {
+    const totalAmount = x.value ? formatEther(x.value) : "";
+    const etherscanTransaction: TransactionPayload = {
+      etherscanLink: getEtherScanHashLink(x.hash, chainId),
+      type: x.type || SUPPORTED_NETWORKS[chainId]?.ticker || CONTRACT_TYPE_ETH,
+      type_image_link: x.type_image_link || "n/a",
+      type_name: x.type_name || "n/a",
+      symbol: SUPPORTED_NETWORKS[chainId]?.ticker,
+      token_id: x.tokenID || "",
+      total_amount: totalAmount,
+      created_at: new Date(Number(x.timeStamp) * 1000),
+      from: x.from,
+      to: x.to,
+      transaction_hash: x.hash,
+      status: x.txreceipt_status && x.txreceipt_status === "0" ? TransactionStatus.failed : TransactionStatus.approved,
+      isEtherscan: true,
+      input: x.input,
+      contract_address: x.contractAddress,
+      transaction_category: x.transaction_category,
+      gas: x.gas,
+      gasPrice: x.gasPrice,
+      chain_id: chainId,
+      currency_amount: "",
+      nonce: x.nonce,
+      from_aa_address: "",
+      is_cancel: false,
+      selected_currency: "",
+    };
+    accumulator.push(formatPastTx(etherscanTransaction, lowerCaseSelectedAddress));
+    return accumulator;
+  }, []);
+
+  return finalTxs;
+};

package/src/utils/interfaces.ts

@@ -394,6 +394,10 @@ export interface TransactionPayload {
   is_cancel: boolean;
   contract_address?: string;
   from_aa_address?: string;
+  isEtherscan?: boolean;
+  token_id?: string;
+  input?: string;
+  etherscanLink?: string;
 }
 
 export interface FetchedTransaction extends TransactionPayload {
@@ -447,6 +451,7 @@ export interface ExtendedAddressPreferences extends AddressPreferences {
   formattedPastTransactions?: FormattedTransactionActivity[];
   paymentTx: FetchCommonTransaction[];
   customNetworks: CustomNetworks[];
+  etherscanTransactions?: FormattedTransactionActivity[];
 }
 
 export interface ProviderChangeChannelEventData {
@@ -479,3 +484,33 @@ export interface DecryptMessageParams extends BaseRequestParams {
 export interface DecryptMessage extends AbstractMessage {
   messageParams: DecryptMessageParams;
 }
+
+export interface EtherscanTransaction {
+  blockNumber: string;
+  timeStamp: string;
+  hash: string;
+  nonce: string;
+  blockHash: string;
+  transactionIndex: string;
+  from: string;
+  to: string;
+  value: string;
+  gas: string;
+  gasPrice: string;
+  isError: string;
+  txreceipt_status: string;
+  input: string;
+  contractAddress: string;
+  cumulativeGasUsed: string;
+  gasUsed: string;
+  confirmations: string;
+  methodId: string;
+  functionName: string;
+  transaction_category: string;
+  type_name: string;
+  type: string;
+  type_image_link: string;
+  chainId: string;
+  tokenSymbol: string;
+  tokenID: string;
+}