ox/src/core/_test/HdKey.test.ts

Ethereum Standard Library

import { Address, HdKey, Mnemonic } from 'ox'
import { describe, expect, test } from 'vp/test'
import { accounts } from '../../../test/constants/accounts.js'
import * as exports from '../HdKey.js'

const seed = Mnemonic.toSeed(
  'test test test test test test test test test test test junk',
)
const extendedKey = HdKey.fromSeed(seed).privateExtendedKey
const json = { xpriv: HdKey.fromSeed(seed).privateExtendedKey }

describe('fromExtendedKey', () => {
  test('default', () => {
    const hdKey = HdKey.fromExtendedKey(extendedKey).derive(HdKey.path())
    expect(hdKey.privateKey!).toBe(accounts[0].privateKey)
    expect(Address.fromPublicKey(hdKey.publicKey)).toBe(accounts[0].address)
  })

  test('options: path', () => {
    for (let index = 0; index < accounts.length; index++) {
      const hdKey = HdKey.fromExtendedKey(extendedKey).derive(
        HdKey.path({ index }),
      )
      expect(Address.fromPublicKey(hdKey.publicKey)).toBe(
        accounts[index]!.address,
      )
    }
  })
})

describe('fromJson', () => {
  test('default', () => {
    const hdKey = HdKey.fromJson(json).derive(HdKey.path())
    expect(hdKey.privateKey!).toBe(accounts[0].privateKey)
    expect(Address.fromPublicKey(hdKey.publicKey)).toBe(accounts[0].address)
  })

  test('options: path', () => {
    for (let index = 0; index < accounts.length; index++) {
      const hdKey = HdKey.fromJson(json).derive(HdKey.path({ index }))
      expect(Address.fromPublicKey(hdKey.publicKey)).toBe(
        accounts[index]!.address,
      )
    }
  })
})

describe('fromSeed', () => {
  test('default', () => {
    const hdKey = HdKey.fromSeed(seed).derive(HdKey.path())
    expect(hdKey.privateKey!).toBe(accounts[0].privateKey)
    expect(Address.fromPublicKey(hdKey.publicKey)).toBe(accounts[0].address)
    expect(hdKey).toMatchInlineSnapshot(`
      {
        "depth": 5,
        "derive": [Function],
        "identifier": "0xa55476015c13afb8afb92160329a8cde976f1f2e",
        "index": 0,
        "privateExtendedKey": "xprvA3KbAeguosodJeRqpV3NF1VYREub6vBASfBEXa1LgZeqPAhCFkHQMBjXYPa8RZvP5tnWMSg2zYcox5vbsfz1pB7J2zU9LEzWxg7rrRpoeSh",
        "privateKey": "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
        "publicExtendedKey": "xpub6GJwaADoeFMvX8WJvWaNc9SGyGk5WNu1ot6qKxQxEuBpFy2LoHbetz41PgEcEg4n2bk3hWoHYJ69EqkjpoSv9KrinCnZV6y4Xo6VJZ6KHWT",
        "publicKey": {
          "prefix": 4,
          "x": "0x8318535b54105d4a7aae60c08fc45f9687181b4fdfc625bd1a753fa7397fed75",
          "y": "0x3547f11ca8696646f2f3acb08e31016afac23e630c5d11f59f61fef57b0d2aa5",
        },
        "versions": {
          "private": 76066276,
          "public": 76067358,
        },
      }
    `)
  })

  test('options: derive', () => {
    for (let index = 0; index < accounts.length; index++) {
      const hdKey = HdKey.fromSeed(seed).derive(HdKey.path({ index }))
      expect(Address.fromPublicKey(hdKey.publicKey)).toBe(
        accounts[index]!.address,
      )
    }
  })
})

describe('path', () => {
  test('default', () => {
    const path = HdKey.path()
    expect(path).toMatchInlineSnapshot(`"m/44'/60'/0'/0/0"`)
  })

  test('options', () => {
    const path = HdKey.path({ account: 1, change: 2, index: 3 })
    expect(path).toMatchInlineSnapshot(`"m/44'/60'/1'/2/3"`)
  })
})

test('exports', () => {
  expect(Object.keys(exports)).toMatchInlineSnapshot(`
    [
      "fromExtendedKey",
      "fromJson",
      "fromSeed",
      "path",
    ]
  `)
})