@ledgerhq/coin-tezos 2.2.0 → 3.0.0-next.0

package/src/logic/getBalance.test.ts

@@ -0,0 +1,33 @@
+import { getBalance } from "./getBalance";
+import { setupServer } from "msw/node";
+import coinConfig, { TezosCoinConfig } from "../config";
+import { HttpResponse, http } from "msw";
+
+describe("getBalance", () => {
+  const mockServer = setupServer();
+  coinConfig.setCoinConfig(
+    () =>
+      ({
+        status: { type: "active" },
+        explorer: { url: "http://tezos.explorer.com" },
+      }) as unknown as TezosCoinConfig,
+  );
+  it("gets the balance of a Tezos account", async () => {
+    mockServer.listen({ onUnhandledRequest: "error" });
+    mockServer.use(
+      http.get("http://tezos.explorer.com/v1/accounts/tz1WvvbEGpBXGeTVbLiR6DYBe1izmgiYuZbq", () =>
+        HttpResponse.json({ type: "empty" }),
+      ),
+      http.get("http://tezos.explorer.com/v1/accounts/tz1TzrmTBSuiVHV2VfMnGRMYvTEPCP42oSM8", () =>
+        HttpResponse.json({ type: "user", balance: 25 }),
+      ),
+    );
+
+    expect(await getBalance("tz1WvvbEGpBXGeTVbLiR6DYBe1izmgiYuZbq")).toEqual([
+      { value: BigInt(-1), asset: { type: "native" } },
+    ]);
+    expect(await getBalance("tz1TzrmTBSuiVHV2VfMnGRMYvTEPCP42oSM8")).toEqual([
+      { value: BigInt(25), asset: { type: "native" } },
+    ]);
+  });
+});

package/src/logic/getBalance.ts

@@ -1,10 +1,17 @@
+import { Balance } from "@ledgerhq/coin-framework/api/types";
 import api from "../network/tzkt";
+import { TezosAsset } from "../types";
 
 /**
  * Retunrs the balance of the given address.
  * If the address is an empty account, returns -1.
  */
-export async function getBalance(address: string): Promise<bigint> {
+export async function getBalance(address: string): Promise<Balance<TezosAsset>[]> {
   const apiAccount = await api.getAccountByAddress(address);
-  return apiAccount.type === "user" ? BigInt(apiAccount.balance) : BigInt(-1);
+  return [
+    {
+      value: apiAccount.type === "user" ? BigInt(apiAccount.balance) : BigInt(-1),
+      asset: { type: "native" },
+    },
+  ];
 }

package/src/logic/listOperations.test.ts

@@ -50,6 +50,8 @@ describe("listOperations", () => {
     storageFee: 1,
     bakerFee: 2,
     allocationFee: 3,
+    gasLimit: 4,
+    storageLimit: 5,
   };
 
   const undelegate: APIDelegationType = {
@@ -67,19 +69,38 @@ describe("listOperations", () => {
     target: { address: someDestinationAddress },
   };
 
-  it.each([undelegate, delegate, transfer])(
-    "should return operation with proper recipient list",
-    async operation => {
-      // Given
-      mockNetworkGetTransactions.mockResolvedValue([operation]);
-      // When
-      const [results, token] = await listOperations("any address", options);
-      // Then
-      expect(results.length).toEqual(1);
-      expect(results[0].recipients).toEqual([someDestinationAddress]);
-      expect(token).toEqual(JSON.stringify(operation.id));
-    },
-  );
+  it.each([
+    ["undelegate", undelegate],
+    ["delegate", delegate],
+    ["transfer", transfer],
+  ])("should return %s operation with proper recipient list", async (_label, operation) => {
+    // Given
+    mockNetworkGetTransactions.mockResolvedValue([operation]);
+    // When
+    const [results, token] = await listOperations("any address", options);
+    // Then
+    expect(results.length).toEqual(1);
+    expect(results[0].recipients).toEqual([someDestinationAddress]);
+    expect(token).toEqual(JSON.stringify(operation.id));
+  });
+
+  it.each([
+    ["undelegate", undelegate],
+    ["delegate", delegate],
+    ["transfer", transfer],
+  ])("should return %s operation with expected details", async (_label, operation) => {
+    // Given
+    mockNetworkGetTransactions.mockResolvedValue([operation]);
+    // When
+    const [results, _] = await listOperations("any address", options);
+    // Then
+    expect(results.length).toEqual(1);
+    expect(results[0].details).toEqual({
+      counter: 65214462,
+      gasLimit: 4,
+      storageLimit: 5,
+    });
+  });
 
   it.each([
     { ...undelegate, newDelegate: null, prevDelegate: null },

package/src/logic/listOperations.ts

@@ -8,6 +8,7 @@ import {
   isAPITransactionType,
 } from "../network/types";
 import { Operation } from "@ledgerhq/coin-framework/api/types";
+import { TezosAsset } from "../types";
 
 /**
  * Returns list of "Transfer", "Delegate" and "Undelegate" Operations associated to an account.
@@ -29,7 +30,7 @@ export async function listOperations(
     sort,
     minHeight,
   }: { limit?: number; token?: string; sort: "Ascending" | "Descending"; minHeight: number },
-): Promise<[Operation<void>[], string]> {
+): Promise<[Operation<TezosAsset>[], string]> {
   let options: AccountsGetOperationsOptions = { limit, sort, "level.ge": minHeight };
   if (token) {
     options = { ...options, lastId: JSON.parse(token) };
@@ -41,7 +42,7 @@ export async function listOperations(
   const nextToken = lastOperation ? JSON.stringify(lastOperation?.id) : "";
   const filteredOperations = operations
     .filter(op => isAPITransactionType(op) || isAPIDelegationType(op))
-    .reduce((acc, op) => acc.concat(convertOperation(address, op)), [] as Operation<void>[]);
+    .reduce((acc, op) => acc.concat(convertOperation(address, op)), [] as Operation<TezosAsset>[]);
   if (sort === "Ascending") {
     //results are always sorted in descending order
     filteredOperations.reverse();
@@ -53,7 +54,7 @@ export async function listOperations(
 function convertOperation(
   address: string,
   operation: APITransactionType | APIDelegationType,
-): Operation<void> {
+): Operation<TezosAsset> {
   const { amount, hash, sender, type } = operation;
 
   let targetAddress = undefined;
@@ -79,6 +80,7 @@ function convertOperation(
     BigInt(operation.allocationFee ?? 0);
 
   return {
+    asset: { type: "native" },
     operationIndex: 0,
     tx: {
       // hash id defined nullable in the tzkt API, but I wonder when it would be null ?
@@ -96,5 +98,10 @@ function convertOperation(
     value: BigInt(amount),
     senders: senders,
     recipients: recipients,
+    details: {
+      counter: operation.counter,
+      gasLimit: operation.gasLimit,
+      storageLimit: operation.storageLimit,
+    },
   };
 }

package/src/logic/tezosToolkit.ts

@@ -1,11 +1,15 @@
 import { TezosToolkit } from "@taquito/taquito";
 import coinConfig from "../config";
 
-let tezos: TezosToolkit | null = null;
-
+// Tezos client instance is cached to avoid costly rebuild at every request
+// Watch out: cache key is the URL, coin module can be instantiated several times with different URLs
+const servers = new Map<string, TezosToolkit>();
 export function getTezosToolkit(): TezosToolkit {
-  if (!tezos) {
-    tezos = new TezosToolkit(coinConfig.getCoinConfig().node.url);
+  const url = coinConfig.getCoinConfig().node.url;
+  let server = servers.get(url);
+  if (server === undefined) {
+    server = new TezosToolkit(url);
+    servers.set(url, server);
   }
-  return tezos;
+  return server;
 }

package/src/types/assets.ts

@@ -0,0 +1,3 @@
+import { Asset } from "@ledgerhq/coin-framework/api/types";
+
+export type TezosAsset = Asset;

package/src/types/index.ts

@@ -1,3 +1,4 @@
+export * from "./assets";
 export * from "./bridge";
 export * from "./errors";
 export * from "./model";