@exodus/ethereum-lib 5.0.0 → 5.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-lib",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Ethereum Library",
   "main": "src/index.js",
   "files": [
@@ -49,5 +49,5 @@
     "@exodus/ethereumclassic-meta": "^1.0.3",
     "@exodus/fantommainnet-meta": "^1.1.2"
   },
-  "gitHead": "a5992c8a158d486d6e95c03b17136b67ee06459c"
+  "gitHead": "6c650d072cc04a4733f99e824a979530d1cd5302"
 }

package/src/sign-message.js

@@ -8,6 +8,7 @@ import {
   concatSig,
 } from '@metamask/eth-sig-util'
 import { hashPersonalMessage, toBuffer } from '@exodus/ethereumjs-util'
+import { normalizeRecoveryParam } from './utils/ecdsa'
 
 function hex0xStringToBuffer(hex) {
   // Remove the 0x
@@ -85,7 +86,11 @@ export async function signMessageWithSigner({ message, signer }) {
   })
 
   return hex0xStringToBuffer(
-    concatSig(toBuffer(sig.recoveryParam), sig.r.toBuffer(), sig.s.toBuffer())
+    concatSig(
+      toBuffer(normalizeRecoveryParam(sig.recoveryParam, { includeBase: true })),
+      sig.r.toBuffer(),
+      sig.s.toBuffer()
+    )
   )
 }
 

package/src/utils/ecdsa.js

@@ -0,0 +1,28 @@
+import assert from 'minimalistic-assert'
+
+const ECDSA_RECOVERY_ID_BASE = 27
+const ALLOWED_VALUES = new Set([27, 28])
+const ALLOWED_VALUES_WITHOUT_BASE = new Set([0, 1])
+
+/*
+   @exodus/elliptic returns signatures that have a recoverParam that is either 0 or 1.
+   In the literature this is called recovery id. To get the value of v (which is the full recovery param)
+   a fixed offset of 27 is added. The value our asset libraries expect is a little all over the place, so we have
+   to either remove or add the offset again, depending on where we pass it. This helper can be used to harden our
+   methods to transform the recovery param to the format we expect, so consumers don't have to think about that.
+   
+   The recovery param is not strictly necessary to recover the public key,
+   so in case we end up with a recovery param that is not 0 or 1, we return undefined
+   */
+
+export const normalizeRecoveryParam = (v, { includeBase = false } = {}) => {
+  const { allowedValues, offset } = includeBase
+    ? { allowedValues: ALLOWED_VALUES, offset: ECDSA_RECOVERY_ID_BASE }
+    : { allowedValues: ALLOWED_VALUES_WITHOUT_BASE, offset: -ECDSA_RECOVERY_ID_BASE }
+
+  if (allowedValues.has(v)) return v
+
+  const param = v + offset
+  assert(allowedValues.has(param), `Failed to normalize unexpected recoveryParam ${v}`)
+  return param
+}