@ocap/client 1.25.4 → 1.25.5

package/docs/how-to-guides-manage-tokens.zh.md

@@ -1,42 +1,42 @@
-# 管理代币
+# 管理通证
 
-本指南提供了使用 OCAP Client 管理同质化代幣的详细步骤。你将学习如何设置代币工厂（作为代币的蓝图），并使用它来铸造（创建新代币）和销毁（销毁现有代币）。这些操作是在你的应用程序中创建和管理自定义经济体系的基础。
+本指南提供了使用 OCAP Client 管理同质化通证的分步说明。你将学习如何设置一个通证工厂（它作为你通证的蓝图），然后用它来铸造（创建新通证）和销毁（销毁现有通证）。这些操作是在你的应用程序中创建和管理自定义经济体系的基础。
 
-铸造代币后，你可以在账户之间进行转移。有关该过程的更多详细信息，请参阅[转移代币和 NFT](./how-to-guides-transfer-tokens-and-nfts.md)指南。
+一旦你铸造了通证，你就可以在账户之间转移它们。有关该过程的更多详细信息，请参阅[转移通证和 NFT](./how-to-guides-transfer-tokens-and-nfts.md)指南。
 
-## 创建代币工厂
+## 创建通证工厂
 
-代币工厂是一种智能合约，用于定义同质化代幣的属性和规则，例如其名称、符号和供应机制。它还管理铸造和销毁的过程。创建工厂是将任何新代币投入流通的第一步。
+通证工厂是一个智能合约，它定义了同质化通证的属性和规则，例如其名称、符号和供应机制。它还管理铸造和销毁的过程。创建工厂是任何新通证进入流通之前的第一个步骤。
 
-`createTokenFactory` 方法将一个新的代币工厂部署到区块链上。
+`createTokenFactory` 方法将一个新的通证工厂部署到区块链上。
 
 ### 参数
 <x-field-group>
   <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="工厂所有者的钱包对象，用于签署交易。"></x-field>
-  <x-field data-name="token" data-type="object" data-required="true" data-desc="一个定义待创建代币属性的对象。">
-    <x-field data-name="name" data-type="string" data-required="true" data-desc="代币的全名（例如，'My Awesome Token'）。"></x-field>
-    <x-field data-name="symbol" data-type="string" data-required="true" data-desc="代币的股票代码符号（例如，'MAT'）。"></x-field>
-    <x-field data-name="decimal" data-type="number" data-required="true" data-desc="代币支持的小数位数。"></x-field>
-    <x-field data-name="description" data-type="string" data-required="false" data-desc="代币的简要描述。"></x-field>
-    <x-field data-name="icon" data-type="string" data-required="false" data-desc="代币图标的 URL。"></x-field>
-    <x-field data-name="maxTotalSupply" data-type="number" data-required="false" data-desc="可铸造的最大总供应量。"></x-field>
+  <x-field data-name="token" 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="symbol" data-type="string" data-required="true" data-desc="通证的股票代码符号（例如，'MAT'）。"></x-field>
+    <x-field data-name="decimal" data-type="number" data-required="true" data-desc="通证支持的小数位数。"></x-field>
+    <x-field data-name="description" data-type="string" data-required="false" data-desc="通证的简要描述。"></x-field>
+    <x-field data-name="icon" data-type="string" data-required="false" data-desc="通证图标的 URL。"></x-field>
+    <x-field data-name="maxTotalSupply" data-type="number" data-required="false" data-desc="可以铸造的最大总供应量。"></x-field>
   </x-field>
-  <x-field data-name="curve" data-type="object" data-required="false" data-desc="联合曲线的配置，以编程方式控制代币价格。如果省略，铸造/销毁将不与储备代币挂钩。">
-    <x-field data-name="basePrice" data-type="number" data-required="false" data-desc="以储备货币计价的代币基础价格。"></x-field>
-    <x-field data-name="fixedPrice" data-type="number" data-required="false" data-desc="代币的固定价格，如果不使用动态曲线。"></x-field>
+  <x-field data-name="curve" data-type="object" data-required="false" data-desc="联合曲线的配置，它以编程方式控制通证的价格。如果省略，铸造/销毁将不与储备通证挂钩。">
+    <x-field data-name="basePrice" data-type="number" data-required="false" data-desc="以储备货币计价的通证基础价格。"></x-field>
+    <x-field data-name="fixedPrice" data-type="number" data-required="false" data-desc="通证的固定价格，如果不使用动态曲线。"></x-field>
     <x-field data-name="slope" data-type="number" data-required="false" data-desc="联合曲线的斜率，决定其陡峭程度。"></x-field>
   </x-field>
   <x-field data-name="feeRate" data-type="number" data-default="0" 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="data" data-type="object" data-required="false" data-desc="附加到通证工厂的可选自定义数据。"></x-field>
 </x-field-group>
 
 ### 返回值
 
-返回一个 promise，该 promise 解析为一个数组，其中包含交易哈希和新创建的代币工厂的地址。
+返回一个 promise，该 promise 解析为一个数组，其中包含交易哈希和新创建的通证工厂地址。
 
 <x-field-group>
-  <x-field data-name="[0]" data-type="string" data-desc="创建工厂的交易哈希。"></x-field>
-  <x-field data-name="[1]" data-type="string" data-desc="新代币工厂的地址。"></x-field>
+  <x-field data-name="[0]" data-type="string" data-desc="工厂创建的交易哈希。"></x-field>
+  <x-field data-name="[1]" data-type="string" data-desc="新通证工厂的地址。"></x-field>
 </x-field-group>
 
 ### 示例
@@ -49,7 +49,7 @@ const endpoint = 'https://beta.abtnetwork.io/api';
 const client = new Client(endpoint);
 const wallet = Wallet.fromRandom();
 
-// 首先，确保钱包中有资金。你可以从水龙头获取测试代币：
+// 首先，确保钱包有资金。你可以从水龙头获取测试通证：
 // https://faucet.abtnetwork.io/
 
 async function createFactory() {
@@ -66,31 +66,31 @@ async function createFactory() {
       feeRate: 100, // 1% 的费用
     });
 
-    console.log('代币工厂创建成功！');
-    console.log('交易哈希：', hash);
-    console.log('工厂地址：', factoryAddress);
+    console.log('通证工厂创建成功！');
+    console.log('交易哈希:', hash);
+    console.log('工厂地址:', factoryAddress);
     return factoryAddress;
   } catch (error) {
-    console.error('创建代币工厂时出错：', error);
+    console.error('创建通证工厂时出错:', error);
   }
 }
 
 createFactory();
 ```
 
-## 铸造代币
+## 铸造通证
 
-铸造是创建新代币并将其添加到总供应量中的过程。这是通过代币工厂完成的。如果工厂配置了联合曲线，铸造将需要使用储备代币进行支付。
+铸造是创建新通证并将其添加到总供应量中的过程。这是通过通证工厂完成的。如果工厂配置了联合曲线，铸造将需要使用储备通证进行支付。
 
-`mintToken` 方法会启动一个交易，从工厂铸造指定数量的代币。
+`mintToken` 方法启动一个交易，从工厂铸造指定数量的通证。
 
 ### 参数
 <x-field-group>
   <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="为铸造操作提供资金并签署交易的钱包。"></x-field>
-  <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="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-group>
 
@@ -109,14 +109,14 @@ async function mintNewTokens(factoryAddress) {
       wallet,
       tokenFactory: factoryAddress,
       amount: 5000,
-      receiver: wallet.address, // 将代币铸造到我们自己的钱包
-      maxReserve: 10, // 支付的最大储备代币。根据联合曲线价格进行调整。
+      receiver: wallet.address, // 将通证铸造到我们自己的钱包
+      maxReserve: 10, // 支付的最大储备通证。根据联合曲线价格进行调整。
     });
 
-    console.log('代币铸造成功！');
-    console.log('交易哈希：', hash);
+    console.log('通证铸造成功！');
+    console.log('交易哈希:', hash);
   } catch (error) {
-    console.error('铸造代币时出错：', error);
+    console.error('铸造通证时出错:', error);
   }
 }
 
@@ -125,19 +125,19 @@ async function mintNewTokens(factoryAddress) {
 // mintNewTokens(factoryAddress);
 ```
 
-## 销毁代币
+## 销毁通证
 
-销毁与铸造相反；它会永久地将代币从流通中移除。如果代币工厂使用联合曲线，销毁代币将向用户返回相应比例的储备货币。
+销毁与铸造相反；它会永久地将通证从流通中移除。如果通证工厂使用联合曲线，销毁通证将向用户返回相应比例的储备货币。
 
-`burnToken` 方法会启动此过程。
+`burnToken` 方法启动此过程。
 
 ### 参数
 <x-field-group>
-  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="持有待销毁代币并将签署交易的钱包。"></x-field>
-  <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="wallet" data-type="WalletObject" data-required="true" data-desc="持有待销毁通证并将签署交易的钱包。"></x-field>
+  <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-group>
 
@@ -156,14 +156,14 @@ async function burnExistingTokens(factoryAddress) {
       wallet,
       tokenFactory: factoryAddress,
       amount: 1000,
-      receiver: wallet.address, // 将储备代币接收回我们自己的钱包
-      minReserve: 1, // 接收的最低储备代币。根据联合曲线价格进行调整。
+      receiver: wallet.address, // 将储备通证接收回我们自己的钱包
+      minReserve: 1, // 接收的最小储备通证。根据联合曲线价格进行调整。
     });
 
-    console.log('代币销毁成功！');
-    console.log('交易哈希：', hash);
+    console.log('通证销毁成功！');
+    console.log('交易哈希:', hash);
   } catch (error) {
-    console.error('销毁代币时出错：', error);
+    console.error('销毁通证时出错:', error);
   }
 }
 
@@ -174,6 +174,6 @@ async function burnExistingTokens(factoryAddress) {
 
 ## 总结
 
-在本指南中，你学习了管理同质化代幣的完整生命周期：创建工厂、铸造新代币以及销毁代币以减少供应。这些强大的原语使你能够在 OCAP 平台上构建复杂的经济系统。
+在本指南中，你学习了管理同质化通证的完整生命周期：创建工厂、铸造新通证以及销毁它们以减少供应。这些强大的原语使你能够在 OCAP 平台上构建复杂的经济系统。
 
-现在你已经知道如何创建代币，下一个合乎逻辑的步骤是学习如何转移它们。请前往[转移代币和 NFT](./how-to-guides-transfer-tokens-and-nfts.md)指南查看具体操作方法。
+现在你已经知道如何创建通证，下一个合乎逻辑的步骤是学习如何转移它们。请前往[转移通证和 NFT](./how-to-guides-transfer-tokens-and-nfts.md)指南查看具体操作方法。

package/docs/how-to-guides-stake-tokens-and-assets.ja.md

@@ -0,0 +1,205 @@
+# トークンと資産のステーキング
+
+ステーキングとは、トークンや資産 (NFT) を特定の受信者にロックアップするプロセスであり、多くの場合、ネットワークを保護したり、ガバナンスに参加したり、報酬を得たりするために行われます。このガイドでは、OCAP クライアントを使用したステーキングのライフサイクル全体 (ステークの作成、取り消し、資産の回収、懲罰的な理由によるステークの没収) をステップバイステップで説明します。
+
+このプロセスには、いくつかの主要なメソッドが含まれます:
+- `stake()`: 新しいステークを作成するため。
+- `revokeStake()`: ステークしたアイテムを引き出すプロセスを開始するため。
+- `claimStake()`: 引き出しを完了し、アイテムをアカウントに戻すため。
+- `slashStake()`: 承認された当事者がステーカーにペナルティを課すことを許可するため。
+
+## ステークする方法
+
+まず、`stake` メソッドを使用してトークンや資産をロックします。このアクションにより、ステークされたアイテムとそれらを管理するルールを保持する、新しいユニークなステークアドレスがチェーン上に作成されます。
+
+### パラメータ
+
+<x-field-group>
+  <x-field data-name="to" data-type="string" data-required="true" data-desc="ステークを受け取るアカウントの DID アドレス。"></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="wallet" data-type="WalletObject" data-required="true" data-desc="ステーカーのウォレットオブジェクト。"></x-field>
+  <x-field data-name="locked" data-type="boolean" data-default="false" data-required="false" data-desc="作成時にステークがロックされるかどうかを示すブール値。"></x-field>
+  <x-field data-name="slashers" data-type="string[]" data-required="false" data-desc="このステークをスラッシュすることが許可されている DID アドレスの配列。指定されていない場合、デフォルトで受信者のアドレスになります。"></x-field>
+  <x-field data-name="message" data-type="string" data-required="false" data-desc="ステークのためのオプションのメモまたはメッセージ。"></x-field>
+  <x-field data-name="nonce" data-type="string" data-required="false" data-desc="ステークアドレスが一意であることを保証するためのオプションのナンス。"></x-field>
+</x-field-group>
+
+### 例
+
+```javascript Staking Tokens and an Asset icon=logos:javascript
+// 'client' が初期化された GraphQLClient インスタンスであり、
+// 'stakerWallet' が有効なウォレットオブジェクトであると仮定します。
+const receiverAddress = 'z29d5852576b8a8b6f3a8b4b74a3f4a3e2e1d'; // ステーク受信者のアドレス
+
+async function createStake() {
+  try {
+    const [txHash, stakeAddress] = await client.stake({
+      to: receiverAddress,
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E', // ステークするトークンのアドレス
+        value: 100, // ステークするトークンの量
+      }],
+      assets: ['zNKtA1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6'], // ステークする資産/NFTのアドレス
+      message: 'バリデーター報酬のためのステーキング',
+      wallet: stakerWallet,
+    });
+
+    console.log('ステークトランザクションが送信されました:', txHash);
+    console.log('新しいステークアドレスが作成されました:', stakeAddress);
+    return stakeAddress;
+  } catch (error) {
+    console.error('ステーク作成エラー:', error);
+  }
+}
+```
+
+### 戻り値
+
+`stake` メソッドは、トランザクションハッシュと新しく作成された `stakeAddress` を含むタプルを返します。このアドレスは、取り消しやスラッシュなど、この特定のステークとの将来のすべてのやり取りにとって重要です。
+
+---
+
+## ステークを取り消す方法
+
+ステークの取り消しは、ステーカーがロックされたトークンと資産を回収するために開始するプロセスです。このトランザクションは資金を即座に返すものではありません。代わりに、オンチェーンのロックアップ期間に従い、請求可能としてマークします。
+
+### パラメータ
+
+<x-field-group>
+  <x-field data-name="from" data-type="string" data-required="true" data-desc="取り消すステークのアドレス ('stake' 呼び出しから取得)。"></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 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="wallet" data-type="WalletObject" data-required="true" data-desc="ステーカーのウォレットオブジェクト。ステークの元の作成者でなければなりません。"></x-field>
+</x-field-group>
+
+### 例
+
+```javascript Revoking a Stake icon=logos:javascript
+// 'stakeAddress' が前のステップで返されたアドレスであり、
+// 'stakerWallet' がステークの作成に使用されたのと同じウォレットであると仮定します。
+
+async function revokeExistingStake(stakeAddress) {
+  try {
+    const revokeTxHash = await client.revokeStake({
+      from: stakeAddress,
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E',
+        value: 100,
+      }],
+      assets: ['zNKtA1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6'],
+      wallet: stakerWallet,
+    });
+
+    console.log('ステーク取り消しトランザクションが送信されました:', revokeTxHash);
+    console.log('重要: 後でステークを請求するために、このハッシュを保存してください。');
+    return revokeTxHash;
+  } catch (error) {
+    console.error('ステーク取り消しエラー:', error);
+  }
+}
+```
+
+### 戻り値
+
+この関数は、取り消し操作のトランザクションハッシュを返します。このハッシュは証拠として機能し、ステークを請求する最終ステップで**必須**です。
+
+---
+
+## 取り消されたステークを請求する方法
+
+ステークが正常に取り消された後、ステーカーは `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>
+
+### 例
+
+```javascript Claiming Staked Items icon=logos:javascript
+// 'stakeAddress' と 'revokeTxHash' は前のステップからのものであり、
+// 'stakerWallet' はステーカーのウォレットであると仮定します。
+
+async function claimRevokedStake(stakeAddress, revokeTxHash) {
+  try {
+    const claimTxHash = await client.claimStake({
+      from: stakeAddress,
+      evidence: revokeTxHash,
+      wallet: stakerWallet,
+    });
+
+    console.log('ステーク請求トランザクションが送信されました:', claimTxHash);
+    console.log('あなたのトークンと資産はあなたのアカウントに返却されました。');
+  } catch (error) {
+    console.error('ステーク請求エラー:', error);
+  }
+}
+```
+
+### 戻り値
+
+このメソッドは最終的なトランザクションハッシュを返します。このトランザクションがチェーン上で確認されると、ステークされたアイテムは `wallet` のアドレスに返却されます。
+
+---
+
+## ステークをスラッシュする方法
+
+スラッシュは、指定された `slasher` (通常はステークの受信者) がステーカーに対して行うことができる懲罰的なアクションです。これは通常、ステーカーが特定のルールに違反した場合に発生します。スラッシュされたトークンや資産はステークから削除され、指定された保管庫に送られます。
+
+### パラメータ
+
+<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="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 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="wallet" data-type="WalletObject" data-required="true" data-desc="承認されたスラッシャーのウォレットオブジェクト。"></x-field>
+</x-field-group>
+
+### 例
+
+```javascript Slashing a Stake icon=logos:javascript
+// 'stakeAddress' がスラッシュされるステークのアドレスであり、
+// 'slasherWallet' が承認されたスラッシャーのウォレットであると仮定します。
+
+async function slashExistingStake(stakeAddress) {
+  try {
+    const slashTxHash = await client.slashStake({
+      from: stakeAddress,
+      reason: 'バリデーターが10回連続でブロックの署名を逃しました。',
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E',
+        value: 10, // 罰として10トークンをスラッシュ
+      }],
+      wallet: slasherWallet,
+    });
+
+    console.log('ステークスラッシュトランザクションが送信されました:', slashTxHash);
+  } catch (error) {
+    console.error('ステークスラッシュエラー:', error);
+  }
+}
+```
+
+### 戻り値
+
+このメソッドは、スラッシュ操作のトランザクションハッシュを返します。
+
+## まとめ
+
+これで、OCAP ブロックチェーンでのステーキングの完全なライフサイクルを学びました: `stake` でステークを作成し、`revokeStake` と `claimStake` で資金を回収し、`slashStake` で悪意のある行為者を罰します。この強力なメカニズムは、多くの分散型アプリケーションの基本です。
+
+ステークできるアイテムについてさらに詳しく知るには、[トークンの管理](./how-to-guides-manage-tokens.md)および[資産 (NFT) の管理](./how-to-guides-manage-assets.md)ガイドを参照してください。

package/docs/how-to-guides-stake-tokens-and-assets.zh-TW.md

@@ -0,0 +1,205 @@
+# 質押代幣與資產
+
+質押是將代幣或資產 (NFTs) 鎖定給特定接收者的過程，通常是為了保護網路、參與治理或賺取獎勵。本指南使用 OCAP Client，提供整個質押生命週期的逐步演練，包括創建質押、撤銷質押、領回資產，以及因懲罰性原因削減質押。
+
+此過程涉及幾個關鍵方法：
+- `stake()`: 用於創建一個新的質押。
+- `revokeStake()`: 用於啟動撤回您已質押物品的過程。
+- `claimStake()`: 用於完成撤回並將物品返還至您的帳戶。
+- `slashStake()`: 用於允許授權方懲罰質押者。
+
+## 如何質押
+
+首先，您使用 `stake` 方法來鎖定您的代幣或資產。此操作會在鏈上創建一個新的、唯一的質押地址，該地址持有您質押的物品及管理它們的規則。
+
+### 參數
+
+<x-field-group>
+  <x-field data-name="to" data-type="string" data-required="true" data-desc="將接收質押的帳戶的 DID 地址。"></x-field>
+  <x-field data-name="assets" data-type="string[]" data-required="false" data-desc="要質押的資產地址 (NFTs) 陣列。"></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="wallet" data-type="WalletObject" data-required="true" data-desc="質押者的錢包物件。"></x-field>
+  <x-field data-name="locked" data-type="boolean" data-default="false" data-required="false" data-desc="一個布林值，表示質押在創建時是否被鎖定。"></x-field>
+  <x-field data-name="slashers" data-type="string[]" data-required="false" data-desc="允許削減此質押的 DID 地址陣列。若未提供，則預設為接收者的地址。"></x-field>
+  <x-field data-name="message" data-type="string" data-required="false" data-desc="質押的選填備註或訊息。"></x-field>
+  <x-field data-name="nonce" data-type="string" data-required="false" data-desc="一個選填的 nonce，以確保質押地址是唯一的。"></x-field>
+</x-field-group>
+
+### 範例
+
+```javascript 質押代幣與資產 icon=logos:javascript
+// 假設 'client' 是一個已初始化的 GraphQLClient 實例
+// 且 'stakerWallet' 是一個有效的錢包物件。
+const receiverAddress = 'z29d5852576b8a8b6f3a8b4b74a3f4a3e2e1d'; // 質押接收者的地址
+
+async function createStake() {
+  try {
+    const [txHash, stakeAddress] = await client.stake({
+      to: receiverAddress,
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E', // 要質押的代幣地址
+        value: 100, // 要質押的代幣數量
+      }],
+      assets: ['zNKtA1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6'], // 要質押的資產/NFT 地址
+      message: '為驗證者獎勵而質押',
+      wallet: stakerWallet,
+    });
+
+    console.log('質押交易已發送：', txHash);
+    console.log('已創建新的質押地址：', stakeAddress);
+    return stakeAddress;
+  } catch (error) {
+    console.error('創建質押時發生錯誤：', error);
+  }
+}
+```
+
+### 返回值
+
+`stake` 方法會返回一個包含交易雜湊值和新創建的 `stakeAddress` 的元組。此地址對於未來與此特定質押的所有互動（例如撤銷或削減）至關重要。
+
+---
+
+## 如何撤銷質押
+
+撤銷質押是由質押者發起，用以取回其鎖定代幣和資產的過程。此交易不會立即返還資金；而是將其標記為可領取，但需遵守任何鏈上的鎖定期。
+
+### 參數
+
+<x-field-group>
+  <x-field data-name="from" data-type="string" data-required="true" data-desc="要撤銷的質押地址（從 'stake' 調用中獲取）。"></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 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="wallet" data-type="WalletObject" data-required="true" data-desc="質押者的錢包物件，必須是質押的原始創建者。"></x-field>
+</x-field-group>
+
+### 範例
+
+```javascript 撤銷質押 icon=logos:javascript
+// 假設 'stakeAddress' 是上一步返回的地址
+// 且 'stakerWallet' 是用於創建質押的同一個錢包。
+
+async function revokeExistingStake(stakeAddress) {
+  try {
+    const revokeTxHash = await client.revokeStake({
+      from: stakeAddress,
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E',
+        value: 100,
+      }],
+      assets: ['zNKtA1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6'],
+      wallet: stakerWallet,
+    });
+
+    console.log('撤銷質押交易已發送：', revokeTxHash);
+    console.log('重要：請保存此雜湊值，以便稍後領取您的質押。');
+    return revokeTxHash;
+  } catch (error) {
+    console.error('撤銷質押時發生錯誤：', error);
+  }
+}
+```
+
+### 返回值
+
+此函數會返回撤銷操作的交易雜湊值。此雜湊值可作為證據，並且是領取質押最終步驟的**必要**條件。
+
+---
+
+## 如何領取已撤銷的質押
+
+質押成功撤銷後，質押者必須發送一筆 `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>
+
+### 範例
+
+```javascript 領取已質押的物品 icon=logos:javascript
+// 假設 'stakeAddress' 和 'revokeTxHash' 來自之前的步驟，
+// 且 'stakerWallet' 是質押者的錢包。
+
+async function claimRevokedStake(stakeAddress, revokeTxHash) {
+  try {
+    const claimTxHash = await client.claimStake({
+      from: stakeAddress,
+      evidence: revokeTxHash,
+      wallet: stakerWallet,
+    });
+
+    console.log('領取質押交易已發送：', claimTxHash);
+    console.log('您的代幣和資產已返還至您的帳戶。');
+  } catch (error) {
+    console.error('領取質押時發生錯誤：', error);
+  }
+}
+```
+
+### 返回值
+
+此方法會返回最終的交易雜湊值。一旦此交易在鏈上得到確認，質押的物品就會返還至 `wallet` 的地址。
+
+---
+
+## 如何削減質押
+
+削減是由指定的 `slasher`（通常是質押接收者）對質押者採取的懲罰性行動。這通常發生在質押者違反某些規則的情況下。被削減的代幣或資產會從質押中移除，並發送到指定的金庫。
+
+### 參數
+
+<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="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 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="wallet" data-type="WalletObject" data-required="true" data-desc="授權削減者的錢包物件。"></x-field>
+</x-field-group>
+
+### 範例
+
+```javascript 削減質押 icon=logos:javascript
+// 假設 'stakeAddress' 是要削減的質押地址，
+// 且 'slasherWallet' 是一個授權削減者的錢包。
+
+async function slashExistingStake(stakeAddress) {
+  try {
+    const slashTxHash = await client.slashStake({
+      from: stakeAddress,
+      reason: '驗證者錯過了連續 10 個區塊的簽署。',
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E',
+        value: 10, // 作為懲罰削減 10 個代幣
+      }],
+      wallet: slasherWallet,
+    });
+
+    console.log('削減質押交易已發送：', slashTxHash);
+  } catch (error) {
+    console.error('削減質押時發生錯誤：', error);
+  }
+}
+```
+
+### 返回值
+
+此方法會返回削減操作的交易雜湊值。
+
+## 總結
+
+您現在已經學會了在 OCAP 區塊鏈上質押的完整生命週期：使用 `stake` 創建質押，使用 `revokeStake` 和 `claimStake` 取回資金，以及使用 `slashStake` 懲罰不良行為者。這個強大的機制是許多去中心化應用的基礎。
+
+要了解更多關於您可以質押的物品，請參閱 [管理代幣](./how-to-guides-manage-tokens.md) 和 [管理資產 (NFTs)](./how-to-guides-manage-assets.md) 指南。