@ocap/client 1.25.4 → 1.25.5

package/docs/api-reference-transaction-helpers.zh-TW.md

@@ -0,0 +1,649 @@
+# 高階 API
+
+交易輔助工具是 OCAP Client 內建的高階函式，它將建立和簽署常見交易的複雜性抽象化。您無需手動建構交易物件，即可使用這些便利的方法來處理諸如建立資產、轉移代幣、質押和執行原子交換等工作流程。這些輔助工具確保交易結構正確，並顯著簡化開發過程。
+
+要更深入地了解底層的交易生命週期，請參閱 [核心概念：交易生命週期](./core-concepts-transaction-lifecycle.md)。
+
+---
+
+## 帳戶管理
+
+### migrateAccount
+
+將帳戶的所有權遷移到新的金鑰對。這對於金鑰輪換或帳戶恢復很有用。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="from" data-type="WalletObject" data-required="true" data-desc="要從中遷移的帳戶的錢包物件。"></x-field>
+  <x-field data-name="to" data-type="WalletObject" data-required="true" data-desc="要遷移到的帳戶的錢包物件。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send an AccountMigrateTx icon=logos:javascript
+const txHash = await client.migrateAccount({
+  from: oldWallet,
+  to: newWallet,
+});
+console.log('Migration transaction hash:', txHash);
+```
+
+### delegate
+
+授權另一個帳戶（受託人）代表委託人發送特定類型的交易。這是一個用於建立安全、沙盒化權限的強大功能。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="from" data-type="WalletObject" data-required="true" data-desc="委託人的錢包，即授予權限的一方。"></x-field>
+  <x-field data-name="to" data-type="WalletObject" data-required="true" data-desc="受託人的錢包，即接收權限的一方。"></x-field>
+  <x-field data-name="privileges" data-type="array" data-required="true" data-desc="一個指定允許操作的權限物件陣列。">
+    <x-field data-name="typeUrl" data-type="string" data-required="true" data-desc="被允許的交易的類型 URL（例如：'fg:t:transfer_v2'）。"></x-field>
+    <x-field data-name="limit" data-type="object" data-required="false" data-desc="對委託的可選限制。">
+      <x-field data-name="tokens" data-type="array" data-desc="對特定同質化代幣的限制。"></x-field>
+      <x-field data-name="assets" data-type="array" data-desc="對特定資產（NFT）的限制。"></x-field>
+    </x-field>
+  </x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="result" data-type="Promise<[string, string]>" data-desc="一個包含交易雜湊值和新建立的委託地址的陣列。"></x-field>
+
+**範例**
+
+```javascript Send a DelegateTx icon=logos:javascript
+const [txHash, delegateAddress] = await client.delegate({
+  from: userWallet,
+  to: appWallet,
+  privileges: [
+    {
+      typeUrl: 'fg:t:transfer_v2',
+    },
+  ],
+});
+console.log('Delegation tx hash:', txHash);
+console.log('Delegate address:', delegateAddress);
+```
+
+### revokeDelegate
+
+從受託人處撤銷先前授予的權限。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="from" data-type="WalletObject" data-required="true" data-desc="委託人的錢包。"></x-field>
+  <x-field data-name="to" data-type="WalletObject" data-required="true" data-desc="受託人的錢包。"></x-field>
+  <x-field data-name="privileges" data-type="array" data-required="true" data-desc="一個指定要撤銷權限的權限物件陣列。">
+     <x-field data-name="typeUrl" data-type="string" data-required="true" data-desc="要撤銷的交易的類型 URL（例如：'fg:t:transfer_v2'）。"></x-field>
+  </x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send a RevokeDelegateTx icon=logos:javascript
+const txHash = await client.revokeDelegate({
+  from: userWallet,
+  to: appWallet,
+  privileges: ['fg:t:transfer_v2'],
+});
+console.log('Revocation tx hash:', txHash);
+```
+
+---
+
+## 資產（NFT）管理
+
+### createAsset
+
+在區塊鏈上建立一個新資產（非同質化代幣）。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="moniker" data-type="string" data-required="true" data-desc="資產的簡短、易於閱讀的名稱。"></x-field>
+  <x-field data-name="data" data-type="object" data-required="true" data-desc="一個包含資產元資料的 JSON 物件。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="資產初始所有者的錢包。"></x-field>
+  <x-field data-name="parent" data-type="string" data-required="false" data-desc="父資產的地址，用於建立層級連結。"></x-field>
+  <x-field data-name="ttl" data-type="number" data-required="false" data-default="0" data-desc="首次消耗後的存活時間（以秒為單位）。"></x-field>
+  <x-field data-name="readonly" data-type="boolean" data-required="false" data-default="false" data-desc="如果為 true，資產在建立後無法更新。"></x-field>
+  <x-field data-name="transferrable" data-type="boolean" data-required="false" data-default="true" data-desc="如果為 true，資產可以轉移到另一個帳戶。"></x-field>
+  <x-field data-name="display" data-type="object" data-required="false" data-desc="用於資產顯示元資料的物件。"></x-field>
+  <x-field data-name="endpoint" data-type="object" data-required="false" data-desc="用於資產端點元資料的物件。"></x-field>
+  <x-field data-name="tags" 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-group>
+
+**返回**
+
+<x-field data-name="result" data-type="Promise<[string, string]>" data-desc="一個包含交易雜湊值和新建立資產地址的陣列。"></x-field>
+
+**範例**
+
+```javascript Send a CreateAssetTx icon=logos:javascript
+const [txHash, assetAddress] = await client.createAsset({
+  moniker: 'My First NFT',
+  data: {
+    typeUrl: 'json',
+    value: { name: 'Digital Collectible', description: 'A unique item.' },
+  },
+  wallet: userWallet,
+});
+console.log('Create asset tx hash:', txHash);
+console.log('New asset address:', assetAddress);
+```
+
+### updateAsset
+
+更新現有非唯讀資產的 `moniker` 和 `data` 欄位。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="address" data-type="string" data-required="true" data-desc="要更新的資產地址。"></x-field>
+  <x-field data-name="moniker" data-type="string" data-required="true" data-desc="資產的新標識名。"></x-field>
+  <x-field data-name="data" data-type="object" data-required="true" data-desc="資產的新 JSON 資料物件。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="資產當前所有者的錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send an UpdateAssetTx icon=logos:javascript
+const txHash = await client.updateAsset({
+  address: 'z3g...',
+  moniker: 'Updated NFT Name',
+  data: {
+    typeUrl: 'json',
+    value: { name: 'Updated Collectible', description: 'Now with more features!' },
+  },
+  wallet: userWallet,
+});
+console.log('Update asset tx hash:', txHash);
+```
+
+### createAssetFactory
+
+建立一個資產工廠，它作為模板，用於鑄造具有一致結構的多個新資產。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="factory" data-type="object" data-required="true" data-desc="一個包含工廠配置的物件。">
+    <x-field data-name="name" data-type="string" data-required="true" data-desc="工廠名稱。"></x-field>
+    <x-field data-name="description" data-type="string" data-required="true" data-desc="工廠描述。"></x-field>
+    <x-field data-name="limit" data-type="number" data-required="false" data-default="0" data-desc="可鑄造資產的最大數量（0 代表無限制）。"></x-field>
+    <x-field data-name="trustedIssuers" data-type="string[]" data-required="false" data-desc="允許從此工廠鑄造的錢包地址列表。"></x-field>
+    <x-field data-name="input" data-type="object" data-required="true" data-desc="定義鑄造所需的輸入。"></x-field>
+    <x-field data-name="output" data-type="object" data-required="true" data-desc="定義鑄造資產的結構，通常使用模板。"></x-field>
+  </x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="擁有該工廠的錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="result" data-type="Promise<[string, string]>" data-desc="一個包含交易雜湊值和新建立工廠地址的陣列。"></x-field>
+
+**範例**
+
+```javascript Send a CreateFactoryTx icon=logos:javascript
+const factoryConfig = {
+  name: 'Ticket Factory',
+  description: 'Mints event tickets',
+  limit: 1000,
+  input: { ... },
+  output: { ... },
+};
+
+const [txHash, factoryAddress] = await client.createAssetFactory({
+  factory: factoryConfig,
+  wallet: eventCreatorWallet,
+});
+console.log('Create factory tx hash:', txHash);
+console.log('New factory address:', factoryAddress);
+```
+
+### acquireAsset
+
+從現有資產工廠獲取（鑄造）一個新資產。這通常由將擁有該資產的終端使用者發起。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="itx" data-type="AcquireAssetV2Tx" data-required="true" data-desc="內部交易物件，通常使用像 `preMintAsset` 這樣的輔助工具來準備。"></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="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send an AcquireAssetV2Tx icon=logos:javascript
+// First, prepare the minting transaction (e.g., on the server)
+const itx = await client.preMintAsset({
+  factory: factoryAddress,
+  owner: userWallet.address,
+  wallet: issuerWallet,
+});
+
+// Then, the user sends the transaction
+const txHash = await client.acquireAsset({ itx, wallet: userWallet });
+console.log('Acquire asset tx hash:', txHash);
+```
+
+### mintAsset
+
+這是與 `acquireAsset` 相對應的發行方操作。它允許受信任的發行方從工廠鑄造資產並將其分配給指定的所有者。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="itx" data-type="MintAssetTx" data-required="true" data-desc="內部交易物件，通常使用 `preMintAsset` 準備。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="受信任發行方的錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send a MintAssetTx icon=logos:javascript
+const itx = await client.preMintAsset({
+  factory: factoryAddress,
+  owner: userWallet.address,
+  wallet: issuerWallet,
+});
+
+const txHash = await client.mintAsset({ itx, wallet: issuerWallet });
+console.log('Mint asset tx hash:', txHash);
+```
+
+---
+
+## 代幣管理
+
+### createTokenFactory
+
+建立一個用於鑄造和銷毀特定同質化代幣的新工廠，通常基於聯合曲線定價模型。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="feeRate" data-type="number" data-required="false" data-default="0" data-desc="鑄造和銷毀操作的手續費率。"></x-field>
+  <x-field data-name="curve" data-type="object" data-required="true" data-desc="用於定價的聯合曲線配置。"></x-field>
+  <x-field data-name="token" data-type="object" data-required="true">
+    <x-field-desc markdown>要建立的代幣的配置。這包括諸如 `name`、`symbol`、`decimal` 和 `maxTotalSupply` 等屬性。</x-field-desc>
+  </x-field>
+  <x-field data-name="data" data-type="object" data-required="false" data-desc="代幣工廠的可選元資料。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="工廠所有者的錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="result" data-type="Promise<[string, string]>" data-desc="一個包含交易雜湊值和新建立代幣工廠地址的陣列。"></x-field>
+
+**範例**
+
+```javascript Send a CreateTokenFactoryTx icon=logos:javascript
+const [txHash, factoryAddress] = await client.createTokenFactory({
+  feeRate: 100, // 1%
+  curve: { fixedPrice: '1' }, // 1 native token per new token
+  token: {
+    name: 'My Community Token',
+    symbol: 'MCT',
+    decimal: 18,
+    maxTotalSupply: '1000000',
+  },
+  wallet: creatorWallet,
+});
+console.log('Create token factory tx hash:', txHash);
+console.log('New token factory address:', factoryAddress);
+```
+
+### updateTokenFactory
+
+更新現有代幣工廠的 `feeRate` 和 `data`。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="address" data-type="string" data-required="true" data-desc="要更新的代幣工廠地址。"></x-field>
+  <x-field data-name="feeRate" data-type="number" data-required="false" data-desc="鑄造和銷毀的新手續費率。"></x-field>
+  <x-field data-name="data" data-type="object" data-required="false" data-desc="代幣工廠的新元資料。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="工廠所有者的錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send an UpdateTokenFactoryTx icon=logos:javascript
+const txHash = await client.updateTokenFactory({
+  address: 'z2f...',
+  feeRate: 50, // 0.5%
+  wallet: ownerWallet,
+});
+console.log('Update token factory tx hash:', txHash);
+```
+
+### mintToken
+
+從代幣工廠鑄造新代幣，以換取儲備代幣（通常是原生鏈代幣）。成本由工廠的聯合曲線決定。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="tokenFactory" data-type="string" data-required="true" data-desc="代幣工廠的地址。"></x-field>
+  <x-field data-name="amount" data-type="number" data-required="true" data-desc="要鑄造的新代幣數量。"></x-field>
+  <x-field data-name="receiver" data-type="string" data-required="true" data-desc="將接收新鑄造代幣的地址。"></x-field>
+  <x-field data-name="maxReserve" data-type="number" data-required="true" data-desc="使用者願意支付的儲備代幣最大數量。這可作為滑價保護。"></x-field>
+  <x-field data-name="data" data-type="object" data-required="false" data-desc="交易的可選元資料。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="發起鑄造的錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send a MintTokenTx icon=logos:javascript
+const txHash = await client.mintToken({
+  tokenFactory: 'z2f...',
+  amount: 100,
+  receiver: userWallet.address,
+  maxReserve: 105, // Willing to pay up to 105 native tokens
+  wallet: userWallet,
+});
+console.log('Mint token tx hash:', txHash);
+```
+
+### burnToken
+
+在工廠銷毀現有代幣，以換取底層儲備代幣。收到的儲備代幣數量由工廠的聯合曲線決定。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="tokenFactory" data-type="string" data-required="true" data-desc="代幣工廠的地址。"></x-field>
+  <x-field data-name="amount" data-type="number" data-required="true" data-desc="要銷毀的代幣數量。"></x-field>
+  <x-field data-name="receiver" data-type="string" data-required="true" data-desc="將接收儲備代幣的地址。"></x-field>
+  <x-field data-name="minReserve" data-type="number" data-required="true" data-desc="使用者預期收到的儲備代幣最小數量。這可作為滑價保護。"></x-field>
+  <x-field data-name="data" data-type="object" data-required="false" data-desc="交易的可選元資料。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="發起銷毀的錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send a BurnTokenTx icon=logos:javascript
+const txHash = await client.burnToken({
+  tokenFactory: 'z2f...',
+  amount: 50,
+  receiver: userWallet.address,
+  minReserve: 48, // Expecting to receive at least 48 native tokens
+  wallet: userWallet,
+});
+console.log('Burn token tx hash:', txHash);
+```
+
+---
+
+## 轉帳與交換
+
+### transfer
+
+在單一交易中將原生代幣、自訂同質化代幣和/或資產（NFT）轉移到另一個帳戶。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="to" data-type="string" 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="token" data-type="number" data-required="false" data-default="0" data-desc="要轉移的鏈原生代幣數量。"></x-field>
+  <x-field data-name="assets" data-type="string[]" data-required="false" data-desc="要轉移的資產地址（NFT）陣列。"></x-field>
+  <x-field data-name="tokens" data-type="object[]" data-required="false" data-desc="要轉移的自訂同質化代幣物件陣列。">
+    <x-field data-name="address" data-type="string" data-required="true" data-desc="自訂代幣合約的地址。"></x-field>
+    <x-field data-name="value" data-type="number" data-required="true" data-desc="要轉移的自訂代幣數量。"></x-field>
+  </x-field>
+  <x-field data-name="memo" 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-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send a TransferV2Tx icon=logos:javascript
+const txHash = await client.transfer({
+  to: 'z1sb...',
+  token: 1.5, // 1.5 of the native chain token
+  assets: ['z3g...'], // An NFT
+  tokens: [{ address: 'z2t...', value: 100 }], // 100 of a custom token
+  memo: 'Payment for services',
+  wallet: senderWallet,
+});
+console.log('Transfer tx hash:', txHash);
+```
+
+### prepareExchange
+
+準備原子交換交易中發送方的一半。它會簽署發送方的報價，並返回一個可以傳遞給接收方的交易物件。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="receiver" data-type="string" 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="offerToken" data-type="number" data-required="false" data-desc="提供的原生代幣數量。"></x-field>
+  <x-field data-name="offerAssets" data-type="string[]" data-required="false" data-desc="提供的資產地址陣列。"></x-field>
+  <x-field data-name="offerTokens" data-type="object[]" data-required="false" data-desc="提供的自訂同質化代幣陣列。"></x-field>
+  <x-field data-name="demandToken" data-type="number" data-required="false" data-desc="要求回報的原生代幣數量。"></x-field>
+  <x-field data-name="demandAssets" data-type="string[]" data-required="false" data-desc="要求回報的資產地址陣列。"></x-field>
+  <x-field data-name="demandTokens" data-type="object[]" data-required="false" data-desc="要求回報的自訂同質化代幣陣列。"></x-field>
+  <x-field data-name="memo" data-type="string" data-required="false" data-desc="交易的可選備註。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionObject" data-type="Promise<object>" data-desc="部分簽署的交易物件。"></x-field>
+
+### finalizeExchange
+
+完成原子交換中接收方的一半。它接收來自 `prepareExchange` 的部分簽署交易，添加接收方的簽名，並返回完全簽署的交易物件。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true" data-desc="從 `prepareExchange` 返回的交易物件。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="接受報價的使用者錢包。"></x-field>
+  <x-field data-name="data" data-type="object" data-required="false" data-desc="多重簽名中的額外資料。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionObject" data-type="Promise<object>" data-desc="完全簽署的多重簽名交易物件。"></x-field>
+
+### exchange
+
+將完全簽署的交換交易發送到區塊鏈。在 `finalizeExchange` 完成後，任何一方都可以呼叫此函式。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="tx" data-type="object" data-required="true" data-desc="從 `finalizeExchange` 返回的交易物件。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="提交交易的使用者錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例（完整交換流程）**
+
+```javascript Perform an atomic swap icon=logos:javascript
+// 1. Offerer prepares the transaction
+const offerTx = await client.prepareExchange({
+  receiver: receiverWallet.address,
+  offerAssets: ['z3g...'], // Offer an NFT
+  demandToken: 10, // Demand 10 native tokens
+  wallet: offererWallet,
+});
+
+// 2. Receiver finalizes the transaction
+const finalTx = await client.finalizeExchange({
+  tx: offerTx,
+  wallet: receiverWallet,
+});
+
+// 3. Either party can send the finalized transaction
+const txHash = await client.exchange({ tx: finalTx, wallet: offererWallet });
+console.log('Exchange tx hash:', txHash);
+```
+
+---
+
+## 質押
+
+### stake
+
+將代幣和/或資產質押到一個接收方地址。質押會鎖定資源，通常是為了換取獎勵或提供安全性。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="to" data-type="string" 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="assets" data-type="string[]" data-required="false" data-desc="要質押的資產地址陣列。"></x-field>
+  <x-field data-name="tokens" data-type="object[]" data-required="false" data-desc="要質押的同質化代幣物件陣列。"></x-field>
+  <x-field data-name="locked" data-type="boolean" data-required="false" data-default="false" data-desc="質押在建立時是否被鎖定。"></x-field>
+  <x-field data-name="slashers" data-type="string[]" data-required="false" data-desc="被允許懲罰此質押的地址列表。"></x-field>
+  <x-field data-name="message" data-type="string" data-required="false" data-desc="質押的可選備註。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="result" data-type="Promise<[string, string]>" data-desc="一個包含交易雜湊值和新建立質押地址的陣列。"></x-field>
+
+**範例**
+
+```javascript Send a StakeTx icon=logos:javascript
+const [txHash, stakeAddress] = await client.stake({
+  to: 'z1v...',
+  tokens: [{ address: 'z2t...', value: 5000 }],
+  message: 'Staking for validator rewards',
+  wallet: userWallet,
+});
+console.log('Stake tx hash:', txHash);
+console.log('New stake address:', stakeAddress);
+```
+
+### revokeStake
+
+撤銷先前質押的代幣和/或資產，啟動將其歸還給所有者的流程。請注意，在資產可以領取之前，可能會有一個解綁期。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="from" data-type="string" 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="assets" data-type="string[]" data-required="false" data-desc="要撤銷的資產地址陣列。"></x-field>
+  <x-field data-name="tokens" data-type="object[]" data-required="false" data-desc="要撤銷的同質化代幣物件陣列。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send a RevokeStakeTx icon=logos:javascript
+const txHash = await client.revokeStake({
+  from: 'z6s...',
+  tokens: [{ address: 'z2t...', value: 1000 }],
+  wallet: userWallet,
+});
+console.log('Revoke stake tx hash:', txHash);
+```
+
+### claimStake
+
+領取已成功撤銷並度過解綁期的質押物品。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="from" data-type="string" data-required="true" data-desc="要從中領取的質押地址。"></x-field>
+  <x-field data-name="evidence" data-type="string" data-required="true" data-desc="`revokeStake` 交易的交易雜湊值。"></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="質押所有者的錢包。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send a ClaimStakeTx icon=logos:javascript
+const revokeTxHash = '0x123...abc';
+const txHash = await client.claimStake({
+  from: 'z6s...',
+  evidence: revokeTxHash,
+  wallet: userWallet,
+});
+console.log('Claim stake tx hash:', txHash);
+```
+
+### slashStake
+
+允許指定的懲罰者對質押進行懲罰，通常是因為不當行為。被懲罰的資產將被轉移到指定的金庫地址。
+
+**參數**
+
+<x-field-group>
+  <x-field data-name="from" data-type="string" data-required="true" data-desc="要懲罰的質押地址。"></x-field>
+  <x-field data-name="reason" data-type="string" 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="assets" data-type="string[]" data-required="false" data-desc="要懲罰的資產地址陣列。"></x-field>
+  <x-field data-name="tokens" data-type="object[]" data-required="false" data-desc="要懲罰的同質化代幣物件陣列。"></x-field>
+</x-field-group>
+
+**返回**
+
+<x-field data-name="transactionHash" data-type="Promise<string>" data-desc="已提交交易的雜湊值。"></x-field>
+
+**範例**
+
+```javascript Send a SlashStakeTx icon=logos:javascript
+const txHash = await client.slashStake({
+  from: 'z6s...',
+  reason: 'Validator downtime',
+  tokens: [{ address: 'z2t...', value: 500 }],
+  wallet: slasherWallet,
+});
+console.log('Slash stake tx hash:', txHash);
+```