mirror of
https://github.com/pezkuwichain/pezkuwi-api.git
synced 2026-10-20 18:56:29 +00:00
Satoshi Qazi Muhammed
611d410f28
The packages/*/package.json files were the manifests the build writes into build/, committed back over the source ones: exports maps of thousands of entries pointing at ./cjs/* files, main at ./cjs/index.js, module and types set. pezkuwi-dev-build-ts generates those fields itself; in the source they pointed at files that only existed because build output had been committed too. main, module, types, exports, browser, react-native and sideEffects are back in the source form of the upstream manifests; every other field is unchanged. - @pezkuwi/* common dependencies 14.0.25 -> 14.0.26 (wasm-crypto 7.5.20 underneath, with working ed25519 and secp256k1) - the root resolutions forcing common 14.0.25 and wasm 7.5.4 onto the whole tree are removed; only the typescript pin remains - @pezkuwi/dev, dev-test and dev-ts ^0.85.12 - the deno script is removed - version 16.5.37
@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