Static ReadonlyKEY_SIZE

bytes

• get bytes(): Uint8Array

  A copy of the bytes; mutating it does not touch this value.

  Returns Uint8Array

Staticcodec

• get codec(): ComponentCodec<X25519PrivateKey>

  Tagged-CBOR codec; decode also accepts the untagged form.

  Returns ComponentCodec<X25519PrivateKey>

Staticrandom

• random(__namedParameters?: RngOptions): X25519PrivateKey

  A fresh random value; pass rng to make it deterministic.

  Parameters

  • __namedParameters: RngOptions = {}

  Returns X25519PrivateKey

Statickeypair

• keypair(__namedParameters?: RngOptions): [X25519PrivateKey, X25519PublicKey]

  A fresh private key and its public key.

  Parameters

  • __namedParameters: RngOptions = {}

  Returns [X25519PrivateKey, X25519PublicKey]

StaticderiveFromKeyMaterial

• deriveFromKeyMaterial(keyMaterial: Uint8Array): X25519PrivateKey

  Derive an X25519PrivateKey from the given key material.

  Parameters

  • keyMaterial: Uint8Array

    The key material to derive from

  Returns X25519PrivateKey

  A new X25519PrivateKey derived from the key material

Staticfrom

• from(data: Uint8Array): X25519PrivateKey

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

  Parameters

  • data: Uint8Array

  Returns X25519PrivateKey

StaticfromHex

• fromHex(hex: string): X25519PrivateKey

  Restore an X25519PrivateKey from a hex string.

  Parameters

  • hex: string

  Returns X25519PrivateKey

toHex

• toHex(): string

  Get hex string representation.

  Returns string

toBase64

• toBase64(): string

  Get base64 representation.

  Returns string

publicKey

• publicKey(): X25519PublicKey

  Get the X25519PublicKey corresponding to this X25519PrivateKey.

  Returns X25519PublicKey

sharedKeyWith

• sharedKeyWith(publicKey: X25519PublicKey): SymmetricKey

  Derive a shared symmetric key from this X25519PrivateKey and the given X25519PublicKey.

  Parameters

  • publicKey: X25519PublicKey

    The other party's public key

  Returns SymmetricKey

  A SymmetricKey derived from the shared secret

sharedSecret

• sharedSecret(publicKey: X25519PublicKey): Uint8Array

  Perform ECDH key agreement with a public key (legacy method).

  Parameters

  • publicKey: X25519PublicKey

  Returns Uint8Array

  Deprecated

  Use sharedKeyWith() instead which returns a SymmetricKey

equals

• equals(other: X25519PrivateKey): boolean

  Compare with another X25519PrivateKey.

  Parameters

  • other: X25519PrivateKey

  Returns boolean

reference

• reference(): Reference

  The reference: the digest of the tagged CBOR, as the reference computes it.

  Returns Reference

refHexShort

• refHexShort(): string

  The first four bytes of reference() in hex, the reference's ref_hex_short.

  Returns string

toString

• toString(): string

  The reference's Display: the type name over the short reference.

  Returns string

cborTags

• cborTags(): Tag[]

  The CBOR tags this type decodes from; the first one is used to encode.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

  Returns the untagged CBOR encoding (as a byte string).

  Returns Cbor

toCbor

• toCbor(): Cbor

  The tagged CBOR form.

  Returns Cbor

toUR

• toUR(): UR

  As a UR, typed by the first tag's name.

  Returns UR

StaticfromCbor

• fromCbor(cbor: Cbor): X25519PrivateKey

  Decode tagged or untagged CBOR.

  Parameters

  • cbor: Cbor

  Returns X25519PrivateKey