mirror of
https://github.com/pezkuwichain/pezkuwi-api.git
synced 2026-10-21 03:06:20 +00:00
Satoshi Qazi Muhammed
b925eca088
Packages had their compiled output checked in next to src/: .js, .d.ts and cjs/ trees at the package root, 251 symlinks into build/, root copies of typegen generate/ and templates/ and of types-support json/, and a LICENSE per package. The build writes all of these into build/ itself; in the source tree they shadowed src/ for anything resolving the package root and drifted from it.
@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
For complete documentation around the interfaces and their use, visit the documentation portal.
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 tutorials? Check out examples for guides on how to use the API to make queries and submit transactions.
Changelog
If you are an existing user, please track the CHANGELOG when changing versions.
Links
- Website: https://pezkuwichain.io
- Documentation: https://docs.pezkuwichain.io
- API Docs: https://js.pezkuwichain.app
- GitHub: https://github.com/pezkuwichain
License
Apache-2.0
Author
Dijital Kurdistan Tech Institute