@ocap/client 1.25.3 → 1.25.5

package/docs/overview.ja.md

@@ -0,0 +1,70 @@
+# 概要
+
+OCAP Clientは、アプリケーションをOCAP搭載のブロックチェーンに接続するために設計された、強力で汎用性の高いJavaScriptライブラリです。データの読み書き、デジタル資産の管理、オンチェーンイベントの監視を行うための、効率的で開発者に優しいインターフェースを提供します。このクライアントは、Node.jsまたはブラウザベースの環境で使用でき、バックエンドサービスとフロントエンドアプリケーションの両方に単一のソリューションを提供します。
+
+このクライアントの核となるのは、トランザクションのエンコードと署名の複雑さを抽象化することで、ブロックチェーンとのインタラクションを簡素化することです。HTTP/Sを介してブロックチェーンノードとのすべての通信にGraphQL APIを使用しており、チェーンデータのクエリやトランザクションの送信が容易になります。
+
+```d2 Client Architecture Overview 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搭載のチェーンでは、最初に入金トランザクション（例：トークンの受信）を受け取ると、新しいアカウントが自動的にオンチェーンで作成されます。アカウントを初期化するために別のトランザクションは必要ありません。
+
+- **ガスレストランザクション**: このクライアントは、指定された「ガス支払者」ウォレットが他のユーザーのトランザクション手数料を負担できるガス支払いメカニズムをサポートしています。これにより、アプリケーションのユーザーにシームレスでガス代無料の体験を提供できます。
+
+### 次のステップ
+
+開発を始める準備はできましたか？始めるのに役立つリンクをいくつか紹介します。
+
+<x-cards data-columns="3">
+  <x-card data-title="はじめに" data-icon="lucide:rocket" data-href="/getting-started">
+    クライアントをインストールし、ベータチェーンに接続して、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/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-TW.md

@@ -0,0 +1,70 @@
+# 總覽
+
+OCAP Client 是一個功能強大且多功能的 JavaScript 函式庫，旨在將您的應用程式連接到由 OCAP 驅動的區塊鏈。它提供了一個精簡、對開發者友好的介面，用於讀取和寫入資料、管理數位資產以及監聽鏈上事件。該客戶端可用於任何 Node.js 或基於瀏覽器的環境，為後端服務和前端應用程式提供單一解決方案。
+
+其核心是，該客戶端透過抽象化交易編碼和簽署的複雜性來簡化區塊鏈互動。它使用 GraphQL API 透過 HTTP/S 與區塊鏈節點進行所有通訊，讓查詢鏈上資料和提交交易變得容易。
+
+```d2 Client Architecture Overview 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/docs/overview.zh.md

@@ -0,0 +1,70 @@
+# 概述
+
+OCAP Client 是一个功能强大且多功能的 JavaScript 库，旨在将您的应用程序连接到由 OCAP 驱动的区块链。它提供了一个简化的、对开发者友好的界面，用于读取和写入数据、管理数字资产以及监听链上事件。该客户端可用于任何 Node.js 或基于浏览器的环境，为后端服务和前端应用程序提供了单一解决方案。
+
+该客户端的核心是通过抽象化交易编码和签名的复杂性来简化区块链交互。它使用 GraphQL API 通过 HTTP/S 与区块链节点进行所有通信，使得查询链上数据和提交交易变得简单。
+
+```d2 Client Architecture Overview 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.5",
   "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.5",
+    "@arcblock/did-util": "1.25.5",
+    "@arcblock/jwt": "1.25.5",
+    "@arcblock/ws": "1.25.5",
+    "@ocap/asset": "1.25.5",
+    "@ocap/mcrypto": "1.25.5",
+    "@ocap/message": "1.25.5",
+    "@ocap/proto": "1.25.5",
+    "@ocap/tx-util": "1.25.5",
+    "@ocap/util": "1.25.5",
+    "@ocap/wallet": "1.25.5"
   },
   "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.5",
+    "@ocap/tx-protocols": "1.25.5"
   },
   "remarkConfig": {
     "plugins": [