@zuhaibnoor/zigchain-sdk 1.0.2 → 1.1.0

package/docs/tokenwrapper.md

@@ -0,0 +1,137 @@
+# Token Wrapper Module
+
+The **Token Wrapper module** keeps track of ZIG tokens that move **out of ZigChain to other blockchains** and come **back again**.
+It helps the chain maintain balance by **locking tokens when they leave** and **unlocking them when they return**, so no extra tokens are ever created.
+
+---
+
+## How Token Wrapping Works (Simple Explanation)
+
+1. You send **ZIG tokens out of ZigChain**
+2. Those ZIG tokens are **locked** on ZigChain
+3. You receive **wrapped ZIG** on another chain
+4. If wrapped ZIG comes back:
+
+   * Wrapped tokens are **destroyed**
+   * Original ZIG tokens are **unlocked**
+
+If wrapped ZIG is **spent on the other chain and never returned**,
+the corresponding ZIG **remains locked forever** on ZigChain.
+
+---
+
+## Setup
+
+```ts
+import {
+  ChainTokenWrapperApi,
+  getNetworkEndpoints,
+  Network
+} from '@zuhaibnoor/zigchain-sdk'
+
+const endpoints = getNetworkEndpoints(Network.Testnet)
+const tokenWrapperApi = new ChainTokenWrapperApi(endpoints)
+```
+
+---
+
+## `fetchModuleInfo`
+
+Returns basic information about the Token Wrapper module.
+
+
+**Method**
+
+```ts
+fetchModuleInfo()
+```
+
+**Example**
+
+```ts
+const info = await tokenWrapperApi.fetchModuleInfo()
+console.log(info)
+```
+
+**Use case**
+
+* Verify that the Token Wrapper module is available and active on the chain
+
+---
+
+## `fetchParams`
+
+Fetches the **configuration parameters** of the Token Wrapper module.
+
+**Method**
+
+```ts
+fetchParams()
+```
+
+**Example**
+
+```ts
+const params = await tokenWrapperApi.fetchParams()
+console.log(params)
+```
+
+**Use case**
+
+* Check whether token wrapping is enabled
+* Inspect module behavior settings
+
+---
+
+## `fetchTotalTransfers`
+
+Returns the **total amount of ZIG tokens**:
+
+* Sent **out of ZigChain**
+* Returned **back to ZigChain**
+
+**Method**
+
+```ts
+fetchTotalTransfers()
+```
+
+**Example**
+
+```ts
+const totals = await tokenWrapperApi.fetchTotalTransfers()
+console.log(totals)
+```
+
+**What this tells you**
+
+* How much ZIG is currently **locked**
+* How much ZIG has **returned**
+* Helps audit cross-chain token movement
+
+---
+
+## Real-World Example
+
+* You send **10 ZIG** out of ZigChain
+* ZigChain **locks 10 ZIG**
+* You receive **10 wrapped ZIG** on another chain
+* You spend **5 wrapped ZIG**
+* You return **5 wrapped ZIG** back
+
+Result:
+
+* **5 ZIG unlocked and returned**
+* **5 ZIG remain locked forever** (because they were spent)
+
+---
+
+## Summary Table
+
+| Function              | Purpose                                         |
+| --------------------- | ----------------------------------------------- |
+| `fetchModuleInfo`     | Shows basic info about the Token Wrapper module |
+| `fetchParams`         | Displays module configuration settings          |
+| `fetchTotalTransfers` | Shows total ZIG moved out and returned          |
+
+

package/docs/upgrade.md

@@ -0,0 +1,133 @@
+# Upgrade Module
+
+The **ChainUpgradeApi** lets you query on-chain upgrade information.
+
+It is used to fetch the **current upgrade plan**, **upgrade authority**, and **module versions**, which helps track scheduled chain upgrades and module migration states.
+
+---
+
+## Setup
+
+```ts
+import {
+  ChainUpgradeApi,
+  getNetworkEndpoints,
+  Network,
+} from '@zuhaibnoor/zigchain-sdk'
+
+const endpoints = getNetworkEndpoints(Network.Testnet)
+const upgradeApi = new ChainUpgradeApi(endpoints)
+```
+
+---
+
+## `fetchCurrentPlan()`
+
+Fetch the **currently scheduled upgrade plan** (if one exists).
+
+**CLI equivalent**
+
+```bash
+zigchaind query upgrade plan
+```
+
+**Method**
+
+```ts
+fetchCurrentPlan()
+```
+
+**Example**
+
+```ts
+const plan = await upgradeApi.fetchCurrentPlan()
+console.dir(plan, { depth: null })
+```
+
+---
+
+## `fetchAuthority()`
+
+Fetch the **upgrade authority address**.
+
+This is typically the governance module account that has permission to schedule upgrades.
+
+**CLI equivalent**
+
+```bash
+zigchaind query upgrade authority
+```
+
+**Method**
+
+```ts
+fetchAuthority()
+```
+
+**Example**
+
+```ts
+const authority = await upgradeApi.fetchAuthority()
+console.log(authority)
+```
+
+---
+
+## `fetchModuleVersions()`
+
+Fetch the **module consensus versions** currently running on-chain.
+
+This is useful during upgrades to verify module migrations.
+
+**CLI equivalent**
+
+```bash
+zigchaind query upgrade module-versions
+```
+
+**Method**
+
+```ts
+fetchModuleVersions()
+```
+
+**Example**
+
+```ts
+const versions = await upgradeApi.fetchModuleVersions()
+console.dir(versions, { depth: null })
+```
+
+---
+
+## Example (Full)
+
+```ts
+import {
+  ChainUpgradeApi,
+  getNetworkEndpoints,
+  Network
+} from '@zuhaibnoor/zigchain-sdk'
+
+async function main() {
+  const endpoints = getNetworkEndpoints(Network.Testnet)
+  const upgradeApi = new ChainUpgradeApi(endpoints)
+
+  console.log('--- Current Upgrade Plan ---')
+  const plan = await upgradeApi.fetchCurrentPlan()
+  console.dir(plan, { depth: null })
+
+  console.log('\n--- Upgrade Authority ---')
+  const authority = await upgradeApi.fetchAuthority()
+  console.log(authority)
+
+  console.log('\n--- Module Versions ---')
+  const versions = await upgradeApi.fetchModuleVersions()
+  console.dir(versions, { depth: null })
+}
+
+main()
+```
+
+---
+