[Coin Fmk] Batcher moving to Network (#6819)

* chore: move batcher to live-network Signed-off-by: Stéphane Prohaszka <[email protected]> * feat: add new network method to avoid expose Axos types Signed-off-by: Stéphane Prohaszka <[email protected]> * fix: network package Signed-off-by: Stéphane Prohaszka <[email protected]> * feat: mark as deprecated old network function Signed-off-by: Stéphane Prohaszka <[email protected]> --------- Signed-off-by: Stéphane Prohaszka <[email protected]>
LedgerHQ · May 22, 2024 · 326cae0 · 326cae0
1 parent dbe40aa
commit 326cae0
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 26 deletions.
diff --git a/.changeset/good-ducks-own.md b/.changeset/good-ducks-own.md
@@ -0,0 +1,6 @@
+---
+"@ledgerhq/live-network": minor
+"@ledgerhq/coin-framework": patch
+---
+
+Add Batcher to live-network and partition Axios types
diff --git a/libs/coin-framework/package.json b/libs/coin-framework/package.json
@@ -87,6 +87,7 @@
     "@ledgerhq/devices": "workspace:^",
     "@ledgerhq/errors": "workspace:^",
     "@ledgerhq/live-env": "workspace:^",
+    "@ledgerhq/live-network": "workspace:^",
     "@ledgerhq/logs": "workspace:^",
     "@ledgerhq/types-cryptoassets": "workspace:^",
     "@ledgerhq/types-live": "workspace:^",

diff --git a/libs/coin-framework/src/nft/support.ts b/libs/coin-framework/src/nft/support.ts
@@ -7,7 +7,7 @@ import type {
 import { getEnv } from "@ledgerhq/live-env";
 import type { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 import { CollectionMetadataInput, NftMetadataInput, NftRequestsBatcher } from "./types";
-import { makeBatcher } from "../batcher";
+import { makeBatcher } from "@ledgerhq/live-network/batcher";
 
 export function isNFTActive(currency: CryptoCurrency | undefined | null): boolean {
   return !!currency && getEnv("NFT_CURRENCIES").split(",").includes(currency?.id);

diff --git a/libs/coin-framework/src/nft/types.ts b/libs/coin-framework/src/nft/types.ts
@@ -1,5 +1,5 @@
 import { NFTCollectionMetadataResponse, NFTMetadataResponse } from "@ledgerhq/types-live";
-import { Batcher } from "../batcher/types";
+import { Batcher } from "@ledgerhq/live-network/batcher/types";
 
 export type NftMetadataInput = {
   contract: string;

diff --git a/libs/coin-modules/coin-evm/src/api/node/ledger.ts b/libs/coin-modules/coin-evm/src/api/node/ledger.ts
@@ -5,8 +5,8 @@ import { getEnv } from "@ledgerhq/live-env";
 import { delay } from "@ledgerhq/live-promise";
 import axios, { AxiosRequestConfig } from "axios";
 import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
-import { Batcher } from "@ledgerhq/coin-framework/batcher/types";
-import { makeBatcher } from "@ledgerhq/coin-framework/batcher/index";
+import { Batcher } from "@ledgerhq/live-network/batcher/types";
+import { makeBatcher } from "@ledgerhq/live-network/batcher/index";
 import { GasEstimationError, LedgerNodeUsedIncorrectly } from "../../errors";
 import OptimismGasPriceOracleAbi from "../../abis/optimismGasPriceOracle.abi.json";
 import { getSerializedTransaction } from "../../transaction";

diff --git a/libs/coin-modules/coin-polkadot/src/network/sidecar.ts b/libs/coin-modules/coin-polkadot/src/network/sidecar.ts
@@ -3,7 +3,7 @@ import querystring from "querystring";
 import { TypeRegistry } from "@polkadot/types";
 import { Extrinsics } from "@polkadot/types/metadata/decorate/types";
 import { getEnv } from "@ledgerhq/live-env";
-import network from "@ledgerhq/live-network/network";
+import network from "@ledgerhq/live-network";
 import { hours, makeLRUCache } from "@ledgerhq/live-network/cache";
 import type {
   PolkadotValidator,
@@ -58,12 +58,7 @@ const ELECTION_STATUS_OPTIMISTIC_THRESHOLD = getEnv("POLKADOT_ELECTION_STATUS_TH
  * @returns {SidecarAccountBalanceInfo}
  */
 const fetchBalanceInfo = async (addr: string): Promise<SidecarAccountBalanceInfo> => {
-  const {
-    data,
-  }: {
-    data: SidecarAccountBalanceInfo;
-  } = await network({
-    method: "GET",
+  const { data } = await network<SidecarAccountBalanceInfo>({
     url: getSidecarUrl(`/accounts/${addr}/balance-info`),
   });
   return data;

diff --git a/libs/live-network/.unimportedrc.json b/libs/live-network/.unimportedrc.json
@@ -1,5 +1,11 @@
 {
-  "entry": ["src/network.ts", "src/cache.ts"],
+  "entry": [
+    "src/batcher/index.ts",
+    "src/batcher/types.ts",
+    "src/cache.ts",
+    "src/index.ts",
+    "src/network.ts"
+  ],
   "ignoreUnimported": [],
   "ignoreUnresolved": []
 }
diff --git a/libs/live-network/package.json b/libs/live-network/package.json
@@ -18,17 +18,18 @@
   },
   "typesVersions": {
     "*": {
-      "*.json": [
-        "*.json"
-      ],
-      "*": [
-        "lib/*"
-      ],
       "lib/*": [
         "lib/*"
       ],
       "lib-es/*": [
         "lib-es/*"
+      ],
+      "batcher": [
+        "lib/batcher/index"
+      ],
+      "*": [
+        "lib/*",
+        "lib/batcher/*"
       ]
     }
   },
@@ -37,6 +38,14 @@
     "./lib/*.js": "./lib/*.js",
     "./lib-es/*": "./lib-es/*.js",
     "./lib-es/*.js": "./lib-es/*.js",
+    "./batcher": {
+      "require": "./lib/batcher/index.js",
+      "default": "./lib-es/batcher/index.js"
+    },
+    "./batcher/*": {
+      "require": "./lib/batcher/*.js",
+      "default": "./lib-es/batcher/*.js"
+    },
     "./*": {
       "require": "./lib/*.js",
       "default": "./lib-es/*.js"
@@ -45,6 +54,10 @@
       "require": "./lib/*.js",
       "default": "./lib-es/*.js"
     },
+    ".": {
+      "require": "./lib/index.js",
+      "default": "./lib-es/index.js"
+    },
     "./package.json": "./package.json"
   },
   "license": "Apache-2.0",
@@ -54,7 +67,6 @@
     "@ledgerhq/live-promise": "workspace:^",
     "@ledgerhq/logs": "workspace:^",
     "axios": "0.26.1",
-    "invariant": "^2.2.2",
     "lru-cache": "^7.14.1"
   },
   "devDependencies": {

diff --git a/libs/coin-framework/src/batcher/index.ts → libs/live-network/src/batcher/index.ts b/libs/coin-framework/src/batcher/index.ts → libs/live-network/src/batcher/index.ts
diff --git a/libs/coin-framework/src/batcher/types.ts → libs/live-network/src/batcher/types.ts b/libs/coin-framework/src/batcher/types.ts → libs/live-network/src/batcher/types.ts
diff --git a/libs/live-network/src/index.ts b/libs/live-network/src/index.ts
@@ -0,0 +1,2 @@
+import { newImplementation } from "./network";
+export default newImplementation;
diff --git a/libs/live-network/src/network.ts b/libs/live-network/src/network.ts
@@ -1,10 +1,14 @@
+import axios, {
+  AxiosPromise,
+  AxiosResponse,
+  type AxiosError,
+  type AxiosRequestConfig,
+  type Method,
+} from "axios";
 import { LedgerAPI4xx, LedgerAPI5xx, NetworkDown } from "@ledgerhq/errors";
 import { changes, getEnv } from "@ledgerhq/live-env";
 import { retry } from "@ledgerhq/live-promise";
 import { log } from "@ledgerhq/logs";
-import type { AxiosError, AxiosRequestConfig, Method } from "axios";
-import axios, { AxiosPromise, AxiosResponse } from "axios";
-import invariant from "invariant";
 
 type Metadata = { startTime: number };
 type ExtendedXHRConfig = AxiosRequestConfig & { metadata?: Metadata };
@@ -158,8 +162,64 @@ const extractErrorMessage = (raw: string): string | undefined => {
   return;
 };
 
+export type LiveNetworkRequest<T> = {
+  url?: string;
+  method?: "GET" | "POST" | "PUT" | "DELETE";
+  headers?: Record<string, string | number | boolean>;
+  baseURL?: string;
+  params?: unknown;
+  data?: T;
+  timeout?: number;
+};
+export type LiveNetworkResponse<T> = {
+  data: T;
+  status: number;
+};
+/**
+ * Network call
+ * @param request
+ * @returns
+ */
+export const newImplementation = async <T = unknown, U = unknown>(
+  request: LiveNetworkRequest<U>,
+): Promise<LiveNetworkResponse<T>> => {
+  let response: AxiosResponse<T>;
+
+  if (!("method" in request)) {
+    request.method = "GET";
+  }
+
+  if (request.method === "GET") {
+    if (!("timeout" in request)) {
+      request.timeout = getEnv("GET_CALLS_TIMEOUT");
+    }
+
+    response = await retry(() => axios(request), {
+      maxRetry: getEnv("GET_CALLS_RETRY"),
+      retryCondition: error => {
+        if (error && error.status) {
+          // A 422 shouldn't be retried without change as explained in this documentation
+          // https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422
+          return error.status !== 422;
+        }
+        return true;
+      },
+    });
+  } else {
+    response = await axios(request);
+  }
+
+  const { data, status } = response;
+  return { data, status };
+};
+
+/**
+ * Network call
+ * @deprecated Use new method by updating your import: `@ledgerhq/live-network`
+ * @param arg Axios request type
+ * @returns Axios response type
+ */
 const implementation = <T = any>(arg: AxiosRequestConfig): AxiosPromise<T> => {
-  invariant(typeof arg === "object", "network takes an object as parameter");
   let promise: AxiosPromise;
 
   if (arg.method === "GET") {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml