@dmapp/zdan-sdk-mini
v0.1.6
Published
Browser SDK for zdan wasm auth and signing
Readme
zdan-sdk-mini
浏览器侧认证 SDK,源码位于 src/,基于 wasm 提供身份初始化、签名和认证数据生成能力。
安装
pnpm add zdan-sdk-mini使用
import { getAuthData, init } from 'zdan-sdk-mini'
await init()
const authData = await getAuthData()如果只想预加载 wasm,可以先执行 await initWasm(),再在需要时调用 init()。
如果构建环境无法处理 SDK 内部的 import.meta.url 资源地址,请在首次调用 initWasm()、init() 或其他 wasm 相关方法前配置外部资源地址:
import { configure, init } from 'zdan-sdk-mini'
configure({
wasmUrl: '/assets/zcrypto.wasm',
runtimeUrl: '/assets/zcrypto.js',
})
await init()未调用 configure() 时,SDK 继续使用内置资源地址。
API
init(options?)initWasm()configure(options)getAuthData(options?)getCachedAuthData()getPublicKey()sign(message)verify(message, signature)getNodeIdHex()createIdentity(options?)importIdentityFromQrPrivateKey(qrKey, options?)setStorageKey(key, password?, options?)getStorageKey(options?)clearStorageKey(options?)bytesToBase64(bytes)base64ToBytes(base64)
构建
pnpm install
pnpm build构建产物输出到 dist/,并包含运行时需要的 wasm/ 资源文件。
目录结构
src/
auth.ts
index.ts
wasm/
dist/运行约束
- 仅支持浏览器环境
- 依赖
window、document、fetch、localStorage - 初始化前调用签名相关方法会抛错
