SDK 功能总览

选择一个 SDK，查看它真实的函数名、传入参数、输出参数和对应 API 参考。能力模型共享，调用契约保持真实。

创建与导出

操作	函数	传入参数	输出参数	用途
导出私钥	exportPrivateKey	input: PrivateKeyExportInput	Promise<string>	使用密码加密私钥并创建完整文档。
导出已加密状态	exportEncryptedState	input: EncryptedStateInput	string	序列化已经加密的状态，无需再次解密私钥。

读取与验证

操作	函数	传入参数	输出参数	用途
解析文档	parseDocument	input: string | Uint8Array	Document	读取 JSON 文本或字节并验证所得文档。
验证文档	validateDocument	value: unknown	Document	验证内存中的值并返回规范化文档。
序列化文档	serializeDocument	document: Document	string	将已验证的文档写为规范 JSON。

解锁

操作	函数	传入参数	输出参数	用途
解锁文档	unlockDocument	document: Document, password: string	Promise<UnlockResult>	解密私钥并确认它与文档中的公钥匹配。

检查

操作	函数	传入参数	输出参数	用途
读取摘要	summary	document: Document	DocumentSummary	读取格式、版本、标签和公钥元数据，不暴露秘密。

失败处理

操作	函数	传入参数	输出参数	用途
处理错误	isKeyHoldError	value: unknown	value	通过稳定错误码处理可预期的失败。

对照 SDK

能力模型保持一致，同时诚实呈现各语言的真实契约。

操作	TypeScript	Go
导出私钥	exportPrivateKey Promise<string>	ExportPrivateKey ([]byte, error)
导出已加密状态	exportEncryptedState string	ExportEncryptedState ([]byte, error)
解析文档	parseDocument Document	Parse (Document, error)
验证文档	validateDocument Document	Validate error
序列化文档	serializeDocument string	Serialize ([]byte, error)
解锁文档	unlockDocument Promise<UnlockResult>	Unlock (*UnlockResult, error)
读取摘要	summary DocumentSummary	Summary (DocumentSummary, error)
处理错误	isKeyHoldError value	ErrorCodeOf ErrorCode