Class HDKey

constructor

• new HDKey(params): HDKey

• Parameters

  • params: HDKeyConstructorParams

  Returns HDKey

_chainCode

_depth

_index

_keyIdentifier

_parentFingerprint

_privateKey

_publicKey

_version

Static Readonly hardenedKeyOffset

chainCode

• get chainCode(): Uint8Array

• Returns Uint8Array

depth

• get depth(): number

• Returns number

extendedPrivateKey

• get extendedPrivateKey(): null | string

• Returns null | string

extendedPublicKey

• get extendedPublicKey(): string

• Returns string

fingerprint

• get fingerprint(): number

• Returns number

hexChainCode

• get hexChainCode(): string

• Returns string

hexPrivKey

• get hexPrivKey(): null | string

• Returns null | string

index

• get index(): number

• Returns number

keyIdentifier

• get keyIdentifier(): Uint8Array

• Returns Uint8Array

nostrPubKey

• get nostrPubKey(): string

• Returns string

parentFingerprint

• get parentFingerprint(): undefined | number

• Returns undefined | number

privateKey

• get privateKey(): Uint8Array

• Returns Uint8Array

pubKeyHash

• get pubKeyHash(): string

• Returns string

publicKey

• get publicKey(): Uint8Array

• Returns Uint8Array

version

• get version(): Bip32NetworkInfo

• Returns Bip32NetworkInfo

derive

• derive(chain): HDKey

• Parameters

  • chain: string

  Returns HDKey

deriveChildKey

• deriveChildKey(index, hardened?): HDKey

• Parameters

  • index: number

  • hardened: boolean = false

  Returns HDKey

serialize

• serialize(prefix, key): string

• Parameters

  • prefix: number

  • key: Uint8Array

  Returns string

sign

• sign(hash): Uint8Array

• Parameters

  • hash: Uint8Array

  Returns Uint8Array

toJSON

• toJSON(): {
      xpriv: string;
      xpub: string;
  }

• Returns {
      xpriv: string;
      xpub: string;
  }

  • xpriv: string

  • xpub: string

verify

• verify(hash, signature): boolean

• Parameters

  • hash: Uint8Array

  • signature: Uint8Array

  Returns boolean

wipePrivateData

• wipePrivateData(): HDKey

• Returns HDKey

Static fromJSON

• fromJSON(json): HDKey

• Parameters

  • json: {
        xpriv: string;
    }

    • xpriv: string

  Returns HDKey

Static parseExtendedKey

• parseExtendedKey(key): HDKey

• Parameters

  • key: string

  Returns HDKey

Static parseMasterSeed

• parseMasterSeed(seed, version): HDKey

• Parameters

  • seed: Uint8Array

  • version: Bip32NetworkInfo

  Returns HDKey