Skip to main content

API reference

These pages are generated from the SDK source metadata and are the precise contract for each public declaration.

  • KeyHoldError — Error thrown by public SDK operations.
  • Cipher — A validated KeyHold cipher section.
  • CipherParameters — Explicit parameters for AES-GCM during private-key export.
  • Document — The complete JSON document represented by the SDK.
  • DocumentSummary — Public, non-secret metadata extracted from a document.
  • EncryptedStateInput — Already-encrypted state that can be serialized without decryption.
  • KeyDerivation — A validated KeyHold key-derivation section.
  • KeyDerivationParameters — Explicit parameters for PBKDF2 during private-key export.
  • PrivateKeyExportInput — Plaintext private-key input used to create a new encrypted document.
  • RecommendedParameters — The complete parameter set required by private-key export.
  • UnlockResult — The private key and public key recovered after a successful unlock.
  • ERROR_CODES — Stable error codes exposed by the KeyHold SDK.
  • FORMAT — The KeyHold document format discriminator.
  • parse — Public variable parse.
  • RECOMMENDED_ITERATIONS — The recommended PBKDF2 iteration count for new exports.
  • serialize — Public variable serialize.
  • unlock — Public variable unlock.
  • validate — Public variable validate.
  • VERSION — The supported KeyHold document version.
  • exportEncryptedState — Serialize state that is already encrypted using KeyHold semantics.
  • exportPrivateKey — Encrypt a private key with a password and return a complete JSON document.
  • isKeyHoldError — Return true when a value is a KeyHold SDK error.
  • parseDocument — Parse JSON text or UTF-8 bytes and validate the resulting document.
  • recommendedParameters — Return the SDK’s recommended explicit export parameters.
  • serializeDocument — Serialize a validated document to canonical JSON.
  • summary — Return the non-secret metadata of a validated document.
  • unlockDocument — Decrypt and validate the private key contained in a document.
  • validateDocument — Validate an in-memory value and return the normalized KeyHold document.