@ocap/client 1.25.3 → 1.25.5

package/docs/api-reference-low-level-api.zh-TW.md

@@ -0,0 +1,228 @@
+# 低階 API
+
+The Low-level API 提供了對整個交易生命週期的精細控制。與將細節抽象化的 [高階 API](./api-reference-transaction-helpers.md) 不同，這些方法允許您手動建構、編碼、簽署和發送交易。這對於進階場景非常理想，例如多重簽名工作流程，其中不同方需要在廣播交易之前簽署交易。
+
+此 API 分為四個主要的方法群組，每個群組對應交易生命週期中的一個階段：
+
+1.  **編碼**：準備一筆交易並將其序列化為二進位緩衝區。
+2.  **簽署**：為已編碼的交易新增數位簽章。
+3.  **多重簽署**：為一筆交易新增多個數位簽章。
+4.  **發送**：將已簽署的交易廣播到區塊鏈。
+
+## 編碼交易
+
+編碼是建立交易的第一步。`encode[Type]Tx` 方法會接收核心交易資料（`itx`）並將其包裝在標準交易結構中，新增必要的細節，如 `chainId` 和 `nonce`。結果是一個可讀的交易物件和一個準備好簽署的二進位緩衝區。
+
+鏈支援的每種交易類型都有一個 `encode` 方法。您可以透過呼叫 `client.getTxEncodeMethods()` 來取得完整列表。
+
+### `encode[Type]Tx(payload)`
+
+編碼一筆交易而不進行簽署。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true">
+    <x-field-desc markdown>交易資料物件。</x-field-desc>
+    <x-field data-name="itx" data-type="object" data-required="true" data-desc="特定於交易類型的內部交易物件。"></x-field>
+    <x-field data-name="from" data-type="string" data-required="false" data-desc="發送者地址。如果未提供，則從錢包中衍生。"></x-field>
+    <x-field data-name="nonce" data-type="number" data-required="false" data-desc="交易 nonce。如果未設定，預設為 `Date.now()`。"></x-field>
+    <x-field data-name="chainId" data-type="string" data-required="false" data-desc="鏈 ID。如果未提供，則從連接的節點中獲取。"></x-field>
+  </x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="用於衍生發送者地址和公鑰的錢包物件。"></x-field>
+  <x-field data-name="delegator" data-type="string" data-required="false" data-desc="委託權限的帳戶地址（如適用）。"></x-field>
+</x-field-group>
+
+**回傳值**
+
+<x-field data-name="Promise<object>" data-type="Promise<object>" data-desc="一個解析為包含已編碼交易物件的 promise。">
+  <x-field data-name="object" data-type="object" data-desc="可讀的交易物件。"></x-field>
+  <x-field data-name="buffer" data-type="Buffer" data-desc="已序列化的交易二進位緩衝區，準備好進行簽署。"></x-field>
+</x-field>
+
+**範例**
+
+```javascript TransferV2Tx icon=logos:javascript
+const { encodeTransferV2Tx } = client;
+const senderWallet = fromRandom();
+const receiverAddress = 'z1...';
+
+const { object, buffer } = await encodeTransferV2Tx({
+  tx: {
+    itx: {
+      to: receiverAddress,
+      value: await client.fromTokenToUnit(10), // 轉移 10 個原生代幣
+    },
+  },
+  wallet: senderWallet,
+});
+
+console.log('已編碼的交易物件：', object);
+console.log('待簽署的緩衝區：', buffer.toString('hex'));
+```
+
+## 簽署交易
+
+The `sign[Type]Tx` 方法建立在編碼步驟之上，透過新增數位簽章。這些方法會編碼交易，然後使用提供的錢包來簽署產生的二進位緩衝區。
+
+您可以透過呼叫 `client.getTxSignMethods()` 來取得所有可用的簽署方法列表。
+
+### `sign[Type]Tx(payload)`
+
+編碼並簽署一筆交易。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true" data-desc="交易資料物件，與編碼時相同。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="用於簽署交易的錢包。"></x-field>
+  <x-field data-name="delegator" data-type="string" data-required="false" data-desc="委託人地址（如適用）。"></x-field>
+  <x-field data-name="encoding" data-type="string" data-required="false" data-desc="輸出的可選編碼（'base16'、'hex'、'base58'、'base64'）。如果省略，則回傳交易物件。"></x-field>
+</x-field-group>
+
+**回傳值**
+
+<x-field data-name="Promise<object|string>" data-type="Promise<object|string>" data-desc="一個解析為已簽署交易物件的 promise，如果指定了 `encoding`，則為編碼後的字串。"></x-field>
+
+**範例**
+
+```javascript TransferV2Tx icon=logos:javascript
+const { signTransferV2Tx } = client;
+const senderWallet = fromRandom();
+const receiverAddress = 'z1...';
+
+const signedTx = await signTransferV2Tx({
+  tx: {
+    itx: {
+      to: receiverAddress,
+      value: await client.fromTokenToUnit(10),
+    },
+  },
+  wallet: senderWallet,
+});
+
+console.log('已簽署的交易：', signedTx);
+```
+
+## 發送交易
+
+The `send[Type]Tx` 方法負責將交易廣播到區塊鏈。如果提供了未簽署的交易和錢包，這些方法可以隱式地執行簽署步驟，或者它們可以發送已經簽署的交易。
+
+可透過 `client.getTxSendMethods()` 取得完整的發送方法列表。
+
+### `send[Type]Tx(payload)`
+
+簽署（如果需要）並將交易發送到鏈上。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true" data-desc="交易物件。可以是已簽署或未簽署的。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="用於簽署交易的錢包。即使交易已預先簽署，仍需要此錢包來識別發送者。"></x-field>
+  <x-field data-name="signature" data-type="string" data-required="false" data-desc="交易的預先計算簽章。如果提供此項，錢包將不會再次用於簽署。"></x-field>
+  <x-field data-name="delegator" data-type="string" data-required="false" data-desc="委託人地址（如適用）。"></x-field>
+  <x-field data-name="commit" data-type="boolean" data-default="false" data-required="false" data-desc="是否在解析前回傳，等待交易被提交到區塊中。"></x-field>
+</x-field-group>
+
+**回傳值**
+
+<x-field data-name="Promise<string>" data-type="Promise<string>" data-desc="一個解析為交易雜湊值的 promise。"></x-field>
+
+**範例：自動簽署**
+
+```javascript TransferV2Tx icon=logos:javascript
+const { sendTransferV2Tx } = client;
+const senderWallet = fromRandom();
+const receiverAddress = 'z1...';
+
+// 客戶端將在發送前使用 senderWallet 簽署此交易。
+const txHash = await sendTransferV2Tx({
+  tx: {
+    itx: {
+      to: receiverAddress,
+      value: await client.fromTokenToUnit(10),
+    },
+  },
+  wallet: senderWallet,
+});
+
+console.log('已發送交易，雜湊值為：', txHash);
+```
+
+**範例：發送預先簽署的交易**
+
+```javascript TransferV2Tx icon=logos:javascript
+// 假設 signedTx 來自 sign[Type]Tx 範例
+const { sendTransferV2Tx } = client;
+
+const txHash = await sendTransferV2Tx({
+  tx: signedTx, // 傳入整個已簽署的交易物件
+  wallet: senderWallet,
+});
+
+console.log('已發送預先簽署的交易，雜湊值為：', txHash);
+```
+
+## 多重簽章交易
+
+對於需要多個簽章的工作流程（例如原子交換），會使用 `multiSign[Type]Tx` 方法。該過程涉及一方首先簽署交易（使用標準的 `sign[Type]Tx` 方法），然後後續各方使用相應的 `multiSign[Type]Tx` 方法新增其簽章。
+
+您可以透過 `client.getTxMultiSignMethods()` 取得支援多重簽章的交易列表。
+
+### `multiSign[Type]Tx(payload)`
+
+為一個已有一或多個簽章的交易新增一個簽章。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true" data-desc="交易物件，應已包含至少一個簽章。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="目前簽署者的錢包。"></x-field>
+  <x-field data-name="delegator" data-type="string" data-required="false" data-desc="目前簽署者的委託人地址（如適用）。"></x-field>
+  <x-field data-name="data" data-type="any" data-required="false" data-desc="可選資料，與簽章一起包含。"></x-field>
+  <x-field data-name="encoding" data-type="string" data-required="false" data-desc="輸出的可選編碼（'base16'、'hex'、'base58'、'base64'）。"></x-field>
+</x-field-group>
+
+**回傳值**
+
+<x-field data-name="Promise<object|string>" data-type="Promise<object|string>" data-desc="一個解析為新增了新簽章的交易物件的 promise。"></x-field>
+
+**範例：原子交換 (`ExchangeV2Tx`)**
+
+```javascript ExchangeV2Tx icon=logos:javascript
+// 兩方的錢包
+const aliceWallet = fromRandom();
+const bobWallet = fromRandom();
+
+// 1. Alice 準備並簽署初始交換交易
+const exchangeTx = {
+  itx: {
+    to: bobWallet.address,
+    sender: {
+      value: await client.fromTokenToUnit(10), // Alice 提供 10 個代幣
+    },
+    receiver: {
+      value: await client.fromTokenToUnit(5), // Alice 要求 5 個代幣
+    },
+  },
+};
+
+const signedByAlice = await client.signExchangeV2Tx({
+  tx: exchangeTx,
+  wallet: aliceWallet,
+});
+
+// 2. Alice 將 `signedByAlice` 發送給 Bob。Bob 新增他的簽章。
+const signedByBoth = await client.multiSignExchangeV2Tx({
+  tx: signedByAlice,
+  wallet: bobWallet,
+});
+
+// 3. Bob 將 `signedByBoth` 發回給 Alice。Alice 發送最終交易。
+const txHash = await client.sendExchangeV2Tx({
+  tx: signedByBoth,
+  wallet: aliceWallet, // 使用發送者錢包提交
+});
+
+console.log('原子交換交易已發送：', txHash);
+```

package/docs/api-reference-low-level-api.zh.md

@@ -0,0 +1,228 @@
+# 低级 API
+
+低级 API 提供了对整个交易生命周期的精细控制。与抽象掉细节的 [高级 API](./api-reference-transaction-helpers.md) 不同，这些方法允许你手动构建、编码、签名和发送交易。这对于高级场景非常理想，例如多重签名工作流，其中不同方需要在交易广播前对其进行签名。
+
+该 API 分为四个主要的方法组，每个方法组对应交易生命周期的一个阶段：
+
+1.  **编码**：准备一笔交易并将其序列化为二进制缓冲区。
+2.  **签名**：向已编码的交易添加数字签名。
+3.  **多签**：向一笔交易添加多个数字签名。
+4.  **发送**：将已签名的交易广播到区块链。
+
+## 编码交易
+
+编码是创建交易的第一步。`encode[Type]Tx` 方法接收核心交易数据 (`itx`)，并将其包装在标准交易结构中，添加 `chainId` 和 `nonce` 等必要信息。结果是一个人类可读的交易对象和一个可供签名的二进制缓冲区。
+
+链支持的每种交易类型都有一个 `encode` 方法。你可以通过调用 `client.getTxEncodeMethods()` 获取完整列表。
+
+### `encode[Type]Tx(payload)`
+
+编码一笔交易，但不进行签名。
+
+**Parameters**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true">
+    <x-field-desc markdown>交易数据对象。</x-field-desc>
+    <x-field data-name="itx" data-type="object" data-required="true" data-desc="特定于交易类型的内部交易对象。"></x-field>
+    <x-field data-name="from" data-type="string" data-required="false" data-desc="发送方地址。如果未提供，则从钱包中派生。"></x-field>
+    <x-field data-name="nonce" data-type="number" data-required="false" data-desc="交易 nonce。如果未设置，默认为 `Date.now()`。"></x-field>
+    <x-field data-name="chainId" data-type="string" data-required="false" data-desc="链 ID。如果未提供，则从连接的节点获取。"></x-field>
+  </x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="用于派生发送方地址和公钥的钱包对象。"></x-field>
+  <x-field data-name="delegator" data-type="string" data-required="false" data-desc="委托权限的账户地址（如果适用）。"></x-field>
+</x-field-group>
+
+**Returns**
+
+<x-field data-name="Promise<object>" data-type="Promise<object>" data-desc="一个 promise，解析为一个包含已编码交易的对象。">
+  <x-field data-name="object" data-type="object" data-desc="人类可读的交易对象。"></x-field>
+  <x-field data-name="buffer" data-type="Buffer" data-desc="序列化后的交易二进制缓冲区，可供签名。"></x-field>
+</x-field>
+
+**示例**
+
+```javascript TransferV2Tx icon=logos:javascript
+const { encodeTransferV2Tx } = client;
+const senderWallet = fromRandom();
+const receiverAddress = 'z1...';
+
+const { object, buffer } = await encodeTransferV2Tx({
+  tx: {
+    itx: {
+      to: receiverAddress,
+      value: await client.fromTokenToUnit(10), // 转移 10 个原生代币
+    },
+  },
+  wallet: senderWallet,
+});
+
+console.log('已编码的交易对象:', object);
+console.log('待签名的缓冲区:', buffer.toString('hex'));
+```
+
+## 签名交易
+
+`sign[Type]Tx` 方法在编码步骤的基础上添加了数字签名。这些方法会对交易进行编码，然后使用提供的钱包对生成的二进制缓冲区进行签名。
+
+你可以通过调用 `client.getTxSignMethods()` 获取所有可用的签名方法列表。
+
+### `sign[Type]Tx(payload)`
+
+编码并签名一笔交易。
+
+**Parameters**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true" data-desc="交易数据对象，与编码时相同。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="用于签名交易的钱包。"></x-field>
+  <x-field data-name="delegator" data-type="string" data-required="false" data-desc="委托人地址（如果适用）。"></x-field>
+  <x-field data-name="encoding" data-type="string" data-required="false" data-desc="输出的可选编码（'base16'、'hex'、'base58'、'base64'）。如果省略，则返回交易对象。"></x-field>
+</x-field-group>
+
+**Returns**
+
+<x-field data-name="Promise<object|string>" data-type="Promise<object|string>" data-desc="一个 promise，解析为已签名的交易对象，如果指定了 `encoding`，则解析为编码后的字符串。"></x-field>
+
+**示例**
+
+```javascript TransferV2Tx icon=logos:javascript
+const { signTransferV2Tx } = client;
+const senderWallet = fromRandom();
+const receiverAddress = 'z1...';
+
+const signedTx = await signTransferV2Tx({
+  tx: {
+    itx: {
+      to: receiverAddress,
+      value: await client.fromTokenToUnit(10),
+    },
+  },
+  wallet: senderWallet,
+});
+
+console.log('已签名的交易:', signedTx);
+```
+
+## 发送交易
+
+`send[Type]Tx` 方法负责将交易广播到区块链。如果提供了未签名的交易和钱包，这些方法可以隐式执行签名步骤，或者它们也可以发送已经签名的交易。
+
+可以通过 `client.getTxSendMethods()` 获取完整的发送方法列表。
+
+### `send[Type]Tx(payload)`
+
+签名（如果需要）并将交易发送到链上。
+
+**Parameters**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true" data-desc="交易对象。可以是已签名或未签名的。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="用于签名交易的钱包。即使交易已预签名，仍需此钱包来识别发送方。"></x-field>
+  <x-field data-name="signature" data-type="string" data-required="false" data-desc="交易的预计算签名。如果提供，将不会再使用钱包进行签名。"></x-field>
+  <x-field data-name="delegator" data-type="string" data-required="false" data-desc="委托人地址（如果适用）。"></x-field>
+  <x-field data-name="commit" data-type="boolean" data-default="false" data-required="false" data-desc="是否在解析前等待交易被提交到区块。"></x-field>
+</x-field-group>
+
+**Returns**
+
+<x-field data-name="Promise<string>" data-type="Promise<string>" data-desc="一个 promise，解析为交易哈希。"></x-field>
+
+**示例：自动签名**
+
+```javascript TransferV2Tx icon=logos:javascript
+const { sendTransferV2Tx } = client;
+const senderWallet = fromRandom();
+const receiverAddress = 'z1...';
+
+// 客户端将在发送前使用 senderWallet 签名此交易。
+const txHash = await sendTransferV2Tx({
+  tx: {
+    itx: {
+      to: receiverAddress,
+      value: await client.fromTokenToUnit(10),
+    },
+  },
+  wallet: senderWallet,
+});
+
+console.log('交易已发送，哈希值为:', txHash);
+```
+
+**示例：发送预签名交易**
+
+```javascript TransferV2Tx icon=logos:javascript
+// 假设 signedTx 来自 sign[Type]Tx 示例
+const { sendTransferV2Tx } = client;
+
+const txHash = await sendTransferV2Tx({
+  tx: signedTx, // 传入整个已签名的交易对象
+  wallet: senderWallet,
+});
+
+console.log('预签名交易已发送，哈希值为:', txHash);
+```
+
+## 多重签名交易
+
+对于需要多个签名（如原子交换）的工作流，使用 `multiSign[Type]Tx` 方法。该过程涉及一方首先签名交易（使用标准的 `sign[Type]Tx` 方法），然后后续各方使用相应的 `multiSign[Type]Tx` 方法添加他们的签名。
+
+你可以通过 `client.getTxMultiSignMethods()` 获取支持多重签名的交易列表。
+
+### `multiSign[Type]Tx(payload)`
+
+向已有一个或多个签名的交易添加一个签名。
+
+**Parameters**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true" data-desc="交易对象，应已包含至少一个签名。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="当前签名者的钱包。"></x-field>
+  <x-field data-name="delegator" data-type="string" data-required="false" data-desc="当前签名者的委托人地址（如果适用）。"></x-field>
+  <x-field data-name="data" data-type="any" data-required="false" data-desc="签名中包含的可选数据。"></x-field>
+  <x-field data-name="encoding" data-type="string" data-required="false" data-desc="输出的可选编码（'base16'、'hex'、'base58'、'base64'）。"></x-field>
+</x-field-group>
+
+**Returns**
+
+<x-field data-name="Promise<object|string>" data-type="Promise<object|string>" data-desc="一个 promise，解析为添加了新签名的交易对象。"></x-field>
+
+**示例：原子交换 (`ExchangeV2Tx`)**
+
+```javascript ExchangeV2Tx icon=logos:javascript
+// 双方的钱包
+const aliceWallet = fromRandom();
+const bobWallet = fromRandom();
+
+// 1. Alice 准备并签署初始交换交易
+const exchangeTx = {
+  itx: {
+    to: bobWallet.address,
+    sender: {
+      value: await client.fromTokenToUnit(10), // Alice 提供 10 个代币
+    },
+    receiver: {
+      value: await client.fromTokenToUnit(5), // Alice 要求 5 个代币
+    },
+  },
+};
+
+const signedByAlice = await client.signExchangeV2Tx({
+  tx: exchangeTx,
+  wallet: aliceWallet,
+});
+
+// 2. Alice 将 `signedByAlice` 发送给 Bob。Bob 添加他的签名。
+const signedByBoth = await client.multiSignExchangeV2Tx({
+  tx: signedByAlice,
+  wallet: bobWallet,
+});
+
+// 3. Bob 将 `signedByBoth` 发回给 Alice。Alice 发送最终交易。
+const txHash = await client.sendExchangeV2Tx({
+  tx: signedByBoth,
+  wallet: aliceWallet, // 使用发送方钱包提交
+});
+
+console.log('原子交换交易已发送:', txHash);
+```