bch-js/test/unit/mnemonic.js

const fixtures = require('./fixtures/mnemonic.json')
const assert = require('assert')
const BCHJS = require('../../src/bch-js')
const bchjs = new BCHJS()

describe('#Mnemonic', () => {
  describe('#generate', () => {
    it('should generate a 12 word mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(128)
      assert.equal(mnemonic.split(' ').length, 12)
    })

    it('should generate a 15 word mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(160)
      assert.equal(mnemonic.split(' ').length, 15)
    })

    it('should generate a 18 word mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(192)
      assert.equal(mnemonic.split(' ').length, 18)
    })

    it('should generate an 21 word mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(224)
      assert.equal(mnemonic.split(' ').length, 21)
    })

    it('should generate an 24 word mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(256)
      assert.equal(mnemonic.split(' ').length, 24)
    })

    it('should generate an 24 word italian mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(
        256,
        bchjs.Mnemonic.wordLists().italian
      )
      assert.equal(mnemonic.split(' ').length, 24)
    })
  })

  describe('#fromEntropy', () => {
    it('should generate a 12 word mnemonic from 16 bytes of entropy', () => {
      const rand = bchjs.Crypto.randomBytes(16)
      const mnemonic = bchjs.Mnemonic.fromEntropy(rand.toString('hex'))
      assert.equal(mnemonic.split(' ').length, 12)
    })

    it('should generate a 15 word mnemonic from 20 bytes of entropy', () => {
      const rand = bchjs.Crypto.randomBytes(20)
      const mnemonic = bchjs.Mnemonic.fromEntropy(rand.toString('hex'))
      assert.equal(mnemonic.split(' ').length, 15)
    })

    it('should generate an 18 word mnemonic from 24 bytes of entropy', () => {
      const rand = bchjs.Crypto.randomBytes(24)
      const mnemonic = bchjs.Mnemonic.fromEntropy(rand.toString('hex'))
      assert.equal(mnemonic.split(' ').length, 18)
    })

    it('should generate an 21 word mnemonic from 28 bytes of entropy', () => {
      const rand = bchjs.Crypto.randomBytes(28)
      const mnemonic = bchjs.Mnemonic.fromEntropy(rand.toString('hex'))
      assert.equal(mnemonic.split(' ').length, 21)
    })

    it('should generate an 24 word mnemonic from 32 bytes of entropy', () => {
      const rand = bchjs.Crypto.randomBytes(32)
      const mnemonic = bchjs.Mnemonic.fromEntropy(rand.toString('hex'))
      assert.equal(mnemonic.split(' ').length, 24)
    })

    it('should generate an 24 french word mnemonic 32 bytes of entropy', () => {
      const rand = bchjs.Crypto.randomBytes(32)
      const mnemonic = bchjs.Mnemonic.fromEntropy(
        rand.toString('hex'),
        bchjs.Mnemonic.wordLists().french
      )
      assert.equal(mnemonic.split(' ').length, 24)
    })

    fixtures.fromEntropy.forEach(entropy => {
      const mnemonic = bchjs.Mnemonic.fromEntropy(entropy.entropy)
      it(`should convert ${entropy.entropy} to ${entropy.mnemonic}`, () => {
        assert.equal(mnemonic, entropy.mnemonic)
      })
    })
  })

  describe('#toEntropy', () => {
    it('should turn a 12 word mnemonic to entropy', () => {
      const mnemonic = bchjs.Mnemonic.generate(128)
      const entropy = bchjs.Mnemonic.toEntropy(mnemonic)
      assert.equal(entropy.length, 16)
    })

    it('should turn a 15 word mnemonic to entropy', () => {
      const mnemonic = bchjs.Mnemonic.generate(160)
      const entropy = bchjs.Mnemonic.toEntropy(mnemonic)
      assert.equal(entropy.length, 20)
    })

    it('should turn a 18 word mnemonic to entropy', () => {
      const mnemonic = bchjs.Mnemonic.generate(192)
      const entropy = bchjs.Mnemonic.toEntropy(mnemonic)
      assert.equal(entropy.length, 24)
    })

    it('should turn a 21 word mnemonic to entropy', () => {
      const mnemonic = bchjs.Mnemonic.generate(224)
      const entropy = bchjs.Mnemonic.toEntropy(mnemonic)
      assert.equal(entropy.length, 28)
    })

    it('should turn a 24 word mnemonic to entropy', () => {
      const mnemonic = bchjs.Mnemonic.generate(256)
      const entropy = bchjs.Mnemonic.toEntropy(mnemonic)
      assert.equal(entropy.length, 32)
    })

    it('should turn a 24 word spanish mnemonic to entropy', () => {
      const mnemonic = bchjs.Mnemonic.generate(
        256,
        bchjs.Mnemonic.wordLists().spanish
      )
      const entropy = bchjs.Mnemonic.toEntropy(
        mnemonic,
        bchjs.Mnemonic.wordLists().spanish
      )
      assert.equal(entropy.length, 32)
    })

    fixtures.fromEntropy.forEach(fixture => {
      const entropy = bchjs.Mnemonic.toEntropy(fixture.mnemonic)
      it(`should convert ${fixture.mnemonic} to ${fixture.entropy}`, () => {
        assert.equal(entropy.toString('hex'), fixture.entropy)
      })
    })
  })

  describe('#validate', () => {
    it('fails for a mnemonic that is too short', () => {
      assert.equal(
        bchjs.Mnemonic.validate(
          'mixed winner',
          bchjs.Mnemonic.wordLists().english
        ),
        'Invalid mnemonic'
      )
    })

    it('fails for a mnemonic that is too long', () => {
      assert.equal(
        bchjs.Mnemonic.validate(
          'mixed winner decide drift danger together twice planet impose asthma catch require select mask awkward spy relief front work solar pitch economy render cake mixed winner decide drift danger together twice planet impose asthma catch require select mask awkward spy relief front work solar pitch economy render cake mixed winner decide drift danger together twice planet impose asthma catch require select mask awkward spy relief front work solar pitch economy render cake mixed winner decide drift danger together twice planet impose asthma catch require select mask awkward spy relief front work solar pitch economy render cake mixed winner decide drift danger together twice planet impose asthma catch require select mask awkward spy relief front work solar pitch economy render cake mixed winner decide drift danger together twice planet impose asthma catch require select mask awkward spy relief front work solar pitch economy render cake mixed winner decide drift danger together twice planet impose asthma catch require select mask awkward spy relief front work solar pitch economy render cake mixed winner decide drift danger together twice planet impose asthma catch require select mask awkward spy relief front work solar pitch economy render cake',
          bchjs.Mnemonic.wordLists().english
        ),
        'Invalid mnemonic'
      )
    })

    it('fails if mnemonic words are not in the word list', () => {
      assert.equal(
        bchjs.Mnemonic.validate(
          'failsauce one two three four five six seven eight nine ten eleven',
          bchjs.Mnemonic.wordLists().english
        ),
        'failsauce is not in wordlist, did you mean balance?'
      )
    })

    it('validate a 128 bit mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(128)
      assert.equal(
        bchjs.Mnemonic.validate(mnemonic, bchjs.Mnemonic.wordLists().english),
        'Valid mnemonic'
      )
    })

    it('validate a 160 bit mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(160)
      assert.equal(
        bchjs.Mnemonic.validate(mnemonic, bchjs.Mnemonic.wordLists().english),
        'Valid mnemonic'
      )
    })

    it('validate a 192 bit mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(192)
      assert.equal(
        bchjs.Mnemonic.validate(mnemonic, bchjs.Mnemonic.wordLists().english),
        'Valid mnemonic'
      )
    })

    it('validate a 224 bit mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(224)
      assert.equal(
        bchjs.Mnemonic.validate(mnemonic, bchjs.Mnemonic.wordLists().english),
        'Valid mnemonic'
      )
    })

    it('validate a 256 bit mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(256)
      assert.equal(
        bchjs.Mnemonic.validate(mnemonic, bchjs.Mnemonic.wordLists().english),
        'Valid mnemonic'
      )
    })

    it('validate a 256 bit chinese simplified mnemonic', () => {
      const mnemonic = bchjs.Mnemonic.generate(
        256,
        bchjs.Mnemonic.wordLists().chinese_simplified
      )
      assert.equal(
        bchjs.Mnemonic.validate(
          mnemonic,
          bchjs.Mnemonic.wordLists().chinese_simplified
        ),
        'Valid mnemonic'
      )
    })
  })

  describe('#toSeed', () => {
    it('should create 512 bit / 64 byte HMAC-SHA512 root seed from a 128 bit mnemonic', async () => {
      const mnemonic = bchjs.Mnemonic.generate(128)
      const rootSeedBuffer = await bchjs.Mnemonic.toSeed(mnemonic, '')
      assert.equal(rootSeedBuffer.byteLength, 64)
    })

    it('should create 512 bit / 64 byte HMAC-SHA512 root seed from a 160 bit mnemonic', async () => {
      const mnemonic = bchjs.Mnemonic.generate(160)
      const rootSeedBuffer = await bchjs.Mnemonic.toSeed(mnemonic, '')
      assert.equal(rootSeedBuffer.byteLength, 64)
    })

    it('should create 512 bit / 64 byte HMAC-SHA512 root seed from a 192 bit mnemonic', async () => {
      const mnemonic = bchjs.Mnemonic.generate(192)
      const rootSeedBuffer = await bchjs.Mnemonic.toSeed(mnemonic, '')
      assert.equal(rootSeedBuffer.byteLength, 64)
    })

    it('should create 512 bit / 64 byte HMAC-SHA512 root seed from a 224 bit mnemonic', async () => {
      const mnemonic = bchjs.Mnemonic.generate(224)
      const rootSeedBuffer = await bchjs.Mnemonic.toSeed(mnemonic, '')
      assert.equal(rootSeedBuffer.byteLength, 64)
    })

    it('should create 512 bit / 64 byte HMAC-SHA512 root seed from a 256 bit mnemonic', async () => {
      const mnemonic = bchjs.Mnemonic.generate(256)
      const rootSeedBuffer = await bchjs.Mnemonic.toSeed(mnemonic, '')
      assert.equal(rootSeedBuffer.byteLength, 64)
    })
  })

  describe('#wordLists', () => {
    it('return a list of 2048 english words', () => {
      assert.equal(bchjs.Mnemonic.wordLists().english.length, 2048)
    })

    it('return a list of 2048 japanese words', () => {
      assert.equal(bchjs.Mnemonic.wordLists().japanese.length, 2048)
    })

    it('return a list of 2048 chinese simplified words', () => {
      assert.equal(bchjs.Mnemonic.wordLists().chinese_simplified.length, 2048)
    })

    it('return a list of 2048 chinese traditional words', () => {
      assert.equal(bchjs.Mnemonic.wordLists().chinese_traditional.length, 2048)
    })

    it('return a list of 2048 french words', () => {
      assert.equal(bchjs.Mnemonic.wordLists().french.length, 2048)
    })

    it('return a list of 2048 italian words', () => {
      assert.equal(bchjs.Mnemonic.wordLists().italian.length, 2048)
    })

    it('return a list of 2048 korean words', () => {
      assert.equal(bchjs.Mnemonic.wordLists().korean.length, 2048)
    })

    it('return a list of 2048 spanish words', () => {
      assert.equal(bchjs.Mnemonic.wordLists().spanish.length, 2048)
    })
  })

  describe('#toKeypairs', async () => {
    fixtures.toKeypairs.forEach(async (fixture, i) => {
      const keypairs = await bchjs.Mnemonic.toKeypairs(fixture.mnemonic, 5)
      keypairs.forEach((keypair, j) => {
        it('Generate keypair from mnemonic', () => {
          assert.equal(
            keypair.privateKeyWIF,
            fixtures.toKeypairs[i].output[j].privateKeyWIF
          )
          // assert.equal(
          //   keypair.address,
          //   fixtures.toKeypairs[i].output[j].address
          // )
        })
      })

      const regtestKeypairs = await bchjs.Mnemonic.toKeypairs(
        fixture.mnemonic,
        5,
        true
      )
      regtestKeypairs.forEach((keypair, j) => {
        it('Generate keypair from mnemonic', () => {
          assert.equal(
            keypair.privateKeyWIF,
            fixtures.toKeypairs[i].output[j].privateKeyWIFRegTest
          )
          // assert.equal(
          //   keypair.address,
          //   fixtures.toKeypairs[i].output[j].regtestAddress
          // )
        })
      })
    })
  })

  describe('#findNearestWord', () => {
    fixtures.findNearestWord.forEach((fixture, i) => {
      const word = bchjs.Mnemonic.findNearestWord(
        fixture.word,
        bchjs.Mnemonic.wordLists()[fixture.language]
      )
      it(`find word ${fixture.foundWord} near ${fixture.word} in ${fixture.language}`, () => {
        assert.equal(word, fixture.foundWord)
      })
    })
  })
})