@ocap/client 1.25.3 → 1.25.4

package/docs/overview.md

@@ -0,0 +1,70 @@
+# Overview
+
+The OCAP Client is a powerful and versatile JavaScript library designed to connect your applications to an OCAP-powered blockchain. It provides a streamlined, developer-friendly interface for reading and writing data, managing digital assets, and listening for on-chain events. The client can be used in any Node.js or browser-based environment, offering a single solution for both backend services and frontend applications.
+
+At its core, the client simplifies blockchain interaction by abstracting away the complexities of transaction encoding and signing. It uses a GraphQL API for all communication with the blockchain node over HTTP/S, making it easy to query chain data and submit transactions.
+
+```d2 Client Architecture Overview icon=mdi:graphql
+direction: down
+
+  your-app: {
+    label: "Your Application\n(Node.js or Browser)"
+    shape: rectangle
+  }
+
+  ocap-client: {
+    label: "@ocap/client"
+    shape: rectangle
+    style.fill: "#f0f9ff"
+  }
+
+  ocap-node: {
+    label: "OCAP Blockchain Node"
+    shape: cylinder
+  }
+
+  your-app -> ocap-client: "High-level API Calls\n(e.g., transfer(), createAsset())"
+  ocap-client -> ocap-node: "GraphQL Queries/Mutations (HTTP/S)\nEvent Subscriptions (WebSocket)"
+
+```
+
+### Key Features
+
+The OCAP Client is organized into several distinct groups of methods to handle different aspects of blockchain communication:
+
+<x-cards data-columns="2">
+  <x-card data-title="Queries" data-icon="lucide:search">
+    Read any data from the blockchain, including blocks, transactions, account states, asset details, and general chain information.
+  </x-card>
+  <x-card data-title="Mutations & Senders" data-icon="lucide:send">
+    Write data to the blockchain. Use high-level helper methods like `transfer` or `createAsset` to easily prepare, sign, and send transactions.
+  </x-card>
+  <x-card data-title="Subscriptions" data-icon="lucide:radio-tower">
+    Listen for real-time on-chain events. Subscribe to topics and receive updates as they happen via a WebSocket connection.
+  </x-card>
+  <x-card data-title="Coders & Signers" data-icon="lucide:edit">
+    For advanced use cases, you can encode and sign transactions manually, giving you full control over the transaction lifecycle.
+  </x-card>
+</x-cards>
+
+### Important Concepts
+
+- **Automatic Account Creation**: On an OCAP-powered chain, a new account is automatically created on-chain when it receives its first incoming transaction (e.g., receiving tokens). You don't need a separate transaction to initialize an account.
+
+- **Gasless Transactions**: The client supports a gas payment mechanism where a designated "gas payer" wallet can sponsor transaction fees for other users. This enables you to create seamless, gas-free experiences for your application's users.
+
+### Where to Go Next
+
+Ready to start building? Here are some helpful links to get you moving:
+
+<x-cards data-columns="3">
+  <x-card data-title="Getting Started" data-icon="lucide:rocket" data-href="/getting-started">
+    Install the client, connect to the Beta chain, and make your first query in under 30 minutes.
+  </x-card>
+  <x-card data-title="How-to Guides" data-icon="lucide:book-open" data-href="/how-to-guides">
+    Follow step-by-step tutorials for common tasks like creating NFTs, transferring tokens, and staking.
+  </x-card>
+  <x-card data-title="API Reference" data-icon="lucide:code" data-href="/api-reference">
+    Dive into the complete API documentation for detailed information on every method, parameter, and data type.
+  </x-card>
+</x-cards>

package/docs/overview.zh.md

@@ -0,0 +1,70 @@
+# 概述
+
+OCAP Client 是一个功能强大且用途广泛的 JavaScript 库，旨在将您的应用程序连接到由 OCAP 驱动的区块链。它提供了一个简化的、对开发者友好的界面，用于读取和写入数据、管理数字资产以及监听链上事件。该客户端可用于任何 Node.js 或基于浏览器的环境，为后端服务和前端应用程序提供统一的解决方案。
+
+其核心在于，该客户端通过抽象交易编码和签名的复杂性来简化与区块链的交互。它通过 HTTP/S 使用 GraphQL API 与区块链节点进行所有通信，使得查询链上数据和提交交易变得简单。
+
+```d2 客户端架构概述 icon=mdi:graphql
+direction: down
+
+  your-app: {
+    label: "你的应用程序\n(Node.js 或浏览器)"
+    shape: rectangle
+  }
+
+  ocap-client: {
+    label: "@ocap/client"
+    shape: rectangle
+    style.fill: "#f0f9ff"
+  }
+
+  ocap-node: {
+    label: "OCAP 区块链节点"
+    shape: cylinder
+  }
+
+  your-app -> ocap-client: "高层 API 调用\n(例如，transfer()、createAsset())"
+  ocap-client -> ocap-node: "GraphQL 查询/变更 (HTTP/S)\n事件订阅 (WebSocket)"
+
+```
+
+### 主要特性
+
+OCAP Client 被组织成几个不同的方法组，以处理区块链通信的不同方面：
+
+<x-cards data-columns="2">
+  <x-card data-title="查询" data-icon="lucide:search">
+    从区块链读取任何数据，包括区块、交易、账户状态、资产详情和常规链信息。
+  </x-card>
+  <x-card data-title="变更与发送器" data-icon="lucide:send">
+    向区块链写入数据。使用诸如 `transfer` 或 `createAsset` 等高层辅助方法，轻松准备、签名和发送交易。
+  </x-card>
+  <x-card data-title="订阅" data-icon="lucide:radio-tower">
+    监听实时链上事件。订阅主题并通过 WebSocket 连接接收实时更新。
+  </x-card>
+  <x-card data-title="编码器与签名器" data-icon="lucide:edit">
+    对于高级用例，您可以手动编码和签署交易，从而完全控制交易的生命周期。
+  </x-card>
+</x-cards>
+
+### 重要概念
+
+- **自动创建账户**：在 OCAP 驱动的链上，当一个新账户收到其第一笔入账交易（例如，接收代币）时，该账户会自动在链上创建。您无需通过单独的交易来初始化账户。
+
+- **无 Gas 费交易**：客户端支持一种 Gas 费支付机制，即由指定的“Gas 费支付方”钱包为其他用户代付交易费用。这使您能够为应用程序的用户创建无缝、免 Gas 费的体验。
+
+### 下一步
+
+准备好开始构建了吗？这里有一些有用的链接可以帮助您快速上手：
+
+<x-cards data-columns="3">
+  <x-card data-title="入门指南" data-icon="lucide:rocket" data-href="/getting-started">
+    安装客户端，连接到 Beta 链，并在 30 分钟内完成您的第一次查询。
+  </x-card>
+  <x-card data-title="操作指南" data-icon="lucide:book-open" data-href="/how-to-guides">
+    遵循分步教程，完成创建 NFT、转移代币和质押等常见任务。
+  </x-card>
+  <x-card data-title="API 参考" data-icon="lucide:code" data-href="/api-reference">
+    深入了解完整的 API 文档，获取有关每个方法、参数和数据类型的详细信息。
+  </x-card>
+</x-cards>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocap/client",
-  "version": "1.25.3",
+  "version": "1.25.4",
   "description": "graphql client to read/write data on arcblock blockchain",
   "keywords": [
     "graphql",
@@ -40,17 +40,17 @@
     "react-app-polyfill": "^1.0.6",
     "readable-stream": "3.6.0",
     "wolfy87-eventemitter": "^5.2.9",
-    "@arcblock/did": "1.25.3",
-    "@arcblock/jwt": "1.25.3",
-    "@arcblock/ws": "1.25.3",
-    "@arcblock/did-util": "1.25.3",
-    "@ocap/asset": "1.25.3",
-    "@ocap/mcrypto": "1.25.3",
-    "@ocap/message": "1.25.3",
-    "@ocap/proto": "1.25.3",
-    "@ocap/tx-util": "1.25.3",
-    "@ocap/util": "1.25.3",
-    "@ocap/wallet": "1.25.3"
+    "@arcblock/did": "1.25.4",
+    "@arcblock/did-util": "1.25.4",
+    "@arcblock/jwt": "1.25.4",
+    "@arcblock/ws": "1.25.4",
+    "@ocap/asset": "1.25.4",
+    "@ocap/mcrypto": "1.25.4",
+    "@ocap/message": "1.25.4",
+    "@ocap/proto": "1.25.4",
+    "@ocap/tx-util": "1.25.4",
+    "@ocap/util": "1.25.4",
+    "@ocap/wallet": "1.25.4"
   },
   "devDependencies": {
     "babel-cli": "^6.26.0",
@@ -71,8 +71,8 @@
     "webpack": "^5.94.0",
     "webpack-bundle-analyzer": "^4.10.2",
     "webpack-cli": "^5.1.4",
-    "@ocap/e2e-test": "1.25.3",
-    "@ocap/tx-protocols": "1.25.3"
+    "@ocap/e2e-test": "1.25.4",
+    "@ocap/tx-protocols": "1.25.4"
   },
   "remarkConfig": {
     "plugins": [