mirror of
https://github.com/pezkuwichain/pezkuwi-api.git
synced 2026-10-26 05:15:04 +00:00
Satoshi Qazi Muhammed
c228f3b56c
- every matrix step (lint, test, build) must pass; nothing is allowed to fail silently - after build, scripts/check-built-manifests.py checks the package.json each build/ directory holds, which is what npm receives: entry points must exist, no ./build/ or ./cjs/cjs/ paths, no string spread into exports, no workspace:/link: ranges - the tree must be unchanged after the step: `yarn lint` runs eslint --fix and `yarn build` regenerates the augment interfaces, so both used to pass on a tree they had rewritten - the dot-notation exclusion had been renamed from kusama to zagros (no such directory) instead of dicle; with the dicle augmentation in the lint program, eslint --fix rewrote api.query['registrar'] style accesses that the build cannot compile - the four compiled-only packages (bizinikiwi-bindings, merkleize-metadata, metadata-builders, papi-utils) have no sources here and are not linted - the auto-approve and auto-merge bots are removed - .prettierrc.cjs uses @pezkuwi/dev
@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