Class ECPrivateKey

Static ReadonlyKEY_SIZE

Staticnew

• new(): ECPrivateKey

  Generate a new random ECPrivateKey.

  Returns ECPrivateKey

Staticrandom

• random(): ECPrivateKey

  Generate a new random ECPrivateKey.

  Returns ECPrivateKey

StaticnewUsing

• newUsing(rng: RandomNumberGenerator): ECPrivateKey

  Generate a new random ECPrivateKey using provided RNG.

  Parameters

  • rng: RandomNumberGenerator

  Returns ECPrivateKey

Statickeypair

• keypair(): [ECPrivateKey, ECPublicKey]

  Generate a new random ECPrivateKey and corresponding ECPublicKey.

  Returns [ECPrivateKey, ECPublicKey]

StatickeypairUsing

• keypairUsing(rng: RandomNumberGenerator): [ECPrivateKey, ECPublicKey]

  Generate a new random ECPrivateKey and corresponding ECPublicKey using the given random number generator.

  Parameters

  • rng: RandomNumberGenerator

  Returns [ECPrivateKey, ECPublicKey]

StaticderiveFromKeyMaterial

• deriveFromKeyMaterial(keyMaterial: Uint8Array): ECPrivateKey

  Derive an ECPrivateKey from the given key material.

  Parameters

  • keyMaterial: Uint8Array

    The key material to derive from

  Returns ECPrivateKey

  A new ECPrivateKey derived from the key material

StaticfromData

• fromData(data: Uint8Array): ECPrivateKey

  Restore an ECPrivateKey from a fixed-size array of bytes.

  Parameters

  • data: Uint8Array

  Returns ECPrivateKey

StaticfromDataRef

• fromDataRef(data: Uint8Array): ECPrivateKey

  Restore an ECPrivateKey from a reference to an array of bytes. Validates the length.

  Parameters

  • data: Uint8Array

  Returns ECPrivateKey

Staticfrom

• from(data: Uint8Array): ECPrivateKey

  Create an ECPrivateKey from raw bytes (legacy alias).

  Parameters

  • data: Uint8Array

  Returns ECPrivateKey

StaticfromHex

• fromHex(hex: string): ECPrivateKey

  Restore an ECPrivateKey from a hex string.

  Parameters

  • hex: string

  Returns ECPrivateKey

data

• data(): Uint8Array

  Get a reference to the fixed-size array of bytes.

  Returns Uint8Array

toData

• toData(): Uint8Array

  Get the raw private key bytes (copy).

  Returns Uint8Array

hex

• hex(): string

  Get hex string representation.

  Returns string

toHex

• toHex(): string

  Get hex string representation (alias for hex()).

  Returns string

toBase64

• toBase64(): string

  Get base64 representation.

  Returns string

publicKey

• publicKey(): ECPublicKey

  Get the ECPublicKey (compressed) corresponding to this ECPrivateKey.

  Returns ECPublicKey

schnorrPublicKey

• schnorrPublicKey(): SchnorrPublicKey

  Get the SchnorrPublicKey (x-only) corresponding to this ECPrivateKey.

  Returns SchnorrPublicKey

ecdsaSign

• ecdsaSign(message: Uint8Array): Uint8Array

  Sign a message using ECDSA.

  Parameters

  • message: Uint8Array

    The message to sign

  Returns Uint8Array

  A 64-byte signature

schnorrSign

• schnorrSign(message: Uint8Array): Uint8Array

  Sign a message using Schnorr signature (BIP-340).

  Parameters

  • message: Uint8Array

    The message to sign

  Returns Uint8Array

  A 64-byte signature

schnorrSignUsing

• schnorrSignUsing(message: Uint8Array, rng: RandomNumberGenerator): Uint8Array

  Sign a message using Schnorr signature with custom RNG.

  Parameters

  • message: Uint8Array

    The message to sign

  • rng: RandomNumberGenerator

    Random number generator for auxiliary randomness

  Returns Uint8Array

  A 64-byte signature

equals

• equals(other: ECPrivateKey): boolean

  Compare with another ECPrivateKey.

  Parameters

  • other: ECPrivateKey

  Returns boolean

toString

• toString(): string

  Get string representation.

  Returns string

cborTags

• cborTags(): Tag[]

  Returns the CBOR tags associated with ECPrivateKey.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

  Returns the untagged CBOR encoding.

  Format: { 2: true, 3: h'<32-byte-key>' }

  Returns Cbor

taggedCbor

• taggedCbor(): Cbor

  Returns the tagged CBOR encoding.

  Returns Cbor

taggedCborData

• taggedCborData(): Uint8Array

  Returns the tagged value in CBOR binary representation.

  Returns Uint8Array

fromUntaggedCbor

• fromUntaggedCbor(cborValue: Cbor): ECPrivateKey

  Creates an ECPrivateKey by decoding it from untagged CBOR.

  Format: { 2: true, 3: h'<32-byte-key>' }

  Parameters

  • cborValue: Cbor

  Returns ECPrivateKey

fromTaggedCbor

• fromTaggedCbor(cborValue: Cbor): ECPrivateKey

  Creates an ECPrivateKey by decoding it from tagged CBOR.

  Parameters

  • cborValue: Cbor

  Returns ECPrivateKey

StaticfromTaggedCbor

• fromTaggedCbor(cborValue: Cbor): ECPrivateKey

  Static method to decode from tagged CBOR.

  Parameters

  • cborValue: Cbor

  Returns ECPrivateKey

StaticfromTaggedCborData

• fromTaggedCborData(data: Uint8Array): ECPrivateKey

  Static method to decode from tagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns ECPrivateKey

StaticfromUntaggedCborData

• fromUntaggedCborData(data: Uint8Array): ECPrivateKey

  Static method to decode from untagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns ECPrivateKey

ur

• ur(): UR

  Returns the UR representation of the ECPrivateKey. Note: URs use untagged CBOR since the type is conveyed by the UR type itself.

  Returns UR

urString

• urString(): string

  Returns the UR string representation.

  Returns string

StaticfromUR

• fromUR(ur: UR): ECPrivateKey

  Creates an ECPrivateKey from a UR.

  Parameters

  • ur: UR

  Returns ECPrivateKey

StaticfromURString

• fromURString(urString: string): ECPrivateKey

  Creates an ECPrivateKey from a UR string.

  Parameters

  • urString: string

  Returns ECPrivateKey