Bip32PublicKey overview

Table of contents

• accessors
  • chainCode
  • publicKey
• arbitrary
  • arbitrary
• derivation
  • deriveChild
• either
  • Either (namespace)
• encoding
  • toBytes
  • toHex
  • toRawBytes
• errors
  • Bip32PublicKeyError (class)
• parsing
  • fromBytes
  • fromHex
• schemas
  • Bip32PublicKey (class)
    • toJSON (method)
    • toString (method)
    • [Inspectable.NodeInspectSymbol] (method)
    • [Equal.symbol] (method)
    • [Hash.symbol] (method)
  • FromBytes
  • FromHex

accessors

chainCode

Get the chain code.

Signature

export declare const chainCode: (bip32PublicKey: Bip32PublicKey) => Uint8Array

Added in v2.0.0

publicKey

Get the public key bytes.

Signature

export declare const publicKey: (bip32PublicKey: Bip32PublicKey) => Uint8Array

Added in v2.0.0

arbitrary

arbitrary

FastCheck arbitrary for generating random Bip32PublicKey instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<Bip32PublicKey>

Added in v2.0.0

derivation

deriveChild

Derive a child public key using the specified index (soft derivation only).

Signature

export declare const deriveChild: (bip32PublicKey: Bip32PublicKey, index: number) => Bip32PublicKey

Added in v2.0.0

either

Either (namespace)

Either-based error handling variants for functions that can fail.

Added in v2.0.0

encoding

toBytes

Convert a Bip32PublicKey to raw bytes (64 bytes).

Signature

export declare const toBytes: (a: Bip32PublicKey, overrideOptions?: ParseOptions) => Uint8Array

Added in v2.0.0

toHex

Convert a Bip32PublicKey to hex string.

Signature

export declare const toHex: (a: Bip32PublicKey, overrideOptions?: ParseOptions) => string

Added in v2.0.0

toRawBytes

Convert a Bip32PublicKey to raw public key bytes (32 bytes only).

Signature

export declare const toRawBytes: (bip32PublicKey: Bip32PublicKey) => Uint8Array

Added in v2.0.0

errors

Bip32PublicKeyError (class)

Error class for Bip32PublicKey related operations.

Signature

export declare class Bip32PublicKeyError

Added in v2.0.0

parsing

fromBytes

Create a BIP32 public key from public key and chain code bytes.

Signature

export declare const fromBytes: (i: Uint8Array, overrideOptions?: ParseOptions) => Bip32PublicKey

Added in v2.0.0

fromHex

Parse Bip32PublicKey from hex string.

Signature

export declare const fromHex: (i: string, overrideOptions?: ParseOptions) => Bip32PublicKey

Added in v2.0.0

schemas

Bip32PublicKey (class)

Schema for Bip32PublicKey representing a BIP32-Ed25519 extended public key. Always 64 bytes: 32-byte public key + 32-byte chaincode. Follows BIP32-Ed25519 hierarchical deterministic key derivation. Supports soft derivation only (hardened derivation requires private key).

Signature

export declare class Bip32PublicKey

Added in v2.0.0

toJSON (method)

Signature

toJSON()

toString (method)

Signature

toString(): string

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

FromBytes

Schema for transforming between Uint8Array and Bip32PublicKey.

Signature

export declare const FromBytes: Schema.transform<
  Schema.SchemaClass<Uint8Array, Uint8Array, never>,
  Schema.SchemaClass<Bip32PublicKey, Bip32PublicKey, never>
>

Added in v2.0.0

FromHex

Schema for transforming between hex string and Bip32PublicKey.

Signature

export declare const FromHex: Schema.transform<
  Schema.filter<Schema.Schema<Uint8Array, string, never>>,
  Schema.transform<
    Schema.SchemaClass<Uint8Array, Uint8Array, never>,
    Schema.SchemaClass<Bip32PublicKey, Bip32PublicKey, never>
  >
>

Added in v2.0.0