@ledgerhq/coin-aptos 1.4.0-next.0

package/src/test/bot-specs.ts

@@ -0,0 +1,86 @@
+import invariant from "invariant";
+import { DeviceModelId } from "@ledgerhq/devices";
+import { getCryptoCurrencyById } from "@ledgerhq/cryptoassets/currencies";
+import { parseCurrencyUnit } from "@ledgerhq/coin-framework/currencies/index";
+import { botTest, genericTestDestination, pickSiblings } from "@ledgerhq/coin-framework/bot/specs";
+import type { AppSpec } from "@ledgerhq/coin-framework/bot/types";
+import { acceptTransaction } from "./speculos-deviceActions";
+import type { Transaction } from "../types";
+
+const currency = getCryptoCurrencyById("aptos");
+const minBalanceNewAccount = parseCurrencyUnit(currency.units[0], "0.0001");
+const maxAccountSiblings = 4;
+
+const aptos: AppSpec<Transaction> = {
+  name: "Aptos",
+  currency,
+  appQuery: {
+    model: DeviceModelId.nanoSP,
+    appName: "Aptos",
+  },
+  genericDeviceAction: acceptTransaction,
+  testTimeout: 5 * 60 * 1000,
+  minViableAmount: minBalanceNewAccount,
+  transactionCheck: ({ maxSpendable }) => {
+    invariant(maxSpendable.gt(minBalanceNewAccount), "balance is too low");
+  },
+  mutations: [
+    {
+      name: "Send ~50%",
+      feature: "send",
+      maxRun: 1,
+      testDestination: genericTestDestination,
+      transaction: ({ account, siblings, bridge, maxSpendable }) => {
+        invariant(maxSpendable.gt(minBalanceNewAccount), "balance is too low");
+
+        const sibling = pickSiblings(siblings, maxAccountSiblings);
+        const recipient = sibling.freshAddress;
+        const amount = maxSpendable.div(2).integerValue();
+
+        const transaction = bridge.createTransaction(account);
+        const updates: Array<Partial<Transaction>> = [
+          {
+            recipient,
+          },
+          { amount },
+        ];
+
+        return {
+          transaction,
+          updates,
+        };
+      },
+      test: ({ account, accountBeforeTransaction, operation }) => {
+        botTest("account balance moved with operation.value", () =>
+          expect(account.balance.toString()).toBe(
+            accountBeforeTransaction.balance.minus(operation.value).toString(),
+          ),
+        );
+      },
+    },
+    {
+      name: "Send max",
+      maxRun: 2,
+      testDestination: genericTestDestination,
+      transaction: ({ account, siblings, bridge }) => {
+        const sibling = pickSiblings(siblings, 4);
+        const recipient = sibling.freshAddress;
+        const transaction = bridge.createTransaction(account);
+
+        return {
+          transaction,
+          updates: [{ recipient }, { useAllAmount: true }],
+        };
+      },
+      test: ({ account, accountBeforeTransaction, operation }) => {
+        botTest("Account balance should have decreased", () => {
+          expect(account.balance.toNumber()).toEqual(
+            accountBeforeTransaction.balance.minus(operation.value).toNumber(),
+          );
+        });
+      },
+    },
+  ],
+};
+
+export default { aptos };

package/src/test/bridgeDatasetTest.ts

@@ -0,0 +1,82 @@
+import { CurrenciesData, DatasetTest } from "@ledgerhq/types-live";
+import BigNumber from "bignumber.js";
+import { fromTransactionRaw } from "../bridge/transaction";
+import { Transaction } from "../types";
+
+const aptos: CurrenciesData<Transaction> = {
+  scanAccounts: [
+    {
+      name: "aptos seed 1",
+      apdus: `
+      => 5b0500000d038000002c8000027d80000000
+      <= 210430cfd94a543eca9ba9d26eafe07f6c28e1e43e4768f3c0bad32efeced8662f8720b44227ab88ddefa2ff5deb5e366c70e8b703aec381de39b103dd50eabf8d9d119000
+      => 5b05000015058000002c8000027d800000008000000080000000
+      <= 21044b16bdc2f72ea4502a8c4879c72e71d4d1a8ec46c43620e00a6f46e0b7569c6b20ba21e074c2bd6b307a35c85afd6ad40dc8319af9ec11660c588ffd3e413773259000
+      => 5b05000015058000002c8000027d800000018000000080000000
+      <= 21049aec773c4b645bba274924e2e8aeea525ba37051c94bfd922b60c87b1692091e207fa1d1caa1209d35fafe59393bc820bb7b0b81f3a808dd3728e0b1347bfff40e9000
+      => 5b05000015058000002c8000027d800000028000000080000000
+      <= 21041fb77263c646810574525025561e4559c338b571f57f1b513d75b1609d5fa5f6205e9117d152b467fac631d742ddbc31ea3cbcaac51273c1e931058a56e983d9f59000
+      `,
+    },
+  ],
+  accounts: [
+    {
+      raw: {
+        id: "js:2:aptos:d1a8c6a1cdd52dd40c7ea61ee4571fb51fcae440a594c1eca18636928f1d3956:",
+        seedIdentifier: "d6816f4f22f867b56cf9304b776f452a16d107835d73ee8a33c4ced210300583",
+        used: true,
+        derivationMode: "",
+        index: 0,
+        freshAddress: "0x445fa0013887abd1a0c14acdec6e48090e0ad3fed3e08202aac15ca14f3be26b",
+        freshAddressPath: "44'/637'/0'/0/0",
+        blockHeight: 266360751,
+        creationDate: "2024-12-18T12:26:31.070Z",
+        operationsCount: 5,
+        operations: [],
+        pendingOperations: [],
+        currencyId: "aptos",
+        lastSyncDate: "2024-12-18T15:20:55.097Z",
+        balance: "30100",
+        spendableBalance: "30100",
+        balanceHistoryCache: {
+          HOUR: { balances: [0, 50000, 50000, 30100], latestDate: 1734534000000 },
+          DAY: { balances: [0], latestDate: 1734480000000 },
+          WEEK: { balances: [0], latestDate: 1734220800000 },
+        },
+        xpub: "d1a8c6a1cdd52dd40c7ea61ee4571fb51fcae440a594c1eca18636928f1d3956",
+        swapHistory: [],
+      },
+      transactions: [
+        {
+          name: "NO_NAME",
+          transaction: fromTransactionRaw({
+            amount: "20000",
+            recipient: "0xd20fa44192f94ba086ab16bfdf57e43ff118ada69b4c66fa9b9a9223cbc068c1",
+            useAllAmount: false,
+            family: "aptos",
+            mode: "send",
+            fees: "1100",
+            options: '{ "maxGasAmount": "11", "gasUnitPrice": "100" }',
+            errors: "{}",
+          }),
+          expectedStatus: () =>
+            // you can use account and transaction for smart logic. drop the =>fn otherwise
+            ({
+              errors: {},
+              warnings: {},
+              estimatedFees: BigNumber("900"),
+              amount: BigNumber("20000"),
+              totalSpent: BigNumber("20900"),
+            }),
+        },
+      ],
+    },
+  ],
+};
+
+export const dataset: DatasetTest<Transaction> = {
+  implementations: ["js"],
+  currencies: {
+    aptos,
+  },
+};

package/src/test/cli.ts

@@ -0,0 +1,80 @@
+import type { Account, AccountLike, AccountLikeArray } from "@ledgerhq/types-live";
+import invariant from "invariant";
+import flatMap from "lodash/flatMap";
+import type { Transaction } from "../types";
+import { getAccountCurrency } from "@ledgerhq/coin-framework/account/index";
+import { AccountType } from "../types";
+
+const options = [
+  {
+    name: "token",
+    alias: "t",
+    type: String,
+    desc: "use an token account children of the account",
+  },
+];
+
+function inferAccounts(account: Account, opts: Record<string, any>): AccountLikeArray {
+  invariant(account.currency.family === "aptos", "aptos family");
+
+  if (!opts.token) {
+    const accounts: Account[] = [account];
+    return accounts;
+  }
+
+  const token = opts.token;
+
+  const subAccounts = account.subAccounts || [];
+
+  if (token) {
+    const subAccount = subAccounts.find(t => {
+      const currency = getAccountCurrency(t);
+      return (
+        token.toLowerCase() === currency.ticker.toLowerCase() || token.toLowerCase() === currency.id
+      );
+    });
+
+    if (!subAccount) {
+      throw new Error(
+        "token account '" +
+          token +
+          "' not found. Available: " +
+          subAccounts.map(t => getAccountCurrency(t).ticker).join(", "),
+      );
+    }
+
+    return [subAccount];
+  }
+
+  return [];
+}
+
+function inferTransactions(
+  transactions: Array<{
+    account: AccountLike;
+    transaction: Transaction;
+  }>,
+): Transaction[] {
+  return flatMap(transactions, ({ transaction, account }) => {
+    invariant(transaction.family === "aptos", "aptos family");
+
+    if (account.type === AccountType.TokenAccount) {
+      const isDelisted = account.token.delisted === true;
+      invariant(!isDelisted, "token is delisted");
+    }
+
+    return {
+      ...transaction,
+      family: "aptos",
+      subAccountId: account.type === AccountType.TokenAccount ? account.id : null,
+    } as Transaction;
+  });
+}
+
+export default function makeCliTools() {
+  return {
+    options,
+    inferAccounts,
+    inferTransactions,
+  };
+}

package/src/test/index.ts

@@ -0,0 +1,3 @@
+export * from "./bridgeDatasetTest";
+export * from "./bot-specs";
+export * from "./speculos-deviceActions";

package/src/test/speculos-deviceActions.ts

@@ -0,0 +1,52 @@
+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 { State } from "@ledgerhq/coin-framework/bot/types";
+
+const typeWording = {
+  send: "Send",
+  lock: "Lock",
+  unlock: "Unlock",
+  withdraw: "Withdraw",
+  vote: "Vote",
+  revoke: "Revoke",
+  activate: "Activate",
+  register: "Create Account",
+};
+
+export const acceptTransaction: DeviceAction<Transaction, State<Transaction>> = deviceActionFlow({
+  steps: [
+    {
+      title: "Review",
+      button: SpeculosButton.RIGHT,
+    },
+    {
+      title: "Type",
+      button: SpeculosButton.RIGHT,
+      expectedValue: ({ transaction }) => {
+        return typeWording[transaction.mode as keyof typeof typeWording];
+      },
+    },
+    {
+      title: "Amount",
+      button: SpeculosButton.RIGHT,
+      expectedValue: ({ account, status }) =>
+        formatDeviceAmount(account.currency, status.amount, {
+          forceFloating: true,
+        }),
+    },
+    {
+      title: "Address",
+      button: SpeculosButton.RIGHT,
+      expectedValue: ({ transaction }) => transaction.recipient,
+    },
+    {
+      title: "Accept",
+      button: SpeculosButton.BOTH,
+    },
+  ],
+});

package/src/types/bridge.ts

@@ -0,0 +1,4 @@
+export enum AccountType {
+  Account = "Account",
+  TokenAccount = "TokenAccount",
+}

package/src/types/index.ts

@@ -0,0 +1,74 @@
+import type { UserTransactionResponse } from "@aptos-labs/ts-sdk";
+import type {
+  Account,
+  Operation,
+  TransactionCommon,
+  TransactionCommonRaw,
+  TransactionStatusCommon,
+  TransactionStatusCommonRaw,
+} from "@ledgerhq/types-live";
+import type { BigNumber } from "bignumber.js";
+export * from "./signer";
+export * from "./bridge";
+
+export type AptosTransaction = UserTransactionResponse & {
+  block: {
+    height: number;
+    hash: string;
+  };
+};
+
+export type AptosOperation = Operation;
+
+export type AptosAccount = Account;
+
+export type TransactionStatus = TransactionStatusCommon;
+
+export type TransactionStatusRaw = TransactionStatusCommonRaw;
+
+export type AptosCoinStoreResource = {
+  coin: {
+    value: string;
+  };
+};
+
+export type AptosResource<T extends Record<string, any> = any> = {
+  data: T;
+  type: string;
+};
+
+export type AptosAddress = {
+  address: string;
+  publicKey: string;
+  path: string;
+};
+
+export interface TransactionOptions {
+  maxGasAmount: string;
+  gasUnitPrice: string;
+}
+
+export type TransactionErrors = {
+  maxGasAmount?: string;
+  gasUnitPrice?: string;
+};
+
+export type Transaction = TransactionCommon & {
+  mode: string;
+  family: "aptos";
+  fees?: BigNumber | null;
+  options: TransactionOptions;
+  errors?: TransactionErrors;
+};
+
+export type TransactionRaw = TransactionCommonRaw & {
+  family: "aptos";
+  mode: string;
+  fees?: string | null;
+  options: string;
+  errors?: string;
+};
+
+export type AptosMoveResource = {
+  [key: string]: { guid: { id: { addr: string; creation_num: string } } };
+};

package/src/types/signer.ts

@@ -0,0 +1,26 @@
+export interface AptosAddress {
+  publicKey: Buffer;
+  chainCode: Buffer;
+  address: string;
+}
+
+export interface AptosSigner {
+  getAddress(path: string, display: boolean): Promise<AptosAddress>;
+  signTransaction(path: string, txBuffer: Buffer): Promise<{ signature: Buffer }>;
+}
+
+export type AptosSignature = {
+  signature: null | Buffer;
+  return_code: number;
+  error_message: string;
+  signature_der: Uint8Array;
+  signature_compact: Uint8Array;
+};
+
+export type AptosGetAddrResponse = {
+  addrByte: Uint8Array;
+  addrString: string;
+  compressed_pk: Uint8Array;
+  return_code: number;
+  error_message: string;
+};

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../../tsconfig.base",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "module": "commonjs",
+    "downlevelIteration": true,
+    "lib": ["es2020", "dom"],
+    "rootDir": "./src",
+    "outDir": "lib",
+    "exactOptionalPropertyTypes": true
+  },
+  "include": ["src/**/*", "deviceTransactionConfig.ts", "transaction.ts"]
+}