@ledgerhq/wallet-api-exchange-module 0.1.0

package/.eslintignore

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

package/.eslintrc.js

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,4 @@
+
+> @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

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

package/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017-present Ledger https://www.ledger.com/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/jest.config.js

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

package/lib/index.d.ts

@@ -0,0 +1,86 @@
+/// <reference types="node" />
+import { CustomModule, Transaction } from "@ledgerhq/wallet-api-client";
+import { ExchangeCompleteParams, ExchangeStartParams } from "./types";
+export * from "./types";
+export declare 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
+     */
+    start(exchangeType: ExchangeStartParams["exchangeType"]): Promise<string>;
+    /**
+     * 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.
+     */
+    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;
+    }): Promise<string>;
+    /**
+     * 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.
+     */
+    completeSell({ provider, fromAccountId, transaction, binaryPayload, signature, feeStrategy, }: {
+        provider: string;
+        fromAccountId: string;
+        transaction: Transaction;
+        binaryPayload: Buffer;
+        signature: Buffer;
+        feeStrategy: ExchangeCompleteParams["feeStrategy"];
+    }): Promise<string>;
+    /**
+     * 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.
+     */
+    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>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAwB,MAAM,6BAA6B,CAAC;AAC9F,OAAO,EACL,sBAAsB,EAEtB,mBAAmB,EAEpB,MAAM,SAAS,CAAC;AAEjB,cAAc,SAAS,CAAC;AAGxB,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;;;;OAKG;IACG,KAAK,CAAC,YAAY,EAAE,mBAAmB,CAAC,cAAc,CAAC;IAW7D;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,MAAM,EACN,IAAI,EACJ,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,GACd,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,WAAW,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;QACnD,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAqBD;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,WAAW,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;KACpD,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBnB;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,GACd,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,WAAW,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;QACnD,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBpB"}

package/lib/index.js

@@ -0,0 +1,137 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExchangeModule = void 0;
+const wallet_api_client_1 = require("@ledgerhq/wallet-api-client");
+__exportStar(require("./types"), exports);
+// TODO maybe find a better way to type the available custom requests with correct types
+class ExchangeModule extends wallet_api_client_1.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
+     */
+    start(exchangeType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request("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.
+     */
+    completeSwap({ provider, fromAccountId, toAccountId, swapId, rate, transaction, binaryPayload, signature, feeStrategy, tokenCurrency, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request("custom.exchange.complete", {
+                exchangeType: "SWAP",
+                provider,
+                fromAccountId,
+                toAccountId,
+                swapId,
+                rate,
+                rawTransaction: (0, wallet_api_client_1.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.
+     */
+    completeSell({ provider, fromAccountId, transaction, binaryPayload, signature, feeStrategy, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request("custom.exchange.complete", {
+                exchangeType: "SELL",
+                provider,
+                fromAccountId,
+                rawTransaction: (0, wallet_api_client_1.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.
+     */
+    completeFund({ provider, fromAccountId, transaction, binaryPayload, signature, feeStrategy, tokenCurrency, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request("custom.exchange.complete", {
+                exchangeType: "FUND",
+                provider,
+                fromAccountId,
+                rawTransaction: (0, wallet_api_client_1.serializeTransaction)(transaction),
+                hexBinaryPayload: binaryPayload.toString("hex"),
+                hexSignature: signature.toString("hex"),
+                feeStrategy,
+                tokenCurrency,
+            });
+            return result.transactionHash;
+        });
+    }
+}
+exports.ExchangeModule = ExchangeModule;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mEAA8F;AAQ9F,0CAAwB;AAExB,wFAAwF;AACxF,MAAa,cAAe,SAAQ,gCAAY;IAC9C;;;;;OAKG;IACG,KAAK,CAAC,YAAiD;;YAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,uBAAuB,EACvB;gBACE,YAAY;aACb,CACF,CAAC;YAEF,OAAO,MAAM,CAAC,aAAa,CAAC;QAC9B,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,MAAM,EACN,IAAI,EACJ,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,GAYd;;YACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,0BAA0B,EAC1B;gBACE,YAAY,EAAE,MAAM;gBACpB,QAAQ;gBACR,aAAa;gBACb,WAAW;gBACX,MAAM;gBACN,IAAI;gBACJ,cAAc,EAAE,IAAA,wCAAoB,EAAC,WAAW,CAAC;gBACjD,gBAAgB,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC/C,YAAY,EAAE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvC,WAAW;gBACX,aAAa;aACd,CACF,CAAC;YAEF,OAAO,MAAM,CAAC,eAAe,CAAC;QAChC,CAAC;KAAA;IAED;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,GAQZ;;YACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,0BAA0B,EAC1B;gBACE,YAAY,EAAE,MAAM;gBACpB,QAAQ;gBACR,aAAa;gBACb,cAAc,EAAE,IAAA,wCAAoB,EAAC,WAAW,CAAC;gBACjD,gBAAgB,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC/C,YAAY,EAAE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvC,WAAW;aACZ,CACF,CAAC;YAEF,OAAO,MAAM,CAAC,eAAe,CAAC;QAChC,CAAC;KAAA;IAED;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,GASd;;YACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,0BAA0B,EAC1B;gBACE,YAAY,EAAE,MAAM;gBACpB,QAAQ;gBACR,aAAa;gBACb,cAAc,EAAE,IAAA,wCAAoB,EAAC,WAAW,CAAC;gBACjD,gBAAgB,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC/C,YAAY,EAAE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvC,WAAW;gBACX,aAAa;aACd,CACF,CAAC;YAEF,OAAO,MAAM,CAAC,eAAe,CAAC;QAChC,CAAC;KAAA;CACF;AAxKD,wCAwKC"}

package/lib/types.d.ts

@@ -0,0 +1,41 @@
+import { RawTransaction } from "@ledgerhq/wallet-api-core";
+export declare enum ExchangeType {
+    SWAP = 0,
+    SELL = 1,
+    FUND = 2,
+    SWAP_NG = 3,
+    SELL_NG = 4,
+    FUND_NG = 5
+}
+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;
+};
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,oBAAY,YAAY;IACtB,IAAI,IAAO;IACX,IAAI,IAAO;IACX,IAAI,IAAO;IACX,OAAO,IAAO;IACd,OAAO,IAAO;IACd,OAAO,IAAO;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;CAC5E,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,cAAc,CAAC;IAC/B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG;IACpE,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG;IACpE,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG;IACpE,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAC9B,0BAA0B,GAC1B,0BAA0B,GAC1B,0BAA0B,CAAC;AAE/B,MAAM,MAAM,sBAAsB,GAAG;IACnC,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/lib/types.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExchangeType = void 0;
+var ExchangeType;
+(function (ExchangeType) {
+    ExchangeType[ExchangeType["SWAP"] = 0] = "SWAP";
+    ExchangeType[ExchangeType["SELL"] = 1] = "SELL";
+    ExchangeType[ExchangeType["FUND"] = 2] = "FUND";
+    ExchangeType[ExchangeType["SWAP_NG"] = 3] = "SWAP_NG";
+    ExchangeType[ExchangeType["SELL_NG"] = 4] = "SELL_NG";
+    ExchangeType[ExchangeType["FUND_NG"] = 5] = "FUND_NG";
+})(ExchangeType || (exports.ExchangeType = ExchangeType = {}));
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAEA,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,+CAAW,CAAA;IACX,+CAAW,CAAA;IACX,+CAAW,CAAA;IACX,qDAAc,CAAA;IACd,qDAAc,CAAA;IACd,qDAAc,CAAA;AAChB,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB"}

package/lib-es/index.d.ts

@@ -0,0 +1,86 @@
+/// <reference types="node" />
+import { CustomModule, Transaction } from "@ledgerhq/wallet-api-client";
+import { ExchangeCompleteParams, ExchangeStartParams } from "./types";
+export * from "./types";
+export declare 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
+     */
+    start(exchangeType: ExchangeStartParams["exchangeType"]): Promise<string>;
+    /**
+     * 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.
+     */
+    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;
+    }): Promise<string>;
+    /**
+     * 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.
+     */
+    completeSell({ provider, fromAccountId, transaction, binaryPayload, signature, feeStrategy, }: {
+        provider: string;
+        fromAccountId: string;
+        transaction: Transaction;
+        binaryPayload: Buffer;
+        signature: Buffer;
+        feeStrategy: ExchangeCompleteParams["feeStrategy"];
+    }): Promise<string>;
+    /**
+     * 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.
+     */
+    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>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib-es/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAwB,MAAM,6BAA6B,CAAC;AAC9F,OAAO,EACL,sBAAsB,EAEtB,mBAAmB,EAEpB,MAAM,SAAS,CAAC;AAEjB,cAAc,SAAS,CAAC;AAGxB,qBAAa,cAAe,SAAQ,YAAY;IAC9C;;;;;OAKG;IACG,KAAK,CAAC,YAAY,EAAE,mBAAmB,CAAC,cAAc,CAAC;IAW7D;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,MAAM,EACN,IAAI,EACJ,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,GACd,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,WAAW,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;QACnD,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAqBD;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,WAAW,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;KACpD,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBnB;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,GACd,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,WAAW,EAAE,WAAW,CAAC;QACzB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;QACnD,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBpB"}

package/lib-es/index.js

@@ -0,0 +1,119 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { CustomModule, serializeTransaction } from "@ledgerhq/wallet-api-client";
+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
+     */
+    start(exchangeType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request("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.
+     */
+    completeSwap({ provider, fromAccountId, toAccountId, swapId, rate, transaction, binaryPayload, signature, feeStrategy, tokenCurrency, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request("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.
+     */
+    completeSell({ provider, fromAccountId, transaction, binaryPayload, signature, feeStrategy, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request("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.
+     */
+    completeFund({ provider, fromAccountId, transaction, binaryPayload, signature, feeStrategy, tokenCurrency, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.request("custom.exchange.complete", {
+                exchangeType: "FUND",
+                provider,
+                fromAccountId,
+                rawTransaction: serializeTransaction(transaction),
+                hexBinaryPayload: binaryPayload.toString("hex"),
+                hexSignature: signature.toString("hex"),
+                feeStrategy,
+                tokenCurrency,
+            });
+            return result.transactionHash;
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/lib-es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAe,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAQ9F,cAAc,SAAS,CAAC;AAExB,wFAAwF;AACxF,MAAM,OAAO,cAAe,SAAQ,YAAY;IAC9C;;;;;OAKG;IACG,KAAK,CAAC,YAAiD;;YAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,uBAAuB,EACvB;gBACE,YAAY;aACb,CACF,CAAC;YAEF,OAAO,MAAM,CAAC,aAAa,CAAC;QAC9B,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,MAAM,EACN,IAAI,EACJ,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,GAYd;;YACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,0BAA0B,EAC1B;gBACE,YAAY,EAAE,MAAM;gBACpB,QAAQ;gBACR,aAAa;gBACb,WAAW;gBACX,MAAM;gBACN,IAAI;gBACJ,cAAc,EAAE,oBAAoB,CAAC,WAAW,CAAC;gBACjD,gBAAgB,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC/C,YAAY,EAAE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvC,WAAW;gBACX,aAAa;aACd,CACF,CAAC;YAEF,OAAO,MAAM,CAAC,eAAe,CAAC;QAChC,CAAC;KAAA;IAED;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,GAQZ;;YACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,0BAA0B,EAC1B;gBACE,YAAY,EAAE,MAAM;gBACpB,QAAQ;gBACR,aAAa;gBACb,cAAc,EAAE,oBAAoB,CAAC,WAAW,CAAC;gBACjD,gBAAgB,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC/C,YAAY,EAAE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvC,WAAW;aACZ,CACF,CAAC;YAEF,OAAO,MAAM,CAAC,eAAe,CAAC;QAChC,CAAC;KAAA;IAED;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,EACjB,QAAQ,EACR,aAAa,EACb,WAAW,EACX,aAAa,EACb,SAAS,EACT,WAAW,EACX,aAAa,GASd;;YACC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,0BAA0B,EAC1B;gBACE,YAAY,EAAE,MAAM;gBACpB,QAAQ;gBACR,aAAa;gBACb,cAAc,EAAE,oBAAoB,CAAC,WAAW,CAAC;gBACjD,gBAAgB,EAAE,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC/C,YAAY,EAAE,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvC,WAAW;gBACX,aAAa;aACd,CACF,CAAC;YAEF,OAAO,MAAM,CAAC,eAAe,CAAC;QAChC,CAAC;KAAA;CACF"}

package/lib-es/types.d.ts

@@ -0,0 +1,41 @@
+import { RawTransaction } from "@ledgerhq/wallet-api-core";
+export declare enum ExchangeType {
+    SWAP = 0,
+    SELL = 1,
+    FUND = 2,
+    SWAP_NG = 3,
+    SELL_NG = 4,
+    FUND_NG = 5
+}
+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;
+};
+//# sourceMappingURL=types.d.ts.map

package/lib-es/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D,oBAAY,YAAY;IACtB,IAAI,IAAO;IACX,IAAI,IAAO;IACX,IAAI,IAAO;IACX,OAAO,IAAO;IACd,OAAO,IAAO;IACd,OAAO,IAAO;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;CAC5E,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,cAAc,CAAC;IAC/B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG;IACpE,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG;IACpE,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG;IACpE,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAC9B,0BAA0B,GAC1B,0BAA0B,GAC1B,0BAA0B,CAAC;AAE/B,MAAM,MAAM,sBAAsB,GAAG;IACnC,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/lib-es/types.js

@@ -0,0 +1,10 @@
+export var ExchangeType;
+(function (ExchangeType) {
+    ExchangeType[ExchangeType["SWAP"] = 0] = "SWAP";
+    ExchangeType[ExchangeType["SELL"] = 1] = "SELL";
+    ExchangeType[ExchangeType["FUND"] = 2] = "FUND";
+    ExchangeType[ExchangeType["SWAP_NG"] = 3] = "SWAP_NG";
+    ExchangeType[ExchangeType["SELL_NG"] = 4] = "SELL_NG";
+    ExchangeType[ExchangeType["FUND_NG"] = 5] = "FUND_NG";
+})(ExchangeType || (ExchangeType = {}));
+//# sourceMappingURL=types.js.map

package/lib-es/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,+CAAW,CAAA;IACX,+CAAW,CAAA;IACX,+CAAW,CAAA;IACX,qDAAc,CAAA;IACd,qDAAc,CAAA;IACd,qDAAc,CAAA;AAChB,CAAC,EAPW,YAAY,KAAZ,YAAY,QAOvB"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@ledgerhq/wallet-api-exchange-module",
+  "version": "0.1.0",
+  "description": "Wallet-API Exchange Module for Ledger Live",
+  "license": "Apache-2.0",
+  "keywords": [
+    "Ledger"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LedgerHQ/ledger-live.git"
+  },
+  "bugs": {
+    "url": "https://github.com/LedgerHQ/ledger-live/issues"
+  },
+  "homepage": "https://github.com/LedgerHQ/ledger-live/tree/develop/libs/exchange-module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ledgerhq/wallet-api-client": "^1.5.0",
+    "@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"
+  },
+  "scripts": {
+    "clean": "rimraf lib lib-es",
+    "build": "tsc && tsc -m ES6 --outDir lib-es",
+    "prewatch": "pnpm build",
+    "watch": "tsc --watch",
+    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx",
+    "lint:fix": "pnpm lint --fix",
+    "test": "jest"
+  }
+}

package/src/index.ts

@@ -0,0 +1,180 @@
+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

@@ -0,0 +1,52 @@
+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

@@ -0,0 +1,15 @@
+{
+  "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/**/*"]
+}