Merge pull request #1498 from xchainjs/hippo/upgrade-crypto

Update crypto dependencies

Author: hippocampus-web3

.changeset/brown-bars-remain.md

@@ -0,0 +1,5 @@
+---
+'@xchainjs/xchain-crypto': patch
+---
+
+Update crypto dependencies

packages/xchain-crypto/__tests__/crypto.test.ts

@@ -1,5 +1,4 @@
 import { decryptFromKeystore, encryptToKeyStore, generatePhrase, validatePhrase } from '../src/crypto'
-import { encodeAddress } from '../src/utils'
 import crypto from 'crypto'
 
 describe('Generate Phrase', () => {
@@ -100,23 +99,3 @@ describe('Import Keystore', () => {
     expect(phraseDecrypted).toEqual(phrase)
   })
 })
-
-describe('encodeAddress', () => {
-  const hexValue = '00112233445566778899aabbccddeeff'
-  const expected = 'thor1qqgjyv6y24n80zye42aueh0wlu65gth0'
-
-  it('encodes a hex string into a Bech32 address with default prefix', () => {
-    const result = encodeAddress(hexValue)
-    expect(result).toBe(expected)
-  })
-
-  it('encodes a Buffer into a Bech32 address with default prefix', () => {
-    const buffer = Buffer.from(hexValue, 'hex')
-    const result = encodeAddress(buffer, undefined, 'hex')
-    expect(result).toBe(expected)
-  })
-  it('should encode using a custom prefix', () => {
-    const result = encodeAddress(hexValue, 'bnb')
-    expect(result.startsWith('bnb1')).toBe(true)
-  })
-})

packages/xchain-crypto/package.json

@@ -39,16 +39,12 @@
   "author": "Thorchain",
   "license": "MIT",
   "devDependencies": {
-    "@types/bip39": "^3.0.0",
-    "@types/crypto-js": "^4.1.1",
     "@types/node": "^22.7.5",
     "@types/uuid": "^9.0.1"
   },
   "dependencies": {
     "@noble/hashes": "^1.8.0",
-    "@scure/base": "^1.2.6",
-    "bip39": "^3.1.0",
-    "crypto-js": "4.2.0",
+    "@scure/bip39": "^1.6.0",
     "uuid": "^9.0.0"
   },
   "publishConfig": {

packages/xchain-crypto/src/crypto.ts

@@ -1,4 +1,6 @@
-import * as bip39 from 'bip39'
+import { generateMnemonic, mnemonicToEntropy, mnemonicToSeedSync, validateMnemonic } from '@scure/bip39'
+import { wordlist } from '@scure/bip39/wordlists/english'
+import { bytesToHex } from '@noble/hashes/utils'
 import crypto from 'crypto'
 import { blake2b } from '@noble/hashes/blake2'
 import { v4 as uuidv4 } from 'uuid'
@@ -53,15 +55,8 @@ const _isNode = (): boolean => {
  * @returns {string} The generated mnemonic phrase.
  */
 export const generatePhrase = (size = 12): string => {
-  if (_isNode()) {
-    const bytes = crypto.randomBytes((size == 12 ? 128 : 256) / 8)
-    const phrase = bip39.entropyToMnemonic(bytes)
-    return phrase
-  } else {
-    const entropy = size == 12 ? 128 : 256
-    const phrase = bip39.generateMnemonic(entropy)
-    return phrase
-  }
+  const strength = size === 12 ? 128 : 256
+  return generateMnemonic(wordlist, strength)
 }
 
 /**
@@ -70,7 +65,7 @@ export const generatePhrase = (size = 12): string => {
  * @returns {boolean} True if the phrase is valid, otherwise false.
  */
 export const validatePhrase = (phrase: string): boolean => {
-  return bip39.validateMnemonic(phrase)
+  return validateMnemonic(phrase, wordlist)
 }
 
 /**
@@ -79,11 +74,11 @@ export const validatePhrase = (phrase: string): boolean => {
  * @returns {Buffer} The seed derived from the phrase.
  * @throws {"Invalid BIP39 phrase"} Thrown if the phrase is invalid.
  */
-export const getSeed = (phrase: string): Buffer => {
+export const getSeed = (phrase: string): Uint8Array => {
   if (!validatePhrase(phrase)) {
     throw new Error('Invalid BIP39 phrase')
   }
-  return bip39.mnemonicToSeedSync(phrase)
+  return mnemonicToSeedSync(phrase)
 }
 
 /**
@@ -92,9 +87,9 @@ export const getSeed = (phrase: string): Buffer => {
  * @returns the entropy phrase
  */
 export const phraseToEntropy = (phrase: string): string => {
-  return bip39.mnemonicToEntropy(phrase)
+  const entropyBytes = mnemonicToEntropy(phrase, wordlist) // Uint8Array
+  return bytesToHex(entropyBytes) // convert to hex string
 }
-
 /**
  * Encrypts the given phrase to a keystore object using the provided password.
  * @param {string} phrase The mnemonic phrase to encrypt.

packages/xchain-crypto/src/utils.ts

@@ -1,85 +1,4 @@
-import { bech32 } from '@scure/base'
 import crypto from 'crypto'
-import cryptojs from 'crypto-js'
-
-const ripemd160 = cryptojs.RIPEMD160,
-  sha256 = cryptojs.SHA256,
-  hexEncoding = cryptojs.enc.Hex
-
-/**
- * Convert a string to an array of bytes.
- *
- * @param {string} string The input string to be converted.
- * @returns {number[]} The bytes representing the input string.
- */
-export const getBytes = (string: string): number[] => {
-  const arrayBytes: number[] = []
-  const buffer = Buffer.from(string, 'utf16le')
-  for (let i = 0; i < buffer.length; i++) {
-    arrayBytes.push(buffer[i])
-  }
-  return arrayBytes
-}
-
-/**
- * Convert a Buffer to a hexadecimal string.
- *
- * @param {Buffer} arr The input Buffer to be converted.
- * @returns {string} The hexadecimal string representing the input Buffer.
- */
-export const ab2hexstring = (arr: Buffer): string => {
-  let result = ''
-  for (let i = 0; i < arr.length; i++) {
-    let str = arr[i].toString(16)
-    str = str.length === 0 ? '00' : str.length === 1 ? '0' + str : str
-    result += str
-  }
-  return result
-}
-
-/**
- * Calculate `ripemd160(sha256(hex))` from a hexadecimal string.
- *
- * @param {string} hex The input hexadecimal string.
- * @returns {string} The result of the hash operation.
- *
- * @throws {"sha256ripemd160 expects a string"} Thrown if a non-string input is provided.
- * @throws {"invalid hex string length"} Thrown if the input hexadecimal string has an invalid length.
- */
-export const sha256ripemd160 = (hex: string): string => {
-  if (typeof hex !== 'string') throw new Error('sha256ripemd160 expects a string')
-  if (hex.length % 2 !== 0) throw new Error(`invalid hex string length: ${hex}`)
-  const hexEncoded = hexEncoding.parse(hex)
-  const ProgramSha256 = sha256(hexEncoded)
-  return ripemd160(ProgramSha256).toString()
-}
-
-/**
- * Encode an address from a string or Buffer.
- *
- * @param {string | Buffer} value The input string or Buffer to be encoded.
- * @param {string} prefix The prefix of the address. (optional)
- * @param {BufferEncoding} type The buffer encoding type. It is used when a string is provided. (optional)
- * @returns {string} The address generated from the input string or Buffer.
- */
-export const encodeAddress = (value: string | Buffer, prefix = 'thor', type: BufferEncoding = 'hex'): string => {
-  const data = Buffer.isBuffer(value) ? value : Buffer.from(value, type)
-  const words = bech32.toWords(Uint8Array.from(data))
-  return bech32.encode(prefix, words)
-}
-
-/**
- * Create an address from a public key.
- *
- * @param {Buffer} publicKey The public key in Buffer format.
- * @returns {string} The address generated from the input public key (Buffer format).
- */
-export const createAddress = (publicKey: Buffer): string => {
-  const hexed = ab2hexstring(publicKey)
-  const hash = sha256ripemd160(hexed)
-  const address = encodeAddress(hash, 'thor')
-  return address
-}
 
 /**
  * Calculate pbkdf2 (Password-Based Key Derivation Function 2).

yarn.lock

@@ -2825,7 +2825,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@scure/bip39@npm:^1.2.1":
+"@scure/bip39@npm:^1.2.1, @scure/bip39@npm:^1.6.0":
   version: 1.6.0
   resolution: "@scure/bip39@npm:1.6.0"
   dependencies:
@@ -3270,15 +3270,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/bip39@npm:^3.0.0":
-  version: 3.0.4
-  resolution: "@types/bip39@npm:3.0.4"
-  dependencies:
-    bip39: "npm:*"
-  checksum: 10c0/d0fbb4e72161f03bba993bebb4b234ecdd1a05189f2d09df566ad69178637d93633bcf8aa6b3ac2724902d7a477c53a24593d7e388b92322076819fac98d738c
-  languageName: node
-  linkType: hard
-
 "@types/bitcore-lib-cash@npm:^8.23.8":
   version: 8.23.8
   resolution: "@types/bitcore-lib-cash@npm:8.23.8"
@@ -3311,13 +3302,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/crypto-js@npm:^4.1.1":
-  version: 4.2.2
-  resolution: "@types/crypto-js@npm:4.2.2"
-  checksum: 10c0/760a2078f36f2a3a1089ef367b0d13229876adcf4bcd6e8824d00d9e9bfad8118dc7e6a3cc66322b083535e12be3a29044ccdc9603bfb12519ff61551a3322c6
-  languageName: node
-  linkType: hard
-
 "@types/eslint@npm:^7.2.13":
   version: 7.29.0
   resolution: "@types/eslint@npm:7.29.0"
@@ -4009,13 +3993,9 @@ __metadata:
   resolution: "@xchainjs/xchain-crypto@workspace:packages/xchain-crypto"
   dependencies:
     "@noble/hashes": "npm:^1.8.0"
-    "@scure/base": "npm:^1.2.6"
-    "@types/bip39": "npm:^3.0.0"
-    "@types/crypto-js": "npm:^4.1.1"
+    "@scure/bip39": "npm:^1.6.0"
     "@types/node": "npm:^22.7.5"
     "@types/uuid": "npm:^9.0.1"
-    bip39: "npm:^3.1.0"
-    crypto-js: "npm:4.2.0"
     uuid: "npm:^9.0.0"
   languageName: unknown
   linkType: soft
@@ -5145,7 +5125,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"bip39@npm:*, bip39@npm:^3.1.0":
+"bip39@npm:^3.1.0":
   version: 3.1.0
   resolution: "bip39@npm:3.1.0"
   dependencies: