Packages
Introduction
Section titled “Introduction”A Product developer rarely calls TrUAPI directly. The @parity/product-sdk family of packages is the typed wrapper, and most Products will install one of them per capability they consume. This page maps which package wraps which TrUAPI method group, and which Product-side how-to guide demonstrates each.
Package Map
Section titled “Package Map”| TrUAPI Method Group | SDK Package | Product-Side How-To |
|---|---|---|
| TrUAPI Calls | @parity/product-sdk (core) | N/A (lifecycle, implicit) |
| Permissions | @parity/product-sdk (core) | N/A |
| Local Storage | @parity/product-sdk-local-storage | Persist Data Locally |
| Account Management | @parity/product-sdk-signer / @parity/product-sdk-address | Sign and Submit Transactions |
| Signing | @parity/product-sdk-signer / @parity/product-sdk-tx | Sign and Submit Transactions |
| Chat | @parity/product-sdk chat APIs | N/A |
| Statement Store | @parity/product-sdk-statement-store | Publish and Subscribe to Off-Chain Data |
| Preimage | @parity/product-sdk-host (Preimage manager) | (covered in Bulletin Chain how-to) |
| Chain Interaction | @parity/product-sdk-chain-client and polkadot-api (PAPI) | Read Chain State |
| Payment | @parity/product-sdk-tx and @parity/product-sdk-utils | N/A |
| Entropy | @parity/product-sdk (deterministic entropy derivation) | n/a (forthcoming) |
The Boundary Between Product Code and Host Code
Section titled “The Boundary Between Product Code and Host Code”A useful way to read the package map is by where the package executes:
- Pure Product packages: Packages such as
@parity/product-sdk-local-storage,@parity/product-sdk-signer,@parity/product-sdk-chain-client, and@parity/product-sdk-txexecute inside the Product sandbox. They are typed wrappers that build a TrUAPI call and dispatch it through the Host API. Your Product depends on them at compile time. - Product-SDK umbrella:
@parity/product-sdkties them together at the top of a Product and wires up the App / chain / storage surfaces with consistent defaults. - Host implementations of TrUAPI: Host implementations live in the Hosts themselves, not in any Product-side package. A Product does not depend on Host code at compile time; it depends on the Host honoring the TrUAPI contract at run time.
Where to Go Next
Section titled “Where to Go Next”-
Versioning
How package versions map to TrUAPI protocol versions.