@useragent-kit/sdk
v0.1.1
Published
UserAgentKit TypeScript SDK for building browser Triangle User Agents with wallet, ProductView, and runtime helpers
Downloads
1,834
Maintainers
Readme
@polkadot-apps/host-sdk
UserAgentKit's TypeScript SDK for building browser Triangle User Agents.
Use this package when you are building the trusted browser shell that owns:
- wallet state
ProductViewmounting- chain/runtime wiring
window.host.__bridgepolicy and capabilities
If you are building the product that runs inside that shell, use @polkadot-apps/product-sdk instead.
Install
npm install @polkadot-apps/host-sdkAll WASM peer dependencies are optional and loaded at runtime:
@useragent-kit/host-wasm— core wallet/chain bindings@useragent-kit/host-coinage-wasm— Coinage vault/path/value helpers@useragent-kit/host-extensions-wasm— Data, Files, Media, WebRTC@useragent-kit/chat-wasm— Chat protocol
Minimal example
import { createHostSdk } from "@polkadot-apps/host-sdk";
const sdk = await createHostSdk();
sdk.wallet.loadMnemonic(
"abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about",
);
console.log("wallet state", sdk.wallet.state());
console.log("root address", sdk.wallet.rootAddress());Main entry points
createHostSdk()for wallet, runtime, and WASM setupmountProductView()for sandboxed product embeddingHostRuntime/HostRuntimeRegistryfor shared runtime ownershipmountHostRuntimeFrame()for runtime-in-a-frame web hosts
Compatibility
- Node.js 18+
- ESM package
- all WASM peer dependencies are optional (
@useragent-kit/host-wasm,@useragent-kit/host-extensions-wasm,@useragent-kit/chat-wasm)
Documentation
- Quickstart: https://github.com/paritytech/useragent-kit/blob/main/site/src/content/docs/getting-started/index.md
- Web integration: https://github.com/paritytech/useragent-kit/blob/main/site/src/content/docs/getting-started/web.md
- Browser host guide: https://github.com/paritytech/useragent-kit/blob/main/site/src/content/docs/getting-started/web-host.md
Experimental surface
This package also includes an experimental subpath for APIs that are still settling. Treat those exports as unstable and pin versions tightly if you adopt them.
