modifying all functions to accept an object as a parameter and return object too

Author: Anderson-Juhasc

README.md

@@ -21,7 +21,7 @@ const mnemonic = 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong'
 const passphrase = 'your super secure passphrase' // optional
 const accountIndex = 0
 
-const { privateKey, publicKey } = accountFromSeedWords(mnemonic, passphrase, accountIndex)
+const { privateKey, publicKey } = accountFromSeedWords({ mnemonic, passphrase, accountIndex })
 ```
 
 ```js
@@ -41,11 +41,11 @@ import {
 
 const privateKey = '5f29af3b9676180290e77a4efad265c4c2ff28a5302461f73597fda26bb25731'
 
-const { publicKey } = getPublicKey(privateKey)
-const nsec = getBech32PrivateKey(privateKey)
-const npub = getBech32PublicKey(publicKey.hex)
+const { publicKey } = getPublicKey({ privateKey })
+const { bech32PrivateKey } = getBech32PrivateKey({ privateKey })
+const { bech32PublicKey } = getBech32PublicKey({ publicKey.hex })
 // or
-const npub = publicKey.bech32
+const bech32PublicKey2 = publicKey.bech32
 ```
 
 ```js
@@ -56,12 +56,11 @@ import {
 
 const mnemonic = 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong'
 const passphrase = 'your super secure passphrase' // optional
-
 const extendedAccountIndex = 0
 const accountIndex = 0
 
-const { privateExtendedKey, publicExtendedKey } = extendedKeysFromSeedWords(mnemonic, passphrase, extendedAccountIndex)
-const { privateKey, publicKey } = accountFromExtendedKey(privateExtendedKey, accountIndex)
+const { privateExtendedKey, publicExtendedKey } = extendedKeysFromSeedWords({ mnemonic, passphrase, extendedAccountIndex })
+const { privateKey, publicKey } = accountFromExtendedKey({ base58Key: privateExtendedKey, accountIndex })
 ```
 
 ```js
@@ -72,5 +71,5 @@ import {
 const publicExtendedKey = 'xpub6C2FTj1fmB2GES9CSxbXYtrve372NjoHLLQxYRGb9qXbMWBLdDH5qQ7pm29LQuYaF4HzFUsdkcj4jurBU3ebF7xkVNbVTY3MCp9mEiX4Te5'
 const accountIndex = 0
 
-const { publicKey } = accountFromExtendedKey(publicExtendedKey, accountIndex)
+const { publicKey } = accountFromExtendedKey({ base58Key: publicExtendedKey, accountIndex })
 ```

src/index.ts

@@ -8,32 +8,39 @@ import {
 } from '@scure/bip39'
 import { bech32 } from 'bech32'
 import { wordlist } from '@scure/bip39/wordlists/english'
-import { DERIVATION_PATH, PUBLIC_KEY_PREFIX, SECRET_KEY_PREFIX } from './constants'
+import { 
+  DERIVATION_PATH,
+  PUBLIC_KEY_PREFIX,
+  SECRET_KEY_PREFIX
+} from './constants'
 
-type ExtendedKeys = {
-  privateExtendedKey: string,
-  publicExtendedKey: string
-}
-type PrivateKey = { hex: string, bech32: string }
-type PublicKey = { hex: string, bech32: string }
-type Account = {
-  privateKey: PrivateKey,
-  publicKey:  PublicKey
-}
+import { 
+  ExtendedKeys,
+  Key,
+  Account,
+} from './types'
 
-export function accountFromSeedWords(mnemonic: string, passphrase?: string, accountIndex = 0): Account {
+export function accountFromSeedWords({
+  mnemonic,
+  passphrase,
+  accountIndex = 0
+} : {
+  mnemonic: string,
+  passphrase?: string,
+  accountIndex?: number
+}): Account {
   const root = HDKey.fromMasterSeed(mnemonicToSeedSync(mnemonic, passphrase))
   const seed = root.derive(`${DERIVATION_PATH}/${accountIndex}'/0/0`)
   const privateKeyHex = bytesToHex(seed.privateKey!)
   const publicKeyHex = bytesToHex(seed.publicKey!.slice(1))
   if (!privateKeyHex && !publicKeyHex) {
     throw new Error('could not derive key pair')
   }
-  const privateKeyBech32 = getBech32PrivateKey(privateKeyHex)
-  const publicKeyBech32 = getBech32PublicKey(publicKeyHex)
+  const { bech32PrivateKey } = getBech32PrivateKey({ privateKey: privateKeyHex })
+  const { bech32PublicKey } = getBech32PublicKey({ publicKey: publicKeyHex })
   return {
-    privateKey: { hex: privateKeyHex, bech32: privateKeyBech32 },
-    publicKey: { hex: publicKeyHex, bech32: publicKeyBech32 } 
+    privateKey: { hex: privateKeyHex, bech32: bech32PrivateKey },
+    publicKey: { hex: publicKeyHex, bech32: bech32PublicKey } 
   }
 }
 
@@ -43,28 +50,36 @@ export function accountFromRandomKey(): Account {
   if (!privateKeyHex && !publicKeyHex) {
     throw new Error('could not derive key pair')
   }
-  const privateKeyBech32 = getBech32PrivateKey(privateKeyHex)
-  const publicKeyBech32 = getBech32PublicKey(publicKeyHex)
+  const { bech32PrivateKey } = getBech32PrivateKey({ privateKey: privateKeyHex })
+  const { bech32PublicKey } = getBech32PublicKey({ publicKey: publicKeyHex })
   return {
-    privateKey: { hex: privateKeyHex, bech32: privateKeyBech32 },
-    publicKey: { hex: publicKeyHex, bech32: publicKeyBech32 } 
+    privateKey: { hex: privateKeyHex, bech32: bech32PrivateKey },
+    publicKey: { hex: publicKeyHex, bech32: bech32PublicKey } 
   }
 }
 
-export function getPublicKey(privateKey: string): {
-  publicKey: PublicKey
+export function getPublicKey({ privateKey }: { privateKey: string }): {
+  publicKey: Key
 } {
   const publicKeyHex = bytesToHex(schnorr.getPublicKey(privateKey))
   if (!publicKeyHex) {
     throw new Error('could not generate public key')
   }
-  const publicKeyBech32 = getBech32PublicKey(publicKeyHex)
+  const { bech32PublicKey } = getBech32PublicKey({ publicKey: publicKeyHex })
   return {
-    publicKey: { hex: publicKeyHex, bech32: publicKeyBech32 } 
+    publicKey: { hex: publicKeyHex, bech32: bech32PublicKey } 
   }
 }
 
-export function extendedKeysFromSeedWords(mnemonic: string, passphrase?: string, extendedAccountIndex = 0): ExtendedKeys {
+export function extendedKeysFromSeedWords({
+  mnemonic,
+  passphrase,
+  extendedAccountIndex = 0
+} : {
+  mnemonic: string,
+  passphrase?: string,
+  extendedAccountIndex?: number
+}): ExtendedKeys {
   let root = HDKey.fromMasterSeed(mnemonicToSeedSync(mnemonic, passphrase))
   let seed = root.derive(`${DERIVATION_PATH}/${extendedAccountIndex}'`)
   let privateExtendedKey = seed.privateExtendedKey
@@ -73,39 +88,49 @@ export function extendedKeysFromSeedWords(mnemonic: string, passphrase?: string,
   return { privateExtendedKey, publicExtendedKey }
 }
 
-export function accountFromExtendedKey(base58key: string, accountIndex = 0): {
-  privateKey?: PrivateKey,
-  publicKey:  PublicKey
+export function accountFromExtendedKey({ 
+  base58Key,
+  accountIndex = 0
+} : {
+  base58Key: string,
+  accountIndex?: number
+}): {
+  privateKey?: Key,
+  publicKey:  Key
 } {
-  let extendedKey = HDKey.fromExtendedKey(base58key)
-  let version = base58key.slice(0, 4)
+  let extendedKey = HDKey.fromExtendedKey(base58Key)
+  let version = base58Key.slice(0, 4)
   let child = extendedKey.deriveChild(0).deriveChild(accountIndex)
   let publicKeyHex = bytesToHex(child.publicKey!.slice(1))
   if (!publicKeyHex) throw new Error('could not derive public key')
-  let publicKeyBech32 = getBech32PublicKey(publicKeyHex)
+  const { bech32PublicKey } = getBech32PublicKey({ publicKey: publicKeyHex })
   if (version === 'xprv') {
     let privateKeyHex = bytesToHex(child.privateKey!)
     if (!privateKeyHex) throw new Error('could not derive private key')
-    let privateKeyBech32 = getBech32PrivateKey(privateKeyHex)
+    const { bech32PrivateKey } = getBech32PrivateKey({ privateKey: privateKeyHex })
     return { 
-      privateKey: { hex: privateKeyHex, bech32: privateKeyBech32 },
-      publicKey: { hex: publicKeyHex, bech32: publicKeyBech32 } 
+      privateKey: { hex: privateKeyHex, bech32: bech32PrivateKey },
+      publicKey: { hex: publicKeyHex, bech32: bech32PublicKey } 
     } 
   }
-  return { publicKey: { hex: publicKeyHex, bech32: publicKeyBech32 } } 
+  return { publicKey: { hex: publicKeyHex, bech32: bech32PublicKey } } 
 }
 
 function hexToBech32(key: string, prefix: string) {
   const words = bech32.toWords(hexToBytes(key))
   return bech32.encode(prefix, words)
 }
 
-export function getBech32PrivateKey(privateKey: string): string {
-  return hexToBech32(privateKey, SECRET_KEY_PREFIX)
+export function getBech32PrivateKey({ privateKey }: { privateKey: string }): { bech32PrivateKey: string } {
+  return {
+    bech32PrivateKey: hexToBech32(privateKey, SECRET_KEY_PREFIX)
+  }
 }
 
-export function getBech32PublicKey(publicKey: string): string {
-  return hexToBech32(publicKey, PUBLIC_KEY_PREFIX)
+export function getBech32PublicKey({ publicKey }: { publicKey: string }): { bech32PublicKey: string } {
+  return {
+    bech32PublicKey: hexToBech32(publicKey, PUBLIC_KEY_PREFIX)
+  }
 }
 
 export function generateSeedWords(): { mnemonic: string } {
@@ -114,7 +139,7 @@ export function generateSeedWords(): { mnemonic: string } {
   }
 }
 
-export function validateWords(mnemonic: string): { isMnemonicValid: boolean } {
+export function validateWords({ mnemonic }: { mnemonic: string }): { isMnemonicValid: boolean } {
   return {
     isMnemonicValid: validateMnemonic(mnemonic, wordlist)
   }

src/types.ts

@@ -0,0 +1,12 @@
+export type Key = { 
+  hex: string,
+  bech32: string
+}
+export type Account = {
+  privateKey: Key,
+  publicKey:  Key
+}
+export type ExtendedKeys = {
+  privateExtendedKey: string,
+  publicExtendedKey: string
+}

tests/accountFromExtendedKey.test.ts

@@ -3,7 +3,8 @@ import { accountFromExtendedKey } from '../src/index'
 
 describe('accountFromExtendedKey', () => {
   it('should get account from extended private key', () => {
-    const { privateKey, publicKey } = accountFromExtendedKey('xprv9z78fizET65qsCaRr1MSutTSGk1fcKfSt1sBqmuWShtkjRJJ4WCKcSnha6EmgNzFSsyom3MWtydHyPtJtSLZQUtictVQtM2vkPcguh6TQCH')
+    const base58Key = 'xprv9z78fizET65qsCaRr1MSutTSGk1fcKfSt1sBqmuWShtkjRJJ4WCKcSnha6EmgNzFSsyom3MWtydHyPtJtSLZQUtictVQtM2vkPcguh6TQCH'
+    const { privateKey, publicKey } = accountFromExtendedKey({ base58Key })
 
     expect(privateKey?.hex).toBe('5f29af3b9676180290e77a4efad265c4c2ff28a5302461f73597fda26bb25731')
     expect(privateKey?.bech32).toBe('nsec1tu567wukwcvq9y880f8045n9cnp07299xqjxrae4jl76y6aj2ucs2mkupq')
@@ -12,7 +13,8 @@ describe('accountFromExtendedKey', () => {
   })
 
   it('should get account from extended public key', () => {
-    const { publicKey } = accountFromExtendedKey('xpub6D6V5EX8HTe95getx2tTH2QApmrA1nPJFEnneAK813RjcDdSc3WaAF7BRNpTF7o7zXjVm3DD3VMX66jhQ7wLaZ9sS6NzyfiwfzqDZbxvpDN')
+    const base58Key = 'xpub6D6V5EX8HTe95getx2tTH2QApmrA1nPJFEnneAK813RjcDdSc3WaAF7BRNpTF7o7zXjVm3DD3VMX66jhQ7wLaZ9sS6NzyfiwfzqDZbxvpDN'
+    const { publicKey } = accountFromExtendedKey({ base58Key })
 
     expect(publicKey.hex).toBe('e8bcf3823669444d0b49ad45d65088635d9fd8500a75b5f20b59abefa56a144f')
     expect(publicKey.bech32).toBe('npub1az708q3kd9zy6z6f44zav5ygvdwelkzspf6mtusttx47lft2z38sghk0w7')

tests/accountFromSeedWords.test.ts

@@ -8,24 +8,35 @@ describe('accountFromSeedWords', () => {
   })
 
   it('should get a 64 bytes hex private key from mnemonic', () => {
-    const accountIndex = 0
-    const { privateKey: sk1 } = accountFromSeedWords('abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about', '', accountIndex)
-    const { privateKey: sk2 } = accountFromSeedWords('zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong', '', accountIndex)
-    const { privateKey: sk3 } = accountFromSeedWords('bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon', '', accountIndex)
+    const { privateKey: sk1 } = accountFromSeedWords({
+      mnemonic: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about',
+      accountIndex: 0
+    })
+    const { privateKey: sk2 } = accountFromSeedWords({
+      mnemonic: 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong',
+      accountIndex: 0
+    })
+    const { privateKey: sk3 } = accountFromSeedWords({
+      mnemonic: 'bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon',
+      accountIndex: 0 
+    })
 
     expect(sk1.hex).toBe('5f29af3b9676180290e77a4efad265c4c2ff28a5302461f73597fda26bb25731')
     expect(sk2.hex).toBe('c26cf31d8ba425b555ca27d00ca71b5008004f2f662470f8c8131822ec129fe2')
     expect(sk3.hex).toBe('45049983ec1e38aa8a4a7d76b0203a4484d9a1d3120017cfd455e80aac2d52e4')
   })
 
   it('should get a 64 bytes hex private key from mnemonic and passphrase', () => {
-    const { privateKey } = accountFromSeedWords('abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about', '123')
+    const { privateKey } = accountFromSeedWords({
+      mnemonic: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about',
+      passphrase: '123'
+    })
     expect(privateKey.hex).toBe('60ecd7942071530818b4f3cf42e402b5c946b3ce387606d134c4613e59fa0196')
   })
 
   it('should thow an error when a invalid mnemonic is provided', () => {
     const fn = () => {
-      accountFromSeedWords('invalid words')
+      accountFromSeedWords({ mnemonic: 'invalid words' })
     }
     expect(fn).toThrowError('Invalid mnemonic')
   })

tests/bech32.test.ts

@@ -12,21 +12,23 @@ describe('bech32 formats', () => {
   })
 
   it('should generate a valid bech32 private and public key', () => {
-    const mnemonic = 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'
-    const { privateKey } = accountFromSeedWords(mnemonic)
-    const { publicKey } = getPublicKey(privateKey.hex)
-    const bech32PrivateKey = getBech32PrivateKey(privateKey.hex)
-    const bech32PublicKey = getBech32PublicKey(publicKey.hex)
+    const { privateKey } = accountFromSeedWords({ 
+      mnemonic: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'
+    })
+    const { publicKey } = getPublicKey({ privateKey: privateKey.hex })
+    const { bech32PrivateKey } = getBech32PrivateKey({ privateKey: privateKey.hex })
+    const { bech32PublicKey } = getBech32PublicKey({ publicKey: publicKey.hex })
     expect(bech32PrivateKey).toBe('nsec1tu567wukwcvq9y880f8045n9cnp07299xqjxrae4jl76y6aj2ucs2mkupq')
     expect(bech32PublicKey).toBe('npub1az708q3kd9zy6z6f44zav5ygvdwelkzspf6mtusttx47lft2z38sghk0w7')
   })
 
   it('should generate a valid bech32 private and public key', () => {
-    const mnemonic = 'bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon'
-    const { privateKey } = accountFromSeedWords(mnemonic)
-    const { publicKey } = getPublicKey(privateKey.hex)
-    const bech32PrivateKey = getBech32PrivateKey(privateKey.hex)
-    const bech32PublicKey = getBech32PublicKey(publicKey.hex)
+    const { privateKey } = accountFromSeedWords({ 
+      mnemonic: 'bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon'
+    })
+    const { publicKey } = getPublicKey({ privateKey: privateKey.hex })
+    const { bech32PrivateKey } = getBech32PrivateKey({ privateKey: privateKey.hex })
+    const { bech32PublicKey } = getBech32PublicKey({ publicKey: publicKey.hex })
     expect(bech32PrivateKey).toBe('nsec1g5zfnqlvrcu24zj204mtqgp6gjzdngwnzgqp0n752h5q4tpd2tjq5khznp')
     expect(bech32PublicKey).toBe('npub1s566ayhl06xkt4k3fk5ttvygjjhtkj8gndfflf3qmv2qpq7xhd2sy3ukkd')
   })

tests/extendedKeysFromSeedWords.test.ts

@@ -3,7 +3,9 @@ import { extendedKeysFromSeedWords } from '../src/index'
 
 describe('extendedPairFromSeedWords', () => {
   it('should get extended keys pair from mnemonic', () => {
-    const { privateExtendedKey, publicExtendedKey } = extendedKeysFromSeedWords('abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about')
+    const { privateExtendedKey, publicExtendedKey } = extendedKeysFromSeedWords({
+      mnemonic: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'
+    })
 
     expect(privateExtendedKey).toBe('xprv9z78fizET65qsCaRr1MSutTSGk1fcKfSt1sBqmuWShtkjRJJ4WCKcSnha6EmgNzFSsyom3MWtydHyPtJtSLZQUtictVQtM2vkPcguh6TQCH')
     expect(publicExtendedKey).toBe('xpub6D6V5EX8HTe95getx2tTH2QApmrA1nPJFEnneAK813RjcDdSc3WaAF7BRNpTF7o7zXjVm3DD3VMX66jhQ7wLaZ9sS6NzyfiwfzqDZbxvpDN')

tests/generateSeedWords.test.ts

@@ -4,7 +4,7 @@ import { generateSeedWords, validateWords } from '../src/index'
 describe('generateSeedWords', () => {
   it('should generate a valid mnemonic', () => {
     const { mnemonic } = generateSeedWords()
-    const { isMnemonicValid } = validateWords(mnemonic)
+    const { isMnemonicValid } = validateWords({ mnemonic })
     expect(isMnemonicValid).toBeTruthy()
   })
 })

tests/getPublicKey.test.ts

@@ -7,7 +7,7 @@ const PUBLIC_KEY = '8a82a85afb75adb8544cb32b8ff7172803922308b59fa06d66d1120ead61
 describe('getPublicKey', () => {
   it('should generate a 64 bytes hex', () => {
     const privateKey = PRIVATE_KEY
-    const { publicKey } = getPublicKey(privateKey)
+    const { publicKey } = getPublicKey({ privateKey })
     expect(publicKey.hex).toHaveLength(64)
     expect(publicKey.hex).toBe(PUBLIC_KEY)
   })

tests/validateWords.test.ts

@@ -3,21 +3,28 @@ import { validateWords } from '../src/index'
 
 describe('validateWords', () => {
   it('should return false when words are invalid', () => {
-    const mnemonic1 = 'invalid words'
-    const { isMnemonicValid: isInvalid1 } = validateWords(mnemonic1)
-    const mnemonic2 = 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon zebra'
-    const { isMnemonicValid: isInvalid2 } = validateWords(mnemonic2)
+    const { isMnemonicValid: isInvalid1 } = validateWords({
+      mnemonic: 'invalid words'
+    })
+    const { isMnemonicValid: isInvalid2 } = validateWords({
+      mnemonic: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon zebra'
+    })
+
     expect(isInvalid1).toBeFalsy()
     expect(isInvalid2).toBeFalsy()
   })
 
   it('should return true when words are valid', () => {
-    const mnemonic1 = 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'
-    const mnemonic2 = 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong'
-    const mnemonic3 = 'bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon'
-    const { isMnemonicValid: isValid1 } = validateWords(mnemonic1)
-    const { isMnemonicValid: isValid2 } = validateWords(mnemonic2)
-    const { isMnemonicValid: isValid3 } = validateWords(mnemonic3)
+    const { isMnemonicValid: isValid1 } = validateWords({
+      mnemonic: 'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'
+    })
+    const { isMnemonicValid: isValid2 } = validateWords({
+      mnemonic: 'zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong'
+    })
+    const { isMnemonicValid: isValid3 } = validateWords({
+      mnemonic: 'bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon bacon'
+    })
+
     expect(isValid1).toBeTruthy()
     expect(isValid2).toBeTruthy()
     expect(isValid3).toBeTruthy()