@ocap/client 1.25.4 → 1.25.6

package/docs/api-reference-transaction-helpers.ja.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 AccountMigrateTxを送信 icon=logos:javascript
+const txHash = await client.migrateAccount({
+  from: oldWallet,
+  to: newWallet,
+});
+console.log('移行トランザクションハッシュ:', 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 DelegateTxを送信 icon=logos:javascript
+const [txHash, delegateAddress] = await client.delegate({
+  from: userWallet,
+  to: appWallet,
+  privileges: [
+    {
+      typeUrl: 'fg:t:transfer_v2',
+    },
+  ],
+});
+console.log('委任トランザクションハッシュ:', txHash);
+console.log('デリゲートアドレス:', 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 RevokeDelegateTxを送信 icon=logos:javascript
+const txHash = await client.revokeDelegate({
+  from: userWallet,
+  to: appWallet,
+  privileges: ['fg:t:transfer_v2'],
+});
+console.log('取り消しトランザクションハッシュ:', 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 CreateAssetTxを送信 icon=logos:javascript
+const [txHash, assetAddress] = await client.createAsset({
+  moniker: '私の最初のNFT',
+  data: {
+    typeUrl: 'json',
+    value: { name: 'デジタルコレクティブル', description: 'ユニークなアイテムです。' },
+  },
+  wallet: userWallet,
+});
+console.log('資産作成トランザクションハッシュ:', txHash);
+console.log('新しい資産アドレス:', 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 UpdateAssetTxを送信 icon=logos:javascript
+const txHash = await client.updateAsset({
+  address: 'z3g...',
+  moniker: '更新されたNFT名',
+  data: {
+    typeUrl: 'json',
+    value: { name: '更新されたコレクティブル', description: 'さらに多くの機能が追加されました！' },
+  },
+  wallet: userWallet,
+});
+console.log('資産更新トランザクションハッシュ:', 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 CreateFactoryTxを送信 icon=logos:javascript
+const factoryConfig = {
+  name: 'チケットファクトリー',
+  description: 'イベントチケットをミントします',
+  limit: 1000,
+  input: { ... },
+  output: { ... },
+};
+
+const [txHash, factoryAddress] = await client.createAssetFactory({
+  factory: factoryConfig,
+  wallet: eventCreatorWallet,
+});
+console.log('ファクトリー作成トランザクションハッシュ:', txHash);
+console.log('新しいファクトリーアドレス:', 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 AcquireAssetV2Txを送信 icon=logos:javascript
+// まず、ミントトランザクションを準備します（例：サーバー上で）
+const itx = await client.preMintAsset({
+  factory: factoryAddress,
+  owner: userWallet.address,
+  wallet: issuerWallet,
+});
+
+// 次に、ユーザーがトランザクションを送信します
+const txHash = await client.acquireAsset({ itx, wallet: userWallet });
+console.log('資産取得トランザクションハッシュ:', 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 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('資産ミントトランザクションハッシュ:', 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 CreateTokenFactoryTxを送信 icon=logos:javascript
+const [txHash, factoryAddress] = await client.createTokenFactory({
+  feeRate: 100, // 1%
+  curve: { fixedPrice: '1' }, // 新しいトークンごとに1ネイティブトークン
+  token: {
+    name: 'マイコミュニティトークン',
+    symbol: 'MCT',
+    decimal: 18,
+    maxTotalSupply: '1000000',
+  },
+  wallet: creatorWallet,
+});
+console.log('トークンファクトリー作成トランザクションハッシュ:', txHash);
+console.log('新しいトークンファクトリーアドレス:', 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 UpdateTokenFactoryTxを送信 icon=logos:javascript
+const txHash = await client.updateTokenFactory({
+  address: 'z2f...',
+  feeRate: 50, // 0.5%
+  wallet: ownerWallet,
+});
+console.log('トークンファクトリー更新トランザクションハッシュ:', 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 MintTokenTxを送信 icon=logos:javascript
+const txHash = await client.mintToken({
+  tokenFactory: 'z2f...',
+  amount: 100,
+  receiver: userWallet.address,
+  maxReserve: 105, // 最大105ネイティブトークンまで支払う意思がある
+  wallet: userWallet,
+});
+console.log('トークンミントトランザクションハッシュ:', 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 BurnTokenTxを送信 icon=logos:javascript
+const txHash = await client.burnToken({
+  tokenFactory: 'z2f...',
+  amount: 50,
+  receiver: userWallet.address,
+  minReserve: 48, // 少なくとも48ネイティブトークンを受け取ることを期待
+  wallet: userWallet,
+});
+console.log('トークンバーントランザクションハッシュ:', 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 TransferV2Txを送信 icon=logos:javascript
+const txHash = await client.transfer({
+  to: 'z1sb...',
+  token: 1.5, // 1.5ネイティブチェーントークン
+  assets: ['z3g...'], // NFT
+  tokens: [{ address: 'z2t...', value: 100 }], // 100カスタムトークン
+  memo: 'サービスへの支払い',
+  wallet: senderWallet,
+});
+console.log('転送トランザクションハッシュ:', 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 アトミックスワップを実行 icon=logos:javascript
+// 1. オファー提供者がトランザクションを準備
+const offerTx = await client.prepareExchange({
+  receiver: receiverWallet.address,
+  offerAssets: ['z3g...'], // NFTをオファー
+  demandToken: 10, // 10ネイティブトークンを要求
+  wallet: offererWallet,
+});
+
+// 2. 受信者がトランザクションを最終処理
+const finalTx = await client.finalizeExchange({
+  tx: offerTx,
+  wallet: receiverWallet,
+});
+
+// 3. どちらの当事者も最終処理されたトランザクションを送信可能
+const txHash = await client.exchange({ tx: finalTx, wallet: offererWallet });
+console.log('交換トランザクションハッシュ:', 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 StakeTxを送信 icon=logos:javascript
+const [txHash, stakeAddress] = await client.stake({
+  to: 'z1v...',
+  tokens: [{ address: 'z2t...', value: 5000 }],
+  message: 'バリデーター報酬のためのステーキング',
+  wallet: userWallet,
+});
+console.log('ステークトランザクションハッシュ:', txHash);
+console.log('新しいステークアドレス:', 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 RevokeStakeTxを送信 icon=logos:javascript
+const txHash = await client.revokeStake({
+  from: 'z6s...',
+  tokens: [{ address: 'z2t...', value: 1000 }],
+  wallet: userWallet,
+});
+console.log('ステーク取り消しトランザクションハッシュ:', 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 ClaimStakeTxを送信 icon=logos:javascript
+const revokeTxHash = '0x123...abc';
+const txHash = await client.claimStake({
+  from: 'z6s...',
+  evidence: revokeTxHash,
+  wallet: userWallet,
+});
+console.log('ステーク請求トランザクションハッシュ:', 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 SlashStakeTxを送信 icon=logos:javascript
+const txHash = await client.slashStake({
+  from: 'z6s...',
+  reason: 'バリデーターのダウンタイム',
+  tokens: [{ address: 'z2t...', value: 500 }],
+  wallet: slasherWallet,
+});
+console.log('ステークスラッシュトランザクションハッシュ:', txHash);
+```