Fork 0

mirror of https://github.com/pezkuwichain/pezkuwi-api.git synced 2026-11-14 10:27:06 +00:00

Files

T

SatoshiQaziMuhammed 1914388d2b docs: API reference and getting-started guide for developers.pezkuwichain.io (#21 )

* docs: generate the API reference for developers.pezkuwichain.io

Add TypeDoc (0.28.20) and `yarn docs`, which builds the reference for the
nine public API packages from src/ into build-docs/, with a landing page
and a getting-started guide whose examples were run against the live
network. The PR workflow builds it so a broken doc comment or config is
caught before merge.

docs/ held only a redirect to polkadot.js.org; it now holds the guide
sources. The README, packages/api/README.md and three CHANGELOG entries
linked to js.pezkuwichain.app, a domain that is not ours and is listed
for sale; they now point to developers.pezkuwichain.io, the Pezkuwi
Portal, or the upstream polkadot.js.org pages the entries came from.

* ci(docs): deploy the reference to developers.pezkuwichain.io

On every master push that changes the generated reference, build it with
`yarn docs` and publish it to the web host the same way pezkuwi-apps
publishes the portal: an approved production environment holds the deploy
key, the bundle is unpacked into releases/<sha>, and going live is one
rename of the current symlink. The switch is checked through nginx for the
public name (deploy sha, index, main.js, search index) and rolled back if
the new release is not served. workflow_dispatch with rollback_to makes an
earlier release live again.

Release-bot version bumps ([CI Skip]) and changes that cannot affect the
output do not ask for an approval.

2026-11-12 22:32:28 +04:00

1.7 KiB

Raw Blame History

@pezkuwi/api

Promise and RxJS APIs for interacting with PezkuwiChain and Bizinikiwi-based networks.

Developed by Dijital Kurdistan Tech Institute

Overview

This library provides a clean wrapper around all the methods exposed by a PezkuwiChain/Bizinikiwi network client and defines all the types exposed by a node.

Documentation

The API reference and a getting-started guide are at developers.pezkuwichain.io.

Installation

# Using npm
npm install @pezkuwi/api

# Using yarn
yarn add @pezkuwi/api

Quick Start

import { ApiPromise, WsProvider } from '@pezkuwi/api';

// Connect to a PezkuwiChain node
const wsProvider = new WsProvider('wss://rpc.pezkuwichain.io');
const api = await ApiPromise.create({ provider: wsProvider });

// Query chain info
const chain = await api.rpc.system.chain();
console.log(`Connected to ${chain}`);

Packages

Package	Description
@pezkuwi/api	Main API package
@pezkuwi/api-derive	Derived API methods
@pezkuwi/types	Type definitions
@pezkuwi/rpc-core	RPC core functionality
@pezkuwi/rpc-provider	RPC providers (WS, HTTP)

Tutorials

Looking for a walkthrough? Getting started connects, reads chain state, follows blocks and sends a transfer.

Changelog

If you are an existing user, please track the CHANGELOG when changing versions.

License

Apache-2.0

Author

Dijital Kurdistan Tech Institute

1.7 KiB Raw Blame History