@xyo-network/wallet 5.1.22 → 5.1.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/wallet",
-  "version": "5.1.22",
+  "version": "5.1.23",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -30,27 +30,30 @@
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src"
+    "src",
+    "!**/*.bench.*",
+    "!**/*.spec.*",
+    "!**/*.test.*"
   ],
   "dependencies": {
     "@scure/bip39": "~2.0.1",
-    "@xylabs/arraybuffer": "~5.0.24",
-    "@xylabs/assert": "~5.0.24",
-    "@xylabs/base": "~5.0.24",
-    "@xylabs/hex": "~5.0.24",
-    "@xylabs/static-implements": "~5.0.24",
-    "@xyo-network/account": "~5.1.22",
-    "@xyo-network/account-model": "~5.1.22",
-    "@xyo-network/key-model": "~5.1.22",
-    "@xyo-network/wallet-model": "~5.1.22",
+    "@xylabs/arraybuffer": "~5.0.33",
+    "@xylabs/assert": "~5.0.33",
+    "@xylabs/base": "~5.0.33",
+    "@xylabs/hex": "~5.0.33",
+    "@xylabs/static-implements": "~5.0.33",
+    "@xyo-network/account": "~5.1.23",
+    "@xyo-network/account-model": "~5.1.23",
+    "@xyo-network/key-model": "~5.1.23",
+    "@xyo-network/wallet-model": "~5.1.23",
     "ethers": "~6.15.0"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "~7.2.8",
     "@xylabs/tsconfig": "~7.2.8",
-    "@xylabs/vitest-matchers": "~5.0.24",
+    "@xylabs/vitest-matchers": "~5.0.33",
     "typescript": "~5.9.3",
-    "vitest": "~4.0.8"
+    "vitest": "~4.0.9"
   },
   "publishConfig": {
     "access": "public"

package/dist/browser/spec/AddressRoundTrip.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=AddressRoundTrip.spec.d.ts.map

package/dist/browser/spec/AddressRoundTrip.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AddressRoundTrip.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/AddressRoundTrip.spec.ts"],"names":[],"mappings":""}

package/dist/browser/spec/HDWallet/HDWallet.browser.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=HDWallet.browser.spec.d.ts.map

package/dist/browser/spec/HDWallet/HDWallet.browser.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.browser.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.browser.spec.ts"],"names":[],"mappings":""}

package/dist/browser/spec/HDWallet/HDWallet.node.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=HDWallet.node.spec.d.ts.map

package/dist/browser/spec/HDWallet/HDWallet.node.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.node.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.node.spec.ts"],"names":[],"mappings":""}

package/dist/browser/spec/HDWallet/HDWallet.spec.d.ts

@@ -1,8 +0,0 @@
-import type { WalletStatic } from '@xyo-network/wallet-model';
-/**
- * Generates tests for a wallet type
- * @param title The title of the test suite
- * @param HDWallet The wallet type to test
- */
-export declare const generateHDWalletTests: (title: string, HDWallet: WalletStatic) => void;
-//# sourceMappingURL=HDWallet.spec.d.ts.map

package/dist/browser/spec/HDWallet/HDWallet.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.spec.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAkB,YAAY,EAAE,MAAM,2BAA2B,CAAA;AA2F7E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAAI,OAAO,MAAM,EAAE,UAAU,YAAY,SAwF1E,CAAA"}

package/dist/neutral/spec/AddressRoundTrip.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=AddressRoundTrip.spec.d.ts.map

package/dist/neutral/spec/AddressRoundTrip.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AddressRoundTrip.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/AddressRoundTrip.spec.ts"],"names":[],"mappings":""}

package/dist/neutral/spec/HDWallet/HDWallet.browser.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=HDWallet.browser.spec.d.ts.map

package/dist/neutral/spec/HDWallet/HDWallet.browser.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.browser.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.browser.spec.ts"],"names":[],"mappings":""}

package/dist/neutral/spec/HDWallet/HDWallet.node.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=HDWallet.node.spec.d.ts.map

package/dist/neutral/spec/HDWallet/HDWallet.node.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.node.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.node.spec.ts"],"names":[],"mappings":""}

package/dist/neutral/spec/HDWallet/HDWallet.spec.d.ts

@@ -1,8 +0,0 @@
-import type { WalletStatic } from '@xyo-network/wallet-model';
-/**
- * Generates tests for a wallet type
- * @param title The title of the test suite
- * @param HDWallet The wallet type to test
- */
-export declare const generateHDWalletTests: (title: string, HDWallet: WalletStatic) => void;
-//# sourceMappingURL=HDWallet.spec.d.ts.map

package/dist/neutral/spec/HDWallet/HDWallet.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.spec.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAkB,YAAY,EAAE,MAAM,2BAA2B,CAAA;AA2F7E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAAI,OAAO,MAAM,EAAE,UAAU,YAAY,SAwF1E,CAAA"}

package/dist/node/spec/AddressRoundTrip.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=AddressRoundTrip.spec.d.ts.map

package/dist/node/spec/AddressRoundTrip.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AddressRoundTrip.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/AddressRoundTrip.spec.ts"],"names":[],"mappings":""}

package/dist/node/spec/HDWallet/HDWallet.browser.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=HDWallet.browser.spec.d.ts.map

package/dist/node/spec/HDWallet/HDWallet.browser.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.browser.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.browser.spec.ts"],"names":[],"mappings":""}

package/dist/node/spec/HDWallet/HDWallet.node.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=HDWallet.node.spec.d.ts.map

package/dist/node/spec/HDWallet/HDWallet.node.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.node.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.node.spec.ts"],"names":[],"mappings":""}

package/dist/node/spec/HDWallet/HDWallet.spec.d.ts

@@ -1,8 +0,0 @@
-import type { WalletStatic } from '@xyo-network/wallet-model';
-/**
- * Generates tests for a wallet type
- * @param title The title of the test suite
- * @param HDWallet The wallet type to test
- */
-export declare const generateHDWalletTests: (title: string, HDWallet: WalletStatic) => void;
-//# sourceMappingURL=HDWallet.spec.d.ts.map

package/dist/node/spec/HDWallet/HDWallet.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HDWallet.spec.d.ts","sourceRoot":"","sources":["../../../../src/spec/HDWallet/HDWallet.spec.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAkB,YAAY,EAAE,MAAM,2BAA2B,CAAA;AA2F7E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,GAAI,OAAO,MAAM,EAAE,UAAU,YAAY,SAwF1E,CAAA"}

package/src/spec/AddressRoundTrip.spec.ts

@@ -1,17 +0,0 @@
-import { Account } from '@xyo-network/account'
-import {
-  describe, expect, it,
-} from 'vitest'
-
-import { HDWallet } from '../HDWallet.ts'
-
-describe('Address', () => {
-  it('should round trip from BigInt', async () => {
-    for (let index = 0; index < 100; index++) {
-      const foo = await HDWallet.random()
-      const privateKey = BigInt(foo.privateKey)
-      const sharedAccount = await Account.fromPrivateKey(privateKey)
-      expect(sharedAccount).toBeDefined()
-    }
-  })
-})

package/src/spec/HDWallet/HDWallet.browser.spec.ts

@@ -1,20 +0,0 @@
-import {
-  describe, expect, it,
-} from 'vitest'
-
-// import { HDWallet } from '../../HDWallet'
-// import { generateHDWalletTests } from './HDWallet.spec'
-
-/**
- * @group jsdom
- */
-/* describe.skip('Node Wallet Test', () => {
-  generateHDWalletTests('HDWallet: Browser', HDWallet)
-})
-*/
-
-describe('Node Wallet Test - Commented Out', () => {
-  it('Stub', () => {
-    expect(true).toBe(true)
-  })
-})

package/src/spec/HDWallet/HDWallet.node.spec.ts

@@ -1,11 +0,0 @@
-import { describe } from 'vitest'
-
-import { HDWallet } from '../../HDWallet.ts'
-import { generateHDWalletTests } from './HDWallet.spec.ts'
-
-/**
- * @group nodejs
- */
-describe('Node Wallet Test', () => {
-  generateHDWalletTests('HDWallet: Node', HDWallet)
-})

package/src/spec/HDWallet/HDWallet.spec.ts

@@ -1,228 +0,0 @@
-import type { Address, Hex } from '@xylabs/hex'
-import { isAddress } from '@xylabs/hex'
-import { matchers } from '@xylabs/vitest-matchers'
-import type { WalletInstance, WalletStatic } from '@xyo-network/wallet-model'
-import {
-  defaultPath, Mnemonic, SigningKey,
-} from 'ethers'
-import {
-  describe, expect, it,
-  test,
-} from 'vitest'
-
-expect.extend(matchers)
-
-import { HDWallet } from '../../HDWallet.ts'
-
-/**
- * The wallet types that can be tested
- */
-type Wallet = HDWallet | WalletInstance
-
-/**
- * The serializable information of a wallet
- */
-interface WalletSnapshot {
-  address: Address
-  path: string | null
-  privateKey: Hex
-  publicKey: Hex
-}
-
-/**
- * Converts a compressed public key to an uncompressed public key
- * @param compressed The compressed public key
- * @returns The uncompressed public key
- */
-const toUncompressedPublicKey = (compressed: string): string => SigningKey.computePublicKey(compressed, false).toLowerCase().replace('0x04', '')
-
-/**
- * Standardizes the representation of a hex string
- * @param unformatted The unformatted hex string
- * @returns The formatted hex string
- */
-const formatHexString = (unformatted: string): string => unformatted.toLowerCase().replace('0x', '')
-
-/**
- * Serializes a wallet to its snapshot representation
- * @param wallet The wallet to snapshot
- * @returns The snapshot representation of the wallet
- */
-const toWalletSnapshot = (wallet: Wallet): WalletSnapshot => {
-  const {
-    address, path, privateKey, publicKey,
-  } = wallet as WalletInstance
-  return {
-    address, path, privateKey, publicKey,
-  }
-}
-
-/**
- * Snapshots the instances of two wallets to ensure repeatability
- * of creation from the same source and prevent unintentional changes
- * to the wallet protocol
- * @param walletA The first wallet to snapshot
- * @param walletB The second wallet to snapshot
- */
-const snapshotWalletInstances = (walletA: Wallet, walletB: Wallet) => {
-  expect(toWalletSnapshot(walletA)).toMatchSnapshot()
-  expect([toWalletSnapshot(walletA), toWalletSnapshot(walletB)]).toMatchSnapshot()
-}
-
-/**
- * Compares two wallets to ensure their public/private keys are equal
- * @param sutA The first wallet to compare
- * @param sutB The second wallet to compare
- */
-const expectWalletsEqual = (sutA: WalletInstance, sutB: Wallet) => {
-  expect(sutA.address).toEqual(formatHexString(sutB.address))
-  expect(sutA.privateKey).toEqual(sutB.privateKey)
-  expect(sutA.private?.hex).toEqual(formatHexString(sutB.privateKey))
-  expect(sutA.publicKey).toEqual(sutB.publicKey)
-  expect(sutA.public?.hex).toEqual(toUncompressedPublicKey(sutB.publicKey))
-}
-
-/**
- * Compares two wallets to ensure their public/private keys and paths are equal
- * @param sutA The first wallet to compare
- * @param sutB The second wallet to compare
- */
-const expectWalletsAndPathsEqual = (sutA: WalletInstance, sutB: Wallet) => {
-  expectWalletsEqual(sutA, sutB)
-  expect(sutA.path).toEqual(sutB.path)
-}
-
-/**
- * Generates tests for a wallet type
- * @param title The title of the test suite
- * @param HDWallet The wallet type to test
- */
-export const generateHDWalletTests = (title: string, HDWallet: WalletStatic) => {
-  describe(title, () => {
-    const phrase = 'later puppy sound rebuild rebuild noise ozone amazing hope broccoli crystal grief'
-    const paths = ['0/4', "44'/0'/0'", "44'/60'/0'/0/0", "44'/60'/0'/0/1", "49'/0'/0'", "84'/0'/0'", "84'/0'/0'/0"]
-
-    describe('constructor', () => {
-      it('can be created from mnemonic', async () => {
-        const sut = await HDWallet.fromPhrase(phrase)
-        console.log('address', sut.address)
-        console.log('privateKeyX', sut.privateKey)
-        const mnemonic = Mnemonic.fromPhrase(phrase)
-        console.log('mnemonic.entropy', mnemonic.entropy)
-        expect(isAddress(sut.address)).toBe(true)
-        expect(sut).toBeDefined()
-      })
-      it.each(paths)('works repeatably & interoperably with Ethers', async (path: string) => {
-        const sutA = await HDWallet.fromPhrase(phrase)
-        const sutB = await HDWallet.fromMnemonic(Mnemonic.fromPhrase(phrase))
-        expectWalletsAndPathsEqual(sutA, sutB)
-        snapshotWalletInstances(sutA, sutB)
-        const accountA = await sutA.derivePath(path)
-        const accountB = await sutB.derivePath(path)
-        expectWalletsAndPathsEqual(accountA, accountB)
-        snapshotWalletInstances(accountA, accountB)
-      })
-    })
-    describe('derivePath', () => {
-      it.each(paths)('works repeatably & interoperably from phrase & extended key', async (path: string) => {
-        const sutA = await HDWallet.fromPhrase(phrase)
-        const sutB = await HDWallet.fromExtendedKey(sutA.extendedKey)
-        expectWalletsEqual(sutA, sutB)
-        expect(sutA.path).not.toBeNull()
-        expect(sutB.path).not.toBeNull()
-        snapshotWalletInstances(sutA, sutB)
-        const accountA = await sutA.derivePath?.(path)
-        const accountB = await sutB.derivePath?.(path)
-        expectWalletsEqual(accountA, accountB)
-        expect(accountA.path).not.toBeNull()
-        expect(accountB.path).not.toBeNull()
-        snapshotWalletInstances(accountA, accountB)
-      })
-
-      it('works when paths provided incrementally', async () => {
-        const parentRelativePath = "44'/60'/0'"
-        const childRelativePath = '0/1'
-        const sutA = await HDWallet.fromPhrase(phrase)
-        const sutB = await HDWallet.fromPhrase(phrase)
-        expectWalletsAndPathsEqual(sutA, sutB)
-        snapshotWalletInstances(sutA, sutB)
-        const accountA = await (await sutA.derivePath(parentRelativePath)).derivePath?.(childRelativePath)
-        const accountB = await sutB.derivePath?.([parentRelativePath, childRelativePath].join('/'))
-        expectWalletsAndPathsEqual(accountA, accountB)
-        snapshotWalletInstances(accountA, accountB)
-      })
-      it('works when paths provided absolutely', async () => {
-        const parentAbsolutePath = "m/44'/60'/0'"
-        const childRelativePath = '0/1'
-        const absolutePath = [parentAbsolutePath, childRelativePath].join('/')
-        const sutA = await HDWallet.fromPhrase(phrase, absolutePath)
-        const sutB = await HDWallet.fromPhrase(phrase, parentAbsolutePath)
-        expect(sutA.path).toEqual(absolutePath)
-        expect(sutB.path).toEqual(parentAbsolutePath)
-        // Skip intermediate snapshot since wallets currently have different paths
-        // snapshotWalletInstances(sutA, sutB)
-        const accountA = sutA
-        const accountB = await sutB.derivePath(childRelativePath)
-        expectWalletsAndPathsEqual(accountA, accountB)
-        // accountA and accountB should be the same instance
-        // expect(accountA).toBe(accountB)
-        snapshotWalletInstances(accountA, accountB)
-      })
-      it('returns cached instances on subsequent requests', async () => {
-        const parent = "44'/60'/0'"
-        const child = '0/1'
-        const sutA = await HDWallet.fromPhrase(phrase)
-        const sutB = await HDWallet.fromPhrase(phrase)
-        expectWalletsAndPathsEqual(sutA, sutB)
-        // sutA and sutB should be the same instance
-        expect(sutA).toBe(sutB)
-        const accountA = await (await sutA.derivePath(parent)).derivePath?.(child)
-        const accountB = await sutB.derivePath?.([parent, child].join('/'))
-        expectWalletsAndPathsEqual(accountA, accountB)
-        // accountA and accountB should be the same instance
-        // expect(accountA).toBe(accountB)
-        snapshotWalletInstances(accountA, accountB)
-      })
-    })
-  })
-}
-
-test('HDWallet tests generator is defined', () => {
-  expect(typeof generateHDWalletTests).toBe('function')
-})
-
-test('Same address, two paths', async () => {
-  const sut = await HDWallet.fromMnemonic(Mnemonic.fromPhrase('later puppy sound rebuild rebuild noise ozone amazing hope broccoli crystal grief'))
-  const accountNode = await sut.derivePath('0')
-  expect(accountNode.path).toBe(`${defaultPath}/0`)
-  const accountA = await sut.derivePath('0/2')
-  const accountB = await accountNode.derivePath('2')
-  const accountAPrime = await accountNode.derivePath("0'/2")
-  const accountAPrime2 = await accountNode.derivePath("0/2'")
-  expect(accountA.address).toEqual(accountB.address)
-  expect(accountNode.address === accountB.address).toBe(false)
-  expect(accountA.address === accountAPrime.address).toBe(false)
-  expect(accountA.address === accountAPrime2.address).toBe(false)
-
-  expect(accountNode.address).toMatchSnapshot()
-  expect(accountA.address).toMatchSnapshot()
-  expect(accountB.address).toMatchSnapshot()
-  expect(accountAPrime.address).toMatchSnapshot()
-})
-
-test('Random Wallet', async () => {
-  const sut = await HDWallet.random()
-  expect(sut).toBeDefined()
-  expect(sut.address).toBeDefined()
-  expect(sut.privateKey).toBeDefined()
-  expect(sut.publicKey).toBeDefined()
-  expect(sut.extendedKey).toBeDefined()
-  expect(sut.path).toBeDefined()
-  expect(sut.path).toBe(defaultPath)
-})
-
-test('HDWallet can be created from mnemonic', async () => {
-  const sut = await HDWallet.fromPhrase('abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about', "m/44'/0'/0'/0/0")
-  expect(sut).toBeDefined()
-  console.log('privateKey', sut.privateKey)
-})