@ocap/client 1.25.3 → 1.25.5

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

@@ -0,0 +1,179 @@
+# 管理通证
+
+本指南提供了使用 OCAP Client 管理同质化通证的分步说明。你将学习如何设置一个通证工厂（它作为你通证的蓝图），然后用它来铸造（创建新通证）和销毁（销毁现有通证）。这些操作是在你的应用程序中创建和管理自定义经济体系的基础。
+
+一旦你铸造了通证，你就可以在账户之间转移它们。有关该过程的更多详细信息，请参阅[转移通证和 NFT](./how-to-guides-transfer-tokens-and-nfts.md)指南。
+
+## 创建通证工厂
+
+通证工厂是一个智能合约，它定义了同质化通证的属性和规则，例如其名称、符号和供应机制。它还管理铸造和销毁的过程。创建工厂是任何新通证进入流通之前的第一个步骤。
+
+`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="通证的全名（例如，'我的超棒通证'）。"></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="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-group>
+
+### 返回值
+
+返回一个 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-group>
+
+### 示例
+
+```javascript Create a Token Factory icon=logos:javascript
+import Client from '@ocap/client';
+import Wallet from '@ocap/wallet';
+
+const endpoint = 'https://beta.abtnetwork.io/api';
+const client = new Client(endpoint);
+const wallet = Wallet.fromRandom();
+
+// 首先，确保钱包有资金。你可以从水龙头获取测试通证：
+// https://faucet.abtnetwork.io/
+
+async function createFactory() {
+  try {
+    const [hash, factoryAddress] = await client.createTokenFactory({
+      wallet,
+      token: {
+        name: 'My Game Coin',
+        symbol: 'MGC',
+        decimal: 18,
+        description: 'The official currency for My Awesome Game.',
+        maxTotalSupply: 1000000,
+      },
+      feeRate: 100, // 1% 的费用
+    });
+
+    console.log('通证工厂创建成功！');
+    console.log('交易哈希:', hash);
+    console.log('工厂地址:', factoryAddress);
+    return factoryAddress;
+  } catch (error) {
+    console.error('创建通证工厂时出错:', error);
+  }
+}
+
+createFactory();
+```
+
+## 铸造通证
+
+铸造是创建新通证并将其添加到总供应量中的过程。这是通过通证工厂完成的。如果工厂配置了联合曲线，铸造将需要使用储备通证进行支付。
+
+`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="data" data-type="object" data-required="false" data-desc="附加到铸造交易的可选自定义数据。"></x-field>
+</x-field-group>
+
+### 返回值
+
+返回一个 promise，该 promise 解析为交易哈希。
+
+<x-field data-name="hash" data-type="string" data-desc="铸造操作的交易哈希。"></x-field>
+
+### 示例
+
+```javascript Mint Tokens from a Factory icon=logos:javascript
+async function mintNewTokens(factoryAddress) {
+  try {
+    const hash = await client.mintToken({
+      wallet,
+      tokenFactory: factoryAddress,
+      amount: 5000,
+      receiver: wallet.address, // 将通证铸造到我们自己的钱包
+      maxReserve: 10, // 支付的最大储备通证。根据联合曲线价格进行调整。
+    });
+
+    console.log('通证铸造成功！');
+    console.log('交易哈希:', hash);
+  } catch (error) {
+    console.error('铸造通证时出错:', error);
+  }
+}
+
+// 假设 `factoryAddress` 可从 createFactory 示例中获得
+// const factoryAddress = '...'; 
+// mintNewTokens(factoryAddress);
+```
+
+## 销毁通证
+
+销毁与铸造相反；它会永久地将通证从流通中移除。如果通证工厂使用联合曲线，销毁通证将向用户返回相应比例的储备货币。
+
+`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="data" data-type="object" data-required="false" data-desc="附加到销毁交易的可选自定义数据。"></x-field>
+</x-field-group>
+
+### 返回值
+
+返回一个 promise，该 promise 解析为交易哈希。
+
+<x-field data-name="hash" data-type="string" data-desc="销毁操作的交易哈希。"></x-field>
+
+### 示例
+
+```javascript Burn Tokens icon=logos:javascript
+async function burnExistingTokens(factoryAddress) {
+  try {
+    const hash = await client.burnToken({
+      wallet,
+      tokenFactory: factoryAddress,
+      amount: 1000,
+      receiver: wallet.address, // 将储备通证接收回我们自己的钱包
+      minReserve: 1, // 接收的最小储备通证。根据联合曲线价格进行调整。
+    });
+
+    console.log('通证销毁成功！');
+    console.log('交易哈希:', hash);
+  } catch (error) {
+    console.error('销毁通证时出错:', error);
+  }
+}
+
+// 假设 `factoryAddress` 可从 createFactory 示例中获得
+// const factoryAddress = '...'; 
+// burnExistingTokens(factoryAddress);
+```
+
+## 总结
+
+在本指南中，你学习了管理同质化通证的完整生命周期：创建工厂、铸造新通证以及销毁它们以减少供应。这些强大的原语使你能够在 OCAP 平台上构建复杂的经济系统。
+
+现在你已经知道如何创建通证，下一个合乎逻辑的步骤是学习如何转移它们。请前往[转移通证和 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.md

@@ -0,0 +1,205 @@
+# Stake Tokens and Assets
+
+Staking is the process of locking up tokens or assets (NFTs) to a specific receiver, often to secure a network, participate in governance, or earn rewards. This guide provides a step-by-step walkthrough of the entire staking lifecycle using the OCAP Client, including creating a stake, revoking it, claiming the assets back, and slashing a stake for punitive reasons.
+
+This process involves a few key methods:
+- `stake()`: To create a new stake.
+- `revokeStake()`: To initiate the process of withdrawing your staked items.
+- `claimStake()`: To finalize the withdrawal and return the items to your account.
+- `slashStake()`: To allow authorized parties to penalize a staker.
+
+## How to Stake
+
+To begin, you use the `stake` method to lock your tokens or assets. This action creates a new, unique stake address on the chain that holds your staked items and the rules governing them.
+
+### Parameters
+
+<x-field-group>
+  <x-field data-name="to" data-type="string" data-required="true" data-desc="The DID address of the account that will receive the stake."></x-field>
+  <x-field data-name="assets" data-type="string[]" data-required="false" data-desc="An array of asset addresses (NFTs) to be staked."></x-field>
+  <x-field data-name="tokens" data-type="object[]" data-required="false" data-desc="An array of token objects to be staked.">
+    <x-field data-name="address" data-type="string" data-required="true" data-desc="The address of the token contract."></x-field>
+    <x-field data-name="value" data-type="number" data-required="true" data-desc="The amount of tokens to stake."></x-field>
+  </x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="The wallet object of the staker."></x-field>
+  <x-field data-name="locked" data-type="boolean" data-default="false" data-required="false" data-desc="A boolean indicating if the stake is locked upon creation."></x-field>
+  <x-field data-name="slashers" data-type="string[]" data-required="false" data-desc="An array of DID addresses permitted to slash this stake. Defaults to the receiver's address if not provided."></x-field>
+  <x-field data-name="message" data-type="string" data-required="false" data-desc="An optional note or message for the stake."></x-field>
+  <x-field data-name="nonce" data-type="string" data-required="false" data-desc="An optional nonce to ensure the stake address is unique."></x-field>
+</x-field-group>
+
+### Example
+
+```javascript Staking Tokens and an Asset icon=logos:javascript
+// Assume 'client' is an initialized GraphQLClient instance
+// and 'stakerWallet' is a valid wallet object.
+const receiverAddress = 'z29d5852576b8a8b6f3a8b4b74a3f4a3e2e1d'; // The address of the stake receiver
+
+async function createStake() {
+  try {
+    const [txHash, stakeAddress] = await client.stake({
+      to: receiverAddress,
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E', // Address of the token to stake
+        value: 100, // Amount of tokens to stake
+      }],
+      assets: ['zNKtA1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6'], // Address of the asset/NFT to stake
+      message: 'Staking for validator rewards',
+      wallet: stakerWallet,
+    });
+
+    console.log('Stake transaction sent:', txHash);
+    console.log('New stake address created:', stakeAddress);
+    return stakeAddress;
+  } catch (error) {
+    console.error('Error creating stake:', error);
+  }
+}
+```
+
+### Return Value
+
+The `stake` method returns a tuple containing the transaction hash and the newly created `stakeAddress`. This address is crucial for all future interactions with this specific stake, such as revoking or slashing.
+
+---
+
+## How to Revoke a Stake
+
+Revoking a stake is the process initiated by the staker to retrieve their locked tokens and assets. This transaction does not immediately return the funds; instead, it marks them as available for claiming, subject to any on-chain lock-up periods.
+
+### Parameters
+
+<x-field-group>
+  <x-field data-name="from" data-type="string" data-required="true" data-desc="The address of the stake to be revoked (obtained from the 'stake' call)."></x-field>
+  <x-field data-name="assets" data-type="string[]" data-required="false" data-desc="An array of asset addresses to revoke from the stake."></x-field>
+  <x-field data-name="tokens" data-type="object[]" data-required="false" data-desc="An array of token objects to revoke.">
+    <x-field data-name="address" data-type="string" data-required="true" data-desc="The address of the token contract."></x-field>
+    <x-field data-name="value" data-type="number" data-required="true" data-desc="The amount of tokens to revoke."></x-field>
+  </x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="The staker's wallet object, which must be the original creator of the stake."></x-field>
+</x-field-group>
+
+### Example
+
+```javascript Revoking a Stake icon=logos:javascript
+// Assume 'stakeAddress' is the address returned from the previous step
+// and 'stakerWallet' is the same wallet used to create the stake.
+
+async function revokeExistingStake(stakeAddress) {
+  try {
+    const revokeTxHash = await client.revokeStake({
+      from: stakeAddress,
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E',
+        value: 100,
+      }],
+      assets: ['zNKtA1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6'],
+      wallet: stakerWallet,
+    });
+
+    console.log('Revoke stake transaction sent:', revokeTxHash);
+    console.log('IMPORTANT: Save this hash to claim your stake later.');
+    return revokeTxHash;
+  } catch (error) {
+    console.error('Error revoking stake:', error);
+  }
+}
+```
+
+### Return Value
+
+This function returns the transaction hash of the revoke operation. This hash serves as evidence and is **required** for the final step of claiming the stake.
+
+---
+
+## How to Claim a Revoked Stake
+
+After a stake has been successfully revoked, the staker must send a `claimStake` transaction to move the tokens and assets back into their account. This finalizes the withdrawal process.
+
+### Parameters
+
+<x-field-group>
+  <x-field data-name="from" data-type="string" data-required="true" data-desc="The address of the stake."></x-field>
+  <x-field data-name="evidence" data-type="string" data-required="true" data-desc="The transaction hash from the 'revokeStake' call, which serves as proof of revocation."></x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="The staker's wallet object."></x-field>
+</x-field-group>
+
+### Example
+
+```javascript Claiming Staked Items icon=logos:javascript
+// Assume 'stakeAddress' and 'revokeTxHash' are from the previous steps,
+// and 'stakerWallet' is the staker's wallet.
+
+async function claimRevokedStake(stakeAddress, revokeTxHash) {
+  try {
+    const claimTxHash = await client.claimStake({
+      from: stakeAddress,
+      evidence: revokeTxHash,
+      wallet: stakerWallet,
+    });
+
+    console.log('Claim stake transaction sent:', claimTxHash);
+    console.log('Your tokens and assets have been returned to your account.');
+  } catch (error) {
+    console.error('Error claiming stake:', error);
+  }
+}
+```
+
+### Return Value
+
+The method returns the final transaction hash. Once this transaction is confirmed on the chain, the staked items are returned to the `wallet`'s address.
+
+---
+
+## How to Slash a Stake
+
+Slashing is a punitive action that can be taken by a designated `slasher` (usually the stake receiver) against a staker. This typically happens if the staker violates certain rules. The slashed tokens or assets are removed from the stake and sent to a designated vault.
+
+### Parameters
+
+<x-field-group>
+  <x-field data-name="from" data-type="string" data-required="true" data-desc="The address of the stake to be slashed."></x-field>
+  <x-field data-name="reason" data-type="string" data-required="true" data-desc="A mandatory message explaining why the slash is occurring."></x-field>
+  <x-field data-name="assets" data-type="string[]" data-required="false" data-desc="An array of asset addresses to be slashed from the stake."></x-field>
+  <x-field data-name="tokens" data-type="object[]" data-required="false" data-desc="An array of token objects to be slashed.">
+    <x-field data-name="address" data-type="string" data-required="true" data-desc="The address of the token contract."></x-field>
+    <x-field data-name="value" data-type="number" data-required="true" data-desc="The amount of tokens to slash."></x-field>
+  </x-field>
+  <x-field data-name="wallet" data-type="WalletObject" data-required="true" data-desc="The wallet object of an authorized slasher."></x-field>
+</x-field-group>
+
+### Example
+
+```javascript Slashing a Stake icon=logos:javascript
+// Assume 'stakeAddress' is the address of the stake to be slashed,
+// and 'slasherWallet' is the wallet of an authorized slasher.
+
+async function slashExistingStake(stakeAddress) {
+  try {
+    const slashTxHash = await client.slashStake({
+      from: stakeAddress,
+      reason: 'Validator missed signing 10 consecutive blocks.',
+      tokens: [{
+        address: 'z35n6aTUTK8h5nAF43h21A1g84g3C3D7B5E',
+        value: 10, // Slashing 10 tokens as a penalty
+      }],
+      wallet: slasherWallet,
+    });
+
+    console.log('Slash stake transaction sent:', slashTxHash);
+  } catch (error) {
+    console.error('Error slashing stake:', error);
+  }
+}
+```
+
+### Return Value
+
+This method returns the transaction hash for the slashing operation.
+
+## Summary
+
+You've now learned the complete lifecycle of staking on the OCAP blockchain: creating a stake with `stake`, retrieving funds with `revokeStake` and `claimStake`, and penalizing bad actors with `slashStake`. This powerful mechanism is fundamental to many decentralized applications.
+
+To learn more about the items you can stake, see the [Manage Tokens](./how-to-guides-manage-tokens.md) and [Manage Assets (NFTs)](./how-to-guides-manage-assets.md) guides.