@ledgerhq/coin-evm 0.2.1 → 0.2.2-nightly.0

package/src/bridge/js.ts

@@ -1,34 +1,36 @@
 import getAddressWrapper from "@ledgerhq/coin-framework/bridge/getAddressWrapper";
 import {
-  DeviceCommunication,
   makeAccountBridgeReceive,
   makeScanAccounts,
 } from "@ledgerhq/coin-framework/bridge/jsHelpers";
+import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import type { AccountBridge, CurrencyBridge } from "@ledgerhq/types-live";
 import { broadcast } from "../broadcast";
 import { createTransaction } from "../createTransaction";
 import { estimateMaxSpendable } from "../estimateMaxSpendable";
 import { getTransactionStatus } from "../getTransactionStatus";
-import getAddress from "../hw-getAddress";
+import resolver from "../hw-getAddress";
 import { hydrate, preload } from "../preload";
 import { prepareTransaction } from "../prepareTransaction";
 import { buildSignOperation } from "../signOperation";
 import { getAccountShape, sync } from "../synchronization";
+import { EvmAddress, EvmSignature, EvmSigner } from "../signer";
 import type { Transaction as EvmTransaction, Transaction } from "../types";
 
 const updateTransaction: AccountBridge<EvmTransaction>["updateTransaction"] = (
   transaction,
-  patch
+  patch,
 ) => {
   return { ...transaction, ...patch } as EvmTransaction;
 };
 
 export function buildCurrencyBridge(
-  deviceCommunication: DeviceCommunication
+  signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>,
 ): CurrencyBridge {
+  const getAddress = resolver(signerContext);
+
   const scanAccounts = makeScanAccounts({
     getAccountShape,
-    deviceCommunication,
     getAddressFn: getAddress,
   });
 
@@ -40,13 +42,12 @@ export function buildCurrencyBridge(
 }
 
 export function buildAccountBridge(
-  deviceCommunication: DeviceCommunication
+  signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>,
 ): AccountBridge<Transaction> {
-  const receive = makeAccountBridgeReceive(
-    getAddressWrapper(getAddress),
-    deviceCommunication
-  );
-  const signOperation = buildSignOperation(deviceCommunication);
+  const getAddress = resolver(signerContext);
+
+  const receive = makeAccountBridgeReceive(getAddressWrapper(getAddress));
+  const signOperation = buildSignOperation(signerContext);
 
   return {
     createTransaction,
@@ -61,17 +62,9 @@ export function buildAccountBridge(
   };
 }
 
-/**
- * FIXME: unsued network and cacheFn are passed to createBridges because of how the
- * libs/ledger-live-common/scripts/sync-families-dispatch.mjs script works.
- */
-export function createBridges(
-  deviceCommunication: DeviceCommunication,
-  _network: unknown,
-  _cacheFn: unknown
-) {
+export function createBridges(signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>) {
   return {
-    currencyBridge: buildCurrencyBridge(deviceCommunication),
-    accountBridge: buildAccountBridge(deviceCommunication),
+    currencyBridge: buildCurrencyBridge(signerContext),
+    accountBridge: buildAccountBridge(signerContext),
   };
 }

package/src/bridge.integration.test.ts

@@ -1,9 +1,5 @@
 import { FeeTooHigh } from "@ledgerhq/errors";
-import type {
-  AccountRaw,
-  CurrenciesData,
-  DatasetTest,
-} from "@ledgerhq/types-live";
+import type { AccountRaw, CurrenciesData, DatasetTest } from "@ledgerhq/types-live";
 import { BigNumber } from "bignumber.js";
 import ethereumScanAccounts1 from "./datasets/ethereum.scanAccounts.1";
 import { ethereum1 } from "./datasets/ethereum1";
@@ -54,10 +50,7 @@ const ethereum: CurrenciesData<Transaction> = {
           }),
           expectedStatus: (account, _, status) => {
             return {
-              amount: BigNumber.max(
-                account.balance.minus(status.estimatedFees),
-                0
-              ),
+              amount: BigNumber.max(account.balance.minus(status.estimatedFees), 0),
               errors: {},
               warnings: {},
             };
@@ -77,7 +70,7 @@ export const dataset: DatasetTest<Transaction> = {
 
 describe("EVM bridge", () => {
   test.todo(
-    "This is an empty test to make jest command pass. Remove it once there is a real test."
+    "This is an empty test to make jest command pass. Remove it once there is a real test.",
   );
 });
 

package/src/broadcast.ts

@@ -19,20 +19,16 @@ export const broadcast: AccountBridge<EvmTransaction>["broadcast"] = async ({
     blockNumber: txResponse.blockNumber,
     blockHeight: txResponse.blockNumber,
     blockHash: txResponse.blockHash,
-    date: new Date(
-      txResponse.timestamp ? txResponse.timestamp * 1000 : Date.now()
-    ),
+    date: new Date(txResponse.timestamp ? txResponse.timestamp * 1000 : Date.now()),
     subOperations:
-      operation.subOperations?.map((subOp) => ({
+      operation.subOperations?.map(subOp => ({
         ...subOp,
         id: encodeOperationId(subOp.accountId, txResponse.hash, subOp.type),
         hash: txResponse.hash,
         blockNumber: txResponse.blockNumber,
         blockHeight: txResponse.blockNumber,
         blockHash: txResponse.blockHash,
-        date: new Date(
-          txResponse.timestamp ? txResponse.timestamp * 1000 : Date.now()
-        ),
+        date: new Date(txResponse.timestamp ? txResponse.timestamp * 1000 : Date.now()),
       })) || [],
   } as Operation;
 };

package/src/buildOptimisticOperation.ts

@@ -1,11 +1,6 @@
 import { findSubAccountById } from "@ledgerhq/coin-framework/account/index";
 import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
-import {
-  Account,
-  Operation,
-  OperationType,
-  TokenAccount,
-} from "@ledgerhq/types-live";
+import { Account, Operation, OperationType, TokenAccount } from "@ledgerhq/types-live";
 import BigNumber from "bignumber.js";
 import eip55 from "eip55";
 import { getEstimatedFees } from "./logic";
@@ -17,7 +12,7 @@ import { Transaction as EvmTransaction } from "./types";
 export const buildOptimisticCoinOperation = (
   account: Account,
   transaction: EvmTransaction,
-  transactionType?: OperationType
+  transactionType?: OperationType,
 ): Operation => {
   const type = transactionType ?? "OUT";
   const estimatedFees = getEstimatedFees(transaction);
@@ -49,13 +44,11 @@ export const buildOptimisticCoinOperation = (
 export const buildOptimisticTokenOperation = (
   account: Account,
   tokenAccount: TokenAccount,
-  transaction: EvmTransaction
+  transaction: EvmTransaction,
 ): Operation => {
   const type = "OUT";
   const estimatedFees = getEstimatedFees(transaction);
-  const value = transaction.useAllAmount
-    ? tokenAccount.balance
-    : transaction.amount;
+  const value = transaction.useAllAmount ? tokenAccount.balance : transaction.amount;
 
   const coinOperation = buildOptimisticCoinOperation(
     account,
@@ -64,7 +57,7 @@ export const buildOptimisticTokenOperation = (
       recipient: tokenAccount.token.contractAddress,
       amount: new BigNumber(0),
     },
-    "FEES"
+    "FEES",
   );
   // keys marked with a <-- will be updated by the broadcast method
   const operation: Operation = {
@@ -97,12 +90,9 @@ export const buildOptimisticTokenOperation = (
  */
 export const buildOptimisticOperation = (
   account: Account,
-  transaction: EvmTransaction
+  transaction: EvmTransaction,
 ): Operation => {
-  const subAccount = findSubAccountById(
-    account,
-    transaction?.subAccountId || ""
-  );
+  const subAccount = findSubAccountById(account, transaction?.subAccountId || "");
   const isTokenTransaction = subAccount?.type === "TokenAccount";
 
   return isTokenTransaction

package/src/cli-transaction.ts

@@ -1,11 +1,5 @@
-import { NetworkRequestCall } from "@ledgerhq/coin-framework/network";
-import { LRUCacheFn } from "@ledgerhq/coin-framework/cache";
-
 // Needed by sync-families-dispatch script
 // libs/ledger-live-common/scripts/sync-families-dispatch.mjs
-export default function makeCliTools(
-  _network: NetworkRequestCall,
-  _cache: LRUCacheFn
-) {
+export default function makeCliTools() {
   return {};
 }

package/src/createTransaction.ts

@@ -8,18 +8,17 @@ import { DEFAULT_GAS_LIMIT } from "./transaction";
  * By default the transaction is an EIP-1559 transaction.
  * @see prepareTransaction that will make sure it's compatible or not
  */
-export const createTransaction: AccountBridge<EvmTransaction>["createTransaction"] =
-  (account) => ({
-    family: "evm",
-    mode: "send",
-    amount: new BigNumber(0),
-    useAllAmount: false,
-    recipient: "",
-    maxFeePerGas: new BigNumber(0),
-    maxPriorityFeePerGas: new BigNumber(0),
-    gasLimit: DEFAULT_GAS_LIMIT,
-    nonce: account.operationsCount + 1,
-    chainId: (account as Account).currency?.ethereumLikeInfo?.chainId || 0,
-    feesStrategy: "medium",
-    type: 2,
-  });
+export const createTransaction: AccountBridge<EvmTransaction>["createTransaction"] = account => ({
+  family: "evm",
+  mode: "send",
+  amount: new BigNumber(0),
+  useAllAmount: false,
+  recipient: "",
+  maxFeePerGas: new BigNumber(0),
+  maxPriorityFeePerGas: new BigNumber(0),
+  gasLimit: DEFAULT_GAS_LIMIT,
+  nonce: account.operationsCount + 1,
+  chainId: (account as Account).currency?.ethereumLikeInfo?.chainId || 0,
+  feesStrategy: "medium",
+  type: 2,
+});

package/src/deviceTransactionConfig.ts

@@ -48,7 +48,7 @@ function getDeviceTransactionConfig({
           type: "text",
           label: "Network",
           value: mainAccount.currency.name,
-        }
+        },
       );
       break;
   }

package/src/errors.ts

@@ -3,3 +3,9 @@ import { createCustomErrorClass } from "@ledgerhq/errors";
 export const EtherscanAPIError = createCustomErrorClass("EtherscanAPIError");
 export const GasEstimationError = createCustomErrorClass("GasEstimationError");
 export const InsufficientFunds = createCustomErrorClass("InsufficientFunds");
+
+// GasTracker errors
+export const NoGasTrackerFound = createCustomErrorClass("NoGasTrackerFound");
+export const GasTrackerDoesNotSupportEIP1559 = createCustomErrorClass(
+  "GasTrackerDoesNotSupportEIP1559",
+);

package/src/estimateMaxSpendable.ts

@@ -4,16 +4,19 @@ import { createTransaction } from "./createTransaction";
 import { prepareTransaction } from "./prepareTransaction";
 import { Transaction as EvmTransaction } from "./types";
 
-export const estimateMaxSpendable: AccountBridge<EvmTransaction>["estimateMaxSpendable"] =
-  async ({ account, parentAccount, transaction }) => {
-    const mainAccount = getMainAccount(account, parentAccount);
-    const estimatedTx = {
-      ...createTransaction(mainAccount),
-      ...transaction,
-      useAllAmount: true,
-    } as EvmTransaction;
+export const estimateMaxSpendable: AccountBridge<EvmTransaction>["estimateMaxSpendable"] = async ({
+  account,
+  parentAccount,
+  transaction,
+}) => {
+  const mainAccount = getMainAccount(account, parentAccount);
+  const estimatedTx = {
+    ...createTransaction(mainAccount),
+    ...transaction,
+    useAllAmount: true,
+  } as EvmTransaction;
 
-    const { amount } = await prepareTransaction(mainAccount, estimatedTx);
+  const { amount } = await prepareTransaction(mainAccount, estimatedTx);
 
-    return amount;
-  };
+  return amount;
+};

package/src/getTransactionStatus.ts

@@ -13,11 +13,7 @@ import { ethers } from "ethers";
 import BigNumber from "bignumber.js";
 import { Account, AccountBridge, SubAccount } from "@ledgerhq/types-live";
 import { findSubAccountById } from "@ledgerhq/coin-framework/account/index";
-import {
-  eip1559TransactionHasFees,
-  getEstimatedFees,
-  legacyTransactionHasFees,
-} from "./logic";
+import { eip1559TransactionHasFees, getEstimatedFees, legacyTransactionHasFees } from "./logic";
 import {
   EvmTransactionEIP1559,
   EvmTransactionLegacy,
@@ -40,7 +36,7 @@ const ethAddressRegEx = /^(0x)?[0-9a-fA-F]{40}$/;
  */
 export const validateRecipient = (
   account: Account,
-  tx: EvmTransaction
+  tx: EvmTransaction,
 ): Array<ValidationIssues> => {
   const errors: ValidationIssues = {};
   const warnings: ValidationIssues = {};
@@ -79,7 +75,7 @@ export const validateRecipient = (
 export const validateAmount = (
   account: Account | SubAccount,
   transaction: EvmTransaction,
-  totalSpent: BigNumber
+  totalSpent: BigNumber,
 ): Array<ValidationIssues> => {
   const errors: ValidationIssues = {};
   const warnings: ValidationIssues = {};
@@ -92,10 +88,7 @@ export const validateAmount = (
   const canHaveZeroAmount = isSmartContractInteraction && transactionHasFees;
 
   // if no amount or 0
-  if (
-    (!transaction.amount || transaction.amount.isZero()) &&
-    !canHaveZeroAmount
-  ) {
+  if ((!transaction.amount || transaction.amount.isZero()) && !canHaveZeroAmount) {
     errors.amount = new AmountRequired(); // "Amount required"
   } else if (totalSpent.isGreaterThan(account.balance)) {
     // if not enough to make the transaction
@@ -111,7 +104,7 @@ export const validateGas = (
   account: Account,
   tx: EvmTransaction,
   gasLimit: BigNumber,
-  estimatedFees: BigNumber
+  estimatedFees: BigNumber,
 ): Array<ValidationIssues> => {
   const errors: ValidationIssues = {};
   const warnings: ValidationIssues = {};
@@ -141,46 +134,42 @@ export const validateGas = (
 /**
  * Validate a transaction and get all possibles errors and warnings about it
  */
-export const getTransactionStatus: AccountBridge<EvmTransaction>["getTransactionStatus"] =
-  async (account, tx) => {
-    const subAccount = findSubAccountById(account, tx.subAccountId || "");
-    const isTokenTransaction = subAccount?.type === "TokenAccount";
-    const { gasLimit, additionalFees, amount } = tx;
-    const estimatedFees = getEstimatedFees(tx);
-    const totalFees = estimatedFees.plus(additionalFees || 0);
-    const totalSpent = isTokenTransaction
-      ? tx.amount
-      : tx.amount.plus(totalFees);
-
-    // Recipient related errors and warnings
-    const [recipientErr, recipientWarn] = validateRecipient(account, tx);
-    // Amount related errors and warnings
-    const [amountErr, amountWarn] = validateAmount(
-      subAccount || account,
-      tx,
-      totalSpent
-    );
-    // Gas related errors and warnings
-    const [gasErr, gasWarn] = validateGas(account, tx, gasLimit, totalFees);
-
-    const errors: ValidationIssues = {
-      ...recipientErr,
-      ...gasErr,
-      ...amountErr,
-    };
-    const warnings: ValidationIssues = {
-      ...recipientWarn,
-      ...gasWarn,
-      ...amountWarn,
-    };
-
-    return {
-      errors,
-      warnings,
-      estimatedFees,
-      amount,
-      totalSpent,
-    };
+export const getTransactionStatus: AccountBridge<EvmTransaction>["getTransactionStatus"] = async (
+  account,
+  tx,
+) => {
+  const subAccount = findSubAccountById(account, tx.subAccountId || "");
+  const isTokenTransaction = subAccount?.type === "TokenAccount";
+  const { gasLimit, additionalFees, amount } = tx;
+  const estimatedFees = getEstimatedFees(tx);
+  const totalFees = estimatedFees.plus(additionalFees || 0);
+  const totalSpent = isTokenTransaction ? tx.amount : tx.amount.plus(totalFees);
+
+  // Recipient related errors and warnings
+  const [recipientErr, recipientWarn] = validateRecipient(account, tx);
+  // Amount related errors and warnings
+  const [amountErr, amountWarn] = validateAmount(subAccount || account, tx, totalSpent);
+  // Gas related errors and warnings
+  const [gasErr, gasWarn] = validateGas(account, tx, gasLimit, totalFees);
+
+  const errors: ValidationIssues = {
+    ...recipientErr,
+    ...gasErr,
+    ...amountErr,
   };
+  const warnings: ValidationIssues = {
+    ...recipientWarn,
+    ...gasWarn,
+    ...amountWarn,
+  };
+
+  return {
+    errors,
+    warnings,
+    estimatedFees,
+    amount,
+    totalSpent,
+  };
+};
 
 export default getTransactionStatus;

package/src/hw-getAddress.ts

@@ -1,24 +1,23 @@
-import type { Resolver } from "@ledgerhq/coin-framework/bridge/getAddressWrapper";
-import Eth from "@ledgerhq/hw-app-eth";
 import eip55 from "eip55";
+import { GetAddressFn } from "@ledgerhq/coin-framework/bridge/getAddressWrapper";
+import { SignerContext } from "@ledgerhq/coin-framework/signer";
+import { GetAddressOptions } from "@ledgerhq/coin-framework/derivation";
+import { EvmAddress, EvmSignature, EvmSigner } from "./signer";
 
-/**
- * Eth app binding request for the address
- */
-const getAddress: Resolver = async (transport, { path, verify }) => {
-  const ethBindings = new Eth(transport);
-  const { address, publicKey, chainCode } = await ethBindings.getAddress(
-    path,
-    verify,
-    false
-  );
-
-  return {
-    address: eip55.encode(address),
-    publicKey,
-    chainCode,
-    path,
+const resolver = (
+  signerContext: SignerContext<EvmSigner, EvmAddress | EvmSignature>,
+): GetAddressFn => {
+  return async (deviceId: string, { path, verify }: GetAddressOptions) => {
+    const { address, publicKey, chainCode } = (await signerContext(deviceId, signer =>
+      signer.getAddress(path, verify, false),
+    )) as EvmAddress;
+    return {
+      address: eip55.encode(address),
+      publicKey,
+      chainCode,
+      path,
+    };
   };
 };
 
-export default getAddress;
+export default resolver;

package/src/logic.ts

@@ -4,7 +4,7 @@ import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 import { mergeOps } from "@ledgerhq/coin-framework/bridge/jsHelpers";
 import { Account, SubAccount } from "@ledgerhq/types-live";
 import { listTokensForCryptoCurrency } from "@ledgerhq/cryptoassets/tokens";
-import { getOptimismAdditionalFees } from "./api/rpc.common";
+import { getOptimismAdditionalFees } from "./api/rpc/rpc.common";
 import {
   Transaction as EvmTransaction,
   EvmTransactionEIP1559,
@@ -39,15 +39,12 @@ export const getEstimatedFees = (tx: EvmTransaction): BigNumber => {
  */
 export const getAdditionalLayer2Fees = async (
   currency: CryptoCurrency,
-  transaction: EvmTransaction
+  transaction: EvmTransaction,
 ): Promise<BigNumber | undefined> => {
   switch (currency.id) {
     case "optimism":
     case "optimism_goerli": {
-      const additionalFees = await getOptimismAdditionalFees(
-        currency,
-        transaction
-      );
+      const additionalFees = await getOptimismAdditionalFees(currency, transaction);
       return additionalFees;
     }
     default:
@@ -72,7 +69,7 @@ const updatableSubAccountProperties: { name: string; isOps: boolean }[] = [
  */
 export const mergeSubAccounts = (
   initialAccount: Account | undefined,
-  newSubAccounts: Partial<SubAccount>[]
+  newSubAccounts: Partial<SubAccount>[],
 ): Array<Partial<SubAccount> | SubAccount> => {
   const oldSubAccounts: Array<Partial<SubAccount> | SubAccount> | undefined =
     initialAccount?.subAccounts;
@@ -135,14 +132,7 @@ export const mergeSubAccounts = (
 export const getSyncHash = (currency: CryptoCurrency): string => {
   const tokens = listTokensForCryptoCurrency(currency);
   const basicTokensListString = tokens
-    .map(
-      (token) =>
-        token.id +
-        token.contractAddress +
-        token.name +
-        token.ticker +
-        token.delisted
-    )
+    .map(token => token.id + token.contractAddress + token.name + token.ticker + token.delisted)
     .join("");
 
   return ethers.utils.sha256(Buffer.from(basicTokensListString));

package/src/preload.ts

@@ -7,24 +7,18 @@ import network from "@ledgerhq/live-network/network";
 import { getEnv } from "@ledgerhq/live-env";
 
 export const fetchERC20Tokens: (
-  currency: CryptoCurrency
-) => Promise<ERC20Token[]> = async (currency) => {
+  currency: CryptoCurrency,
+) => Promise<ERC20Token[]> = async currency => {
   const { ethereumLikeInfo } = currency;
 
-  const url = `${getEnv("DYNAMIC_CAL_BASE_URL")}/evm/${
-    ethereumLikeInfo?.chainId || 0
-  }/erc20.json`;
+  const url = `${getEnv("DYNAMIC_CAL_BASE_URL")}/evm/${ethereumLikeInfo?.chainId || 0}/erc20.json`;
   const dynamicTokens: ERC20Token[] | null = await network({
     method: "GET",
     url,
   })
     .then(({ data }: { data: ERC20Token[] }) => (data.length ? data : null))
-    .catch((e) => {
-      log(
-        "error",
-        "EVM Family: Couldn't fetch dynamic CAL tokens from " + url,
-        e
-      );
+    .catch(e => {
+      log("error", "EVM Family: Couldn't fetch dynamic CAL tokens from " + url, e);
       return null;
     });
   if (dynamicTokens) return dynamicTokens;
@@ -33,11 +27,7 @@ export const fetchERC20Tokens: (
   const tokens = tokensByChainId[ethereumLikeInfo?.chainId || ""];
   if (tokens) return tokens;
 
-  log(
-    "warning",
-    `EVM Family: No tokens found in CAL for currency: ${currency.id}`,
-    currency
-  );
+  log("warning", `EVM Family: No tokens found in CAL for currency: ${currency.id}`, currency);
   return [];
 };