Variable hdkeychainConst

Type Declaration

• address: function

  • address(key: string, network?: Network): Promise<string>

    Get the P2PKH address for an extended key. Calls Go: hdkeychain.ExtendedKey.Address() from btcutil/hdkeychain.

    Parameters

    • key: string
    • network: Network = 'mainnet'

    Returns Promise<string>

• derive: function

  • derive(key: string, index: number): Promise<string>

    Derive a child key at the given index. Use index >= 0x80000000 for hardened. Calls Go: hdkeychain.ExtendedKey.Derive() from btcutil/hdkeychain.

    Parameters

    • key: string
    • index: number

    Returns Promise<string>

• deriveHardened: function

  • deriveHardened(key: string, index: number): Promise<string>

    Derive a hardened child key (adds 0x80000000 to the index automatically). Calls Go: hdkeychain.ExtendedKey.Derive() with HardenedKeyStart from btcutil/hdkeychain.

    Parameters

    • key: string
    • index: number

    Returns Promise<string>

• derivePath: function

  • derivePath(key: string, path: string): Promise<string>

    Derive along a BIP-32 path like "m/44'/0'/0'/0/0". Supports both ' and h as hardened suffixes. Calls Go: hdkeychain.ExtendedKey.Derive() iteratively from btcutil/hdkeychain.

    Parameters

    • key: string
    • path: string

    Returns Promise<string>

• fromString: function

  • fromString(key: string): Promise<ExtendedKeyInfo>

    Parse an extended key string (xprv/xpub/tprv/tpub) and return info. Calls Go: hdkeychain.NewKeyFromString() from btcutil/hdkeychain.

    Parameters

    • key: string

    Returns Promise<ExtendedKeyInfo>

• generateSeed: function

  • generateSeed(length?: number): Promise<Uint8Array<ArrayBufferLike>>

    Generate a random seed of the given length in bytes (default: 32). Calls Go: hdkeychain.GenerateSeed() from btcutil/hdkeychain.

    Parameters

    • Optionallength: number

    Returns Promise<Uint8Array<ArrayBufferLike>>

• neuter: function

  • neuter(key: string): Promise<string>

    Convert a private extended key to its public counterpart. Calls Go: hdkeychain.ExtendedKey.Neuter() from btcutil/hdkeychain.

    Parameters

    • key: string

    Returns Promise<string>

• newMaster: function

  • newMaster(seed: Bytes, network?: Network): Promise<string>

    Create a master extended key from a seed (hex). Calls Go: hdkeychain.NewMaster() from btcutil/hdkeychain.

    Parameters

    • seed: Bytes
    • network: Network = 'mainnet'

    Returns Promise<string>

• publicKey: function

  • publicKey(key: string): Promise<Uint8Array<ArrayBufferLike>>

    Get the compressed public key (hex) for an extended key. Calls Go: hdkeychain.ExtendedKey.ECPubKey() from btcutil/hdkeychain.

    Parameters

    • key: string

    Returns Promise<Uint8Array<ArrayBufferLike>>