@ocap/client 1.25.3 → 1.25.5

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-TW.md

@@ -0,0 +1,229 @@
+# 輔助方法
+
+`GraphQLClient` 類別是與 OCAP 驅動的區塊鏈互動的主要介面。它提供了一套全面的方法，用於查詢鏈狀態、發送交易以及訂閱即時事件。它被設計為在 Node.js 和瀏覽器環境中都能無縫運作。
+
+```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);
+})();
+```
+
+本節為 `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 Creating a Client Instance 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 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)
+
+設定一個錢包作為「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 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...');
+```
+
+---
+
+## 代幣工具方法
+
+這些輔助方法簡化了人類可讀的代幣數量與鏈上基本單位表示之間的轉換。
+
+### 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 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();
+```
+
+---
+
+## 方法探索
+
+客戶端會為所連接的 OCAP 節點支援的每種交易類型動態產生方法。這些探索方法讓您能夠以程式化的方式列出所有可用的交易相關函式。
+
+### getTxSendMethods()
+
+傳回所有可用的 `send...Tx` 方法名稱陣列。這些方法處理簽署和發送交易的完整生命週期。
+
+### getTxEncodeMethods()
+
+傳回所有可用的 `encode...Tx` 方法名稱陣列。這些方法準備並將交易序列化為緩衝區，但不會簽署它。
+
+### getTxSignMethods()
+
+傳回所有可用的 `sign...Tx` 方法名稱陣列。這些方法會編碼然後簽署交易，並傳回已簽署的交易物件。
+
+### getTxMultiSignMethods()
+
+傳回所有可用的 `multiSign...Tx` 方法名稱陣列，用於多重簽名工作流程。
+
+**範例**
+
+```javascript Listing Available Transaction Methods icon=logos:javascript
+const sendMethods = client.getTxSendMethods();
+console.log('Available send methods:', sendMethods);
+// 範例輸出：[ 'sendPokeTx', 'sendTransferTx', ... ]
+```

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

@@ -0,0 +1,229 @@
+# 辅助方法
+
+`GraphQLClient` 类是与由 OCAP 驱动的区块链进行交互的主要接口。它提供了一套全面的方法，用于查询链状态、发送交易以及订阅实时事件。它被设计为可以在 Node.js 和浏览器环境中无缝工作。
+
+```javascript Client Initialization 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 Creating a Client Instance 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 Fetching Chain Context 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 Subscribing to New Blocks 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 Token Amount Conversion 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 Listing Available Transaction Methods icon=logos:javascript
+const sendMethods = client.getTxSendMethods();
+console.log('可用的发送方法：', sendMethods);
+// 示例输出：[ 'sendPokeTx', 'sendTransferTx', ... ]
+```