@ledgerhq/coin-evm 0.5.0 → 0.5.1-next.0

package/src/__tests__/unit/logic.unit.test.ts

@@ -1,20 +1,14 @@
-import BigNumber from "bignumber.js";
-import { getEnv, setEnv } from "@ledgerhq/live-env";
-import { TokenCurrency } from "@ledgerhq/types-cryptoassets";
-import * as cryptoAssetsTokens from "@ledgerhq/cryptoassets/tokens";
 import { getCryptoCurrencyById, getTokenById } from "@ledgerhq/cryptoassets";
+import * as cryptoAssetsTokens from "@ledgerhq/cryptoassets/tokens";
+import { getEnv, setEnv } from "@ledgerhq/live-env";
+import { CryptoCurrency, TokenCurrency, Unit } from "@ledgerhq/types-cryptoassets";
+import BigNumber from "bignumber.js";
 import * as RPC_API from "../../api/node/rpc.common";
-import {
-  deepFreeze,
-  makeAccount,
-  makeNftOperation,
-  makeOperation,
-  makeTokenAccount,
-} from "../fixtures/common.fixtures";
 import {
   attachOperations,
   eip1559TransactionHasFees,
   getAdditionalLayer2Fees,
+  getDefaultFeeUnit,
   getEstimatedFees,
   getGasLimit,
   getSyncHash,
@@ -22,6 +16,15 @@ import {
   mergeSubAccounts,
   padHexString,
 } from "../../logic";
+
+import {
+  deepFreeze,
+  makeAccount,
+  makeNftOperation,
+  makeOperation,
+  makeTokenAccount,
+} from "../fixtures/common.fixtures";
+
 import {
   EvmTransactionEIP1559,
   EvmTransactionLegacy,
@@ -202,6 +205,40 @@ describe("EVM Family", () => {
       });
     });
 
+    describe("getDefaultFeeUnit", () => {
+      it("should return the unit when currency has only one", () => {
+        const expectedUnit: Unit = {
+          name: "name",
+          code: "code",
+          magnitude: 18,
+        };
+
+        const currency: Partial<CryptoCurrency> = {
+          units: [expectedUnit],
+        };
+
+        expect(getDefaultFeeUnit(currency as CryptoCurrency)).toEqual(expectedUnit);
+      });
+
+      it("should return the second unit when currency has multiple", () => {
+        const expectedUnit: Unit = {
+          name: "name",
+          code: "code",
+          magnitude: 18,
+        };
+
+        const currency: Partial<CryptoCurrency> = {
+          units: [
+            { ...expectedUnit, name: "unit0" },
+            expectedUnit,
+            { ...expectedUnit, name: "unit2" },
+          ],
+        };
+
+        expect(getDefaultFeeUnit(currency as CryptoCurrency)).toEqual(expectedUnit);
+      });
+    });
+
     describe("getAdditionalLayer2Fees", () => {
       const optimism = getCryptoCurrencyById("optimism");
       const ethereum = getCryptoCurrencyById("ethereum");

package/src/api/explorer/index.ts

@@ -14,6 +14,7 @@ export const getExplorerApi = (currency: CryptoCurrency): ExplorerApi => {
     case "etherscan":
     case "blockscout":
     case "teloscan":
+    case "klaytnfinder":
       return etherscanLikeApi;
     case "ledger":
       return ledgerExplorerApi;

package/src/api/explorer/types.ts

@@ -43,6 +43,10 @@ export const isLedgerExplorerConfig = (
  */
 export const isEtherscanLikeExplorerConfig = (
   explorerConfig: ExplorerConfig,
-): explorerConfig is ExplorerConfig & { type: "etherscan" | "blockscout" } => {
-  return ["etherscan", "blockscout"].includes(explorerConfig?.type as string);
+): explorerConfig is ExplorerConfig & {
+  type: "etherscan" | "blockscout" | "teloscan" | "klaytnfinder";
+} => {
+  return ["etherscan", "blockscout", "teloscan", "klaytnfinder"].includes(
+    explorerConfig?.type as string,
+  );
 };

package/src/api/node/rpc.common.ts

@@ -226,7 +226,7 @@ export const getBlockByHeight: NodeApi["getBlockByHeight"] = (currency, blockHei
 export const getOptimismAdditionalFees: NodeApi["getOptimismAdditionalFees"] = makeLRUCache(
   async (currency, transaction) =>
     withApi(currency, async api => {
-      if (!["optimism", "optimism_goerli"].includes(currency.id)) {
+      if (!["optimism", "optimism_goerli", "base", "base_goerli"].includes(currency.id)) {
         return new BigNumber(0);
       }
 

package/src/logic.ts

@@ -1,7 +1,7 @@
 import { ethers } from "ethers";
 import BigNumber from "bignumber.js";
-import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 import { isNFTActive } from "@ledgerhq/coin-framework/nft/support";
+import { CryptoCurrency, Unit } from "@ledgerhq/types-cryptoassets";
 import { mergeOps } from "@ledgerhq/coin-framework/bridge/jsHelpers";
 import { Account, SubAccount, Operation } from "@ledgerhq/types-live";
 import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
@@ -44,6 +44,12 @@ export const getEstimatedFees = (tx: EvmTransaction): BigNumber => {
   return tx.maxFeePerGas?.multipliedBy(gasLimit) || new BigNumber(0);
 };
 
+/**
+ * Helper to get the currency unit to be used for the fee field
+ */
+export const getDefaultFeeUnit = (currency: CryptoCurrency): Unit =>
+  currency.units.length > 1 ? currency.units[1] : currency.units[0];
+
 /**
  * Helper returning the potential additional fees necessary for layer twos
  * to settle the transaction on layer 1.
@@ -54,7 +60,9 @@ export const getAdditionalLayer2Fees = async (
 ): Promise<BigNumber | undefined> => {
   switch (currency.id) {
     case "optimism":
-    case "optimism_goerli": {
+    case "optimism_goerli":
+    case "base":
+    case "base_goerli": {
       const nodeApi = getNodeApi(currency);
       const additionalFees = await nodeApi.getOptimismAdditionalFees(currency, transaction);
       return additionalFees;

package/src/specs.ts

@@ -14,7 +14,7 @@ import {
   getCryptoCurrencyById,
   parseCurrencyUnit,
 } from "@ledgerhq/coin-framework/currencies/index";
-import { CryptoCurrencyIds } from "@ledgerhq/types-live";
+import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 import { cryptocurrenciesById } from "@ledgerhq/cryptoassets/currencies";
 import { botTest, genericTestDestination, pickSiblings } from "@ledgerhq/coin-framework/bot/specs";
 import { acceptTransaction } from "./speculos-deviceActions";
@@ -26,7 +26,7 @@ const testTimeout = 10 * 60 * 1000;
 const ETH_UNIT = { code: "ETH", name: "ETH", magnitude: 18 };
 const MBTC_UNIT = { name: "mBTC", code: "mBTC", magnitude: 5 };
 
-const minBalancePerCurrencyId: Record<CryptoCurrencyIds, BigNumber> = {
+const minBalancePerCurrencyId: Partial<Record<CryptoCurrency["id"], BigNumber>> = {
   arbitrum: parseCurrencyUnit(ETH_UNIT, "0.001"),
   arbitrum_goerli: parseCurrencyUnit(ETH_UNIT, "0.001"),
   optimism: parseCurrencyUnit(ETH_UNIT, "0.001"),
@@ -35,6 +35,10 @@ const minBalancePerCurrencyId: Record<CryptoCurrencyIds, BigNumber> = {
   metis: parseCurrencyUnit(ETH_UNIT, "0.01"),
   moonriver: parseCurrencyUnit(ETH_UNIT, "0.1"),
   rsk: parseCurrencyUnit(MBTC_UNIT, "0.05"),
+  polygon_zk_evm: parseCurrencyUnit(ETH_UNIT, "0.001"),
+  polygon_zk_evm_testnet: parseCurrencyUnit(ETH_UNIT, "0.001"),
+  base: parseCurrencyUnit(ETH_UNIT, "0.001"),
+  base_goerli: parseCurrencyUnit(ETH_UNIT, "0.001"),
 };
 
 /**
@@ -79,8 +83,12 @@ const testCoinBalance: MutationSpec<EvmTransaction>["test"] = ({
   // effectively used gas but the "bid"/proposition of gas of the transaction
   // resulting in inconsistencies regarding the cumulated value of a tx.
   // value + gasLimit * gasPrice <-- gasPrice can be wrong here.
-  const underValuedFeesCurrencies = ["optimism", "optimism_goerli"];
-  const overValuedFeesCurrencies = ["arbitrum", "arbitrum_goerli"];
+  //
+  // Klaytn is not providing the right gasPrice either at the moment
+  // and their explorers are using the transaction gasPrice
+  // instead of the effectiveGasPrice from the receipt
+  const underValuedFeesCurrencies = ["optimism", "optimism_goerli", "base", "base_goerli"];
+  const overValuedFeesCurrencies = ["arbitrum", "arbitrum_goerli", "klaytn"];
   const currenciesWithFlakyBehaviour = [...underValuedFeesCurrencies, ...overValuedFeesCurrencies];
 
   // Classic test verifying exactly the balance
@@ -286,14 +294,14 @@ const evmBasicMutations: ({
 
 export default Object.values(cryptocurrenciesById)
   .filter(currency => currency.family === "evm")
-  .reduce<Record<CryptoCurrencyIds, AppSpec<EvmTransaction>>>((acc, currency) => {
+  .reduce<Partial<Record<CryptoCurrency["id"], AppSpec<EvmTransaction>>>>((acc, currency) => {
     acc[currency.id] = {
       name: currency.name,
       currency,
       appQuery: {
         model: DeviceModelId.nanoS,
         appName: "Ethereum",
-        appVersion: "1.10.2",
+        appVersion: "1.10.3",
       },
       testTimeout,
       transactionCheck: transactionCheck(currency.id),

package/src/types/transaction.ts

@@ -137,6 +137,8 @@ export type GasOptions = {
   [key in "slow" | "medium" | "fast"]: FeeData;
 };
 
+export type Strategy = keyof GasOptions;
+
 export type EvmTransactionNftParam = {
   tokenId: ProtoNFT["tokenId"];
   contract: ProtoNFT["contract"];