@exodus/ethereum-lib 4.4.0 → 4.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/ethereum-lib",
-  "version": "4.4.0",
+  "version": "4.6.0",
   "description": "Ethereum Library",
   "main": "src/index.js",
   "files": [
@@ -46,6 +46,7 @@
     "@exodus/optimism-meta": "^1.2.10",
     "@exodus/rootstock-meta": "^1.0.5",
     "@exodus/solidity-contract": "^1.1.3",
+    "@metamask/eth-sig-util": "^4.0.1",
     "base-x": "^3.0.2",
     "ethjs-util": "0.1.6",
     "lodash": "^4.17.15",
@@ -59,5 +60,5 @@
     "@exodus/bnbmainnet-meta": "^1.0.0",
     "@exodus/elliptic": "^6.5.4-precomputed"
   },
-  "gitHead": "952a85ff2ce573b294d53fb411b9858088d15229"
+  "gitHead": "a9f627045d3323b35362d3513dd0ec325ccbfd7c"
 }

package/src/balances/ethereum-balance.js

@@ -1,5 +1,6 @@
 import { get } from 'lodash'
 
+// @deprecated to be removed. Use balances!
 export const getEthereumBalances = ({ asset, liquidBalance, accountState }) => {
   // asset = ethereum or ethereumgoerli or ethereumholesky
   const delegatedBalance = get(

package/src/balances/index.js

@@ -1,2 +1,3 @@
+// @deprecated to be removed. Use balances!
 export * from './ethereum-balance'
 export * from './polygon-balance'

package/src/balances/polygon-balance.js

@@ -3,6 +3,7 @@ import assets from '@exodus/ethereum-meta'
 
 const polygon = assets.find(({ name: tokenName }) => tokenName === 'polygon')
 
+// @deprecated to be removed. Use balances!
 export const getPolygonBalances = ({ liquidBalance, accountState }) => {
   const delegatedBalance = get(
     accountState,

package/src/fee-data/basemainnet.js

@@ -3,7 +3,7 @@ import { asset } from '@exodus/basemainnet-meta'
 
 export default new FeeData({
   config: {
-    gasPrice: '0.07 Gwei',
+    gasPrice: '0.2 Gwei',
     max: '1 Gwei',
     min: '0.001 Gwei',
     fuelThreshold: '750000 Gwei',

package/src/index.js

@@ -5,6 +5,7 @@ export * from './utils'
 export * from './constants'
 export * from './fee-monitor'
 export * from './selectors'
+export { signMessage } from './sign-message'
 export { default as createGetKeyIdentifier } from './key-identifier'
 export { default as createEthereumLikeAccountState } from './account-state'
 

package/src/sign-message.js

@@ -0,0 +1,96 @@
+import assert from 'minimalistic-assert'
+import {
+  SignTypedDataVersion,
+  typedSignatureHash,
+  TypedDataUtils,
+  personalSign,
+  signTypedData,
+  concatSig,
+} from '@metamask/eth-sig-util'
+import { hashPersonalMessage, toBuffer } from '@exodus/ethereumjs-util'
+
+function hex0xStringToBuffer(hex) {
+  // Remove the 0x
+  const hexWithout0x = hex.startsWith('0x') ? hex.slice(2) : hex
+  // Pad the value until even
+  const hexWithLeadingZeros = hexWithout0x.length % 2 === 0 ? hexWithout0x : '0' + hexWithout0x
+  // Finally return the buffer
+  return Buffer.from(hexWithLeadingZeros, 'hex')
+}
+
+/**
+ * Converts a buffer to the 0xhex encoded value
+ * @param {Buffer} buf the buffer to convert to 0xHEXSTRING
+ * @returns the hex-encoded value prepended with 0x
+ */
+function bufferToHex0xString(buf) {
+  if (!Buffer.isBuffer(buf)) {
+    throw new TypeError('expected a buffer')
+  }
+
+  const hex = buf.toString('hex')
+
+  if (typeof hex !== 'string') {
+    throw new TypeError('expected hex string')
+  }
+
+  return '0x' + hex
+}
+
+export const signMessage = async ({ privateKey, message }) => {
+  const { rawMessage, EIP712Message } = message
+
+  // Exclusive OR (XOR)
+  assert(!!rawMessage !== !!EIP712Message, 'Need either rawMessage or EIP712Message')
+
+  if (rawMessage) {
+    return hex0xStringToBuffer(personalSign({ privateKey, data: bufferToHex0xString(rawMessage) }))
+  }
+
+  if (EIP712Message) {
+    const version = Array.isArray(EIP712Message) ? SignTypedDataVersion.V1 : SignTypedDataVersion.V4
+
+    return hex0xStringToBuffer(signTypedData({ privateKey, data: EIP712Message, version }))
+  }
+}
+
+/**
+ * @typedef {import('bn.js').BN} BN
+ * @typedef {{r: BN, s: BN, recoverParam: number}} Signature
+ * @typedef {{
+ *   sign: ({ data: Buffer, ecOptions?: { canonical?: boolean }, enc?: string }) => Promise<Signature | Buffer>
+ *   getPublicKey: () => Promise<Buffer>
+ * }} Signer
+ */
+
+/**
+ * @param {object} params
+ * @param {{rawMessage: Buffer, EIP712Message: any}} params.message
+ * @param {Signer} signer
+ * @return {Promise<string>}
+ */
+export async function signMessageWithSigner({ message, signer }) {
+  const { rawMessage, EIP712Message } = message
+  assert(!!rawMessage !== !!EIP712Message, 'Need either rawMessage or EIP712Message')
+
+  const msgHash = EIP712Message
+    ? getEIP712MessageHash(EIP712Message)
+    : hashPersonalMessage(rawMessage)
+
+  const sig = await signer.sign({
+    data: msgHash,
+    ecOptions: { canonical: true },
+    enc: 'raw',
+  })
+
+  return hex0xStringToBuffer(
+    concatSig(toBuffer(sig.recoveryParam), sig.r.toBuffer(), sig.s.toBuffer())
+  )
+}
+
+function getEIP712MessageHash(message) {
+  const version = Array.isArray(message) ? SignTypedDataVersion.V1 : SignTypedDataVersion.V4
+  return version === SignTypedDataVersion.V1
+    ? hex0xStringToBuffer(typedSignatureHash(message))
+    : TypedDataUtils.eip712Hash(message, version)
+}

package/src/unsigned-tx/create-unsigned-tx.js

@@ -57,6 +57,7 @@ export default function createUnsignedTx({
     privateKey, // Used for importing private key
     fee: baseAsset.currency.baseUnit(gasPrice.toBaseNumber() * gasLimit),
     eip1559Enabled: !!eip1559Enabled,
+    fromAddress,
   }
 
   return {

package/src/unsigned-tx/sign-unsigned-tx.js

@@ -11,7 +11,10 @@ export async function signUnsignedTxWithSigner(unsignedTx, signer) {
   const tx = createEthereumJsTx(unsignedTx)
 
   const ethSigner = async (data) => {
-    const sig = await signer({ data, ecOptions: { canonical: true }, enc: 'raw' })
+    // temporarily support both function and object
+    const sig = await (typeof signer === 'function'
+      ? signer({ data, ecOptions: { canonical: true }, enc: 'raw' })
+      : signer.sign({ data, ecOptions: { canonical: true }, enc: 'raw' }))
     const signature = new Uint8Array(64)
     signature.set(sig.r.toArrayLike(Uint8Array, 'be', 32), 0)
     signature.set(sig.s.toArrayLike(Uint8Array, 'be', 32), 32)