@ledgerhq/coin-filecoin/src/test/speculos-deviceActions.ts

Ledger Filecoin Coin integration

import type { DeviceAction } from "@ledgerhq/coin-framework/bot/types";
import type { Transaction } from "../types";
import {
  deviceActionFlow,
  formatDeviceAmount,
  SpeculosButton,
} from "@ledgerhq/coin-framework/bot/specs";
import {
  BotScenario,
  expectedToFieldForTokenTransfer,
  Methods,
  methodToString,
} from "../bridge/utils";
import { isFilEthAddress } from "../network";
import { fromEthAddress, fromString, toEthAddress } from "iso-filecoin/address";
import { getSubAccount } from "../common-logic";
import invariant from "invariant";

export const generateDeviceActionFlow = (scenario: BotScenario): DeviceAction<Transaction, any> => {
  const data: Parameters<typeof deviceActionFlow<Transaction>>[0] = { steps: [] };
  data.steps = data.steps.concat([
    {
      title: "Please",
      button: SpeculosButton.RIGHT,
    },
  ]);
  if (scenario == BotScenario.F4_RECIPIENT) {
    data.steps.push({
      title: "To",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ transaction }) => {
        const addr = fromString(transaction.recipient);
        if (isFilEthAddress(addr)) {
          return toEthAddress(addr) + transaction.recipient;
        }
        return "unexpected flow... address should be eth type";
      },
    });
  } else if (scenario == BotScenario.ETH_RECIPIENT) {
    data.steps.push({
      title: "To",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ transaction }) => {
        const addr = fromEthAddress(transaction.recipient, "mainnet");
        return transaction.recipient + addr.toString();
      },
    });
  } else if (scenario == BotScenario.TOKEN_TRANSFER) {
    data.steps.push({
      title: "To",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ transaction }) => {
        return expectedToFieldForTokenTransfer(transaction.recipient);
      },
    });
  } else {
    data.steps.push({
      title: "To",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ transaction }) => transaction.recipient,
    });
  }

  data.steps = data.steps.concat([
    {
      title: "From",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ account }) => account.freshAddress,
    },
    {
      title: "Nonce",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ transaction }) => transaction.nonce.toString(),
    },
  ]);

  if (scenario == BotScenario.TOKEN_TRANSFER) {
    data.steps.push({
      title: "Value",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ account, transaction }) => {
        const subAccount = getSubAccount(account, transaction);
        invariant(subAccount, "subAccount is required for token transfer");

        return formatDeviceAmount(subAccount.token, transaction.amount, {
          hideCode: false,
          showAllDigits: true,
        });
      },
    });
  } else {
    data.steps.push({
      title: "Value",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ account, status }) =>
        formatDeviceAmount(account.currency, status.amount, {
          hideCode: true,
          showAllDigits: true,
        }),
    });
  }

  if (scenario === BotScenario.TOKEN_TRANSFER) {
    data.steps.push({
      title: "Gas Limit",
      button: SpeculosButton.RIGHT,
      expectedValue: ({ transaction, account }) =>
        formatDeviceAmount(account.currency, transaction.gasLimit, {
          hideCode: false,
          showAllDigits: true,
        }),
    });
  } else {
    data.steps = data.steps.concat([
      {
        title: "Gas Limit",
        button: SpeculosButton.RIGHT,
        expectedValue: ({ transaction }) => transaction.gasLimit.toFixed(),
      },
      {
        title: "Gas Premium",
        button: SpeculosButton.RIGHT,
        expectedValue: ({ account, transaction }) =>
          formatDeviceAmount(account.currency, transaction.gasPremium, {
            hideCode: true,
            showAllDigits: true,
          }),
      },
      {
        title: "Gas Fee Cap",
        button: SpeculosButton.RIGHT,
        expectedValue: ({ account, transaction }) =>
          formatDeviceAmount(account.currency, transaction.gasFeeCap, {
            hideCode: true,
            showAllDigits: true,
          }),
      },
    ]);
  }

  if (scenario == BotScenario.ETH_RECIPIENT || scenario == BotScenario.F4_RECIPIENT) {
    data.steps.push({
      title: "Method",
      button: SpeculosButton.RIGHT,
      expectedValue: () => Methods.InvokeEVM.toString(),
    });
  } else if (scenario == BotScenario.TOKEN_TRANSFER) {
    data.steps.push({
      title: "Method",
      button: SpeculosButton.RIGHT,
      expectedValue: () => methodToString(Methods.ERC20Transfer),
    });
  } else {
    data.steps.push({
      title: "Method",
      button: SpeculosButton.RIGHT,
      expectedValue: () => "Transfer",
    });
  }

  data.steps.push({
    title: "APPROVE",
    button: SpeculosButton.BOTH,
  });
  return deviceActionFlow(data);
};