@ledgerhq/coin-aptos 2.2.0-next.1 → 2.2.0-nightly.2

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

@@ -1,6 +1,6 @@
 import { Aptos } from "@aptos-labs/ts-sdk";
-import type { Api } from "@ledgerhq/coin-framework/api/types";
-import type { AptosAsset, AptosExtra, AptosFeeParameters, AptosSender } from "../../types/assets";
+import type { AlpacaApi } from "@ledgerhq/coin-framework/api/types";
+import type { AptosAsset } from "../../types/assets";
 import type { AptosConfig } from "../../config";
 import { createApi } from "../../api";
 import coinConfig from "../../config";
@@ -33,8 +33,7 @@ describe("createApi", () => {
   });
 
   it("should return an API object with alpaca api methods", () => {
-    const api: Api<AptosAsset, AptosExtra, AptosSender, AptosFeeParameters> =
-      createApi(mockAptosConfig);
+    const api: AlpacaApi<AptosAsset> = createApi(mockAptosConfig);
 
     // Check that methods are set with what we expect
     expect(api.broadcast).toBeDefined();
@@ -70,8 +69,7 @@ describe("lastBlock", () => {
       }),
     }));
 
-    const api: Api<AptosAsset, AptosExtra, AptosSender, AptosFeeParameters> =
-      createApi(mockAptosConfig);
+    const api: AlpacaApi<AptosAsset> = createApi(mockAptosConfig);
 
     expect(await api.lastBlock()).toStrictEqual({
       height: 123,

package/src/__tests__/bridge/synchronisation.test.ts

@@ -798,10 +798,15 @@ describe("getAccountShape", () => {
       blockHeight: 316278241,
     }));
 
-    const mockGetBalance = jest.fn().mockImplementation(() => BigNumber(5000000));
+    const TOKEN_CONTRACT_ADDRESS = "0xd111::staked_coin::StakedAptos";
+
+    const mockGetBalances = jest
+      .fn()
+      .mockResolvedValue([{ contractAddress: TOKEN_CONTRACT_ADDRESS, amount: BigNumber(1234567) }]);
+
     mockedAptosAPI.mockImplementation(() => ({
+      getBalances: mockGetBalances,
       getAccountInfo: mockGetAccountInfo,
-      getBalance: mockGetBalance,
     }));
 
     const mockGetAccountSpy = jest.spyOn({ getAccount: mockGetAccountInfo }, "getAccount");
@@ -1312,9 +1317,14 @@ describe("getSubAccountShape", () => {
   ] as Operation[];
 
   it("returns the correct information", async () => {
-    const mockGetBalance = jest.fn().mockImplementation(() => BigNumber(1234567));
+    const TOKEN_CONTRACT_ADDRESS = "0xd111::staked_coin::StakedAptos";
+
+    const mockGetBalances = jest
+      .fn()
+      .mockResolvedValue([{ contractAddress: TOKEN_CONTRACT_ADDRESS, amount: BigNumber(1234567) }]);
+
     mockedAptosAPI.mockImplementation(() => ({
-      getBalance: mockGetBalance,
+      getBalances: mockGetBalances,
     }));
 
     const subAccount = await getSubAccountShape(currency, address, parentId, token, operations);
@@ -1421,9 +1431,14 @@ describe("getSubAccounts", () => {
   ] as Operation[];
 
   it("returns the correct information", async () => {
-    const mockGetBalance = jest.fn().mockImplementation(() => BigNumber(1234567));
+    const TOKEN_CONTRACT_ADDRESS = "0xd111::staked_coin::StakedAptos";
+
+    const mockGetBalances = jest
+      .fn()
+      .mockResolvedValue([{ contractAddress: TOKEN_CONTRACT_ADDRESS, amount: BigNumber(1234567) }]);
+
     mockedAptosAPI.mockImplementation(() => ({
-      getBalance: mockGetBalance,
+      getBalances: mockGetBalances,
     }));
 
     mockedDecodeTokenAccountId.mockReturnValue({

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

@@ -0,0 +1,80 @@
+import { getBalances } from "../../logic/getBalances";
+import { APTOS_ASSET_ID, TOKEN_TYPE } from "../../constants";
+import type { AptosAPI } from "../../network";
+
+describe("getBalance", () => {
+  it("should return balance with value 10", async () => {
+    const mockAptosClient = {
+      getBalances: jest.fn().mockResolvedValue([{ contractAddress: APTOS_ASSET_ID, amount: 10n }]),
+    } as Partial<AptosAPI> as AptosAPI;
+
+    const accountAddress = "0x4be47904b31063d60ac0dfde06e5dc203e647edbe853bae0e666ae5a763c3906";
+
+    const balances = await getBalances(mockAptosClient, accountAddress);
+
+    expect(balances).toStrictEqual([{ value: 10n, asset: { type: "native" } }]);
+  });
+
+  it("should return empty array when no contract_address and no data", async () => {
+    const mockAptosClient = {
+      getBalances: jest.fn().mockResolvedValue([]),
+    } as Partial<AptosAPI> as AptosAPI;
+
+    const accountAddress = "0x4be47904b31063d60ac0dfde06e5dc203e647edbe853bae0e666ae5a763c3906";
+
+    const balances = await getBalances(mockAptosClient, accountAddress);
+    expect(balances).toStrictEqual([]);
+  });
+
+  it("should return balance with 'native' contract_address (APTOS_ASSET_ID)", async () => {
+    const mockAptosClient = {
+      getBalances: jest.fn().mockResolvedValue([{ contractAddress: APTOS_ASSET_ID, amount: 10n }]),
+    } as Partial<AptosAPI> as AptosAPI;
+
+    const accountAddress = "0x4be47904b31063d60ac0dfde06e5dc203e647edbe853bae0e666ae5a763c3906";
+
+    const balances = await getBalances(mockAptosClient, accountAddress);
+
+    expect(balances).toStrictEqual([{ value: 10n, asset: { type: "native" } }]);
+  });
+
+  it("should return token balance when contract_address is a coin token", async () => {
+    const TOKEN_ASSET_ID = "0x1::my_token::Token";
+    const mockAptosClient = {
+      getBalances: jest.fn().mockResolvedValue([{ contractAddress: TOKEN_ASSET_ID, amount: 25n }]),
+    } as Partial<AptosAPI> as AptosAPI;
+
+    const accountAddress = "0x4be47904b31063d60ac0dfde06e5dc203e647edbe853bae0e666ae5a763c3906";
+
+    const balances = await getBalances(mockAptosClient, accountAddress);
+
+    expect(balances).toStrictEqual([
+      {
+        value: 25n,
+        asset: { type: "token", contractAddress: TOKEN_ASSET_ID, standard: TOKEN_TYPE.COIN },
+      },
+    ]);
+  });
+
+  it("should return token balance when contract_address is a fungible_asset token", async () => {
+    const TOKEN_ASSET_ID = "0x1";
+    const mockAptosClient = {
+      getBalances: jest.fn().mockResolvedValue([{ contractAddress: TOKEN_ASSET_ID, amount: 25n }]),
+    } as Partial<AptosAPI> as AptosAPI;
+
+    const accountAddress = "0x4be47904b31063d60ac0dfde06e5dc203e647edbe853bae0e666ae5a763c3906";
+
+    const balances = await getBalances(mockAptosClient, accountAddress);
+
+    expect(balances).toStrictEqual([
+      {
+        value: 25n,
+        asset: {
+          type: "token",
+          contractAddress: TOKEN_ASSET_ID,
+          standard: TOKEN_TYPE.FUNGIBLE_ASSET,
+        },
+      },
+    ]);
+  });
+});

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

@@ -14,11 +14,10 @@ import {
 import network from "@ledgerhq/live-network";
 import BigNumber from "bignumber.js";
 import { AptosAPI } from "../../network";
-import { AptosAsset, AptosExtra, AptosSender } from "../../types/assets";
+import { AptosAsset } from "../../types/assets";
 import { Pagination, TransactionIntent } from "@ledgerhq/coin-framework/api/types";
-import { TokenCurrency } from "@ledgerhq/types-cryptoassets";
 import { APTOS_ASSET_ID } from "../../constants";
-import { AptosTransaction } from "../../types";
+import { AptosBalance, AptosTransaction } from "../../types";
 
 jest.mock("@aptos-labs/ts-sdk");
 jest.mock("@apollo/client");
@@ -96,75 +95,6 @@ describe("Aptos API", () => {
     });
   });
 
-  describe("getBalance", () => {
-    let token: TokenCurrency;
-
-    beforeEach(() => {
-      token = {
-        type: "TokenCurrency",
-        id: "aptos_token",
-        name: "Aptos Token",
-        ticker: "APT",
-        units: [{ name: "APT", code: "APT", magnitude: 6 }],
-        contractAddress: "APTOS_1_ADDRESS",
-        tokenType: "fungible_asset",
-        parentCurrency: {
-          type: "CryptoCurrency",
-          id: "aptos",
-          name: "Aptos",
-          ticker: "APT",
-          units: [{ name: "APT", code: "APT", magnitude: 6 }],
-          color: "#000000",
-          family: "aptos",
-          scheme: "aptos",
-          explorerViews: [],
-          managerAppName: "Aptos",
-          coinType: 637,
-        },
-      };
-    });
-
-    it("get coin balance", async () => {
-      mockedAptos.mockImplementation(() => ({
-        view: jest.fn().mockReturnValue(["1234"]),
-      }));
-
-      token.tokenType = "coin";
-      const api = new AptosAPI("aptos");
-      const balance = await api.getBalance("address", token);
-
-      expect(balance).toEqual(new BigNumber(1234));
-    });
-
-    it("get fungible assets balance", async () => {
-      mockedAptos.mockImplementation(() => ({
-        view: jest.fn().mockReturnValue(["12345"]),
-      }));
-
-      token.tokenType = "fungible_asset";
-
-      const api = new AptosAPI("aptos");
-      const balance = await api.getBalance("address", token);
-
-      expect(balance).toEqual(new BigNumber(12345));
-    });
-
-    it("return 0 balace if could not retrieve proper balance of fungible assets", async () => {
-      mockedAptos.mockImplementation(() => ({
-        view: jest.fn().mockImplementation(() => {
-          throw new Error("error");
-        }),
-      }));
-
-      token.tokenType = "fungible_asset";
-
-      const api = new AptosAPI("aptos");
-      const balance = await api.getBalance("address", token);
-
-      expect(balance).toEqual(new BigNumber(0));
-    });
-  });
-
   describe("getAccountInfo", () => {
     it("calls getCoinBalance, fetchTransactions and getHeight", async () => {
       mockedAptos.mockImplementation(() => ({
@@ -177,6 +107,12 @@ describe("Aptos API", () => {
           block_height: "1",
           block_hash: "83ca6d",
         }),
+        getCurrentFungibleAssetBalances: jest.fn().mockResolvedValue([
+          {
+            asset_type: APTOS_ASSET_ID,
+            amount: new BigNumber(123),
+          },
+        ]),
       }));
 
       mockedNetwork.mockResolvedValue(
@@ -307,6 +243,12 @@ describe("Aptos API", () => {
           block_height: "1",
           block_hash: "83ca6d",
         }),
+        getCurrentFungibleAssetBalances: jest.fn().mockResolvedValue([
+          {
+            asset_type: APTOS_ASSET_ID,
+            amount: new BigNumber(123),
+          },
+        ]),
       }));
 
       mockedNetwork.mockResolvedValue(
@@ -361,6 +303,12 @@ describe("Aptos API", () => {
           block_height: "1",
           block_hash: "83ca6d",
         }),
+        getCurrentFungibleAssetBalances: jest.fn().mockResolvedValue([
+          {
+            asset_type: APTOS_ASSET_ID,
+            amount: new BigNumber(123),
+          },
+        ]),
       }));
 
       mockedNetwork.mockResolvedValue(
@@ -398,8 +346,7 @@ describe("Aptos API", () => {
       }));
 
       const api = new AptosAPI("aptos");
-      const accountInfo = await api.getAccountInfo("APTOS_1_ADDRESS", "1");
-
+      const accountInfo = await api.getAccountInfo(APTOS_ASSET_ID, "1");
       expect(accountInfo.balance).toEqual(new BigNumber(123));
       expect(accountInfo.transactions).toEqual([null]);
       expect(accountInfo.blockHeight).toEqual(999);
@@ -612,19 +559,20 @@ describe("Aptos API", () => {
       }));
 
       const amount = BigInt(100);
-      const sender: AptosSender = {
+      const sender = {
         xpub: "xpub",
         freshAddress: "address1",
       };
       const recipient = "address2";
 
       const api = new AptosAPI("aptos");
-      const transactionIntent: TransactionIntent<AptosAsset, AptosExtra, AptosSender> = {
+      const transactionIntent: TransactionIntent<AptosAsset> = {
         asset: {
           type: "native",
         },
         type: "send",
-        sender,
+        sender: sender.freshAddress,
+        senderPublicKey: sender.xpub,
         amount,
         recipient,
       };
@@ -676,21 +624,22 @@ describe("Aptos API", () => {
       }));
 
       const amount = BigInt(100);
-      const sender: AptosSender = {
+      const sender = {
         xpub: "xpub",
         freshAddress: "address1",
       };
       const recipient = "address2";
 
       const api = new AptosAPI("aptos");
-      const transactionIntent: TransactionIntent<AptosAsset, AptosExtra, AptosSender> = {
+      const transactionIntent: TransactionIntent<AptosAsset> = {
         asset: {
           type: "token",
           standard: "coin",
           contractAddress: "0x111",
         },
         type: "send",
-        sender,
+        sender: sender.freshAddress,
+        senderPublicKey: sender.xpub,
         amount,
         recipient,
       };
@@ -741,21 +690,22 @@ describe("Aptos API", () => {
       }));
 
       const amount = BigInt(100);
-      const sender: AptosSender = {
+      const sender = {
         xpub: "xpub",
         freshAddress: "address1",
       };
       const recipient = "address2";
 
       const api = new AptosAPI("aptos");
-      const transactionIntent: TransactionIntent<AptosAsset, AptosExtra, AptosSender> = {
+      const transactionIntent: TransactionIntent<AptosAsset> = {
         asset: {
           type: "token",
           standard: "fungible_asset",
           contractAddress: "0x111",
         },
         type: "send",
-        sender,
+        sender: sender.freshAddress,
+        senderPublicKey: sender.xpub,
         amount,
         recipient,
       };
@@ -782,6 +732,10 @@ describe("Aptos API", () => {
 
   describe("getBalances", () => {
     it("returns an array of AptosBalances objects", async () => {
+      const expectedAptosBalace: AptosBalance = {
+        contractAddress: APTOS_ASSET_ID,
+        amount: BigNumber(200),
+      };
       const assets = [{ asset_type: APTOS_ASSET_ID, amount: 200 }];
       const mockGetCurrentFungibleAssetBalances = jest.fn().mockResolvedValue(assets);
       mockedAptos.mockImplementation(() => ({
@@ -791,21 +745,61 @@ describe("Aptos API", () => {
       const address = "0x42";
 
       const api = new AptosAPI("aptos");
-      const balances = await api.getBalances(address);
+      const balances = await api.getBalances(address, APTOS_ASSET_ID);
 
       expect(mockGetCurrentFungibleAssetBalances).toHaveBeenCalledWith({
         options: {
-          offset: 0,
-          limit: 1000,
           where: {
             asset_type: { _eq: APTOS_ASSET_ID },
             owner_address: { _eq: address },
           },
         },
       });
-      expect(balances).toHaveLength(1);
-      expect(balances[0].contractAddress).toBe(assets[0].asset_type);
-      expect(balances[0].amount).toStrictEqual(BigNumber(assets[0].amount));
+      expect(balances).toEqual([expectedAptosBalace]);
+    });
+
+    it("returns an array of AptosBalances when just address ispassed", async () => {
+      const expectedAptosBalace: AptosBalance = {
+        contractAddress: APTOS_ASSET_ID,
+        amount: BigNumber(200),
+      };
+      const assets = [{ asset_type: APTOS_ASSET_ID, amount: 200n }];
+      const mockGetCurrentFungibleAssetBalances = jest.fn().mockResolvedValue(assets);
+      mockedAptos.mockImplementation(() => ({
+        getCurrentFungibleAssetBalances: mockGetCurrentFungibleAssetBalances,
+      }));
+      const address = "0x42";
+      const api = new AptosAPI("aptos");
+
+      const balance = await api.getBalances(address);
+
+      expect(mockGetCurrentFungibleAssetBalances).toHaveBeenCalledWith({
+        options: {
+          where: {
+            owner_address: { _eq: address },
+          },
+        },
+      });
+      expect(balance).toEqual([expectedAptosBalace]);
+    });
+
+    it("return 0 balace if could not retrieve proper balance of fungible assets", async () => {
+      const expectedBalance = new BigNumber(0);
+      mockedAptos.mockImplementation(() => ({
+        getCurrentFungibleAssetBalances: jest.fn().mockImplementation(() => {
+          throw new Error("error");
+        }),
+      }));
+
+      const api = new AptosAPI("aptos");
+      const balance = await api.getBalances("address", "0x42");
+
+      expect(balance).toEqual([
+        {
+          contractAddress: "",
+          amount: expectedBalance,
+        },
+      ]);
     });
   });
 

package/src/api/index.ts

@@ -1,16 +1,14 @@
-import type { Api } from "@ledgerhq/coin-framework/api/index";
+import type { AlpacaApi } from "@ledgerhq/coin-framework/api/index";
 import type { AptosConfig as AptosConfigApi } from "../config";
 import type { Balance, Pagination, TransactionIntent } from "@ledgerhq/coin-framework/api/types";
 import coinConfig from "../config";
-import type { AptosAsset, AptosExtra, AptosFeeParameters, AptosSender } from "../types/assets";
+import type { AptosAsset } from "../types/assets";
 import { AptosAPI } from "../network";
 import { combine } from "../logic/combine";
 import { craftTransaction } from "../logic/craftTransaction";
-import { getBalance } from "../logic/getBalance";
+import { getBalances } from "../logic/getBalances";
 
-export function createApi(
-  config: AptosConfigApi,
-): Api<AptosAsset, AptosExtra, AptosSender, AptosFeeParameters> {
+export function createApi(config: AptosConfigApi): AlpacaApi<AptosAsset> {
   coinConfig.setCoinConfig(() => ({ ...config, status: { type: "active" } }));
 
   const client = new AptosAPI(config.aptosSettings);
@@ -20,9 +18,9 @@ export function createApi(
     combine: (tx, signature, pubkey): string => combine(tx, signature, pubkey),
     craftTransaction: (transactionIntent, _customFees): Promise<string> =>
       craftTransaction(client, transactionIntent),
-    estimateFees: (transactionIntent: TransactionIntent<AptosAsset, AptosExtra, AptosSender>) =>
+    estimateFees: (transactionIntent: TransactionIntent<AptosAsset>) =>
       client.estimateFees(transactionIntent),
-    getBalance: (address): Promise<Balance<AptosAsset>[]> => getBalance(client, address),
+    getBalance: (address): Promise<Balance<AptosAsset>[]> => getBalances(client, address),
     lastBlock: () => client.getLastBlock(),
     listOperations: (address: string, pagination: Pagination) =>
       client.listOperations(address, pagination),

package/src/bridge/synchronisation.ts

@@ -13,6 +13,7 @@ import {
   encodeTokenAccountId,
 } from "@ledgerhq/coin-framework/account/index";
 import { AccountShapeInfo } from "@ledgerhq/coin-framework/bridge/jsHelpers";
+import BigNumber from "bignumber.js";
 
 /**
  * List of properties of a sub account that can be updated when 2 "identical" accounts are found
@@ -70,7 +71,7 @@ export const mergeSubAccounts = (
           mergeOps(
             duplicatedAccount[name as keyof TokenAccount] as Operation[],
             newSubAccount[name as keyof TokenAccount] as Operation[],
-          ) || [];
+          ) ?? [];
       }
     }
 
@@ -100,7 +101,8 @@ export const getSubAccountShape = async (
 ): Promise<TokenAccount> => {
   const aptosClient = new AptosAPI(currency.id);
   const tokenAccountId = encodeTokenAccountId(parentId, token);
-  const balance = await aptosClient.getBalance(address, token);
+  const balances = await aptosClient.getBalances(address, token.contractAddress);
+  const balance = balances.length > 0 ? balances[0].amount : BigNumber(0);
   const firstOperation = operations
     .sort((a, b) => b.date.getTime() - a.date.getTime())
     .at(operations.length - 1);

package/src/logic/craftTransaction.ts

@@ -1,5 +1,5 @@
 import type { TransactionIntent } from "@ledgerhq/coin-framework/lib/api/types";
-import type { AptosAsset, AptosExtra, AptosSender } from "../types/assets";
+import type { AptosAsset } from "../types/assets";
 import type { Account, TokenAccount } from "@ledgerhq/types-live";
 import type { AptosAPI } from "../network";
 import buildTransaction, { isTokenType } from "./buildTransaction";
@@ -10,7 +10,7 @@ import type { AptosBalance } from "../types";
 
 export async function craftTransaction(
   aptosClient: AptosAPI,
-  transactionIntent: TransactionIntent<AptosAsset, AptosExtra, AptosSender>,
+  transactionIntent: TransactionIntent<AptosAsset>,
 ): Promise<string> {
   const newTx = createTransaction();
   newTx.amount = BigNumber(transactionIntent.amount.toString());
@@ -19,8 +19,8 @@ export async function craftTransaction(
   newTx.useAllAmount = transactionIntent.amount === BigInt(0);
 
   const account = {
-    freshAddress: transactionIntent.sender.freshAddress,
-    xpub: transactionIntent.sender.xpub,
+    freshAddress: transactionIntent.sender,
+    xpub: transactionIntent.senderPublicKey,
     subAccounts: new Array<TokenAccount>(),
   } as Account;
 
@@ -29,7 +29,7 @@ export async function craftTransaction(
   let balance: AptosBalance | undefined;
 
   if (newTx.useAllAmount === true) {
-    const balances = await aptosClient.getBalances(transactionIntent.sender.freshAddress);
+    const balances = await aptosClient.getBalances(transactionIntent.sender);
     balance = balances?.find(
       b => b.contractAddress.toLowerCase() === contractAddress?.toLowerCase(),
     );
@@ -54,9 +54,7 @@ export async function craftTransaction(
   return aptosTx.bcsToHex().toString();
 }
 
-function getContractAddress(
-  txIntent: TransactionIntent<AptosAsset, AptosExtra, AptosSender>,
-): string {
+function getContractAddress(txIntent: TransactionIntent<AptosAsset>): string {
   if (txIntent.asset.type === "token" && isTokenType(txIntent.asset.standard)) {
     return txIntent.asset.contractAddress;
   }

package/src/logic/getBalances.ts

@@ -0,0 +1,27 @@
+import type { Balance } from "@ledgerhq/coin-framework/lib/api/types";
+import type { AptosAsset } from "../types/assets";
+import type { AptosAPI } from "../network";
+import { APTOS_ASSET_ID, TOKEN_TYPE } from "../constants";
+
+export async function getBalances(
+  aptosClient: AptosAPI,
+  address: string,
+  contract_address?: string,
+): Promise<Balance<AptosAsset>[]> {
+  const balances = await aptosClient.getBalances(address, contract_address);
+
+  return balances.map(balance => {
+    const isNative = balance.contractAddress === APTOS_ASSET_ID;
+    const standard =
+      balance.contractAddress.split("::").length === 3
+        ? TOKEN_TYPE.COIN
+        : TOKEN_TYPE.FUNGIBLE_ASSET;
+
+    return {
+      value: BigInt(balance.amount.toString()),
+      asset: isNative
+        ? { type: "native" }
+        : { type: "token", contractAddress: balance.contractAddress, standard: standard },
+    };
+  });
+}