Installation

rpckit is distributed as multiple packages. Install only what you need.

Quick Start

For most applications using WebSocket:

The core package provides shared types and utilities. It's automatically installed as a dependency of all transport packages.

npm i @rpckit/core

Exports:

parse() - Create transports from URL strings
createParse() - Factory for custom parse functions with overridden package maps
BatchScheduler - Request batching utility
withRetry() - Exponential backoff retry wrapper
TypeScript types and interfaces

Electrum Cash types and a pre-configured parse are available via @rpckit/core/electrum-cash.

WebSocket transport with subscriptions, reconnection, and keep-alive.

npm i @rpckit/websocket

Works in browsers and Node.js.

TCP transport with TLS support. Node.js only.

npm i @rpckit/tcp

Stateless HTTP transport. Works in browsers and Node.js.

npm i @rpckit/http

Meta-transport for failover across multiple transports.

npm i @rpckit/fallback

Meta-transport for m-of-n quorum consensus.

npm i @rpckit/cluster

To install all packages:

npm i @rpckit/core @rpckit/websocket @rpckit/tcp @rpckit/http @rpckit/fallback @rpckit/cluster