Collection of SDKs for developing Polkadot applications

Note

This implementation is suitable for Web3 Summit demonstration purposes, but is not yet production ready. Features, APIs, and architecture may still change significantly as the project evolves.

Specification

• Host API protocol — source of truth for the host ↔ product integration protocol.

Packages

For Product developers

• host-api-wrapper — Host API wrapper for integrating and running a product inside the Polkadot browser host.
• product-react-renderer — Custom React reconciler for rendering native UI widgets from product scripts.
• product-bulletin — Bulletin Chain client adapter for product applications, wrapping @parity/bulletin-sdk.

For Host developers

• host-api — Transport implementation for host ↔ product integration.
• host-container — Host-side container for hosting and managing products within the Polkadot ecosystem.
• host-papp — Polkadot app integration layer for the host.
• host-papp-react-ui — React UI flow for the Polkadot app integration.
• host-chat — Account lookup and chat-message codecs for host applications integrating with the Polkadot People chain.
• host-worker-sandbox — QuickJS-based sandbox for running product worker code in an isolated VM.
• host-substrate-chain-connection — Ref-counted polkadot-api connection pool with shared WebSocket/light-client lifecycle.

Shared libraries

• handoff-service — HOP (Handoff Pool) P2P file transfer service with end-to-end encryption over the Bulletin chain.
• statement-store — Encrypted, signed request/response messaging sessions over a Polkadot statement store.
• storage-adapter — Pluggable key/value storage adapters (in-memory, localStorage) with typed field views.
• scale — Additional SCALE codecs built on top of scale-ts.
• substrate-slot-sr25519-wasm — sr25519 WASM for slot-account secrets, matching the Android/iOS Substrate SDK SlotAccountKey.

Changelog

See CHANGELOG.md for release history.

Migration guides

• v0.7 → v0.8
• v0.6 → v0.7

Contribution

See CONTRIBUTING.md for more information.

Security

These packages are reference SDKs, not a hardened, production-ready release. If you build on them, you are responsible for:

• Reviewing the code yourself before relying on it; we publish a reference, not an audited library
• Pinning versions and keeping dependencies up to date and free of known vulnerabilities
• Securing the application you build with these SDKs
• Tracking the latest tagged releases for security fixes; older releases are not backported (exceptions might apply)

For Parity's security disclosure process and Bug Bounty program, see https://parity.io/bug-bounty.