mirror of
https://github.com/pezkuwichain/pezkuwi-api.git
synced 2026-04-22 02:08:01 +00:00
71 lines
1.7 KiB
Markdown
71 lines
1.7 KiB
Markdown
# @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](https://js.pezkuwichain.app/docs/api/).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# Using npm
|
|
npm install @pezkuwi/api
|
|
|
|
# Using yarn
|
|
yarn add @pezkuwi/api
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```javascript
|
|
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](https://js.pezkuwichain.app/docs/api/examples/promise/) 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](CHANGELOG.md) 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
|