Compare commits

...

3 Commits

Author SHA1 Message Date
Jackson Mills
7f3e852dac Lint 2022-07-15 16:24:40 -07:00
Jackson Mills
d07efd5bc4 Use swap method that works with react-native 2022-07-15 15:54:08 -07:00
Jackson Mills
60e90aaed0 Add validation checks for bip39 and rfc1751 + tests 2022-07-15 15:49:54 -07:00
3 changed files with 65 additions and 13 deletions

View File

@@ -1,7 +1,7 @@
/* eslint-disable max-lines -- There are lots of equivalent constructors which make sense to have here. */
import BigNumber from 'bignumber.js'
import { fromSeed } from 'bip32'
import { mnemonicToSeedSync } from 'bip39'
import { mnemonicToSeedSync, validateMnemonic } from 'bip39'
import _ from 'lodash'
import {
classicAddressToXAddress,
@@ -229,6 +229,12 @@ class Wallet {
})
}
// Otherwise decode using bip39's mnemonic standard
if (!validateMnemonic(mnemonic)) {
throw new ValidationError(
'Unable to parse the given mnemonic using bip39 encoding',
)
}
const seed = mnemonicToSeedSync(mnemonic)
const masterNode = fromSeed(seed)
const node = masterNode.derivePath(

View File

@@ -136,7 +136,13 @@ function getSubKey(
const ch = [0, 0, 0, 0, 0, 0, 0, 0, 0]
let word = ''
for (word of sublist) {
const idx = rfc1751WordList.indexOf(word)
const idx = rfc1751WordList.indexOf(word.toUpperCase())
if (idx === -1) {
throw new TypeError(
`Expected an RFC1751 word, but received '${word}'. ` +
`For the full list of words in the RFC1751 encoding see https://datatracker.ietf.org/doc/html/rfc1751`,
)
}
const shift = (8 - ((bits + 11) % 8)) % 8
const y = idx << shift
const cl = y >> 16
@@ -171,10 +177,14 @@ function bufferToArray(buf: Buffer): number[] {
* @returns A buffer containing the same data with reversed endianness
*/
function swap128(buf: Buffer): Buffer {
const result = Buffer.alloc(16)
result.writeBigUInt64LE(buf.readBigUInt64BE(0), 8)
result.writeBigUInt64LE(buf.readBigUInt64BE(8), 0)
return result
// Interprets buffer as an array of (two, in this case) 64-bit numbers and swaps byte order in-place.
const reversedBytes = buf.swap64()
// Swap the two 64-bit numbers since our buffer is 128 bits.
return Buffer.concat(
[reversedBytes.slice(8, 16), reversedBytes.slice(0, 8)],
16,
)
}
export { rfc1751MnemonicToKey, keyToRFC1751Mnemonic }

View File

@@ -143,6 +143,41 @@ describe('Wallet', function () {
assert.equal(wallet.seed, expectedSeed)
})
it('throws an error when using an RFC1751 mnemonic for bip39', function () {
const algorithm = ECDSA.ed25519
const mnemonic =
'CAB BETH HANK BIRD MEND SIGN GILD ANY KERN HYDE CHAT STUB'
assert.throws(() => {
Wallet.fromMnemonic(mnemonic, {
mnemonicEncoding: 'bip39',
algorithm,
})
}, /^Unable to parse the given mnemonic using bip39 encoding$/u)
})
it('throws an error when using an bip39 mnemonic for RFC1751', function () {
const mnemonic =
'draw attack antique swing base employ blur above palace lucky glide clap pen use illegal'
assert.throws(() => {
Wallet.fromMnemonic(mnemonic, {
mnemonicEncoding: 'rfc1751',
})
}, /^Expected an RFC1751 word, but received 'attack'\. For the full list of words in the RFC1751 encoding see https:\/\/datatracker\.ietf\.org\/doc\/html\/rfc1/u)
})
it('derives a wallet using rfc1751 mnemonic with lowercase words', function () {
const algorithm = ECDSA.ed25519
const mnemonic =
'cab beth hank bird mend sign gild any kern hyde chat stub'
const expectedSeed = 'sEdVaw4m9W3H3ou3VnyvDwvPAP5BEz1'
const wallet = Wallet.fromMnemonic(mnemonic, {
mnemonicEncoding: 'rfc1751',
algorithm,
})
assert.equal(wallet.seed, expectedSeed)
})
it('derives a wallet using a Regular Key Pair', function () {
const masterAddress = 'rUAi7pipxGpYfPNg3LtPcf2ApiS8aw9A93'
const regularKeyPair = {
@@ -211,11 +246,11 @@ describe('Wallet', function () {
describe('fromMnemonic', function () {
const mnemonic =
'try milk link drift aware pass obtain again music stick pluck fold'
'assault rare scout seed design extend noble drink talk control guitar quote'
const publicKey =
'0257B550BA2FDCCF0ADDA3DEB2A5411700F3ADFDCC7C68E1DCD1E2B63E6B0C63E6'
'035953FCD81D001CF634EB44A87940F3F98ADF2483D09C914BAED0539BE50F385D'
const privateKey =
'008F942B6E229C0E9CEE47E7A94253DABB6A9855F4BA2D8A741FA31851A1D423C3'
'0013FC461CA5799F1357C8130AF703CBA7E9C28E072C6CA8F7DEF8601CDE98F394'
it('derives a wallet using default derivation path', function () {
const wallet = Wallet.fromMnemonic(mnemonic)
@@ -235,15 +270,16 @@ describe('Wallet', function () {
it('derives a wallet using a Regular Key Pair', function () {
const masterAddress = 'rUAi7pipxGpYfPNg3LtPcf2ApiS8aw9A93'
const regularKeyPair = {
mnemonic: 'KNEW BENT LYNN LED GAD BEN KENT SHAM HOBO RINK WALT ALLY',
mnemonic: 'I IRE BOND BOW TRIO LAID SEAT GOAL HEN IBIS IBIS DARE',
publicKey:
'02FBC77338A52D9733641437A77369ACB0D89D52642740A008509F7A3A7450C841',
'0330E7FC9D56BB25D6893BA3F317AE5BCF33B3291BD63DB32654A313222F7FD020',
privateKey:
'007A10DF756751129060DD29C9BB6733ADB92507B7DD83BB0795CAA09FB815BE22',
'001ACAAEDECE405B2A958212629E16F2EB46B153EEE94CDD350FDEFF52795525B7',
}
const wallet = Wallet.fromMnemonic(regularKeyPair.mnemonic, {
masterAddress,
mnemonicEncoding: 'rfc1751',
})
assert.equal(wallet.publicKey, regularKeyPair.publicKey)
@@ -253,7 +289,7 @@ describe('Wallet', function () {
})
describe('fromEntropy', function () {
let entropy
let entropy: number[]
const publicKey =
'0390A196799EE412284A5D80BF78C3E84CBB80E1437A0AECD9ADF94D7FEAAFA284'
const privateKey =