Files
pezkuwi-api/packages/rpc-provider
Satoshi Qazi Muhammed 7c6cac97da Fix the lint errors
Most are object keys out of order after the rename (dicle, pezkuwi,
bizinikiwi, teyrchains and zagros sort differently from the names they
replaced); they are sorted, behaviour is unchanged. The rest:

- createClass: header.hash is already the BlockHash type; the
  `as any` cast is removed
- ScProvider: WellKnownChain is a string union in @bizinikiwi/connect,
  so `string | WellKnownChain` was `string`; the spec parameter says so
- ScProvider: the jsonRpcResponses loop is a named async function whose
  rejection (chain removed, client terminated) is caught explicitly
  instead of a floating promise
- the fake chain in the spec no longer needs a non-null assertion
- Extrinsic.hash: redundant non-null assertion removed
- metadata-get.mjs writes the 2026 header
2026-10-08 03:23:10 +04:00
..
2026-10-08 03:23:10 +04:00

@pezkuwi/rpc-provider

Generic transport providers to handle the transport of method calls to and from Pezkuwi clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.

Provider Selection

There are three flavours of the providers provided, one allowing for using HTTP as a transport mechanism, the other using WebSockets, and the third one uses bizinikiwi light-client through @bizinikiwi/connect. It is generally recommended to use the WsProvider since in addition to standard calls, it allows for subscriptions where all changes to state can be pushed from the node to the client.

All providers are usable (as is the API), in both browser-based and Node.js environments. Polyfills for unsupported functionality are automatically applied based on feature-detection.

Usage

Installation -

yarn add @pezkuwi/rpc-provider

WebSocket Initialization -

import { WsProvider } from '@pezkuwi/rpc-provider';

// this is the actual default endpoint
const provider = new WsProvider('ws://127.0.0.1:9944');
const version = await provider.send('client_version', []);

console.log('client version', version);

HTTP Initialization -

import { HttpProvider } from '@pezkuwi/rpc-provider';

// this is the actual default endpoint
const provider = new HttpProvider('http://127.0.0.1:9933');
const version = await provider.send('chain_getBlockHash', []);

console.log('latest block Hash', hash);

@bizinikiwi/connect Initialization -

Instantiating a Provider for the Pezkuwi Relay Chain:

import { ScProvider } from '@pezkuwi/rpc-provider';
import * as Sc from '@bizinikiwi/connect';

const provider = new ScProvider(Sc, Sc.WellKnownChain.pezkuwi);

await provider.connect();

const version = await provider.send('chain_getBlockHash', []);

Instantiating a Provider for a Pezkuwi teyrchain:

import { ScProvider } from '@pezkuwi/rpc-provider';
import * as Sc from '@bizinikiwi/connect';

const pezkuwiProvider = new ScProvider(Sc, Sc.WellKnownChain.pezkuwi);
const teyrchainProvider = new ScProvider(Sc, teyrchainSpec, pezkuwiProvider);

await teyrchainProvider.connect();

const version = await teyrchainProvider.send('chain_getBlockHash', []);