@ledgerhq/wallet-api-exchange-module 0.1.0 → 0.2.0-next.0

package/lib-es/package.json

@@ -0,0 +1 @@
+{ "type": "module" }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/wallet-api-exchange-module",
-  "version": "0.1.0",
+  "version": "0.2.0-next.0",
   "description": "Wallet-API Exchange Module for Ledger Live",
   "license": "Apache-2.0",
   "keywords": [
@@ -14,6 +14,13 @@
     "url": "https://github.com/LedgerHQ/ledger-live/issues"
   },
   "homepage": "https://github.com/LedgerHQ/ledger-live/tree/develop/libs/exchange-module",
+  "main": "lib/index.js",
+  "module": "lib-es/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "/lib",
+    "/lib-es"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -22,50 +29,14 @@
     "@ledgerhq/wallet-api-core": "^1.6.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.4",
-    "@types/node": "^20.2.5",
-    "jest": "^28.1.1",
-    "jest-environment-jsdom": "28",
-    "ts-jest": "^28.0.5"
-  },
-  "typesVersions": {
-    "*": {
-      "*.json": [
-        "*.json"
-      ],
-      "*": [
-        "lib/*"
-      ],
-      "lib/*": [
-        "lib/*"
-      ],
-      "lib-es/*": [
-        "lib-es/*"
-      ]
-    }
-  },
-  "exports": {
-    "./lib/*": "./lib/*.js",
-    "./lib/*.js": "./lib/*.js",
-    "./lib-es/*": "./lib-es/*.js",
-    "./lib-es/*.js": "./lib-es/*.js",
-    "./*": {
-      "require": "./lib/*.js",
-      "default": "./lib-es/*.js"
-    },
-    "./*.js": {
-      "require": "./lib/*.js",
-      "default": "./lib-es/*.js"
-    },
-    "./package.json": "./package.json"
+    "@types/node": "^20.2.5"
   },
   "scripts": {
     "clean": "rimraf lib lib-es",
-    "build": "tsc && tsc -m ES6 --outDir lib-es",
+    "build": "tsc && tsc -m ES6 --outDir lib-es && echo '{ \"type\": \"module\" }' > lib-es/package.json",
     "prewatch": "pnpm build",
     "watch": "tsc --watch",
     "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx",
-    "lint:fix": "pnpm lint --fix",
-    "test": "jest"
+    "lint:fix": "pnpm lint --fix"
   }
 }

package/.eslintignore

@@ -1,2 +0,0 @@
-lib/
-lib-es/

package/.eslintrc.js

@@ -1,20 +0,0 @@
-module.exports = {
-  env: {
-    browser: true,
-    es6: true,
-  },
-  overrides: [
-    {
-      files: ["src/**/*.test.{ts,tsx}"],
-      env: {
-        "jest/globals": true,
-      },
-      plugins: ["jest"],
-    },
-  ],
-  rules: {
-    "no-console": ["error", { allow: ["warn", "error"] }],
-    "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/no-explicit-any": "warn",
-  },
-};

package/.turbo/turbo-build.log

@@ -1,4 +0,0 @@
-
-> @ledgerhq/wallet-api-exchange-module@0.1.0 build /home/runner/work/ledger-live/ledger-live/libs/exchange-module
-> tsc && tsc -m ES6 --outDir lib-es
-

package/.unimportedrc.json

@@ -1,5 +0,0 @@
-{
-  "entry": ["src/index.ts"],
-  "ignoreUnimported": [],
-  "ignoreUnresolved": []
-}

package/jest.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-  preset: "ts-jest",
-  testEnvironment: "jsdom",
-  testPathIgnorePatterns: ["lib/", "lib-es/"],
-  globals: {
-    "ts-jest": {
-      isolatedModules: true,
-    },
-  },
-};

package/src/index.ts

@@ -1,180 +0,0 @@
-import { CustomModule, Transaction, serializeTransaction } from "@ledgerhq/wallet-api-client";
-import {
-  ExchangeCompleteParams,
-  ExchangeCompleteResult,
-  ExchangeStartParams,
-  ExchangeStartResult,
-} from "./types";
-
-export * from "./types";
-
-// TODO maybe find a better way to type the available custom requests with correct types
-export class ExchangeModule extends CustomModule {
-  /**
-   * Start the exchange process by generating a nonce on Ledger device
-   * @param exchangeType - used by the exchange transport to discern between swap/sell/fund
-   *
-   * @returns - A transaction ID used to complete the exchange process
-   */
-  async start(exchangeType: ExchangeStartParams["exchangeType"]) {
-    const result = await this.request<ExchangeStartParams, ExchangeStartResult>(
-      "custom.exchange.start",
-      {
-        exchangeType,
-      },
-    );
-
-    return result.transactionId;
-  }
-
-  /**
-   * Complete an exchange swap process by passing by the exchange content and its signature.
-   * User will be prompted on its device to approve the swap exchange operation.
-   * If the exchange is validated, the transaction is then signed and broadcasted to the network.
-   * @param provider - Used to verify the signature
-   * @param fromAccountId - Identifier of the account used as a source for the tx or parent account (for "new token")
-   * @param toAccountId - Identifier of the account or parent account (for "new token") used as a destination
-   * @param swapId - Identifier of the swap used by backend
-   * @param rate - Swap rate in the transaction
-   * @param tokenCurrency - "new token" used in the transaction, not listed yet in wallet-api list
-   * @param transaction - Transaction containing the recipient and amount
-   * @param binaryPayload - Blueprint of the data that we'll allow signing
-   * @param signature - Ensures the source of the payload
-   * @param feesStrategy - Slow / Medium / Fast
-   *
-   * @returns - The broadcasted transaction hash.
-   */
-  async completeSwap({
-    provider,
-    fromAccountId,
-    toAccountId,
-    swapId,
-    rate,
-    transaction,
-    binaryPayload,
-    signature,
-    feeStrategy,
-    tokenCurrency,
-  }: {
-    provider: string;
-    fromAccountId: string;
-    toAccountId: string;
-    swapId: string;
-    rate: number;
-    transaction: Transaction;
-    binaryPayload: Buffer;
-    signature: Buffer;
-    feeStrategy: ExchangeCompleteParams["feeStrategy"];
-    tokenCurrency?: string;
-  }) {
-    const result = await this.request<ExchangeCompleteParams, ExchangeCompleteResult>(
-      "custom.exchange.complete",
-      {
-        exchangeType: "SWAP",
-        provider,
-        fromAccountId,
-        toAccountId,
-        swapId,
-        rate,
-        rawTransaction: serializeTransaction(transaction),
-        hexBinaryPayload: binaryPayload.toString("hex"),
-        hexSignature: signature.toString("hex"),
-        feeStrategy,
-        tokenCurrency,
-      },
-    );
-
-    return result.transactionHash;
-  }
-
-  /**
-   * Complete an exchange sell process by passing by the exchange content and its signature.
-   * User will be prompted on its device to approve the sell exchange operation.
-   * If the exchange is validated, the transaction is then signed and broadcasted to the network.
-   * @param provider - Used to verify the signature
-   * @param fromAccountId - Identifier of the account used as a source for the tx
-   * @param transaction - Transaction containing the recipient and amount
-   * @param binaryPayload - Blueprint of the data that we'll allow signing
-   * @param signature - Ensures the source of the payload
-   * @param feesStrategy - Slow / Medium / Fast
-   *
-   * @returns - The broadcasted transaction hash.
-   */
-  async completeSell({
-    provider,
-    fromAccountId,
-    transaction,
-    binaryPayload,
-    signature,
-    feeStrategy,
-  }: {
-    provider: string;
-    fromAccountId: string;
-    transaction: Transaction;
-    binaryPayload: Buffer;
-    signature: Buffer;
-    feeStrategy: ExchangeCompleteParams["feeStrategy"];
-  }): Promise<string> {
-    const result = await this.request<ExchangeCompleteParams, ExchangeCompleteResult>(
-      "custom.exchange.complete",
-      {
-        exchangeType: "SELL",
-        provider,
-        fromAccountId,
-        rawTransaction: serializeTransaction(transaction),
-        hexBinaryPayload: binaryPayload.toString("hex"),
-        hexSignature: signature.toString("hex"),
-        feeStrategy,
-      },
-    );
-
-    return result.transactionHash;
-  }
-
-  /**
-   * Complete an exchange fund process by passing by the exchange content and its signature.
-   * User will be prompted on its device to approve the fund exchange operation.
-   * If the exchange is validated, the transaction is then signed and broadcasted to the network.
-   * @param provider - Used to verify the signature
-   * @param fromAccountId - Identifier of the account used as a source for the tx
-   * @param transaction - Transaction containing the recipient and amount
-   * @param binaryPayload - Blueprint of the data that we'll allow signing
-   * @param signature - Ensures the source of the payload
-   * @param feesStrategy - Slow / Medium / Fast
-   *
-   * @returns - The broadcasted transaction hash.
-   */
-  async completeFund({
-    provider,
-    fromAccountId,
-    transaction,
-    binaryPayload,
-    signature,
-    feeStrategy,
-    tokenCurrency,
-  }: {
-    provider: string;
-    fromAccountId: string;
-    transaction: Transaction;
-    binaryPayload: Buffer;
-    signature: Buffer;
-    feeStrategy: ExchangeCompleteParams["feeStrategy"];
-    tokenCurrency?: string;
-  }): Promise<string> {
-    const result = await this.request<ExchangeCompleteParams, ExchangeCompleteResult>(
-      "custom.exchange.complete",
-      {
-        exchangeType: "FUND",
-        provider,
-        fromAccountId,
-        rawTransaction: serializeTransaction(transaction),
-        hexBinaryPayload: binaryPayload.toString("hex"),
-        hexSignature: signature.toString("hex"),
-        feeStrategy,
-        tokenCurrency,
-      },
-    );
-
-    return result.transactionHash;
-  }
-}

package/src/types.ts

@@ -1,52 +0,0 @@
-import { RawTransaction } from "@ledgerhq/wallet-api-core";
-
-export enum ExchangeType {
-  SWAP = 0x00,
-  SELL = 0x01,
-  FUND = 0x02,
-  SWAP_NG = 0x03,
-  SELL_NG = 0x04,
-  FUND_NG = 0x05,
-}
-
-export type ExchangeStartParams = {
-  exchangeType: "FUND" | "SELL" | "SWAP" | "FUND_NG" | "SELL_NG" | "SWAP_NG";
-};
-
-export type ExchangeStartResult = {
-  transactionId: string;
-};
-
-export type ExchangeCompleteBaseParams = {
-  provider: string;
-  fromAccountId: string;
-  rawTransaction: RawTransaction;
-  hexBinaryPayload: string;
-  hexSignature: string;
-  feeStrategy: "SLOW" | "MEDIUM" | "FAST" | "CUSTOM";
-  tokenCurrency?: string;
-};
-
-export type ExchangeCompleteFundParams = ExchangeCompleteBaseParams & {
-  exchangeType: "FUND";
-};
-
-export type ExchangeCompleteSellParams = ExchangeCompleteBaseParams & {
-  exchangeType: "SELL";
-};
-
-export type ExchangeCompleteSwapParams = ExchangeCompleteBaseParams & {
-  exchangeType: "SWAP";
-  toAccountId: string;
-  swapId: string;
-  rate: number;
-};
-
-export type ExchangeCompleteParams =
-  | ExchangeCompleteFundParams
-  | ExchangeCompleteSellParams
-  | ExchangeCompleteSwapParams;
-
-export type ExchangeCompleteResult = {
-  transactionHash: string;
-};

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "extends": "../../tsconfig.base",
-  "compilerOptions": {
-    "declaration": true,
-    "declarationMap": true,
-    "noImplicitAny": false,
-    "noImplicitThis": false,
-    "downlevelIteration": true,
-    "module": "commonjs",
-    "lib": ["es2020", "dom"],
-    "jsx": "react",
-    "outDir": "lib"
-  },
-  "include": ["src/**/*"]
-}