🚀 (signer-utils) [DSDK-556]: Create shared signer utils package (#437)

packages/signer/keyring-btc/package.json

@@ -51,6 +51,7 @@
     "@ledgerhq/eslint-config-dsdk": "workspace:*",
     "@ledgerhq/jest-config-dsdk": "workspace:*",
     "@ledgerhq/prettier-config-dsdk": "workspace:*",
+    "@ledgerhq/signer-utils": "workspace:*",
     "@ledgerhq/tsconfig-dsdk": "workspace:*",
     "ts-node": "^10.9.2"
   },

packages/signer/keyring-btc/src/internal/app-binder/command/GetExtendedPublicKeyCommand.ts

@@ -12,8 +12,7 @@ import {
   GlobalCommandErrorHandler,
   InvalidStatusWordError,
 } from "@ledgerhq/device-management-kit";
-
-import { DerivationPathUtils } from "@internal/shared/utils/DerivationPathUtils";
+import { DerivationPathUtils } from "@ledgerhq/signer-utils";
 
 const STATUS_CODE_LENGTH = 2;
 

packages/signer/keyring-eth/package.json

@@ -51,6 +51,7 @@
     "@ledgerhq/eslint-config-dsdk": "workspace:*",
     "@ledgerhq/jest-config-dsdk": "workspace:*",
     "@ledgerhq/prettier-config-dsdk": "workspace:*",
+    "@ledgerhq/signer-utils": "workspace:*",
     "@ledgerhq/tsconfig-dsdk": "workspace:*",
     "@types/semver": "^7.5.8",
     "rxjs": "^7.8.1",

packages/signer/keyring-eth/src/internal/app-binder/command/GetAddressCommand.ts

@@ -12,12 +12,12 @@ import {
   InvalidStatusWordError,
   isHexaString,
 } from "@ledgerhq/device-management-kit";
+import { DerivationPathUtils } from "@ledgerhq/signer-utils";
 
 import {
   GetAddressCommandArgs,
   GetAddressCommandResponse,
 } from "@api/app-binder/GetAddressCommandTypes";
-import { DerivationPathUtils } from "@internal/shared/utils/DerivationPathUtils";
 
 const CHAIN_CODE_LENGTH = 32;
 

packages/signer/keyring-eth/src/internal/app-binder/command/SignEIP712Command.ts

@@ -12,10 +12,10 @@ import {
   GlobalCommandErrorHandler,
   InvalidStatusWordError,
 } from "@ledgerhq/device-management-kit";
+import { DerivationPathUtils } from "@ledgerhq/signer-utils";
 import { Maybe } from "purify-ts";
 
 import { type Signature } from "@api/model/Signature";
-import { DerivationPathUtils } from "@internal/shared/utils/DerivationPathUtils";
 
 const R_LENGTH = 32;
 const S_LENGTH = 32;

packages/signer/keyring-eth/src/internal/app-binder/task/SendSignPersonalMessageTask.ts

@@ -6,13 +6,13 @@ import {
   InvalidStatusWordError,
   isSuccessCommandResult,
 } from "@ledgerhq/device-management-kit";
+import { DerivationPathUtils } from "@ledgerhq/signer-utils";
 
 import { Signature } from "@api/model/Signature";
 import {
   SignPersonalMessageCommand,
   SignPersonalMessageCommandResponse,
 } from "@internal/app-binder/command/SignPersonalMessageCommand";
-import { DerivationPathUtils } from "@internal/shared/utils/DerivationPathUtils";
 
 import { SendCommandInChunksTask } from "./SendCommandInChunksTask";
 

packages/signer/keyring-eth/src/internal/app-binder/task/SendSignTransactionTask.ts

@@ -6,13 +6,13 @@ import {
   InvalidStatusWordError,
   isSuccessCommandResult,
 } from "@ledgerhq/device-management-kit";
+import { DerivationPathUtils } from "@ledgerhq/signer-utils";
 
 import { Signature } from "@api/index";
 import {
   SignTransactionCommand,
   SignTransactionCommandResponse,
 } from "@internal/app-binder/command/SignTransactionCommand";
-import { DerivationPathUtils } from "@internal/shared/utils/DerivationPathUtils";
 
 import { SendCommandInChunksTask } from "./SendCommandInChunksTask";
 

packages/signer/signer-utils/.prettierignore

@@ -0,0 +1,2 @@
+lib/*
+coverage/*

packages/signer/signer-utils/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require("@ledgerhq/prettier-config-dsdk"),
+};

packages/signer/signer-utils/CHANGELOG.md

@@ -0,0 +1 @@
+# @ledgerhq/signer-utils

packages/signer/signer-utils/README.md

@@ -0,0 +1 @@
+# Ledger Signer Utils Package

packages/signer/signer-utils/eslint.config.mjs

@@ -0,0 +1,13 @@
+import config from "@ledgerhq/eslint-config-dsdk";
+
+export default [
+  ...config,
+  {
+    ignores: ["eslint.config.mjs"],
+    languageOptions: {
+      parserOptions: {
+        project: "./tsconfig.json",
+      },
+    },
+  },
+];

packages/signer/signer-utils/jest.config.ts

@@ -0,0 +1,26 @@
+/* eslint no-restricted-syntax: 0 */
+import { JestConfigWithTsJest, pathsToModuleNameMapper } from "ts-jest";
+
+import { compilerOptions } from "./tsconfig.json";
+
+const paths = pathsToModuleNameMapper(compilerOptions.paths, {
+  prefix: "<rootDir>/",
+});
+
+const config: JestConfigWithTsJest = {
+  preset: "@ledgerhq/jest-config-dsdk",
+  setupFiles: ["<rootDir>/jest.setup.ts"],
+  testPathIgnorePatterns: ["<rootDir>/lib/esm", "<rootDir>/lib/cjs"],
+  collectCoverageFrom: [
+    "src/**/*.ts",
+    "!src/**/*.stub.ts",
+    "!src/index.ts",
+    "!src/api/index.ts",
+    "!src/**/__test-utils__/*",
+  ],
+  moduleNameMapper: {
+    ...paths,
+  },
+};
+
+export default config;

packages/signer/signer-utils/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@ledgerhq/signer-utils",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "private": true,
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    },
+    "./*": {
+      "types": "./lib/types/*",
+      "import": "./lib/esm/*",
+      "require": "./lib/cjs/*"
+    }
+  },
+  "files": [
+    "./lib"
+  ],
+  "scripts": {
+    "prebuild": "rimraf lib",
+    "build": "pnpm lmdk-build --entryPoints src/index.ts,src/**/*.ts --tsconfig tsconfig.prod.json",
+    "dev": "concurrently \"pnpm watch:builds\" \"pnpm watch:types\"",
+    "watch:builds": "pnpm lmdk-watch --entryPoints src/index.ts,src/**/*.ts --tsconfig tsconfig.prod.json",
+    "watch:types": "concurrently \"tsc --watch -p tsconfig.prod.json\" \"tsc-alias --watch -p tsconfig.prod.json\"",
+    "lint": "eslint",
+    "lint:fix": "pnpm lint --fix",
+    "postpack": "find . -name '*.tgz' -exec cp {} ../../../dist/ \\; ",
+    "prettier": "prettier . --check",
+    "prettier:fix": "prettier . --write",
+    "typecheck": "tsc --noEmit",
+    "test": "jest",
+    "test:watch": "pnpm test -- --watch",
+    "test:coverage": "pnpm test -- --coverage"
+  },
+  "devDependencies": {
+    "@ledgerhq/device-management-kit": "workspace:*",
+    "@ledgerhq/esbuild-tools": "workspace:*",
+    "@ledgerhq/eslint-config-dsdk": "workspace:*",
+    "@ledgerhq/jest-config-dsdk": "workspace:*",
+    "@ledgerhq/prettier-config-dsdk": "workspace:*",
+    "@ledgerhq/tsconfig-dsdk": "workspace:*",
+    "ts-node": "^10.9.2"
+  },
+  "peerDependencies": {
+    "@ledgerhq/device-management-kit": "workspace:*"
+  }
+}

packages/signer/signer-utils/src/index.ts

@@ -0,0 +1 @@
+export * from "./utils/DerivationPathUtils";

packages/signer/keyring-eth/src/internal/shared/utils/DerivationPathUtils.ts → packages/signer/signer-utils/src/utils/DerivationPathUtils.ts

@@ -1,5 +1,3 @@
-// TODO: Move to shared package and use in both keyring-btc and keyring-eth
-
 export class DerivationPathUtils {
   static PADDING = 0x80000000;
 

packages/signer/signer-utils/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "@ledgerhq/tsconfig-dsdk/tsconfig.sdk",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": "./lib/types",
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "bundler",
+    "emitDeclarationOnly": true,
+    "paths": {
+      "@api/*": ["./src/api/*"],
+      "@internal/*": ["./src/internal/*"],
+      "@root/*": ["./*"]
+    },
+    "resolveJsonModule": true
+  },
+  "include": ["src", "jest.*.ts"]
+}

packages/signer/signer-utils/tsconfig.prod.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src"]
+}