SDK operation map

Choose an SDK to see its real function names, input types, output types, and the corresponding API reference. The operation model stays shared; the contract stays honest.

Create & export

Operation	Function	Input	Output	Purpose
Export private key	exportPrivateKey	input: PrivateKeyExportInput	Promise<string>	Encrypt a private key with a password and create a complete document.
Export encrypted state	exportEncryptedState	input: EncryptedStateInput	string	Serialize encrypted state without decrypting the private key.

Read & validate

Operation	Function	Input	Output	Purpose
Parse document	parseDocument	input: string | Uint8Array	Document	Read JSON text or bytes and validate the resulting document.
Validate document	validateDocument	value: unknown	Document	Validate an in-memory value and return the normalized document.
Serialize document	serializeDocument	document: Document	string	Write a validated document as canonical JSON.

Unlock

Operation	Function	Input	Output	Purpose
Unlock document	unlockDocument	document: Document, password: string	Promise<UnlockResult>	Decrypt the private key and verify that it matches the document public key.

Inspect

Operation	Function	Input	Output	Purpose
Read summary	summary	document: Document	DocumentSummary	Read format, version, label, and public-key metadata without secrets.

Failure handling

Operation	Function	Input	Output	Purpose
Handle errors	isKeyHoldError	value: unknown	value	Handle predictable failures through stable error codes.

Compare SDKs

Keep the same capability model while showing each language’s real contract.

Operation	TypeScript	Go
Export private key	exportPrivateKey Promise<string>	ExportPrivateKey ([]byte, error)
Export encrypted state	exportEncryptedState string	ExportEncryptedState ([]byte, error)
Parse document	parseDocument Document	Parse (Document, error)
Validate document	validateDocument Document	Validate error
Serialize document	serializeDocument string	Serialize ([]byte, error)
Unlock document	unlockDocument Promise<UnlockResult>	Unlock (*UnlockResult, error)
Read summary	summary DocumentSummary	Summary (DocumentSummary, error)
Handle errors	isKeyHoldError value	ErrorCodeOf ErrorCode