mirror of
https://github.com/pezkuwichain/pezkuwi-api.git
synced 2026-11-14 18:37:06 +00:00
SatoshiQaziMuhammed
1914388d2b
* 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.
47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
# Pezkuwi API
|
|
|
|
`@pezkuwi/api` is the JavaScript and TypeScript library for talking to PezkuwiChain
|
|
and other Bizinikiwi-based networks. Your application loads it and connects
|
|
straight to a node's RPC endpoint: there is no server in between.
|
|
|
|
- New here? Start with [Getting started](getting-started.md).
|
|
- Looking for a class or a method? Use the search box, or browse the packages below.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install @pezkuwi/api
|
|
```
|
|
|
|
## Packages
|
|
|
|
| Package | What it does |
|
|
|---|---|
|
|
| `@pezkuwi/api` | `ApiPromise` and `ApiRx`, the entry points most applications use |
|
|
| `@pezkuwi/api-base` | The base class both APIs share |
|
|
| `@pezkuwi/api-derive` | Derived queries that combine several storage reads into one answer |
|
|
| `@pezkuwi/api-contract` | Deploying and calling ink! smart contracts |
|
|
| `@pezkuwi/rpc-core` | The typed JSON-RPC layer |
|
|
| `@pezkuwi/rpc-provider` | `WsProvider`, `HttpProvider` and the light-client provider |
|
|
| `@pezkuwi/types` | The runtime type registry and every chain type |
|
|
| `@pezkuwi/types-codec` | SCALE codec primitives (`Struct`, `Enum`, `Vec`, `Compact`, …) |
|
|
| `@pezkuwi/types-create` | Building types from their definitions |
|
|
|
|
Keys and signing live in `@pezkuwi/keyring`, and hashing and address helpers in
|
|
`@pezkuwi/util-crypto`. Both come from the
|
|
[pezkuwi-common](https://github.com/pezkuwichain/pezkuwi-common) repository.
|
|
|
|
## Public endpoints
|
|
|
|
| Network | WebSocket RPC |
|
|
|---|---|
|
|
| PezkuwiChain relay | `wss://rpc.pezkuwichain.io` |
|
|
| PezkuwiChain Asset Hub | `wss://asset-hub-rpc.pezkuwichain.io` |
|
|
| Zagros Asset Hub (test network) | `wss://zagros-asset-hub-rpc.pezkuwichain.io` |
|
|
|
|
## Source
|
|
|
|
The code is at [github.com/pezkuwichain/pezkuwi-api](https://github.com/pezkuwichain/pezkuwi-api).
|
|
This reference is generated from it, so what you read here is what the published
|
|
packages contain.
|