Skip to Content
Getting StartedInstallation

Installation

Umbrella package

Install the unified entry point:

pnpm add @parity/product-sdk

This re-exports every module and provides createApp(). For most applications, this is all you need.

Individual packages

Install only what you use:

pnpm add @parity/product-sdk-chain-client @parity/product-sdk-tx
PackageRole
@parity/product-sdk-chain-clientMulti-chain PAPI client
@parity/product-sdk-txTransaction submission and batching
@parity/product-sdk-signerMulti-provider signer manager
@parity/product-sdk-contractsTyped Asset Hub contract calls
@parity/product-sdk-cloud-storageCloud Storage upload and retrieval
@parity/product-sdk-statement-storeStatement Store publish/subscribe
@parity/product-sdk-keysHierarchical key derivation
@parity/product-sdk-local-storageKey-value storage abstraction
@parity/product-sdk-hostContainer detection and host APIs
@parity/product-sdk-addressSS58/H160 encoding and conversion
@parity/product-sdk-cryptoCryptographic primitives
@parity/product-sdk-descriptorsPAPI chain descriptors
@parity/product-sdk-loggerStructured logging
@parity/product-sdk-utilsEncoding and balance formatting

Requirements

  • Node.js ≥ 20
  • Module format: ESM only. The SDK does not ship CommonJS builds.
  • TypeScript ≥ 5.0 if consuming types (strict mode supported)
  • Runtime host: the umbrella @parity/product-sdk requires a compatible host (Polkadot Desktop, Polkadot Mobile, or a web host like dot.li ). For local development, @parity/host-api-test-sdk embeds a test host in your dev server.

Next step

Continue to the Quickstart.

Last updated on