PrivateKey overview

Table of contents

• arbitrary
  • arbitrary
• bip32
  • derive
• bip39
  • fromMnemonic
  • generateMnemonic
  • validateMnemonic
• cardano
  • CardanoPath
• cryptography
  • sign
  • toPublicKey
• effect
  • Either (namespace)
• encoding
  • toBech32
  • toBytes
  • toHex
• errors
  • PrivateKeyError (class)
    • _tag (property)
• generators
  • generate
  • generateExtended
• parsing
  • fromBech32
  • fromBytes
  • fromHex
• schemas
  • PrivateKey (class)
    • toJSON (method)
    • toString (method)
    • [Inspectable.NodeInspectSymbol] (method)
    • [Equal.symbol] (method)
    • [Hash.symbol] (method)
• utils
  • FromBech32
  • FromBytes
  • FromHex

arbitrary

arbitrary

FastCheck arbitrary for generating random PrivateKey instances. Generates 32-byte private keys.

Signature

export declare const arbitrary: FastCheck.Arbitrary<PrivateKey>

Added in v2.0.0

bip32

derive

Derive a child private key using BIP32 path (sync version that throws PrivateKeyError). All errors are normalized to PrivateKeyError with contextual information.

Signature

export declare const derive: (privateKey: PrivateKey, path: string) => PrivateKey

Added in v2.0.0

bip39

fromMnemonic

Create a PrivateKey from a mnemonic phrase (sync version that throws PrivateKeyError). All errors are normalized to PrivateKeyError with contextual information.

Signature

export declare const fromMnemonic: (mnemonic: string, password?: string) => PrivateKey

Added in v2.0.0

generateMnemonic

Generate a new mnemonic phrase using BIP39.

Signature

export declare const generateMnemonic: (strength?: 128 | 160 | 192 | 224 | 256) => string

Added in v2.0.0

validateMnemonic

Validate a mnemonic phrase using BIP39.

Signature

export declare const validateMnemonic: (mnemonic: string) => boolean

Added in v2.0.0

cardano

CardanoPath

Cardano BIP44 derivation path utilities.

Signature

export declare const CardanoPath: {
  create: (account?: number, role?: 0 | 2, index?: number) => string
  payment: (account?: number, index?: number) => string
  stake: (account?: number, index?: number) => string
}

Added in v2.0.0

cryptography

sign

Sign a message using Ed25519 (sync version that throws PrivateKeyError). All errors are normalized to PrivateKeyError with contextual information. For extended keys (64 bytes), uses CML-compatible Ed25519-BIP32 signing. For normal keys (32 bytes), uses standard Ed25519 signing.

Signature

export declare const sign: (privateKey: PrivateKey, message: Uint8Array) => Ed25519Signature.Ed25519Signature

Added in v2.0.0

toPublicKey

Derive the public key (VKey) from a private key. Compatible with CML privateKey.to_public().

Signature

export declare const toPublicKey: (privateKey: PrivateKey) => VKey.VKey

Added in v2.0.0

effect

Either (namespace)

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

Added in v2.0.0

encoding

toBech32

Convert a PrivateKey to a Bech32 string. Automatically selects the appropriate prefix based on key length:

• 32 bytes → ed25519_sk1... (normal key)
• 64 bytes → ed25519e_sk1... (extended key) Compatible with CML.PrivateKey.to_bech32().

Signature

export declare const toBech32: (a: PrivateKey, overrideOptions?: ParseOptions) => string

Added in v2.0.0

toBytes

Convert a PrivateKey to raw bytes.

Signature

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

Added in v2.0.0

toHex

Convert a PrivateKey to a hex string.

Signature

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

Added in v2.0.0

errors

PrivateKeyError (class)

Error class for PrivateKey operations

Signature

export declare class PrivateKeyError {
  constructor(message: string)
}

Added in v2.0.0

_tag (property)

Signature

readonly _tag: "PrivateKeyError"

generators

generate

Generate a random 32-byte Ed25519 private key. Compatible with CML.PrivateKey.generate_ed25519().

Signature

export declare const generate: () => Uint8Array

Added in v2.0.0

generateExtended

Generate a random 64-byte extended Ed25519 private key. Compatible with CML.PrivateKey.generate_ed25519extended().

Signature

export declare const generateExtended: () => Uint8Array

Added in v2.0.0

parsing

fromBech32

Parse a PrivateKey from a Bech32 string. Supports both extended (ed25519e_sk1...) and normal (ed25519_sk1...) formats. Compatible with CML.PrivateKey.from_bech32().

Signature

export declare const fromBech32: (i: string, overrideOptions?: ParseOptions) => PrivateKey

Added in v2.0.0

fromBytes

Parse a PrivateKey from raw bytes. Supports both 32-byte and 64-byte private keys.

Signature

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

Added in v2.0.0

fromHex

Parse a PrivateKey from a hex string. Supports both 32-byte (64 chars) and 64-byte (128 chars) hex strings.

Signature

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

Added in v2.0.0

schemas

PrivateKey (class)

Schema for PrivateKey representing an Ed25519 private key. Supports both standard 32-byte and CIP-0003 extended 64-byte formats. Follows the Conway-era CDDL specification with CIP-0003 compatibility.

Signature

export declare class PrivateKey

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

utils

FromBech32

Signature

export declare const FromBech32: Schema.transformOrFail<
  typeof Schema.String,
  Schema.SchemaClass<PrivateKey, PrivateKey, never>,
  never
>

FromBytes

Signature

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

FromHex

Signature

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