Class PublicKeyGenerator

Helper class to generate public keys from an extended public key (XPub) that has been derived up to the co-signer index.

Please note that in Kaspa master public keys use kpub prefix.

See

PrivateKeyGenerator, XPub, XPrv, Mnemonic

Constructors

constructor

Methods

changeAddress changeAddressAsString changeAddressAsStrings changeAddresses changePubkey changePubkeyAsString changePubkeys changePubkeysAsStrings free receiveAddress receiveAddressAsString receiveAddressAsStrings receiveAddresses receivePubkey receivePubkeyAsString receivePubkeys receivePubkeysAsStrings toString fromMasterXPrv fromXPub

Constructors

constructor

Methods

changeAddress

  • changeAddress(networkType, index): Address

  • Generate a single Change Address derivation at a given index.

    Parameters

    Returns Address

changeAddressAsString

  • changeAddressAsString(networkType, index): string

  • Generate a single Change Address derivation at a given index and return it as a string.

    Parameters

    Returns string

changeAddressAsStrings

  • changeAddressAsStrings(networkType, start, end): string[]

  • Generate a range of Change Address derivations and return them as strings.

    Parameters

    Returns string[]

changeAddresses

  • changeAddresses(networkType, start, end): Address[]

  • Generate Change Address derivations for a given range.

    Parameters

    Returns Address[]

changePubkey

  • changePubkey(index): PublicKey

  • Generate a single Change Public Key derivation at a given index.

    Parameters

    • index: number

    Returns PublicKey

changePubkeyAsString

  • changePubkeyAsString(index): string

  • Generate a single Change Public Key derivation at a given index and return it as a string.

    Parameters

    • index: number

    Returns string

changePubkeys

  • changePubkeys(start, end): (string | PublicKey)[]

  • Generate Change Public Key derivations for a given range.

    Parameters

    • start: number
    • end: number

    Returns (string | PublicKey)[]

changePubkeysAsStrings

  • changePubkeysAsStrings(start, end): string[]

  • Generate a range of Change Public Key derivations and return them as strings.

    Parameters

    • start: number
    • end: number

    Returns string[]

free

  • free(): void

  • Returns void

receiveAddress

  • receiveAddress(networkType, index): Address

  • Generate a single Receive Address derivation at a given index.

    Parameters

    Returns Address

receiveAddressAsString

  • receiveAddressAsString(networkType, index): string

  • Generate a single Receive Address derivation at a given index and return it as a string.

    Parameters

    Returns string

receiveAddressAsStrings

  • receiveAddressAsStrings(networkType, start, end): string[]

  • Generate a range of Receive Address derivations and return them as strings.

    Parameters

    Returns string[]

receiveAddresses

  • receiveAddresses(networkType, start, end): Address[]

  • Generate Receive Address derivations for a given range.

    Parameters

    Returns Address[]

receivePubkey

  • receivePubkey(index): PublicKey

  • Generate a single Receive Public Key derivation at a given index.

    Parameters

    • index: number

    Returns PublicKey

receivePubkeyAsString

  • receivePubkeyAsString(index): string

  • Generate a single Receive Public Key derivation at a given index and return it as a string.

    Parameters

    • index: number

    Returns string

receivePubkeys

  • receivePubkeys(start, end): (string | PublicKey)[]

  • Generate Receive Public Key derivations for a given range.

    Parameters

    • start: number
    • end: number

    Returns (string | PublicKey)[]

receivePubkeysAsStrings

  • receivePubkeysAsStrings(start, end): string[]

  • Generate a range of Receive Public Key derivations and return them as strings.

    Parameters

    • start: number
    • end: number

    Returns string[]

toString

  • toString(): string

  • Returns string

Static fromMasterXPrv

  • fromMasterXPrv(xprv, is_multisig, account_index, cosigner_index?): PublicKeyGenerator

  • Parameters

    • xprv: string | XPrv
    • is_multisig: boolean
    • account_index: bigint
    • Optional cosigner_index: number

    Returns PublicKeyGenerator

Static fromXPub

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc