[XRP] Expose functions for Alpaca (#7160)

* feat: separate core logic from bridge logic Signed-off-by: Stéphane Prohaszka <[email protected]> * feat: move files to correct sub dir Signed-off-by: Stéphane Prohaszka <[email protected]> * feat: reorganize module Signed-off-by: Stéphane Prohaszka <[email protected]> * feat: update Polkadot Alpaca api and add consistency with Ripple Signed-off-by: Stéphane Prohaszka <[email protected]> * fix: missing export Signed-off-by: Stéphane Prohaszka <[email protected]> * feat: returns operations content Signed-off-by: Stéphane Prohaszka <[email protected]> * fix: unimported Signed-off-by: Stéphane Prohaszka <[email protected]> * chore: cleanup Signed-off-by: Stéphane Prohaszka <[email protected]> * chore: changeset Signed-off-by: Stéphane Prohaszka <[email protected]> * fix: xrp dataset import Signed-off-by: Stéphane Prohaszka <[email protected]> * feat: add unit test to core Signed-off-by: Stéphane Prohaszka <[email protected]> * feat: add more unit test Signed-off-by: Stéphane Prohaszka <[email protected]> --------- Signed-off-by: Stéphane Prohaszka <[email protected]>
LedgerHQ · Jun 27, 2024 · b14d37d · b14d37d
1 parent f6cea5f
commit b14d37d
Show file tree

Hide file tree

Showing 65 changed files with 1,170 additions and 392 deletions.
diff --git a/.changeset/silly-toes-lick.md b/.changeset/silly-toes-lick.md
@@ -0,0 +1,7 @@
+---
+"@ledgerhq/coin-polkadot": minor
+"@ledgerhq/coin-xrp": minor
+"@ledgerhq/live-common": minor
+---
+
+Expose API on CoinModule (Xrp and Polkadot) so they can be used in a dedicated service
diff --git a/libs/coin-modules/coin-polkadot/.unimportedrc.json b/libs/coin-modules/coin-polkadot/.unimportedrc.json
@@ -1,13 +1,11 @@
 {
   "entry": [
+    "src/api/index.ts",
     "src/bridge/index.ts",
     "src/bridge/deviceTransactionConfig.ts",
     "src/bridge/formatters.ts",
     "src/signer/index.ts",
-    "src/test/cli.ts",
     "src/test/index.ts",
-    "src/test/specs.ts",
-    "src/types/errors.ts",
     "src/index.ts"
   ],
   "ignorePatterns": [

diff --git a/libs/coin-modules/coin-polkadot/package.json b/libs/coin-modules/coin-polkadot/package.json
@@ -83,6 +83,9 @@
       "lib-es/*": [
         "lib-es/*"
       ],
+      "api": [
+        "lib/api/index"
+      ],
       "logic": [
         "lib/logic/index"
       ],
@@ -91,6 +94,7 @@
       ],
       "*": [
         "lib/*",
+        "lib/api/*",
         "lib/bridge/*",
         "lib/logic/*",
         "lib/signer/*",
@@ -102,6 +106,10 @@
   "exports": {
     "./lib/*": "./lib/*.js",
     "./lib-es/*": "./lib-es/*.js",
+    "./api": {
+      "require": "./lib/api/index.js",
+      "default": "./lib-es/api/index.js"
+    },
     "./deviceTransactionConfig": {
       "require": "./lib/bridge/deviceTransactionConfig.js",
       "default": "./lib-es/bridge/deviceTransactionConfig.js"

diff --git a/libs/coin-modules/coin-polkadot/src/api/index.ts b/libs/coin-modules/coin-polkadot/src/api/index.ts
@@ -0,0 +1,63 @@
+import { PolkadotConfig, setCoinConfig } from "../config";
+import {
+  broadcast,
+  craftEstimationTransaction,
+  craftTransaction,
+  defaultExtrinsicArg,
+  estimateFees,
+  getBalance,
+  listOperations,
+  type Operation,
+} from "../logic";
+
+export type Api = {
+  broadcast: (tx: string) => Promise<string>;
+  combine: (tx: string, signature: string, pubkey: string) => string;
+  craftTransaction: (
+    address: string,
+    transaction: {
+      recipient: string;
+      amount: bigint;
+      fee: bigint;
+    },
+  ) => Promise<string>;
+  estimateFees: (addr: string, amount: bigint) => Promise<bigint>;
+  getBalance: (address: string) => Promise<bigint>;
+  listOperations: (address: string, blockHeight: number) => Promise<Operation[]>;
+};
+export function createApi(config: PolkadotConfig): Api {
+  setCoinConfig(() => ({ ...config, status: { type: "active" } }));
+
+  return {
+    broadcast,
+    combine: () => {
+      throw new Error("UnsupportedMethod");
+    },
+    craftTransaction: craft,
+    estimateFees: estimate,
+    getBalance,
+    listOperations,
+  };
+}
+
+async function craft(
+  address: string,
+  transaction: {
+    recipient: string;
+    amount: bigint;
+  },
+): Promise<string> {
+  const extrinsicArg = defaultExtrinsicArg(transaction.amount, transaction.recipient);
+  //TODO: Retrieve correctly the nonce via a call to the node `await api.rpc.system.accountNextIndex(address)`
+  const nonce = -1;
+  const tx = await craftTransaction(address, nonce, extrinsicArg);
+  const extrinsic = tx.registry.createType("Extrinsic", tx.unsigned, {
+    version: tx.unsigned.version,
+  });
+  return extrinsic.toHex();
+}
+
+async function estimate(addr: string, amount: bigint): Promise<bigint> {
+  const tx = await craftEstimationTransaction(addr, amount);
+  return estimateFees(tx);
+}
diff --git a/libs/coin-modules/coin-polkadot/src/logic/broadcast.ts b/libs/coin-modules/coin-polkadot/src/logic/broadcast.ts
@@ -1,7 +1,7 @@
 import polkadotAPI from "../network";
 import { loadPolkadotCrypto } from "./polkadot-crypto";
 
-export default async function broadcast(signature: string): Promise<string> {
+export async function broadcast(signature: string): Promise<string> {
   await loadPolkadotCrypto();
   return await polkadotAPI.submitExtrinsic(signature);
 }
diff --git a/libs/coin-modules/coin-polkadot/src/logic/estimateFees.test.ts b/libs/coin-modules/coin-polkadot/src/logic/estimateFees.test.ts
@@ -1,5 +1,5 @@
 import { loadPolkadotCrypto } from "./polkadot-crypto";
-import estimateFees from "./estimateFees";
+import { estimateFees } from "./estimateFees";
 import {
   fixtureChainSpec,
   fixtureTxMaterialWithMetadata,

diff --git a/libs/coin-modules/coin-polkadot/src/logic/estimateFees.ts b/libs/coin-modules/coin-polkadot/src/logic/estimateFees.ts
@@ -3,10 +3,7 @@ import { fakeSignExtrinsic } from "./signTransaction";
 import polkadotAPI from "../network";
 import { CoreTransaction } from "../types";
 
-export default async function estimateFees({
-  unsigned,
-  registry,
-}: CoreTransaction): Promise<bigint> {
+export async function estimateFees({ unsigned, registry }: CoreTransaction): Promise<bigint> {
   await loadPolkadotCrypto();
 
   const fakeSignedTx = await fakeSignExtrinsic(unsigned, registry);

diff --git a/libs/coin-modules/coin-polkadot/src/logic/getBalance.ts b/libs/coin-modules/coin-polkadot/src/logic/getBalance.ts
@@ -0,0 +1,6 @@
+import network from "../network";
+
+export async function getBalance(addr: string): Promise<bigint> {
+  const balances = await network.getBalances(addr);
+  return BigInt(balances.balance.toString());
+}
diff --git a/libs/coin-modules/coin-polkadot/src/logic/index.ts b/libs/coin-modules/coin-polkadot/src/logic/index.ts
@@ -13,7 +13,7 @@ export {
 } from "./craftTransaction";
 export { signExtrinsic } from "./signTransaction";
 
-import broadcast from "./broadcast";
-import estimateFees from "./estimateFees";
-
-export { broadcast, estimateFees };
+export { broadcast } from "./broadcast";
+export { getBalance } from "./getBalance";
+export { estimateFees } from "./estimateFees";
+export { listOperations, type Operation } from "./listOperations";
diff --git a/libs/coin-modules/coin-polkadot/src/logic/listOperations.ts b/libs/coin-modules/coin-polkadot/src/logic/listOperations.ts
@@ -0,0 +1,49 @@
+import network from "../network";
+import { PolkadotOperation } from "../types";
+
+export type Operation = {
+  hash: string;
+  address: string;
+  type: string;
+  value: bigint;
+  fee: bigint;
+  blockHeight: number;
+  senders: string[];
+  recipients: string[];
+  date: Date;
+  transactionSequenceNumber: number;
+};
+
+export async function listOperations(addr: string): Promise<Operation[]> {
+  //The accountId is used to map Operations to Live types.
+  const fakeAccountId = "";
+  const operations = await network.getOperations(fakeAccountId, addr);
+
+  return operations.map(convertToCoreOperation(addr));
+}
+
+const convertToCoreOperation = (address: string) => (operation: PolkadotOperation) => {
+  const {
+    hash,
+    type,
+    value,
+    fee,
+    blockHeight,
+    senders,
+    recipients,
+    date,
+    transactionSequenceNumber,
+  } = operation;
+  return {
+    hash,
+    address,
+    type,
+    value: BigInt(value.toString()),
+    fee: BigInt(fee.toString()),
+    blockHeight: blockHeight ?? 0,
+    senders,
+    recipients,
+    date,
+    transactionSequenceNumber: transactionSequenceNumber ?? 0,
+  };
+};
diff --git a/libs/coin-modules/coin-polkadot/src/network/index.ts b/libs/coin-modules/coin-polkadot/src/network/index.ts
@@ -2,6 +2,7 @@ import { makeLRUCache, minutes, hours } from "@ledgerhq/live-network/cache";
 import { getOperations as bisonGetOperations } from "./bisontrails";
 import {
   getAccount as sidecardGetAccount,
+  getBalances as sidecardGetBalances,
   getMinimumBondBalance as sidecarGetMinimumBondBalance,
   getRegistry as sidecarGetRegistry,
   getStakingProgress as sidecarGetStakingProgress,
@@ -36,6 +37,14 @@ type PolkadotAPIAccount = {
   nominations: PolkadotNomination[];
 };
 
+type PolkadotAPIBalanceInfo = {
+  blockHeight: number;
+  balance: BigNumber;
+  spendableBalance: BigNumber;
+  nonce: number;
+  lockedBalance: BigNumber;
+};
+
 type CacheOpts = {
   force: boolean;
 };
@@ -96,6 +105,8 @@ const shortenMetadata = async (transaction: string): Promise<string> => {
 
 export default {
   getAccount: async (address: string): Promise<PolkadotAPIAccount> => sidecardGetAccount(address),
+  getBalances: async (address: string): Promise<PolkadotAPIBalanceInfo> =>
+    sidecardGetBalances(address),
   getOperations: bisonGetOperations,
   getMinimumBondBalance,
   getRegistry,

diff --git a/libs/coin-modules/coin-polkadot/src/network/sidecar.ts b/libs/coin-modules/coin-polkadot/src/network/sidecar.ts
@@ -310,7 +310,7 @@ export const getAccount = async (addr: string) => {
  * @async
  * @param {*} addr - the account address
  */
-const getBalances = async (addr: string) => {
+export const getBalances = async (addr: string) => {
   const balanceInfo = await fetchBalanceInfo(addr);
   // Locked is the highest value among locks
   const totalLocked = balanceInfo.locks.reduce((total, lock) => {

diff --git a/libs/coin-modules/coin-xrp/.unimportedrc.json b/libs/coin-modules/coin-xrp/.unimportedrc.json
@@ -1,15 +1,12 @@
 {
   "entry": [
     "src/api/index.ts",
-    "src/bridge/js.ts",
-    "src/cli-transaction.ts",
-    "src/deviceTransactionConfig.ts",
-    "src/errors.ts",
-    "src/hw-getAddress.ts",
-    "src/serialization.ts",
-    "src/specs.ts",
-    "src/transaction.ts",
-    "src/datasets/dataset-1.ts"
+    "src/bridge/index.ts",
+    "src/bridge/deviceTransactionConfig.ts",
+    "src/datasets/dataset-1.ts",
+    "src/signer/index.ts",
+    "src/test/index.ts",
+    "src/index.ts"
   ],
   "ignorePatterns": [
     "**/node_modules/**",

diff --git a/libs/coin-modules/coin-xrp/jest.config.js b/libs/coin-modules/coin-xrp/jest.config.js
@@ -1,6 +1,8 @@
-/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+// `workerThreads: true` is required for validating object with `bigint` values
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
-  testPathIgnorePatterns: ["lib/", "lib-es/"],
+  testPathIgnorePatterns: ["lib/", "lib-es/", ".*\\.integ\\.test\\.[tj]s"],
+  workerThreads: true,
 };
diff --git a/libs/coin-modules/coin-xrp/jest.integ.config.js b/libs/coin-modules/coin-xrp/jest.integ.config.js
@@ -0,0 +1,7 @@
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testRegex: ".integ.test.ts$",
+  testPathIgnorePatterns: ["lib/", "lib-es/"],
+};
diff --git a/libs/coin-modules/coin-xrp/package.json b/libs/coin-modules/coin-xrp/package.json
@@ -28,18 +28,73 @@
       "lib-es/*": [
         "lib-es/*"
       ],
+      "api": [
+        "lib/api/index"
+      ],
+      "deviceTransactionConfig": [
+        "lib/bridge/deviceTransactionConfig"
+      ],
+      "logic": [
+        "lib/logic/index"
+      ],
+      "specs": [
+        "lib/test/bot-specs"
+      ],
+      "transaction": [
+        "lib/bridge/transaction"
+      ],
+      "types": [
+        "lib/types/index"
+      ],
       "*": [
-        "lib/*"
+        "lib/*",
+        "lib/bridge/*",
+        "lib/logic/*",
+        "lib/signer/*",
+        "lib/test/*",
+        "lib/types/*"
       ]
     }
   },
   "exports": {
     "./lib/*": "./lib/*.js",
     "./lib-es/*": "./lib-es/*.js",
+    "./api": {
+      "require": "./lib/api/index.js",
+      "default": "./lib-es/api/index.js"
+    },
+    "./deviceTransactionConfig": {
+      "require": "./lib/bridge/deviceTransactionConfig.js",
+      "default": "./lib-es/bridge/deviceTransactionConfig.js"
+    },
+    "./logic": {
+      "require": "./lib/logic/index.js",
+      "default": "./lib-es/logic/index.js"
+    },
+    "./signer": {
+      "require": "./lib/signer/index.js",
+      "default": "./lib-es/signer/index.js"
+    },
+    "./specs": {
+      "require": "./lib/test/bot-specs.js",
+      "default": "./lib-es/test/bot-specs.js"
+    },
+    "./transaction": {
+      "require": "./lib/bridge/transaction.js",
+      "default": "./lib-es/bridge/transaction.js"
+    },
+    "./types": {
+      "require": "./lib/types/index.js",
+      "default": "./lib-es/types/index.js"
+    },
     "./*": {
       "require": "./lib/*.js",
       "default": "./lib-es/*.js"
     },
+    ".": {
+      "require": "./lib/index.js",
+      "default": "./lib-es/index.js"
+    },
     "./package.json": "./package.json"
   },
   "license": "Apache-2.0",
@@ -57,6 +112,7 @@
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
+    "@faker-js/faker": "^8.4.1",
     "@ledgerhq/types-cryptoassets": "workspace:^",
     "@types/invariant": "^2.2.37",
     "@types/jest": "^29.5.12",
@@ -75,6 +131,7 @@
     "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx --cache",
     "lint:fix": "pnpm lint --fix",
     "test": "jest",
+    "test-integ": "jest --config=jest.integ.config.js",
     "typecheck": "tsc --noEmit",
     "unimported": "unimported"
   }

diff --git a/libs/coin-modules/coin-xrp/please-add-coverage.test.ts b/libs/coin-modules/coin-xrp/please-add-coverage.test.ts