@ledgerhq/hw-app-eth 6.28.2 → 6.29.0

package/lib-es/utils.js

@@ -1,6 +1,29 @@
 import { encode, decode } from "@ethersproject/rlp";
 import { BigNumber } from "bignumber.js";
-export function decodeTxInfo(rawTx) {
+export function splitPath(path) {
+    var result = [];
+    var components = path.split("/");
+    components.forEach(function (element) {
+        var number = parseInt(element, 10);
+        if (isNaN(number)) {
+            return; // FIXME shouldn't it throws instead?
+        }
+        if (element.length > 1 && element[element.length - 1] === "'") {
+            number += 0x80000000;
+        }
+        result.push(number);
+    });
+    return result;
+}
+export function hexBuffer(str) {
+    return Buffer.from(str.startsWith("0x") ? str.slice(2) : str, "hex");
+}
+export function maybeHexBuffer(str) {
+    if (!str)
+        return null;
+    return hexBuffer(str);
+}
+export var decodeTxInfo = function (rawTx) {
     var VALID_TYPES = [1, 2];
     var txType = VALID_TYPES.includes(rawTx[0]) ? rawTx[0] : null;
     var rlpData = txType === null ? rawTx : rawTx.slice(1);
@@ -68,5 +91,18 @@ export function decodeTxInfo(rawTx) {
         chainIdTruncated: chainIdTruncated,
         vrsOffset: vrsOffset
     };
-}
+};
+/**
+ * @ignore for the README
+ *
+ * Helper to convert an integer as a hexadecimal string with the right amount of digits
+ * to respect the number of bytes given as parameter
+ *
+ * @param int Integer
+ * @param bytes Number of bytes it should be represented as (1 byte = 2 caraters)
+ * @returns The given integer as an hexa string padded with the right number of 0
+ */
+export var intAsHexBytes = function (int, bytes) {
+    return int.toString(16).padStart(2 * bytes, "0");
+};
 //# sourceMappingURL=utils.js.map

package/lib-es/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,IAAM,WAAW,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,IAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChE,IAAM,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACzD,IAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAhC,CAAgC,CAAC,CAAC;IAC7E,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,SAAS,CAAC;IACd,IAAI,MAAM,KAAK,CAAC,EAAE;QAChB,UAAU;QACV,SAAS,GAAG;YACV,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACnB,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;YACjB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;SAClB,CAAC;KACH;SAAM,IAAI,MAAM,KAAK,CAAC,EAAE;QACvB,UAAU;QACV,SAAS,GAAG;YACV,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACnB,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;YACjB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;SAClB,CAAC;KACH;SAAM;QACL,YAAY;QACZ,SAAS,GAAG;YACV,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACnB,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;YACjB,mCAAmC;YACnC,OAAO,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC;SAClE,CAAC;KACH;IAED,IAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC;IACrC,IAAI,OAAO,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;IAC/B,IAAI,UAAU,EAAE;QACd,wDAAwD;QACxD,OAAO,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QACxD,IAAM,mBAAmB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5C,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,UAAU,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;SACtC;aAAM;YACL,UAAU,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;SAC7D;QACD,gBAAgB,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;KACxD;IAED,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACvC,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAEpE,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE/C,sFAAsF;QACtF,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE;YACpB,sDAAsD;YACtD,SAAS,EAAE,CAAC;YAEZ,mCAAmC;YACnC,IAAM,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;YAEvC,qDAAqD;YACrD,SAAS,IAAI,aAAa,GAAG,CAAC,CAAC;SAChC;KACF;IAED,OAAO;QACL,SAAS,WAAA;QACT,MAAM,QAAA;QACN,OAAO,SAAA;QACP,gBAAgB,kBAAA;QAChB,SAAS,WAAA;KACV,CAAC;AACJ,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,IAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnC,UAAU,CAAC,OAAO,CAAC,UAAC,OAAO;QACzB,IAAI,MAAM,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACnC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE;YACjB,OAAO,CAAC,qCAAqC;SAC9C;QACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;YAC7D,MAAM,IAAI,UAAU,CAAC;SACtB;QACD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,GAA8B;IAE9B,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;AACxB,CAAC;AAED,MAAM,CAAC,IAAM,YAAY,GAAG,UAAC,KAAa;IACxC,IAAM,WAAW,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,IAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChE,IAAM,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACzD,IAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAhC,CAAgC,CAAC,CAAC;IAC7E,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,IAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,SAAS,CAAC;IACd,IAAI,MAAM,KAAK,CAAC,EAAE;QAChB,UAAU;QACV,SAAS,GAAG;YACV,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACnB,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;YACjB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;SAClB,CAAC;KACH;SAAM,IAAI,MAAM,KAAK,CAAC,EAAE;QACvB,UAAU;QACV,SAAS,GAAG;YACV,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACnB,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;YACjB,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;SAClB,CAAC;KACH;SAAM;QACL,YAAY;QACZ,SAAS,GAAG;YACV,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACnB,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;YACjB,mCAAmC;YACnC,OAAO,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC;SAClE,CAAC;KACH;IAED,IAAM,UAAU,GAAG,SAAS,CAAC,OAAO,CAAC;IACrC,IAAI,OAAO,GAAG,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC;IAC/B,IAAI,UAAU,EAAE;QACd,wDAAwD;QACxD,OAAO,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QACxD,IAAM,mBAAmB,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5C,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,UAAU,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;SACtC;aAAM;YACL,UAAU,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;SAC7D;QACD,gBAAgB,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;KACxD;IAED,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACvC,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;QAEpE,SAAS,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAE/C,sFAAsF;QACtF,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE;YACpB,sDAAsD;YACtD,SAAS,EAAE,CAAC;YAEZ,mCAAmC;YACnC,IAAM,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;YAEvC,qDAAqD;YACrD,SAAS,IAAI,aAAa,GAAG,CAAC,CAAC;SAChC;KACF;IAED,OAAO;QACL,SAAS,WAAA;QACT,MAAM,QAAA;QACN,OAAO,SAAA;QACP,gBAAgB,kBAAA;QAChB,SAAS,WAAA;KACV,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,IAAM,aAAa,GAAG,UAAC,GAAW,EAAE,KAAa;IACtD,OAAA,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC;AAAzC,CAAyC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/hw-app-eth",
-  "version": "6.28.2",
+  "version": "6.29.0",
   "description": "Ledger Hardware Wallet Ethereum Application API",
   "keywords": [
     "Ledger",
@@ -32,15 +32,20 @@
     "@ledgerhq/cryptoassets": "^6.28.2",
     "@ledgerhq/errors": "^6.10.0",
     "@ledgerhq/hw-transport": "^6.27.1",
+    "@ledgerhq/hw-transport-mocker": "^6.27.1",
     "@ledgerhq/logs": "^6.10.0",
     "axios": "^0.26.1",
     "bignumber.js": "^9.0.2"
   },
+  "gitHead": "dd0dea64b58e5a9125c8a422dcffd29e5ef6abec",
   "scripts": {
-    "clean": "bash ../../script/clean.sh",
-    "build": "bash ../../script/build.sh",
-    "watch": "bash ../../script/watch.sh",
-    "doc": "bash ../../script/doc.sh"
-  },
-  "gitHead": "e86a1210a6b9d4271116b21c195bcadbf11b950f"
-}
+    "clean": "rimraf lib lib-es",
+    "build": "tsc && tsc -m ES6 --outDir lib-es",
+    "prewatch": "pnpm build",
+    "watch": "tsc --watch",
+    "doc": "documentation readme src/** --section=API --pe ts --re ts --re d.ts",
+    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx",
+    "lint:fix": "pnpm lint --fix",
+    "test": "jest"
+  }
+}

package/src/Eth.ts

@@ -17,7 +17,7 @@
 // FIXME drop:
 import type Transport from "@ledgerhq/hw-transport";
 import { BigNumber } from "bignumber.js";
-import { decodeTxInfo } from "./utils";
+import { decodeTxInfo, hexBuffer, maybeHexBuffer, splitPath } from "./utils";
 // NB: these are temporary import for the deprecated fallback mechanism
 import { LedgerEthTransactionResolution, LoadConfig } from "./services/types";
 import ledgerService from "./services/ledger";
@@ -25,6 +25,11 @@ import {
   EthAppNftNotSupported,
   EthAppPleaseEnableContractData,
 } from "./errors";
+import {
+  signEIP712HashedMessage,
+  signEIP712Message,
+  EIP712Message,
+} from "./modules/EIP712";
 
 export type StarkQuantizationType =
   | "eth"
@@ -40,33 +45,6 @@ const starkQuantizationTypeMap = {
   erc721mintable: 5,
 };
 
-function splitPath(path: string): number[] {
-  const result: number[] = [];
-  const components = path.split("/");
-  components.forEach((element) => {
-    let number = parseInt(element, 10);
-    if (isNaN(number)) {
-      return; // FIXME shouldn't it throws instead?
-    }
-    if (element.length > 1 && element[element.length - 1] === "'") {
-      number += 0x80000000;
-    }
-    result.push(number);
-  });
-  return result;
-}
-
-function hexBuffer(str: string): Buffer {
-  return Buffer.from(str.startsWith("0x") ? str.slice(2) : str, "hex");
-}
-
-function maybeHexBuffer(
-  str: string | null | undefined
-): Buffer | null | undefined {
-  if (!str) return null;
-  return hexBuffer(str);
-}
-
 const remapTransactionRelatedErrors = (e) => {
   if (e && e.statusCode === 0x6a80) {
     return new EthAppPleaseEnableContractData(
@@ -76,6 +54,7 @@ const remapTransactionRelatedErrors = (e) => {
 
   return e;
 };
+
 /**
  * Ethereum API
  *
@@ -107,6 +86,7 @@ export default class Eth {
         "signTransaction",
         "signPersonalMessage",
         "getAppConfiguration",
+        "signEIP712Message",
         "signEIP712HashedMessage",
         "starkGetPublicKey",
         "starkSignOrder",
@@ -251,9 +231,8 @@ export default class Eth {
     }
 
     const rawTx = Buffer.from(rawTxHex, "hex");
-    const { vrsOffset, txType, chainId, chainIdTruncated } = decodeTxInfo(
-      rawTx
-    );
+    const { vrsOffset, txType, chainId, chainIdTruncated } =
+      decodeTxInfo(rawTx);
 
     const paths = splitPath(path);
     let response;
@@ -432,31 +411,55 @@ export default class Eth {
     s: string;
     r: string;
   }> {
-    const domainSeparator = hexBuffer(domainSeparatorHex);
-    const hashStruct = hexBuffer(hashStructMessageHex);
-    const paths = splitPath(path);
-    const buffer = Buffer.alloc(1 + paths.length * 4 + 32 + 32, 0);
-    let offset = 0;
-    buffer[0] = paths.length;
-    paths.forEach((element, index) => {
-      buffer.writeUInt32BE(element, 1 + 4 * index);
-    });
-    offset = 1 + 4 * paths.length;
-    domainSeparator.copy(buffer, offset);
-    offset += 32;
-    hashStruct.copy(buffer, offset);
-    return this.transport
-      .send(0xe0, 0x0c, 0x00, 0x00, buffer)
-      .then((response) => {
-        const v = response[0];
-        const r = response.slice(1, 1 + 32).toString("hex");
-        const s = response.slice(1 + 32, 1 + 32 + 32).toString("hex");
-        return {
-          v,
-          r,
-          s,
-        };
-      });
+    return signEIP712HashedMessage(
+      this.transport,
+      path,
+      domainSeparatorHex,
+      hashStructMessageHex
+    );
+  }
+
+  /**
+   * Sign an EIP-721 formatted message following the specification here:
+   * https://github.com/LedgerHQ/app-ethereum/blob/develop/doc/ethapp.asc#sign-eth-eip-712
+   @example
+   eth.signEIP721Message("44'/60'/0'/0/0", {
+      domain: {
+        chainId: 69,
+        name: "Da Domain",
+        verifyingContract: "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
+        version: "1"
+      },
+      types: {
+        "EIP712Domain": [
+              { name: "name", type: "string" },
+              { name: "version", type: "string" },
+              { name: "chainId", type: "uint256" },
+              { name: "verifyingContract", type: "address" }
+          ],
+        "Test": [
+          { name: "contents", type: "string" }
+        ]
+      },
+      primaryType: "Test",
+      message: {contents: "Hello, Bob!"},
+    })
+   * 
+   * @param {String} path derivationPath
+   * @param {Object} jsonMessage message to sign
+   * @param {Boolean} fullImplem use the legacy implementation
+   * @returns {Promise}
+   */
+  async signEIP712Message(
+    path: string,
+    jsonMessage: EIP712Message,
+    fullImplem = false
+  ): Promise<{
+    v: number;
+    s: string;
+    r: string;
+  }> {
+    return signEIP712Message(this.transport, path, jsonMessage, fullImplem);
   }
 
   /**

package/src/modules/EIP712/EIP712.types.ts

@@ -0,0 +1,54 @@
+export type EIP712Message = {
+  domain: EIP712MessageDomain;
+  types: EIP712MessageTypes;
+  primaryType: string;
+  message: Record<string, unknown>;
+};
+
+export type EIP712MessageDomain = Partial<{
+  name: string;
+  chainId: number;
+  version: string;
+  verifyingContract: string;
+  salt: string;
+}>;
+
+export type EIP712MessageTypesEntry = {
+  name: string;
+  type: string;
+};
+
+export type EIP712MessageTypes = {
+  EIP712Domain: EIP712MessageTypesEntry[];
+  [key: string]: EIP712MessageTypesEntry[];
+};
+
+export type StructDefData = Required<
+  | {
+      structType: "name";
+      value: string;
+    }
+  | {
+      structType: "field";
+      value: Buffer;
+    }
+>;
+
+export type StructImplemData = Required<
+  | {
+      structType: "root";
+      value: string;
+    }
+  | {
+      structType: "array";
+      value: number;
+    }
+  | {
+      structType: "field";
+      value: Required<{
+        data: unknown;
+        type: string;
+        sizeInBits: number | undefined;
+      }>;
+    }
+>;

package/src/modules/EIP712/EIP712.utils.ts

@@ -0,0 +1,251 @@
+import { hexBuffer, intAsHexBytes } from "../../utils";
+import { EIP712MessageTypesEntry } from "./EIP712.types";
+
+/**
+ * @ignore for the README
+ *
+ * A Map of helpers to get the wanted binary value for
+ * each type of array possible in a type definition
+ */
+enum EIP712_ARRAY_TYPE_VALUE {
+  DYNAMIC = 0,
+  FIXED = 1,
+}
+
+/**
+ * @ignore for the README
+ *
+ * A Map of helpers to get the id and size to return for each
+ * type that can be used in EIP712
+ */
+export const EIP712_TYPE_PROPERTIES: Record<
+  string,
+  {
+    key: (size?: number) => number;
+    sizeInBits: (size?: number) => number | null;
+  }
+> = {
+  CUSTOM: {
+    key: () => 0,
+    sizeInBits: () => null,
+  },
+  INT: {
+    key: () => 1,
+    sizeInBits: (size) => Number(size) / 8,
+  },
+  UINT: {
+    key: () => 2,
+    sizeInBits: (size) => Number(size) / 8,
+  },
+  ADDRESS: {
+    key: () => 3,
+    sizeInBits: () => null,
+  },
+  BOOL: {
+    key: () => 4,
+    sizeInBits: () => null,
+  },
+  STRING: {
+    key: () => 5,
+    sizeInBits: () => null,
+  },
+  BYTES: {
+    key: (size) => (typeof size !== "undefined" ? 6 : 7),
+    sizeInBits: (size) => (typeof size !== "undefined" ? Number(size) : null),
+  },
+};
+
+/**
+ * @ignore for the README
+ *
+ * A Map of encoders to transform a value to formatted buffer
+ */
+export const EIP712_TYPE_ENCODERS = {
+  INT(value: number | string | null): Buffer {
+    const failSafeValue = value ?? 0;
+
+    if (typeof failSafeValue === "string" && failSafeValue?.startsWith("0x")) {
+      return hexBuffer(failSafeValue);
+    }
+
+    const valueAsInt =
+      typeof failSafeValue === "string"
+        ? parseInt(failSafeValue, 10)
+        : failSafeValue;
+
+    const valueAsHexString = valueAsInt.toString(16);
+    const paddedHexString =
+      valueAsHexString.length % 2 ? "0" + valueAsHexString : valueAsHexString;
+
+    return Buffer.from(paddedHexString, "hex");
+  },
+
+  UINT(value: number | string): Buffer {
+    return this.INT(value);
+  },
+
+  BOOL(value: number | string | boolean | null): Buffer {
+    return this.INT(typeof value === "boolean" ? Number(value) : value);
+  },
+
+  ADDRESS(value: string | null): Buffer {
+    // Only sending the first 10 bytes (why ?)
+    return hexBuffer(value ?? "").slice(0, 20);
+  },
+
+  STRING(value: string | null): Buffer {
+    return Buffer.from(value ?? "", "utf-8");
+  },
+
+  BYTES(value: string | null, sizeInBits?: number): Buffer {
+    const failSafeValue = value ?? "";
+    // Why slice again ?
+    return hexBuffer(failSafeValue).slice(
+      0,
+      sizeInBits ?? (failSafeValue?.length - 2) / 2
+    );
+  },
+};
+
+/**
+ * @ignore for the README
+ *
+ * Helper parsing an EIP712 Type name to return its type and size(s)
+ * if it's an array or nested arrays
+ *
+ * @see EIP712MessageTypes
+ *
+ * @example "uint8[2][][4]" => [{name: "uint", bits: 8}, [2, null, 4]]
+ * @example "bool" => [{name: "bool", bits: null}, []]
+ *
+ * @param {String} typeName
+ * @returns {[{ name: string; bits: Number | null }, Array<Number | null | undefined>]}
+ */
+export const destructTypeFromString = (
+  typeName?: string
+): [
+  { name: string; bits: number | undefined } | null,
+  Array<number | null>
+] => {
+  // Will split "any[][1][10]" in "any", "[][1][10]"
+  const splitNameAndArraysRegex = new RegExp(/^([^[\]]*)(\[.*\])*/g);
+  // Will match all numbers (or null) inside each array. [0][10][] => [0,10,null]
+  const splitArraysRegex = new RegExp(/\[(\d*)\]/g);
+  // Will separate the the name from the potential bits allocation. uint8 => [uint,8]
+  const splitNameAndNumberRegex = new RegExp(/(\D*)(\d*)/);
+
+  const [, type, maybeArrays] =
+    splitNameAndArraysRegex.exec(typeName || "") || [];
+  const [, name, bits] = splitNameAndNumberRegex.exec(type || "") || [];
+  const typeDescription = name
+    ? { name, bits: bits ? Number(bits) : undefined }
+    : null;
+
+  const arrays = maybeArrays ? [...maybeArrays.matchAll(splitArraysRegex)] : [];
+  // Parse each size to either a Number or null
+  const arraySizes = arrays.map(([, size]) => (size ? Number(size) : null));
+
+  return [typeDescription, arraySizes];
+};
+
+/**
+ * @ignore for the README
+ *
+ * Helper to construct the hexadecimal ByteString for the description
+ * of a field in an EIP712 Message
+ *
+ * @param isArray
+ * @param typeSize
+ * @param typeValue
+ * @returns {String} HexByteString
+ */
+export const constructTypeDescByteString = (
+  isArray: boolean,
+  typeSize: number | null | undefined,
+  typeValue: number
+): string => {
+  if (typeValue >= 16) {
+    throw new Error(
+      "Eth utils - constructTypeDescByteString - Cannot accept a typeValue >= 16 because the typeValue can only be 4 bits in binary" +
+        { isArray, typeSize, typeValue }
+    );
+  }
+  // 1 is array, 0 is not array
+  const isArrayBit = isArray ? "1" : "0";
+  // 1 has type size, 0 has no type size
+  const hasTypeSize = typeof typeSize === "number" ? "1" : "0";
+  // 2 unused bits
+  const unusedBits = "00";
+  // type key as 4 bits
+  const typeValueBits = typeValue.toString(2).padStart(4, "0");
+
+  return intAsHexBytes(
+    parseInt(isArrayBit + hasTypeSize + unusedBits + typeValueBits, 2),
+    1
+  );
+};
+
+/**
+ * @ignore for the README
+ *
+ * Helper to create the buffer to describe an EIP712 types' entry structure
+ *
+ * @param {EIP712MessageTypesEntry} entry
+ * @returns {Buffer}
+ */
+export const makeTypeEntryStructBuffer = ({
+  name,
+  type,
+}: EIP712MessageTypesEntry): Buffer => {
+  const [typeDescription, arrSizes] = destructTypeFromString(type as string);
+  const isTypeAnArray = Boolean(arrSizes.length);
+  const typeProperties =
+    EIP712_TYPE_PROPERTIES[typeDescription?.name?.toUpperCase() || ""] ||
+    EIP712_TYPE_PROPERTIES.CUSTOM;
+
+  const typeKey = typeProperties.key(typeDescription?.bits);
+  const typeSizeInBits = typeProperties.sizeInBits(typeDescription?.bits);
+
+  const typeDescData = constructTypeDescByteString(
+    isTypeAnArray,
+    typeSizeInBits,
+    typeKey
+  );
+
+  const bufferArray: Buffer[] = [Buffer.from(typeDescData, "hex")];
+
+  if (typeProperties === EIP712_TYPE_PROPERTIES.CUSTOM) {
+    bufferArray.push(
+      Buffer.from(intAsHexBytes(typeDescription?.name?.length ?? 0, 1), "hex")
+    );
+    bufferArray.push(Buffer.from(typeDescription?.name ?? "", "utf-8"));
+  }
+
+  if (typeof typeSizeInBits === "number") {
+    bufferArray.push(Buffer.from(intAsHexBytes(typeSizeInBits, 1), "hex"));
+  }
+
+  if (isTypeAnArray) {
+    bufferArray.push(Buffer.from(intAsHexBytes(arrSizes.length, 1), "hex"));
+
+    arrSizes.forEach((size) => {
+      if (typeof size === "number") {
+        bufferArray.push(
+          Buffer.from(intAsHexBytes(EIP712_ARRAY_TYPE_VALUE.FIXED, 1), "hex"),
+          Buffer.from(intAsHexBytes(size, 1), "hex")
+        );
+      } else {
+        bufferArray.push(
+          Buffer.from(intAsHexBytes(EIP712_ARRAY_TYPE_VALUE.DYNAMIC, 1), "hex")
+        );
+      }
+    });
+  }
+
+  bufferArray.push(
+    Buffer.from(intAsHexBytes(name.length, 1), "hex"),
+    Buffer.from(name, "utf-8")
+  );
+
+  return Buffer.concat(bufferArray);
+};