@toruslabs/ethereum-controllers 5.0.1 → 5.0.3

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

@@ -3,7 +3,7 @@ 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";
-interface IPreferencesControllerOptions {
+export interface IPreferencesControllerOptions {
     config?: Partial<PreferencesConfig> & Pick<PreferencesConfig, "api" | "commonApiHost" | "signInPrefix">;
     state?: Partial<PreferencesState<ExtendedAddressPreferences>>;
     provider: SafeEventEmitterProvider;
@@ -38,8 +38,7 @@ export default class PreferencesController extends BasePreferencesController<Ext
     switchChain(data: {
         chainId: string;
     }): void;
-    addCustomNetwork({ type, network }: {
-        type: string;
+    addCustomNetwork({ network }: {
         network: CustomNetworkPayload;
     }): Promise<number>;
     deleteCustomNetwork(id: number): Promise<boolean>;
@@ -51,4 +50,3 @@ export default class PreferencesController extends BasePreferencesController<Ext
     private calculatePastTx;
     private cancelTxCalculate;
 }
-export {};

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

@@ -265,12 +265,13 @@ export interface CustomNetworks {
     network_name: string;
     public_address: string;
     chain_id: string;
-    type: string;
     rpc_url: string;
-    deleted: boolean;
     symbol?: string;
+    symbol_name?: string;
+    decimals?: string;
+    logo?: string;
     block_explorer_url?: string;
-    is_test_net?: boolean;
+    is_testnet?: boolean;
 }
 export interface EthereumUser extends User {
     customNetworks: CustomNetworks[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toruslabs/ethereum-controllers",
-  "version": "5.0.1",
+  "version": "5.0.3",
   "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.0.0",
+    "@toruslabs/base-controllers": "^5.0.3",
     "@toruslabs/http-helpers": "^6.0.0",
     "@toruslabs/openlogin-jrpc": "^6.1.0",
     "async-mutex": "^0.4.0",
@@ -64,7 +64,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4da373abb1bbcc3be55cba412a3e3f5931f47f06",
+  "gitHead": "106d19ac996998cf3199edca74f7afb907a0b6ae",
   "devDependencies": {
     "@nomicfoundation/hardhat-toolbox": "^4.0.0",
     "hardhat": "^2.19.3"

package/src/Preferences/PreferencesController.ts

@@ -33,7 +33,7 @@ import type {
   TransactionPayload,
 } from "../utils/interfaces";
 
-interface IPreferencesControllerOptions {
+export interface IPreferencesControllerOptions {
   config?: Partial<PreferencesConfig> & Pick<PreferencesConfig, "api" | "commonApiHost" | "signInPrefix">;
   state?: Partial<PreferencesState<ExtendedAddressPreferences>>;
   provider: SafeEventEmitterProvider;
@@ -211,7 +211,6 @@ export default class PreferencesController
 
   async fetchEtherscanTx<T>(parameters: { selectedAddress: string; chainId: string }): Promise<T[]> {
     try {
-      // TODO: rewrite this api to use chainId
       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));
@@ -270,9 +269,11 @@ export default class PreferencesController
       ticker: network.nativeCurrency.symbol,
       chainId: network.chainId,
       blockExplorerUrl: network.blockExplorerUrls[0],
+      tickerName: network.nativeCurrency.name,
+      logo: network.nativeCurrency.symbol,
     };
 
-    const isSuccess = await this.addCustomNetwork({ type: "rpc", network: newNetwork });
+    const isSuccess = await this.addCustomNetwork({ network: newNetwork });
     if (!isSuccess) throw new Error("unable to add custom network");
   }
 
@@ -287,18 +288,20 @@ export default class PreferencesController
   }
 
   // Custom Network methods
-  public async addCustomNetwork({ type, network }: { type: string; network: CustomNetworkPayload }): Promise<number> {
+  public async addCustomNetwork({ network }: { network: CustomNetworkPayload }): Promise<number> {
     try {
       const apiUrl = new URL(this.config.api);
-      apiUrl.pathname = `/customnetwork/${type}`;
+      apiUrl.pathname = `/customnetwork`;
       const { selectedAddress } = this.state;
-      const payload = {
+      const payload: Partial<CustomNetworks> = {
         network_name: network.displayName,
         rpc_url: network.rpcTarget,
         chain_id: network.chainId,
         symbol: network.ticker,
         block_explorer_url: network.blockExplorerUrl || undefined,
-        is_test_net: network.isTestnet || false,
+        is_testnet: network.isTestnet || false,
+        logo: network.logo,
+        symbol_name: network.tickerName,
       };
       const res = await post<{ data: CustomNetworks }>(apiUrl.href, payload, this.headers(selectedAddress), { useAPIKey: true });
       await this.sync(selectedAddress);
@@ -330,13 +333,13 @@ export default class PreferencesController
       const apiUrl = new URL(this.config.api);
       apiUrl.pathname = `/customnetwork/${id}`;
 
-      const payload = {
+      const payload: Partial<CustomNetworks> = {
         network_name: network.displayName,
         rpc_url: network.rpcTarget,
         chain_id: network.chainId,
         symbol: network.ticker || undefined,
         block_explorer_url: network.blockExplorerUrl || undefined,
-        is_test_net: network.isTestnet || false,
+        is_testnet: network.isTestnet || false,
       };
       await patch(apiUrl.href, payload, this.headers(selectedAddress), { useAPIKey: true });
       await this.sync(selectedAddress);

package/src/utils/interfaces.ts

@@ -323,12 +323,13 @@ export interface CustomNetworks {
   network_name: string;
   public_address: string;
   chain_id: string;
-  type: string;
   rpc_url: string;
-  deleted: boolean;
   symbol?: string;
+  symbol_name?: string;
+  decimals?: string;
+  logo?: string;
   block_explorer_url?: string;
-  is_test_net?: boolean;
+  is_testnet?: boolean;
 }
 
 export interface EthereumUser extends User {