Class SigningPrivateKey

Static ReadonlyUR_TYPE

StaticnewSchnorr

• newSchnorr(key: ECPrivateKey): SigningPrivateKey

  Creates a new Schnorr signing private key from an ECPrivateKey.

  Parameters

  • key: ECPrivateKey

    The EC private key to use for Schnorr signing

  Returns SigningPrivateKey

  A new Schnorr signing private key

StaticnewEcdsa

• newEcdsa(key: ECPrivateKey): SigningPrivateKey

  Creates a new ECDSA signing private key from an ECPrivateKey.

  Parameters

  • key: ECPrivateKey

    The EC private key to use for ECDSA signing

  Returns SigningPrivateKey

  A new ECDSA signing private key

StaticnewEd25519

• newEd25519(key: Ed25519PrivateKey): SigningPrivateKey

  Creates a new Ed25519 signing private key from an Ed25519PrivateKey.

  Parameters

  • key: Ed25519PrivateKey

    The Ed25519 private key to use

  Returns SigningPrivateKey

  A new Ed25519 signing private key

StaticnewSr25519

• newSr25519(key: Sr25519PrivateKey): SigningPrivateKey

  Creates a new SR25519 signing private key from an Sr25519PrivateKey.

  Parameters

  • key: Sr25519PrivateKey

    The SR25519 private key to use

  Returns SigningPrivateKey

  A new SR25519 signing private key

StaticnewMldsa

• newMldsa(key: MLDSAPrivateKey): SigningPrivateKey

  Creates a new MLDSA signing private key from an MLDSAPrivateKey.

  Parameters

  • key: MLDSAPrivateKey

    The MLDSA private key to use

  Returns SigningPrivateKey

  A new MLDSA signing private key

Staticrandom

• random(): SigningPrivateKey

  Creates a new random Ed25519 signing private key.

  Returns SigningPrivateKey

  A new random Ed25519 signing private key

StaticrandomSchnorr

• randomSchnorr(): SigningPrivateKey

  Creates a new random Schnorr signing private key.

  Returns SigningPrivateKey

  A new random Schnorr signing private key

StaticrandomEcdsa

• randomEcdsa(): SigningPrivateKey

  Creates a new random ECDSA signing private key.

  Returns SigningPrivateKey

  A new random ECDSA signing private key

StaticrandomSr25519

• randomSr25519(): SigningPrivateKey

  Creates a new random SR25519 signing private key.

  Returns SigningPrivateKey

  A new random SR25519 signing private key

scheme

• scheme(): SignatureScheme

  Returns the signature scheme of this key.

  Returns SignatureScheme

keyType

• keyType(): string

  Returns a human-readable string identifying the key type.

  Returns string

  A string like "Ed25519", "Schnorr", "ECDSA", "Sr25519", "MLDSA-44", etc.

toEc

• toEc(): ECPrivateKey | null

  Returns the underlying EC private key if this is a Schnorr or ECDSA key.

  Returns ECPrivateKey | null

  The EC private key if this is a Schnorr or ECDSA key, null otherwise

toEd25519

• toEd25519(): Ed25519PrivateKey | null

  Returns the underlying Ed25519 private key if this is an Ed25519 key.

  Returns Ed25519PrivateKey | null

  The Ed25519 private key if this is an Ed25519 key, null otherwise

toSr25519

• toSr25519(): Sr25519PrivateKey | null

  Returns the underlying Sr25519 private key if this is an Sr25519 key.

  Returns Sr25519PrivateKey | null

  The Sr25519 private key if this is an Sr25519 key, null otherwise

toMldsa

• toMldsa(): MLDSAPrivateKey | null

  Returns the underlying MLDSA private key if this is an MLDSA key.

  Returns MLDSAPrivateKey | null

  The MLDSA private key if this is an MLDSA key, null otherwise

isSchnorr

• isSchnorr(): boolean

  Checks if this is a Schnorr signing key.

  Returns boolean

isEcdsa

• isEcdsa(): boolean

  Checks if this is an ECDSA signing key.

  Returns boolean

isEd25519

• isEd25519(): boolean

  Checks if this is an Ed25519 signing key.

  Returns boolean

isSr25519

• isSr25519(): boolean

  Checks if this is an Sr25519 signing key.

  Returns boolean

isMldsa

• isMldsa(): boolean

  Checks if this is an MLDSA signing key.

  Returns boolean

publicKey

• publicKey(): SigningPublicKey

  Derives the corresponding public key for this private key.

  Returns SigningPublicKey

  The public key corresponding to this private key

equals

• equals(other: SigningPrivateKey): boolean

  Compare with another SigningPrivateKey.

  Parameters

  • other: SigningPrivateKey

  Returns boolean

toString

• toString(): string

  Get string representation.

  Returns string

reference

• reference(): Reference

  Returns a unique reference to this SigningPrivateKey instance.

  The reference is derived from the SHA-256 hash of the tagged CBOR representation, providing a unique, content-addressable identifier.

  Returns Reference

signWithOptions

• signWithOptions(message: Uint8Array, options?: SigningOptions): Signature

  Signs a message with optional signing options.

  Different signature schemes may use the options differently:

  • Schnorr: Can accept a custom random number generator via SigningOptions.Schnorr
  • SSH: Would require namespace and hash algorithm (not yet implemented)
  • Other schemes (ECDSA, Ed25519, Sr25519, MLDSA): Options are ignored

  Parameters

  • message: Uint8Array

    The message to sign

  • Optionaloptions: SigningOptions

    Optional signing options

  Returns Signature

  The digital signature

sign

• sign(message: Uint8Array): Signature

  Signs a message using default options.

  This is a convenience method that calls signWithOptions with no options.

  Parameters

  • message: Uint8Array

    The message to sign

  Returns Signature

  The digital signature

verify

• verify(signature: Signature, message: Uint8Array): boolean

  Verifies a signature against a message.

  Parameters

  • signature: Signature

    The signature to verify

  • message: Uint8Array

    The message that was allegedly signed

  Returns boolean

  true if the signature is valid, false otherwise

cborTags

• cborTags(): Tag[]

  Returns the CBOR tags associated with SigningPrivateKey.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

  Returns the untagged CBOR encoding.

  Format (matching Rust bc-components):

  • Schnorr: h'<32-byte-private-key>' (bare byte string)
  • ECDSA: [1, h'<32-byte-private-key>']
  • Ed25519: [2, h'<32-byte-private-key>']
  • Sr25519: [3, h'<32-byte-seed>']
  • MLDSA: delegates to MLDSAPrivateKey (tagged)

  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): SigningPrivateKey

  Creates a SigningPrivateKey by decoding it from untagged CBOR.

  Format (matching Rust bc-components):

  • h'<32-byte-key>' (bare byte string) for Schnorr
  • [1, h'<32-byte-key>'] for ECDSA
  • [2, h'<32-byte-key>'] for Ed25519
  • [3, h'<32-byte-seed>'] for Sr25519
  • tagged MLDSA private key for MLDSA variants

  Parameters

  • cborValue: Cbor

  Returns SigningPrivateKey

fromTaggedCbor

• fromTaggedCbor(cborValue: Cbor): SigningPrivateKey

  Creates a SigningPrivateKey by decoding it from tagged CBOR.

  Parameters

  • cborValue: Cbor

  Returns SigningPrivateKey

StaticfromTaggedCbor

• fromTaggedCbor(cborValue: Cbor): SigningPrivateKey

  Static method to decode from tagged CBOR.

  Parameters

  • cborValue: Cbor

  Returns SigningPrivateKey

StaticfromTaggedCborData

• fromTaggedCborData(data: Uint8Array): SigningPrivateKey

  Static method to decode from tagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns SigningPrivateKey

StaticfromUntaggedCborData

• fromUntaggedCborData(data: Uint8Array): SigningPrivateKey

  Static method to decode from untagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns SigningPrivateKey

ur

• ur(): UR

  Returns the UR representation of the signing private key.

  Returns UR

urString

• urString(): string

  Returns the UR string representation of the signing private key.

  Returns string

StaticfromUR

• fromUR(ur: UR): SigningPrivateKey

  Creates a SigningPrivateKey from a UR.

  Parameters

  • ur: UR

  Returns SigningPrivateKey

StaticfromURString

• fromURString(urString: string): SigningPrivateKey

  Creates a SigningPrivateKey from a UR string.

  Parameters

  • urString: string

  Returns SigningPrivateKey

StaticfromUrString

• fromUrString(urString: string): SigningPrivateKey

  Alias for fromURString for Rust API compatibility.

  Parameters

  • urString: string

  Returns SigningPrivateKey

toSsh

• toSsh(comment?: string): string

  Converts the private key to OpenSSH format. Currently only supports Ed25519 keys.

  Parameters

  • Optionalcomment: string

  Returns string