@ledgerhq/coin-aptos 2.5.1 → 2.5.2-nightly.1

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

@@ -0,0 +1,221 @@
+import BigNumber from "bignumber.js";
+import {
+  canRestake,
+  canStake,
+  canUnstake,
+  canWithdraw,
+  getDelegationOpMaxAmount,
+  mapStakingPositions,
+} from "../../logic/staking";
+import { createFixtureAccount } from "../../bridge/bridge.fixture";
+import { MIN_COINS_ON_SHARES_POOL } from "../../constants";
+
+const stakingPositions = [
+  {
+    active: BigNumber(123456789),
+    inactive: BigNumber(567567567),
+    pendingInactive: BigNumber(5345),
+    validatorId: "validator-1",
+  },
+  {
+    active: BigNumber(0),
+    inactive: BigNumber(33333),
+    pendingInactive: BigNumber(67868678),
+    validatorId: "validator-2",
+  },
+  {
+    active: BigNumber(45864986459),
+    inactive: BigNumber(0),
+    pendingInactive: BigNumber(0),
+    validatorId: "validator-3",
+  },
+];
+
+const nonBreakableSpace = " ";
+
+describe("mapStakingPositions", () => {
+  it("returns the staking positions per validator", () => {
+    const validators = [
+      {
+        activeStake: BigNumber(8972343459783425),
+        commission: BigNumber(8),
+        address: "validator-1",
+        name: "validator-1",
+        shares: "no-shares",
+      },
+      {
+        activeStake: BigNumber(172343459783425),
+        commission: BigNumber(8),
+        address: "validator-2",
+        name: "validator-2",
+        shares: "no-shares",
+      },
+      {
+        activeStake: BigNumber(1743459783425),
+        commission: BigNumber(7),
+        address: "validator-3",
+        name: "validator-3",
+        shares: "no-shares",
+      },
+    ];
+
+    const expected = [
+      {
+        active: BigNumber("123456789"),
+        inactive: BigNumber("567567567"),
+        pendingInactive: BigNumber("5345"),
+        validatorId: "validator-1",
+        formattedAmount: `1.23456${nonBreakableSpace}APT`,
+        formattedPending: `0.00005345${nonBreakableSpace}APT`,
+        formattedAvailable: `5.67567${nonBreakableSpace}APT`,
+        rank: 0,
+        validator: {
+          activeStake: BigNumber("8972343459783425"),
+          commission: BigNumber("8"),
+          address: "validator-1",
+          name: "validator-1",
+          shares: "no-shares",
+        },
+      },
+      {
+        active: BigNumber("0"),
+        inactive: BigNumber("33333"),
+        pendingInactive: BigNumber("67868678"),
+        validatorId: "validator-2",
+        formattedAmount: `0${nonBreakableSpace}APT`,
+        formattedPending: `0.678686${nonBreakableSpace}APT`,
+        formattedAvailable: `0.00033333${nonBreakableSpace}APT`,
+        rank: 1,
+        validator: {
+          activeStake: BigNumber("172343459783425"),
+          commission: BigNumber("8"),
+          address: "validator-2",
+          name: "validator-2",
+          shares: "no-shares",
+        },
+      },
+      {
+        active: BigNumber("45864986459"),
+        inactive: BigNumber("0"),
+        pendingInactive: BigNumber("0"),
+        validatorId: "validator-3",
+        formattedAmount: `458.649${nonBreakableSpace}APT`,
+        formattedPending: `0${nonBreakableSpace}APT`,
+        formattedAvailable: `0${nonBreakableSpace}APT`,
+        rank: 2,
+        validator: {
+          activeStake: BigNumber("1743459783425"),
+          commission: BigNumber("7"),
+          address: "validator-3",
+          name: "validator-3",
+          shares: "no-shares",
+        },
+      },
+    ];
+
+    expect(
+      mapStakingPositions(stakingPositions, validators, {
+        name: "Aptos",
+        code: "APT",
+        magnitude: 8,
+      }),
+    ).toMatchObject(expected);
+  });
+});
+
+describe("canStake", () => {
+  it(`returns false for an account with a balance with less than ${MIN_COINS_ON_SHARES_POOL} APT`, () => {
+    const account = createFixtureAccount({
+      balance: BigNumber(5),
+      spendableBalance: BigNumber(5),
+    });
+    const expected = canStake(account);
+    expect(expected).toBe(false);
+  });
+
+  it(`returns true for an account with balance with more than ${MIN_COINS_ON_SHARES_POOL} APT`, () => {
+    const account = createFixtureAccount({
+      balance: BigNumber(1212312312312),
+      spendableBalance: BigNumber(1212312312312),
+    });
+    const expected = canStake(account);
+    expect(expected).toBe(true);
+  });
+});
+
+describe("canUnstake", () => {
+  it("returns true if there's no amount staked", () => {
+    const expected = canUnstake(stakingPositions[0]);
+    expect(expected).toBe(true);
+  });
+
+  it("returns false if there's no amount staked", () => {
+    const expected = canUnstake(stakingPositions[1]);
+    expect(expected).toBe(false);
+  });
+});
+
+describe("canWithdraw", () => {
+  it("returns true if there's no amount inactive", () => {
+    const expected = canWithdraw(stakingPositions[0]);
+    expect(expected).toBe(true);
+  });
+
+  it("returns false if there's no amount inactive", () => {
+    const expected = canWithdraw(stakingPositions[2]);
+    expect(expected).toBe(false);
+  });
+});
+
+describe("canRestake", () => {
+  it("returns true if there's no amount inactive", () => {
+    const expected = canRestake(stakingPositions[0]);
+    expect(expected).toBe(true);
+  });
+
+  it("returns false if there's no amount inactive", () => {
+    const expected = canRestake(stakingPositions[2]);
+    expect(expected).toBe(false);
+  });
+});
+
+describe("getDelegationOpMaxAmount", () => {
+  it("get maximum amount available to unstake", () => {
+    const account = createFixtureAccount({
+      aptosResources: {
+        activeBalance: BigNumber(45988443248),
+        pendingInactiveBalance: BigNumber(67874023),
+        inactiveBalance: BigNumber(567600900),
+        stakingPositions,
+      },
+    });
+    const expected = getDelegationOpMaxAmount(account, "validator-1", "unstake");
+    expect(expected).toEqual(BigNumber(123456789));
+  });
+
+  it("get maximum amount available to withdraw", () => {
+    const account = createFixtureAccount({
+      aptosResources: {
+        activeBalance: BigNumber(45988443248),
+        pendingInactiveBalance: BigNumber(67874023),
+        inactiveBalance: BigNumber(567600900),
+        stakingPositions,
+      },
+    });
+    const expected = getDelegationOpMaxAmount(account, "validator-1", "withdraw");
+    expect(expected).toEqual(BigNumber(567567567));
+  });
+
+  it("get maximum amount available to restake", () => {
+    const account = createFixtureAccount({
+      aptosResources: {
+        activeBalance: BigNumber(45988443248),
+        pendingInactiveBalance: BigNumber(67874023),
+        inactiveBalance: BigNumber(567600900),
+        stakingPositions,
+      },
+    });
+    const expected = getDelegationOpMaxAmount(account, "validator-1", "restake");
+    expect(expected).toEqual(BigNumber(5345));
+  });
+});

package/src/__tests__/network/client.test.ts

@@ -649,7 +649,7 @@ describe("Aptos API", () => {
         },
       });
 
-      expect(fees.value.toString()).toEqual("40");
+      expect(fees.value.toString()).toEqual("44");
     });
 
     it("estimates the fees for token coin", async () => {
@@ -716,7 +716,7 @@ describe("Aptos API", () => {
         },
       });
 
-      expect(fees.value.toString()).toEqual("20");
+      expect(fees.value.toString()).toEqual("22");
     });
 
     it("estimates the fees for token FA", async () => {
@@ -782,7 +782,7 @@ describe("Aptos API", () => {
         },
       });
 
-      expect(fees.value.toString()).toEqual("30");
+      expect(fees.value.toString()).toEqual("33");
     });
   });
 

package/src/__tests__/network/validators.test.ts

@@ -0,0 +1,105 @@
+import { Aptos } from "@aptos-labs/ts-sdk";
+import { ApolloClient } from "@apollo/client";
+import { getValidators } from "../../network/validators";
+import BigNumber from "bignumber.js";
+
+jest.mock("@aptos-labs/ts-sdk");
+let mockedAptos: jest.Mocked<any>;
+
+jest.mock("@apollo/client");
+let mockedApolloClient: jest.Mocked<any>;
+
+describe("getValidators", () => {
+  beforeEach(() => {
+    mockedAptos = jest.mocked(Aptos);
+    mockedApolloClient = jest.mocked(ApolloClient);
+  });
+
+  afterAll(() => {
+    jest.useRealTimers();
+  });
+
+  const current_delegator_balances = [
+    {
+      __typename: "current_delegator_balances",
+      current_pool_balance: {
+        __typename: "current_delegated_staking_pool_balances",
+        total_coins: 211045219713562,
+        operator_commission_percentage: 900,
+        staking_pool_address: "0x001232f58b963938486a11f88c1c36d61d82738b1828625a95a1e85b4c8d1282",
+        total_shares: 200020456320587.72,
+      },
+      shares: 94692342176,
+      delegator_address: "0xb1a1d4624c5163445c993d9db9cd5bd3fc6b2c5e85a14216c3781d04d4f92d08",
+      staking_pool_metadata: {
+        __typename: "current_staking_pool_voter",
+        operator_aptos_name: [],
+      },
+    },
+    {
+      __typename: "current_delegator_balances",
+      current_pool_balance: {
+        __typename: "current_delegated_staking_pool_balances",
+        total_coins: 116781362397133,
+        operator_commission_percentage: 499,
+        staking_pool_address: "0x05dece2ed08c68f8730527e9b3ebb3536efc3361f4ef37ba0b16a3310db836af",
+        total_shares: 115552903623705.77,
+      },
+      shares: 15149284011,
+      delegator_address: "0x4ee1f2b7a1069a09b7d9c800928bfe851bc7649a0fb4e0d918554e0d445db4bc",
+      staking_pool_metadata: {
+        __typename: "current_staking_pool_voter",
+        operator_aptos_name: [
+          {
+            __typename: "current_aptos_names",
+            domain_with_suffix: "cryptomolot.apt",
+            is_active: true,
+          },
+        ],
+      },
+    },
+  ];
+
+  const expectedResponse = [
+    {
+      activeStake: BigNumber(211045219713562),
+      address: "0x001232f58b963938486a11f88c1c36d61d82738b1828625a95a1e85b4c8d1282",
+      commission: BigNumber(9),
+      name: "0x001232f58b963938486a11f88c1c36d61d82738b1828625a95a1e85b4c8d1282",
+      nextUnlockTime: "32d 5h 26m",
+      shares: 200020456320587.72,
+      wwwUrl:
+        "https://explorer.aptoslabs.com/account/0x001232f58b963938486a11f88c1c36d61d82738b1828625a95a1e85b4c8d1282?network=mainnet",
+    },
+    {
+      activeStake: BigNumber(116781362397133),
+      address: "0x05dece2ed08c68f8730527e9b3ebb3536efc3361f4ef37ba0b16a3310db836af",
+      commission: BigNumber(4.99),
+      name: "cryptomolot.apt",
+      nextUnlockTime: "32d 5h 26m",
+      shares: 115552903623705.77,
+      wwwUrl:
+        "https://explorer.aptoslabs.com/account/0x05dece2ed08c68f8730527e9b3ebb3536efc3361f4ef37ba0b16a3310db836af?network=mainnet",
+    },
+  ];
+
+  it("returns the correct information", async () => {
+    mockedAptos.mockImplementation(() => ({
+      getAccountResource: async () => ({ locked_until_secs: "1750051574" }),
+    }));
+
+    mockedApolloClient.mockImplementation(() => ({
+      query: async () => ({
+        data: {
+          current_delegator_balances,
+        },
+      }),
+    }));
+
+    jest.useFakeTimers().setSystemTime(new Date("2025-05-15"));
+
+    const validators = await getValidators("aptos");
+
+    expect(validators).toMatchObject(expectedResponse);
+  });
+});

package/src/__tests__/utils/IconGenerator.test.ts

@@ -0,0 +1,13 @@
+import { IconGenerator } from "../../utils";
+
+describe("IconGenerator", () => {
+  it("returns a picture bitmap", () => {
+    const icon = new IconGenerator("seed");
+    expect(icon).toBeInstanceOf(IconGenerator);
+    expect(icon.generate).toBeInstanceOf(Function);
+
+    const iconString = icon.generate();
+    expect(typeof iconString).toBe("string");
+    expect(iconString.startsWith("data:image/bmp;base64")).toBe(true);
+  });
+});

package/src/__tests__/utils/index.test.ts

@@ -0,0 +1,11 @@
+import { endpointByCurrencyId } from "../../utils";
+
+describe("endpointByCurrencyId", () => {
+  it("gets the aptos endpoint based on the currency id", () => {
+    expect(endpointByCurrencyId("aptos")).toBe("https://apt.coin.ledger.com/node/v1");
+    expect(endpointByCurrencyId("aptos_testnet")).toBe("https://apt.coin.ledger-stg.com/node/v1");
+    expect(() => endpointByCurrencyId("NONE")).toThrow(
+      "unexpected currency id format <NONE>, should be like aptos[_testnet]",
+    );
+  });
+});

package/src/bridge/bridge.fixture.ts

@@ -33,6 +33,12 @@ export function createFixtureAccount(account?: Partial<AptosAccount>): AptosAcco
     lastSyncDate: new Date(),
     balanceHistoryCache: emptyHistoryCache,
     swapHistory: [],
+    aptosResources: {
+      stakingPositions: [],
+      activeBalance: BigNumber(0),
+      inactiveBalance: BigNumber(0),
+      pendingInactiveBalance: BigNumber(0),
+    },
     ...account,
   };
 }
@@ -90,6 +96,12 @@ export function createFixtureAccountWithSubAccount(
         swapHistory: [],
       },
     ],
+    aptosResources: {
+      stakingPositions: [],
+      activeBalance: BigNumber(0),
+      inactiveBalance: BigNumber(0),
+      pendingInactiveBalance: BigNumber(0),
+    },
     ...account,
   };
 }

package/src/bridge/deviceTransactionConfig.ts

@@ -1,28 +1,97 @@
 import type { CommonDeviceTransactionField as DeviceTransactionField } from "@ledgerhq/coin-framework/transaction/common";
-import BigNumber from "bignumber.js";
+import { Account, AccountLike } from "@ledgerhq/types-live";
+import { Transaction } from "../types";
+import { formatCurrencyUnit } from "@ledgerhq/coin-framework/currencies/formatCurrencyUnit";
+import { getAccountCurrency, getMainAccount } from "@ledgerhq/coin-framework/account/helpers";
 
-export const methodToString = (method: number): string => {
-  switch (method) {
-    case 0:
-      return "Coin transfer";
-    default:
-      return "Unknown";
-  }
-};
+function getDeviceTransactionConfig({
+  account,
+  parentAccount,
+  transaction,
+}: {
+  account: AccountLike;
+  parentAccount: Account | null | undefined;
+  transaction: Transaction;
+}): Array<DeviceTransactionField> {
+  const { mode } = transaction;
+  const fields: DeviceTransactionField[] = [];
+  const mainAccount = getMainAccount(account, parentAccount);
 
-export type ExtraDeviceTransactionField = {
-  type: "aptos.extendedAmount";
-  label: string;
-  value: number | BigNumber;
-};
+  const { fees } = transaction;
+  if (fees) {
+    fields.push({
+      type: "text",
+      label: "Transaction Fee",
+      value: formatCurrencyUnit(getAccountCurrency(mainAccount).units[0], fees, {
+        showCode: true,
+        disableRounding: true,
+      }),
+    });
+  }
 
-function getDeviceTransactionConfig(): Array<DeviceTransactionField> {
-  const fields: Array<DeviceTransactionField> = [];
-  fields.push({
-    type: "text",
-    label: "Type",
-    value: methodToString(0),
-  });
+  if (mode === "send") {
+    if (account.type === "TokenAccount") {
+      fields.push({
+        type: "text",
+        label: "Type",
+        value: "Token transfer",
+      });
+      fields.push({
+        type: "text",
+        label: "Amount",
+        value: formatCurrencyUnit(getAccountCurrency(account).units[0], transaction.amount, {
+          showCode: true,
+          disableRounding: true,
+        }),
+      });
+    } else if (account.type === "Account") {
+      fields.push({
+        type: "text",
+        label: "Amount",
+        value: formatCurrencyUnit(getAccountCurrency(account).units[0], transaction.amount, {
+          showCode: true,
+          disableRounding: true,
+        }),
+      });
+    }
+  } else if ((mode === "stake" || mode === "restake") && account.type === "Account") {
+    fields.push({
+      type: "text",
+      label: "Delegate to",
+      value: transaction.recipient,
+    });
+    fields.push({
+      type: "text",
+      label: "Amount",
+      value: formatCurrencyUnit(getAccountCurrency(account).units[0], transaction.amount, {
+        showCode: true,
+        disableRounding: true,
+      }),
+    });
+  } else if (mode === "unstake" && account.type === "Account") {
+    fields.push({
+      type: "text",
+      label: "Undelegate from",
+      value: transaction.recipient,
+    });
+    fields.push({
+      type: "text",
+      label: "Amount",
+      value: formatCurrencyUnit(getAccountCurrency(account).units[0], transaction.amount, {
+        showCode: true,
+        disableRounding: true,
+      }),
+    });
+  } else if (mode === "withdraw" && account.type === "Account") {
+    fields.push({
+      type: "text",
+      label: "Amount",
+      value: formatCurrencyUnit(getAccountCurrency(account).units[0], transaction.amount, {
+        showCode: true,
+        disableRounding: true,
+      }),
+    });
+  }
 
   return fields;
 }

package/src/bridge/estimateMaxSpendable.ts

@@ -1,19 +1,19 @@
-import type { Account, AccountLike } from "@ledgerhq/types-live";
+import type { AccountLike } from "@ledgerhq/types-live";
 import { BigNumber } from "bignumber.js";
 import { getMainAccount } from "@ledgerhq/coin-framework/account/index";
 import { AptosAPI } from "../network";
 import { getEstimatedGas } from "./getFeesForTransaction";
 import { getMaxSendBalance } from "./logic";
-import type { Transaction } from "../types";
 import { DEFAULT_GAS, DEFAULT_GAS_PRICE } from "../constants";
+import type { AptosAccount, Transaction } from "../types";
 
 const estimateMaxSpendable = async ({
   account,
   parentAccount,
   transaction,
 }: {
-  account: AccountLike;
-  parentAccount?: Account;
+  account: AccountLike<AptosAccount>;
+  parentAccount?: AptosAccount;
   transaction?: Transaction;
 }): Promise<BigNumber> => {
   const mainAccount = getMainAccount(account, parentAccount);
@@ -30,7 +30,7 @@ const estimateMaxSpendable = async ({
     gasUnitPrice = BigNumber(estimate.gasUnitPrice);
   }
 
-  return getMaxSendBalance(maxGasAmount, gasUnitPrice, mainAccount, transaction);
+  return getMaxSendBalance(mainAccount, transaction, maxGasAmount, gasUnitPrice);
 };
 
 export default estimateMaxSpendable;

package/src/bridge/getFeesForTransaction.ts

@@ -5,7 +5,13 @@ import BigNumber from "bignumber.js";
 import { makeLRUCache, seconds } from "@ledgerhq/live-network/cache";
 import { AptosAPI } from "../network";
 import { getTokenAccount } from "./logic";
-import { DEFAULT_GAS, DEFAULT_GAS_PRICE, ESTIMATE_GAS_MUL } from "../constants";
+import {
+  DEFAULT_GAS,
+  DEFAULT_GAS_PRICE,
+  ESTIMATE_GAS_MUL,
+  ESTIMATE_GAS_MUL_FOR_STAKING,
+  STAKING_TX_MODES,
+} from "../constants";
 import type { Transaction, TransactionErrors } from "../types";
 import buildTransaction from "../logic/buildTransaction";
 
@@ -38,14 +44,17 @@ export const getFee = async (
     maxGasAmount: gasLimit.toString(),
     gasUnitPrice: gasPrice.toString(),
   };
+
   if (account.xpub) {
     try {
       const publicKeyEd = new Ed25519PublicKey(account.xpub as string);
       const tx = await buildTransaction(account, transaction, aptosClient);
-      const simulation = await aptosClient.simulateTransaction(publicKeyEd, tx);
-      const completedTx = simulation[0];
+      const [completedTx] = await aptosClient.simulateTransaction(publicKeyEd, tx);
 
-      gasLimit = new BigNumber(completedTx.gas_used).multipliedBy(ESTIMATE_GAS_MUL);
+      const gasMultiplier = STAKING_TX_MODES.includes(transaction.mode)
+        ? ESTIMATE_GAS_MUL_FOR_STAKING
+        : ESTIMATE_GAS_MUL;
+      gasLimit = new BigNumber(completedTx.gas_used).multipliedBy(gasMultiplier).integerValue();
       gasPrice = new BigNumber(completedTx.gas_unit_price);
 
       const expectedGas = gasPrice.multipliedBy(gasLimit);
@@ -55,9 +64,11 @@ export const getFee = async (
           res.errors.maxGasAmount = "GasInsufficientBalance";
         } else if (
           !completedTx.vm_status.includes("INSUFFICIENT_BALANCE") &&
+          !completedTx.vm_status.includes("EDELEGATOR_ACTIVE_BALANCE_TOO_LOW") &&
+          !completedTx.vm_status.includes("EDELEGATOR_PENDING_INACTIVE_BALANCE_TOO_LOW") &&
           !completedTx.vm_status.includes("0x203ed") // 0x203ed -> PROLOGUE_ECANT_PAY_GAS_DEPOSIT equivalent to INSUFFICIENT_BALANCE_FOR_TRANSACTION_FEE
         ) {
-          // INSUFFICIENT_BALANCE will be processed by getTransactionStatus
+          // INSUFFICIENT_BALANCE and EDELEGATOR_ACTIVE_BALANCE_TOO_LOW will be processed by getTransactionStatus
           throw Error(`Simulation failed with following error: ${completedTx.vm_status}`);
         }
       }
@@ -70,6 +81,7 @@ export const getFee = async (
       throw error;
     }
   }
+
   return res;
 };