@ocap/client 1.25.3 → 1.25.4

package/README.md

@@ -1,100 +1,96 @@
-![graphql-client](https://www.arcblock.io/.netlify/functions/badge/?text=graphql-client)
+！[graphql-client]（https://www.arcblock.io/.netlify/functions/badge/?text=graphql-client）
 
-[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
-[![docs](https://img.shields.io/badge/powered%20by-arcblock-green.svg)](https://docs.arcblock.io)
-[![Gitter](https://badges.gitter.im/ArcBlock/community.svg)](https://gitter.im/ArcBlock/community?utm_source=badge\&utm_medium=badge\&utm_campaign=pr-badge)
+[！
+[！
+[！[gitter]（https://badges.gitter.im/arcblock/community.svg）]（https://gitter.im/arcblock/arcblock/community?utm_source = badge = badge \＆utmm_medium = badge \ utm_campaign = badeaign = badeaign = badage）
+客户库可以在Node.js和浏览器环境中使用http/https通过http/https发送所有请求，将您的应用程序连接到Forge Power的区块链节点。
 
-Client library to connect your app with forge powered blockchain node, all requests are sent over http/https, can be used in both Node.js and browser environment.
+“ GraphQlClient”实例主要支持5组方法，这些方法可节省您的时间，从/到区块链读取数据时。
 
-A `GraphQLClient` instance mainly supports 5 groups of methods that saves you time when read/write data from/to blockchain.
+_`queries`：QUERY BLOCK/TRASSACTION/ACCENT/ACCENT/ASSET/CHAIN/NODE数据表格区块链
+_`突变“：将事务发送到区块链``sendtx'，所有交易应在发送到区块链之前签署所有交易
+*``订阅'：收听区块链上任何数据的更改
+*``senders'：采用``钱包''和`tx`对象的快捷方式，然后进行签名，然后发送
+*`coders`：采用``钱包''和`tx`对象的快捷方式，编码事务以进行后期签名，内部由发件人内部使用
 
-* `queries`: query block/transaction/account/asset/chain/node data form the blockchain
-* `mutations`: send transaction to the blockchain, `sendTx`, all transactions should be signed before sending out to the blockchain
-* `subscriptions`: listen to changes of any data on the blockchain
-* `senders`: shortcut methods that takes a `wallet` and a `tx` object, then do the signing, and sending
-* `encoders`: shortcut methods that takes a `wallet` and a `tx` object, encode the transaction for later signing, used internally by senders
+＃＃ 目录
 
+_[安装]（＃安装）
+_[用法]（＃使用）
+_[示例]（＃示例）
+_[调试]（＃调试）\*[文档]（＃文档）
 
-## Table of Contents
+＃＃ 安装
 
-* [Install](#install)
-* [Usage](#usage)
-* [Examples](#examples)
-* [Debugging](#debugging)
-* [Documentation](#documentation)
-
-
-## Install
-
-```shell
+```壳
 npm i @ocap/client -S
-# OR
-pnpm install @ocap/client
+＃ 或者
+PNPM install @ocap/client
 ```
 
+＃＃ 用法
+
+``JS
+const mcrypto = require（'@ocap/mcrypto'）;
+const graphQlclient = require（'@ocap/client'）;
+const {fromrandom，wallettype} = require（'@ocap/wallet'）;
+const {hextobytes} = require（'@ocap/util'）;
+
+const client = new GraphQlClient（'http：//localhost：8210/api'）;
+console.log（{
+查询：client.getqueries（），
+订阅：client.getSubscriptions（），
+突变：client.getmutations（），
+发件人：client.gettxsendmethods（），
+编码器：client.getTxEncodePhods（），
+}）;
+
+（async（）=> {
+//查询链状态数据
+const Chaininfo =等待客户端。GetChainInfo（）;
+const forgestate =等待客户端。
+const block =等待client.getBlock（{height：2}）;
+console.log（'getchaininfo'，chaininfo）;
+console.log（'getforgentate'，宽恕）；
+console.log（'getBlock'，block）;
+
+//发送交易
+const钱包= fromrandom（
+wallettype（{
+角色：mcrypto.types.roletype.role_account，
+PK：mcrypto.types.keytype.secp256k1，
+哈希：mcrypto.types.hashtype.sha3，
+}））
+）；
+const hash =等待client.declare（{
+绰号：“用户名”，
+钱包，
+}）;
+console.log（hash）;
+}）（）;
 
-## Usage
-
-```js
-const Mcrypto = require('@ocap/mcrypto');
-const GraphQLClient = require('@ocap/client');
-const { fromRandom, WalletType } = require('@ocap/wallet');
-const { hexToBytes } = require('@ocap/util');
-
-const client = new GraphQLClient('http://localhost:8210/api');
-console.log({
-  queries: client.getQueries(),
-  subscriptions: client.getSubscriptions(),
-  mutations: client.getMutations(),
-  senders: client.getTxSendMethods(),
-  encoders: client.getTxEncodeMethods(),
-});
-
-(async () => {
-  // Query chain state data
-  const chainInfo = await client.getChainInfo();
-  const forgeState = await client.getForgeState();
-  const block = await client.getBlock({ height: 2 });
-  console.log('getChainInfo', chainInfo);
-  console.log('getForgeState', forgeState);
-  console.log('getBlock', block);
-
-  // Send transaction
-  const wallet = fromRandom(
-    WalletType({
-      role: Mcrypto.types.RoleType.ROLE_ACCOUNT,
-      pk: Mcrypto.types.KeyType.SECP256K1,
-      hash: Mcrypto.types.HashType.SHA3,
-    })
-  );
-  const hash = await client.declare({
-    moniker: 'username',
-    wallet,
-  });
-  console.log(hash);
-})();
 ```
 
 
-## Examples
+##示例
 
-* [Declare identify on the blockchain](./examples/declare.js)
-* [Get free token for newly created account](./examples/get_free_token.js)
-* [Transfer assets between 2 accounts](./examples/transfer_asset.js)
-* [Transfer tokens between 2 accounts](./examples/transfer_token.js)
-* [Exchange asset and token between 2 newly created accounts](./examples/exchange.js)
-* [Create/update asset on the blockchain](./examples/asset.js)
-* [Consume newly create asset](./examples/consume_asset.js)
-* [Stake for the connected node](./examples/stake_for_node.js)
+*[在区块链上声明标识]（./示例/scellare.js）
+*[为新创建的帐户获取免费令牌]（./示例/get_free_token.js）
+*[2个帐户之间的转移资产]（./示例/Transfer_asset.js）
+*[2个帐户之间的转移令牌]（./示例/trassing_token.js）
+*[2个新创建的帐户之间的Exchange Asset和令牌]（./示例/Exchange.js）
+*[在区块链上创建/更新资产]（./示例/Asset.js）
+*[消费新创建资产]（./示例/clummume_asset.js）
+*[连接节点的股份]（./示例/stake_for_node.js）
 
 
-## Debugging
+##调试
+*如果您在node.js中：`debug =@ocap/client node script.js`
+*如果您在浏览器中：`localstorage.setitem（'debug'，'@ocap/client'）
 
-* If you are in Node.js: `DEBUG=@ocap/client node script.js`
-* If you are in browser: `localStorage.setItem('DEBUG', '@ocap/client')`
 
+##文档
 
-## Documentation
-
-* Query arguments and response structure can be found here: [QUERIES.md](./docs/QUERIES.md)
-* Complete method list can be found here: [README.md](./docs/README.md)
+*查询参数和响应结构可以在此处找到：[queries.md]（./docs/queries.md）
+*完整的方法列表可以在此处找到：[readme.md]（./docs/readme.md）
+```

package/dist/report.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8"/>
     <meta name="viewport" content="width=device-width, initial-scale=1"/>
-    <title>@ocap/client [22 Sep 2025 at 12:14]</title>
+    <title>@ocap/client [27 Sep 2025 at 08:11]</title>
     <link rel="shortcut icon" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAABrVBMVEUAAAD///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////+O1foceMD///+J0/qK1Pr7/v8Xdr/9///W8P4UdL7L7P0Scr2r4Pyj3vwad8D5/f/2/f+55f3E6f34+/2H0/ojfMKpzOd0rNgQcb3F3O/j9f7c8v6g3Pz0/P/w+v/q+P7n9v6T1/uQ1vuE0vqLut/y+v+Z2fvt+f+15Pzv9fuc2/vR7v2V2Pvd6/bg9P7I6/285/2y4/yp3/zp8vk8i8kqgMT7/P31+fyv4vxGkcz6/P6/6P3j7vfS5PNnpNUxhcbO7f7F6v3O4vHK3/DA2u631Ouy0eqXweKJud5wqthfoNMMbLvY8f73+v2dxeR8sNtTmdDx9/zX6PSjyeaCtd1YnNGX2PuQveCGt95Nls42h8dLlM3F4vBtAAAAM3RSTlMAAyOx0/sKBvik8opWGBMOAe3l1snDm2E9LSb06eHcu5JpHbarfHZCN9CBb08zzkdNS0kYaptYAAAFV0lEQVRYw92X51/aYBDHHS2O2qqttVbrqNq9m+TJIAYIShBkWwqIiCgoWvfeq7Z2/s29hyQNyUcR7LveGwVyXy6XH8/9rqxglLfUPLxVduUor3h0rfp2TYvpivk37929TkG037hffoX0+peVtZQc1589rigVUdXS/ABSAyEmGIO/1XfvldSK8vs3OqB6u3m0nxmIrvgB0dj7rr7Y9IbuF68hnfFaiHA/sxqm0wciIG43P60qKv9WXWc1RXGh/mFESFABTSBi0sNAKzqet17eCtOb3kZIDwxEEU0oAIJGYxNBDhBND29e0rtXXbcpuPmED9IhEAAQ/AXEaF8EPmnrrKsv0LvWR3fg5sWDNAFZOgAgaKvZDogHNU9MFwnnYROkc56RD5CjAbQX9Ow4g7upCsvYu55aSI/Nj0H1akgKQEUM94dwK65hYRmFU9MIcH/fqJYOZYcnuJSU/waKDgTOEVaVKhwrTRP5XzgSpAITYzom7UvkhFX5VutmxeNnWDjjswTKTyfgluNDGbUpWissXhF3s7mlSml+czWkg3D0l1nNjGNjz3myOQOa1KM/jOS6ebdbAVTCi4gljHSFrviza7tOgRWcS0MOUX9zdNgag5w7rRqA44Lzw0hr1WqES36dFliSJFlh2rXIae3FFcDDgKdxrUIDePr8jGcSClV1u7A9xeN0ModY/pHMxmR1EzRh8TJiwqsHmKW0l4FCEZI+jHio+JdPPE9qwQtTRxku2D8sIeRL2LnxWSllANCQGOIiqVHAz2ye2JR0DcH+HoxDkaADLjgxjKQ+AwCX/g0+DNgdG0ukYCONAe+dbc2IAc6fwt1ARoDSezNHxV2Cmzwv3O6lDMV55edBGwGK9n1+x2F8EDfAGCxug8MhpsMEcTEAWf3rx2vZhe/LAmtIn/6apE6PN0ULKgywD9mmdxbmFl3OvD5AS5fW5zLbv/YHmcsBTjf/afDz3MaZTVCfAP9z6/Bw6ycv8EUBWJIn9zYcoAWWlW9+OzO3vkTy8H+RANLmdrpOuYWdZYEXpo+TlCJrW5EARb7fF+bWdqf3hhyZI1nWJQHgznErZhbjoEsWqi8dQNoE294aldzFurwSABL2XXMf9+H1VQGke9exw5P/AnA5Pv5ngMul7LOvO922iwACu8WkCwLCafvM4CeWPxfA8lNHcWZSoi8EwMAIciKX2Z4SWCMAa3snCZ/G4EA8D6CMLNFsGQhkkz/gQNEBbPCbWsxGUpYVu3z8IyNAknwJkfPMEhLyrdi5RTyUVACkw4GSFRNWJNEW+fgPGwHD8/JxnRuLabN4CGNRkAE23na2+VmEAUmrYymSGjMAYqH84YUIyzgzs3XC7gNgH36Vcc4zKY9o9fgPBXUAiHHwVboBHGLiX6Zcjp1f2wu4tvzZKo0ecPnDtQYDQvJXaBeNzce45Fp28ZQLrEZVuFqgBwOalArKXnW1UzlnSusQKJqKYNuz4tOnI6sZG4zanpemv+7ySU2jbA9h6uhcgpfy6G2PahirDZ6zvq6zDduMVFTKvzw8wgyEdelwY9in3XkEPs3osJuwRQ4qTkfzifndg9Gfc4pdsu82+tTnHZTBa2EAMrqr2t43pguc8tNm7JQVQ2S0ukj2d22dhXYP0/veWtwKrCkNoNimAN5+Xr/oLrxswKbVJjteWrX7eR63o4j9q0GxnaBdWgGA5VStpanIjQmEhV0/nVt5VOFUvix6awJhPcAaTEShgrG+iGyvb5a0Ndb1YGHFPEwoqAinoaykaID1o1pdPNu7XsnCKQ3R+hwWIIhGvORcJUBYXe3Xa3vq/mF/N9V13ugufMkfXn+KHsRD0B8AAAAASUVORK5CYII=" type="image/x-icon" />
 
     <script>

package/docs/_sidebar.md

@@ -0,0 +1,22 @@
+* [Overview](/overview.md)
+* [Getting Started](/getting-started.md)
+  * [Installation](/getting-started-installation.md)
+  * [Basic Usage](/getting-started-basic-usage.md)
+* [How-to Guides](/how-to-guides.md)
+  * [Manage Accounts](/how-to-guides-manage-accounts.md)
+  * [Delegate Permissions](/how-to-guides-delegate-permissions.md)
+  * [Transfer Tokens and NFTs](/how-to-guides-transfer-tokens-and-nfts.md)
+  * [Manage Assets (NFTs)](/how-to-guides-manage-assets.md)
+  * [Manage Tokens](/how-to-guides-manage-tokens.md)
+  * [Stake Tokens and Assets](/how-to-guides-stake-tokens-and-assets.md)
+* [Core Concepts](/core-concepts.md)
+  * [Client Architecture](/core-concepts-client-architecture.md)
+  * [Transaction Lifecycle](/core-concepts-transaction-lifecycle.md)
+  * [Event Subscriptions](/core-concepts-event-subscriptions.md)
+  * [Gas Payment](/core-concepts-gas-payment.md)
+* [API Reference](/api-reference.md)
+  * [Helper Methods](/api-reference-client-methods.md)
+  * [Query & Mutation Methods](/api-reference-query-mutation-methods.md)
+  * [High-level API](/api-reference-transaction-helpers.md)
+  * [Low-level API](/api-reference-low-level-api.md)
+  * [Data Types](/api-reference-data-types.md)

package/docs/api-reference-client-methods.md

@@ -0,0 +1,229 @@
+# Helper Methods
+
+The `GraphQLClient` class is the primary interface for interacting with an OCAP-powered blockchain. It provides a comprehensive set of methods for querying the chain state, sending transactions, and subscribing to real-time events. It is designed to work seamlessly in both Node.js and browser environments.
+
+```javascript Client Initialization icon=logos:javascript
+const GraphQLClient = require('@ocap/client');
+
+// Connect to the Beta chain
+const client = new GraphQLClient('https://beta.abtnetwork.io/api');
+
+(async () => {
+  const res = await client.getChainInfo();
+  console.log('Connected to chain:', res.info.network);
+})();
+```
+
+This section provides a detailed reference for the core helper methods of the `GraphQLClient` class.
+
+## Constructor
+
+### new GraphQLClient(endpoint, autoInit)
+
+Creates a new instance of the `GraphQLClient`.
+
+**Parameters**
+
+<x-field-group>
+  <x-field data-name="endpoint" data-type="string" data-required="true">
+    <x-field-desc markdown>The absolute URL of the GraphQL endpoint for the blockchain node (e.g., `https://beta.abtnetwork.io/api`).</x-field-desc>
+  </x-field>
+  <x-field data-name="autoInit" data-type="boolean" data-default="true" data-required="false">
+    <x-field-desc markdown>If `true`, the client will automatically fetch and cache essential chain information (the "context") upon initialization. This is recommended for most use cases.</x-field-desc>
+  </x-field>
+</x-field-group>
+
+**Example**
+
+```javascript Creating a Client Instance icon=logos:javascript
+const client = new GraphQLClient('https://beta.abtnetwork.io/api', true);
+```
+
+---
+
+## Core Methods
+
+These methods provide fundamental functionality for interacting with the client and the chain.
+
+### getContext()
+
+Fetches and caches essential chain information, such as the chain ID, native token details, and transaction fee configurations. This method is called automatically if `autoInit` is enabled in the constructor. Subsequent calls will return the cached context.
+
+**Returns**
+
+<x-field data-name="Promise<object>" data-type="object" data-desc="A promise that resolves to the context object containing chain metadata.">
+  <x-field data-name="chainId" data-type="string" data-desc="The unique identifier of the blockchain network."></x-field>
+  <x-field data-name="consensus" data-type="string" data-desc="The consensus engine version."></x-field>
+  <x-field data-name="token" data-type="object" data-desc="Information about the native token.">
+    <x-field data-name="address" data-type="string" data-desc="The address of the native token contract."></x-field>
+    <x-field data-name="decimal" data-type="number" data-desc="The number of decimal places for the native token."></x-field>
+    <x-field data-name="symbol" data-type="string" data-desc="The symbol of the native token (e.g., TBA)."></x-field>
+  </x-field>
+  <x-field data-name="txConfig" data-type="object" data-desc="Transaction fee and gas configuration."></x-field>
+</x-field>
+
+**Example**
+
+```javascript Fetching Chain Context icon=logos:javascript
+async function logChainToken() {
+  const context = await client.getContext();
+  console.log(`Native Token Symbol: ${context.token.symbol}`);
+}
+
+logChainToken();
+```
+
+### setGasPayer(wallet)
+
+Configures a wallet to act as a "gas payer." When set, this wallet will sponsor the transaction fees for transactions sent through this client instance, enabling gasless experiences for users. For more details, see the [Gas Payment](./core-concepts-gas-payment.md) concept guide.
+
+**Parameters**
+
+<x-field data-name="wallet" data-type="WalletObject" data-required="true">
+  <x-field-desc markdown>A wallet object with `address`, `publicKey`, and `secretKey` properties, equipped with a `sign` method.</x-field-desc>
+</x-field>
+
+### decodeTx(input)
+
+Deserializes a transaction from various formats into a human-readable JavaScript object.
+
+**Parameters**
+
+<x-field data-name="input" data-type="Buffer | string" data-required="true">
+  <x-field-desc markdown>The transaction data to decode. Can be a `Buffer` or a string in `hex`, `base58`, or `base64` format.</x-field-desc>
+</x-field>
+
+**Returns**
+
+<x-field data-name="object" data-type="object" data-desc="The decoded transaction object."></x-field>
+
+### getType(name)
+
+Retrieves the Protobuf message class for a given type name. This is useful for advanced scenarios where you need to manually construct or inspect Protobuf messages.
+
+**Parameters**
+
+<x-field data-name="name" data-type="string" data-required="true" data-desc="The name of the Protobuf message type (e.g., 'Transaction', 'TransferTx')."></x-field>
+
+**Returns**
+
+<x-field data-name="class | null" data-type="object" data-desc="The message class constructor, or null if not found."></x-field>
+
+---
+
+## Event Subscription
+
+The client supports real-time event subscriptions over WebSockets, allowing your application to react instantly to on-chain events.
+
+### subscribe(topic, callback)
+
+Establishes a WebSocket connection and subscribes to a specific event topic.
+
+**Parameters**
+
+<x-field-group>
+  <x-field data-name="topic" data-type="string" data-required="true" data-desc="The event topic to subscribe to (e.g., 'newBlock', 'tx:transfer')."></x-field>
+  <x-field data-name="callback" data-type="function" data-required="true" data-desc="A function to execute when an event is received. It receives the event payload as its only argument."></x-field>
+</x-field-group>
+
+### unsubscribe(topic, callback)
+
+Removes a previously registered callback for a specific topic.
+
+**Parameters**
+
+<x-field-group>
+  <x-field data-name="topic" data-type="string" data-required="true" data-desc="The event topic to unsubscribe from."></x-field>
+  <x-field data-name="callback" data-type="function" data-required="true" data-desc="The specific callback function to remove."></x-field>
+</x-field-group>
+
+**Example**
+
+```javascript Subscribing to New Blocks icon=logos:javascript
+const handleNewBlock = (block) => {
+  console.log(`New block received! Height: ${block.height}`);
+  
+  // Unsubscribe after receiving one block
+  client.unsubscribe('newBlock', handleNewBlock);
+  console.log('Unsubscribed from newBlock events.');
+};
+
+client.subscribe('newBlock', handleNewBlock);
+console.log('Subscribed to newBlock events...');
+```
+
+---
+
+## Token Utility Methods
+
+These helpers simplify conversions between the human-readable token amount and the on-chain base unit representation.
+
+### fromUnitToToken(value)
+
+Converts a value from the chain's base unit (a large integer string) to a standard decimal string, based on the native token's decimal places.
+
+**Parameters**
+
+<x-field data-name="value" data-type="string" data-required="true" data-desc="The amount in the chain's base unit."></x-field>
+
+**Returns**
+
+<x-field data-name="string" data-type="string" data-desc="The amount in the standard token unit."></x-field>
+
+### fromTokenToUnit(amount)
+
+Converts a standard decimal amount into the chain's base unit representation (a BN.js instance).
+
+**Parameters**
+
+<x-field data-name="amount" data-type="number | string" data-required="true" data-desc="The token amount in its standard decimal form."></x-field>
+
+**Returns**
+
+<x-field data-name="BN" data-type="object" data-desc="A BN.js instance representing the value in the chain's base unit."></x-field>
+
+**Example**
+
+```javascript Token Amount Conversion icon=logos:javascript
+async function convertToken() {
+  // Convert 100 TBA to its base unit
+  const unitAmount = await client.fromTokenToUnit(100);
+  console.log(`100 TBA is ${unitAmount.toString()} in base units.`);
+
+  // Convert it back
+  const tokenAmount = await client.fromUnitToToken(unitAmount.toString());
+  console.log(`${unitAmount.toString()} base units is ${tokenAmount} TBA.`);
+}
+
+convertToken();
+```
+
+---
+
+## Method Discovery
+
+The client dynamically generates methods for every transaction type supported by the connected OCAP node. These discovery methods allow you to programmatically list all available transaction-related functions.
+
+### getTxSendMethods()
+
+Returns an array of all available `send...Tx` method names. These methods handle the full lifecycle of signing and sending a transaction.
+
+### getTxEncodeMethods()
+
+Returns an array of all available `encode...Tx` method names. These methods prepare and serialize a transaction into a buffer, but do not sign it.
+
+### getTxSignMethods()
+
+Returns an array of all available `sign...Tx` method names. These methods encode and then sign a transaction, returning the signed transaction object.
+
+### getTxMultiSignMethods()
+
+Returns an array of all available `multiSign...Tx` method names, used for multi-signature workflows.
+
+**Example**
+
+```javascript Listing Available Transaction Methods icon=logos:javascript
+const sendMethods = client.getTxSendMethods();
+console.log('Available send methods:', sendMethods);
+// Example output: [ 'sendPokeTx', 'sendTransferTx', ... ]
+```

package/docs/api-reference-client-methods.zh.md

@@ -0,0 +1,229 @@
+# 辅助方法
+
+`GraphQLClient` 类是与 OCAP 驱动的区块链进行交互的主要接口。它提供了一套全面的方法，用于查询链状态、发送交易以及订阅实时事件。它被设计为在 Node.js 和浏览器环境中都能无缝工作。
+
+```javascript 客户端初始化 icon=logos:javascript
+const GraphQLClient = require('@ocap/client');
+
+// 连接到 Beta 链
+const client = new GraphQLClient('https://beta.abtnetwork.io/api');
+
+(async () => {
+  const res = await client.getChainInfo();
+  console.log('已连接到链：', res.info.network);
+})();
+```
+
+本节为 `GraphQLClient` 类的核心辅助方法提供了详细的参考。
+
+## 构造函数
+
+### new GraphQLClient(endpoint, autoInit)
+
+创建一个新的 `GraphQLClient` 实例。
+
+**参数**
+
+<x-field-group>
+  <x-field data-name="endpoint" data-type="string" data-required="true">
+    <x-field-desc markdown>区块链节点的 GraphQL 端点的绝对 URL（例如，`https://beta.abtnetwork.io/api`）。</x-field-desc>
+  </x-field>
+  <x-field data-name="autoInit" data-type="boolean" data-default="true" data-required="false">
+    <x-field-desc markdown>如果为 `true`，客户端将在初始化时自动获取并缓存基本的链信息（“上下文”）。对于大多数用例，建议使用此选项。</x-field-desc>
+  </x-field>
+</x-field-group>
+
+**示例**
+
+```javascript 创建客户端实例 icon=logos:javascript
+const client = new GraphQLClient('https://beta.abtnetwork.io/api', true);
+```
+
+---
+
+## 核心方法
+
+这些方法提供了与客户端和链进行交互的基本功能。
+
+### getContext()
+
+获取并缓存基本的链信息，例如链 ID、原生代币详情和交易费用配置。如果在构造函数中启用了 `autoInit`，此方法会自动调用。后续调用将返回缓存的上下文。
+
+**返回**
+
+<x-field data-name="Promise<object>" data-type="object" data-desc="一个解析为包含链元数据的上下文对象的 promise。">
+  <x-field data-name="chainId" data-type="string" data-desc="区块链网络的唯一标识符。"></x-field>
+  <x-field data-name="consensus" data-type="string" data-desc="共识引擎版本。"></x-field>
+  <x-field data-name="token" data-type="object" data-desc="关于原生代币的信息。">
+    <x-field data-name="address" data-type="string" data-desc="原生代币合约的地址。"></x-field>
+    <x-field data-name="decimal" data-type="number" data-desc="原生代币的小数位数。"></x-field>
+    <x-field data-name="symbol" data-type="string" data-desc="原生代币的符号（例如，TBA）。"></x-field>
+  </x-field>
+  <x-field data-name="txConfig" data-type="object" data-desc="交易费用和 gas 配置。"></x-field>
+</x-field>
+
+**示例**
+
+```javascript 获取链上下文 icon=logos:javascript
+async function logChainToken() {
+  const context = await client.getContext();
+  console.log(`原生代币符号： ${context.token.symbol}`);
+}
+
+logChainToken();
+```
+
+### setGasPayer(wallet)
+
+配置一个钱包作为“gas 支付者”。设置后，该钱包将为通过此客户端实例发送的交易赞助交易费，从而为用户提供无 gas 费体验。更多详情，请参阅 [Gas 支付](./core-concepts-gas-payment.md) 概念指南。
+
+**参数**
+
+<x-field data-name="wallet" data-type="WalletObject" data-required="true">
+  <x-field-desc markdown>一个钱包对象，具有 `address`、`publicKey` 和 `secretKey` 属性，并配备了 `sign` 方法。</x-field-desc>
+</x-field>
+
+### decodeTx(input)
+
+将各种格式的交易反序列化为人类可读的 JavaScript 对象。
+
+**参数**
+
+<x-field data-name="input" data-type="Buffer | string" data-required="true">
+  <x-field-desc markdown>要解码的交易数据。可以是 `Buffer` 或 `hex`、`base58` 或 `base64` 格式的字符串。</x-field-desc>
+</x-field>
+
+**返回**
+
+<x-field data-name="object" data-type="object" data-desc="解码后的交易对象。"></x-field>
+
+### getType(name)
+
+根据给定的类型名称检索 Protobuf 消息类。这对于需要手动构造或检查 Protobuf 消息的高级场景很有用。
+
+**参数**
+
+<x-field data-name="name" data-type="string" data-required="true" data-desc="Protobuf 消息类型的名称（例如，'Transaction'、'TransferTx'）。"></x-field>
+
+**返回**
+
+<x-field data-name="class | null" data-type="object" data-desc="消息类的构造函数，如果未找到则为 null。"></x-field>
+
+---
+
+## 事件订阅
+
+客户端支持通过 WebSocket 进行实时事件订阅，使您的应用程序能够即时响应链上事件。
+
+### subscribe(topic, callback)
+
+建立一个 WebSocket 连接并订阅特定的事件主题。
+
+**参数**
+
+<x-field-group>
+  <x-field data-name="topic" data-type="string" data-required="true" data-desc="要订阅的事件主题（例如，'newBlock'、'tx:transfer'）。"></x-field>
+  <x-field data-name="callback" data-type="function" data-required="true" data-desc="接收到事件时执行的函数。它接收事件负载作为其唯一参数。"></x-field>
+</x-field-group>
+
+### unsubscribe(topic, callback)
+
+移除先前为特定主题注册的回调。
+
+**参数**
+
+<x-field-group>
+  <x-field data-name="topic" data-type="string" data-required="true" data-desc="要取消订阅的事件主题。"></x-field>
+  <x-field data-name="callback" data-type="function" data-required="true" data-desc="要移除的特定回调函数。"></x-field>
+</x-field-group>
+
+**示例**
+
+```javascript 订阅新区块 icon=logos:javascript
+const handleNewBlock = (block) => {
+  console.log(`收到新区块！高度： ${block.height}`);
+  
+  // 收到一个区块后取消订阅
+  client.unsubscribe('newBlock', handleNewBlock);
+  console.log('已取消订阅 newBlock 事件。');
+};
+
+client.subscribe('newBlock', handleNewBlock);
+console.log('已订阅 newBlock 事件...');
+```
+
+---
+
+## 代币工具方法
+
+这些辅助方法简化了人类可读的代币数量和链上基本单位表示之间的转换。
+
+### fromUnitToToken(value)
+
+根据原生代币的小数位数，将一个值从链的基本单位（一个大整数字符串）转换为标准的十进制字符串。
+
+**参数**
+
+<x-field data-name="value" data-type="string" data-required="true" data-desc="以链的基本单位表示的数量。"></x-field>
+
+**返回**
+
+<x-field data-name="string" data-type="string" data-desc="以标准代币单位表示的数量。"></x-field>
+
+### fromTokenToUnit(amount)
+
+将一个标准的十进制数量转换为链的基本单位表示（一个 BN.js 实例）。
+
+**参数**
+
+<x-field data-name="amount" data-type="number | string" data-required="true" data-desc="以标准十进制形式表示的代币数量。"></x-field>
+
+**返回**
+
+<x-field data-name="BN" data-type="object" data-desc="一个 BN.js 实例，表示以链的基本单位计的值。"></x-field>
+
+**示例**
+
+```javascript 代币数量转换 icon=logos:javascript
+async function convertToken() {
+  // 将 100 TBA 转换为其基本单位
+  const unitAmount = await client.fromTokenToUnit(100);
+  console.log(`100 TBA 等于 ${unitAmount.toString()} 基本单位。`);
+
+  // 再转换回来
+  const tokenAmount = await client.fromUnitToToken(unitAmount.toString());
+  console.log(`${unitAmount.toString()} 基本单位等于 ${tokenAmount} TBA。`);
+}
+
+convertToken();
+```
+
+---
+
+## 方法发现
+
+客户端为所连接的 OCAP 节点支持的每种交易类型动态生成方法。这些发现方法允许您以编程方式列出所有可用的与交易相关的功能。
+
+### getTxSendMethods()
+
+返回所有可用的 `send...Tx` 方法名称的数组。这些方法处理签名和发送交易的完整生命周期。
+
+### getTxEncodeMethods()
+
+返回所有可用的 `encode...Tx` 方法名称的数组。这些方法将交易准备并序列化为缓冲区，但不进行签名。
+
+### getTxSignMethods()
+
+返回所有可用的 `sign...Tx` 方法名称的数组。这些方法对交易进行编码然后签名，返回已签名的交易对象。
+
+### getTxMultiSignMethods()
+
+返回所有可用的 `multiSign...Tx` 方法名称的数组，用于多重签名工作流。
+
+**示例**
+
+```javascript 列出可用的交易方法 icon=logos:javascript
+const sendMethods = client.getTxSendMethods();
+console.log('可用的发送方法：', sendMethods);
+// 示例输出：[ 'sendPokeTx', 'sendTransferTx', ... ]
+```