@zuhaibnoor/zigchain-sdk 1.0.2 → 1.1.0

package/docs/interchain-accounts.md

@@ -0,0 +1,120 @@
+# Interchain Accounts (ICA) Module
+
+The **Interchain Accounts (ICA) module** allows one blockchain to control an account on another blockchain through IBC.
+
+It enables:
+
+* Remote account creation
+* Cross-chain transaction execution
+* Programmatic interaction between chains
+
+This module has two parts:
+
+* **Controller** → The chain initiating control
+* **Host** → The chain hosting the remote account
+
+---
+
+# Setup
+
+```ts
+import {
+  ChainInterchainAccountsApi,
+  getNetworkEndpoints,
+  Network,
+} from '@zuhaibnoor/zigchain-sdk'
+
+const endpoints = getNetworkEndpoints(Network.Testnet)
+const icaApi = new ChainInterchainAccountsApi(endpoints)
+```
+
+---
+
+## `fetchControllerParams()`
+
+```ts
+fetchControllerParams()
+```
+
+### What it does
+
+Fetches the **current parameters** of the ICA Controller submodule.
+
+The controller is responsible for:
+
+* Creating interchain accounts
+* Sending transactions to remote chains
+* Managing cross-chain account control
+
+---
+
+### CLI Equivalent
+
+```bash
+zigchaind query interchain-accounts controller params
+```
+
+---
+
+### Example
+
+```ts
+const controllerParams = await icaApi.fetchControllerParams()
+console.dir(controllerParams, { depth: null })
+```
+
+---
+
+## `fetchHostParams()`
+
+```ts
+fetchHostParams()
+```
+
+### What it does
+
+Fetches the **current parameters** of the ICA Host submodule.
+
+The host is responsible for:
+
+* Receiving interchain account requests
+* Executing transactions on behalf of remote controllers
+* Managing allowed message types
+
+---
+
+### CLI Equivalent
+
+```bash
+zigchaind query interchain-accounts host params
+```
+
+---
+
+### Example
+
+```ts
+const hostParams = await icaApi.fetchHostParams()
+console.dir(hostParams, { depth: null })
+```
+
+---
+
+# Interchain Accounts
+
+Interchain Accounts allow one chain to control an account on another chain.
+
+Example:
+
+* ZigChain (Controller)
+* Another IBC chain (Host)
+
+ZigChain can:
+
+* Create an account on the host chain
+* Send transactions to be executed there
+* Manage funds remotely
+
+This makes advanced cross-chain applications possible.
+
+---

package/docs/mint.md

@@ -0,0 +1,133 @@
+# Mint Module
+
+The **ChainMintApi** lets you query minting-related data.
+It is used to fetch **inflation**, **annual token provisions**, and **mint module parameters**.
+
+---
+
+## Setup
+
+```ts
+import {
+  ChainMintApi,
+  getNetworkEndpoints,
+  Network,
+} from '@zuhaibnoor/zigchain-sdk'
+
+cosnt endpoints = getNetworkEndpoints(Network.Testnet)
+const mintApi = new ChainMintApi(endpoints)
+```
+
+---
+
+## `fetchInflation`
+
+Fetch the **current inflation rate** of the chain.
+
+**CLI equivalent**
+
+```bash
+zigchaind query mint inflation
+```
+
+**Method**
+
+```ts
+fetchInflation()
+```
+
+**Example**
+
+```ts
+const inflation = await mintApi.fetchInflation()
+console.log(inflation)
+```
+
+---
+
+## `fetchAnnualProvisions`
+
+Fetch the **annual provisions**, i.e. the total number of tokens minted per year.
+
+**CLI equivalent**
+
+```bash
+zigchaind query mint annual-provisions
+```
+
+**Method**
+
+```ts
+fetchAnnualProvisions()
+```
+
+**Example**
+
+```ts
+const annualProvisions = await mintApi.fetchAnnualProvisions()
+console.log(annualProvisions)
+```
+
+---
+
+## `fetchParams`
+
+Fetch the **mint module parameters**.
+
+**CLI equivalent**
+
+```bash
+zigchaind query mint params
+```
+
+**Method**
+
+```ts
+fetchParams()
+```
+
+**Example**
+
+```ts
+const params = await mintApi.fetchParams()
+console.dir(params, { depth: null })
+```
+
+---
+
+## Example (Full)
+
+```ts
+import {
+  ChainMintApi,
+  getNetworkEndpoints,
+  Network
+} from '@zuhaibnoor/zigchain-sdk'
+
+async function main() {
+  const endpoints = getNetworkEndpoints(Network.Testnet)
+  const mintApi = new ChainMintApi(endpoints)
+
+  const inflation = await mintApi.fetchInflation()
+  console.log('Inflation:', inflation)
+
+  const annualProvisions = await mintApi.fetchAnnualProvisions()
+  console.log('Annual Provisions:', annualProvisions)
+
+  const params = await mintApi.fetchParams()
+  console.log('Mint Params:')
+  console.dir(params, { depth: null })
+}
+
+main()
+```
+
+---
+
+## Notes
+
+* Mint queries are **read-only** and require no wallet.
+* Inflation and provisions are returned as **string values** for precision.
+* All mint endpoints are queried via **LCD**.
+
+

package/docs/runtime.md

@@ -0,0 +1,81 @@
+# Runtime Module
+
+## Overview
+
+The **Runtime module** provides information about the **running ZigChain application itself**, not about accounts, balances, validators, or governance.
+
+It allows you to:
+
+* Inspect how the chain is configured
+* Discover what services and APIs the chain exposes
+* Read AutoCLI command definitions generated by the chain
+
+⚠️ **Important**
+This module is **read-only and informational**.
+It does **not** change chain state and does **not** require any address or permissions.
+
+---
+
+## When should you use the Runtime module?
+
+Use this module when you want to:
+
+* Build developer tools, explorers, or SDKs
+* Inspect chain configuration values
+* Discover available gRPC services
+* Understand how CLI commands are generated internally
+
+---
+
+## Initialization
+
+```ts
+import {
+  ChainRuntimeApi,
+  getNetworkEndpoints,
+  Network
+} from '@zuhaibnoor/zigchain-sdk'
+
+const endpoints = getNetworkEndpoints(Network.Testnet)
+const runtime = new ChainRuntimeApi(endpoints)
+```
+
+---
+
+## `fetchConfig()`
+
+### Purpose
+
+Fetches the **current runtime configuration** of the ZigChain node.
+
+This includes application-level configuration such as:
+
+* API settings
+* gRPC settings
+* pruning options
+* minimum gas prices
+* other node runtime parameters
+
+### Usage Example
+
+```ts
+const config = await runtime.fetchConfig()
+console.dir(config, { depth: null })
+```
+
+### When to use
+
+* Debug node behavior
+* Verify network configuration
+* Inspect gas, API, or service settings
+
+---
+
+
+## Summary Table
+
+| Function                    | CLI Command                          | Description                                                    |
+| --------------------------- | ------------------------------------ | -------------------------------------------------------------- |
+| `fetchConfig()`             | `zigchaind query runtime config`     | Fetches the current node and application runtime configuration |
+
+

package/docs/slashing.md

@@ -0,0 +1,139 @@
+# Slashing Module
+
+The **ChainSlashingApi** lets you query slashing-related data.
+It is used to fetch **slashing parameters** and **validator signing information**, which helps track validator uptime and potential slashing conditions.
+
+---
+
+## Setup
+
+```ts
+import {
+  ChainSlashingApi,
+  getNetworkEndpoints,
+  Network,
+} from '@zuhaibnoor/zigchain-sdk'
+
+const endpoints = getNetworkEndpoints(Network.Testnet)
+const slashingApi = new ChainSlashingApi(endpoints)
+```
+
+---
+
+## `fetchParams`
+
+Fetch the **slashing module parameters**.
+
+**CLI equivalent**
+
+```bash
+zigchaind query slashing params
+```
+
+**Method**
+
+```ts
+fetchParams()
+```
+
+**Example**
+
+```ts
+const params = await slashingApi.fetchParams()
+console.dir(params, { depth: null })
+```
+
+---
+
+## `fetchSigningInfos`
+
+Fetch **signing information for all validators**.
+This includes missed blocks, start height, and jail status.
+
+**CLI equivalent**
+
+```bash
+zigchaind query slashing signing-infos
+```
+
+**Method**
+
+```ts
+fetchSigningInfos()
+```
+
+**Example**
+
+```ts
+const infos = await slashingApi.fetchSigningInfos()
+console.log(infos)
+```
+
+---
+
+## `fetchSigningInfo`
+
+Fetch **signing information for a specific validator** using its **consensus address**.
+
+**CLI equivalent**
+
+```bash
+zigchaind query slashing signing-info <valcons-address>
+```
+
+**Method**
+
+```ts
+fetchSigningInfo(valConsAddress: string)
+```
+
+**Example**
+
+```ts
+const signingInfo = await slashingApi.fetchSigningInfo(
+  'zigvalcons1qd9g9rwjmgs7k02w65t2hlekc39vnqsq0ajs47'
+)
+
+console.dir(signingInfo, { depth: null })
+```
+
+---
+
+## Example (Full)
+
+```ts
+import {
+  ChainSlashingApi,
+  getNetworkEndpoints,
+  Network
+} from '@zuhaibnoor/zigchain-sdk'
+
+async function main() {
+  const endpoints = getNetworkEndpoints(Network.Testnet)
+  const slashingApi = new ChainSlashingApi(endpoints)
+
+  console.log('--- Slashing Params ---')
+  const params = await slashingApi.fetchParams()
+  console.dir(params, { depth: null })
+
+  console.log('\n--- All Signing Infos ---')
+  const infos = await slashingApi.fetchSigningInfos()
+  console.log(infos)
+
+  console.log('\n--- Single Signing Info ---')
+  const singleInfo = await slashingApi.fetchSigningInfo(
+    'zigvalcons1qd9g9rwjmgs7k02w65t2hlekc39vnqsq0ajs47'
+  )
+  console.dir(singleInfo, { depth: null })
+}
+
+main()
+```
+
+---
+
+## Notes
+
+* Slashing queries are **read-only** and require no wallet.
+* All slashing queries are performed via **LCD endpoints**.
+