# 高レベルAPI
トランザクションヘルパーは、OCAP Client に組み込まれた高レベル関数であり、一般的なトランザクションの作成と署名の複雑さを抽象化します。トランザクションオブジェクトを手動で構築する代わりに、アセットの作成、トークンの転送、ステーキング、アトミックスワップの実行などのワークフローに、これらの便利なメソッドを使用できます。これらのヘルパーは、トランザクション構造が正しいことを保証し、開発プロセスを大幅に簡素化します。
基盤となるトランザクションライフサイクルの詳細については、[コアコンセプト：トランザクションライフサイクル](./core-concepts-transaction-lifecycle.md)を参照してください。
---
## アカウント管理
### migrateAccount
アカウントの所有権を新しいキーペアに移行します。これは、キーのローテーションやアカウントの回復に役立ちます。
**パラメータ**
**戻り値**
**例**
```javascript AccountMigrateTx を送信 icon=logos:javascript
const txHash = await client.migrateAccount({
from: oldWallet,
to: newWallet,
});
console.log('Migration transaction hash:', txHash);
```
### delegate
別のアカウント（デリゲート先）がデリゲーター（委任者）に代わって特定の種類のトランザクションを送信することを承認します。これは、安全でサンドボックス化された権限を作成するための強力な機能です。
**パラメータ**
**戻り値**
**例**
```javascript 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
以前に付与された権限をデリゲート先から取り消します。
**パラメータ**
**戻り値**
**例**
```javascript 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
ブロックチェーン上に新しいアセット（非代替性トークン）を作成します。
**パラメータ**
**戻り値**
**例**
```javascript 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` フィールドを更新します。
**パラメータ**
**戻り値**
**例**
```javascript 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
アセットファクトリーを作成します。これは、一貫した構造を持つ複数の新しいアセットをミントするためのテンプレートとして機能します。
**パラメータ**
**戻り値**
**例**
```javascript 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
既存のアセットファクトリーから新しいアセットを取得（ミント）します。これは通常、アセットを所有するエンドユーザーによって開始されます。
**パラメータ**
**戻り値**
**例**
```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('Acquire asset tx hash:', txHash);
```
### mintAsset
これは`acquireAsset`の発行者側の対応物です。信頼できる発行者がファクトリーからアセットをミントし、指定された所有者に割り当てることを許可します。
**パラメータ**
**戻り値**
**例**
```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('Mint asset tx hash:', txHash);
```
---
## トークン管理
### createTokenFactory
特定のファンジブルトークンをミントおよびバーンするための新しいファクトリーを作成します。多くの場合、ボンディングカーブの価格設定モデルに基づいています。
**パラメータ**
作成されるトークンの設定。これには`name`、`symbol`、`decimal`、`maxTotalSupply`などのプロパティが含まれます。
**戻り値**
**例**
```javascript CreateTokenFactoryTx を送信 icon=logos:javascript
const [txHash, factoryAddress] = await client.createTokenFactory({
feeRate: 100, // 1%
curve: { fixedPrice: '1' }, // 新規トークンごとに1ネイティブトークン
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` を更新します。
**パラメータ**
**戻り値**
**例**
```javascript 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
トークンファクトリーから新しいトークンを、リザーブトークン（通常はネイティブチェーンのトークン）と引き換えにミントします。コストはファクトリーのボンディングカーブによって決定されます。
**パラメータ**
**戻り値**
**例**
```javascript MintTokenTx を送信 icon=logos:javascript
const txHash = await client.mintToken({
tokenFactory: 'z2f...',
amount: 100,
receiver: userWallet.address,
maxReserve: 105, // 最大105ネイティブトークンまで支払う意思がある
wallet: userWallet,
});
console.log('Mint token tx hash:', txHash);
```
### burnToken
ファクトリーで既存のトークンをバーンして、基礎となるリザーブトークンを返してもらいます。受け取るリザーブトークンの量は、ファクトリーのボンディングカーブによって決定されます。
**パラメータ**
**戻り値**
**例**
```javascript BurnTokenTx を送信 icon=logos:javascript
const txHash = await client.burnToken({
tokenFactory: 'z2f...',
amount: 50,
receiver: userWallet.address,
minReserve: 48, // 少なくとも48ネイティブトークンを受け取ることを期待
wallet: userWallet,
});
console.log('Burn token tx hash:', txHash);
```
---
## 転送と交換
### transfer
ネイティブトークン、カスタムファンジブルトークン、および/またはアセット（NFT）を、単一のトランザクションで別のアカウントに転送します。
**パラメータ**
**戻り値**
**例**
```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: 'Payment for services',
wallet: senderWallet,
});
console.log('Transfer tx hash:', txHash);
```
### prepareExchange
アトミックスワップ（交換）トランザクションの送信者側を準備します。送信者のオファーに署名し、受信者に渡すことができるトランザクションオブジェクトを返します。
**パラメータ**
**戻り値**
### finalizeExchange
アトミックスワップの受信者側を最終処理します。`prepareExchange` からの部分的に署名されたトランザクションを受け取り、受信者の署名を追加し、完全に署名されたトランザクションオブジェクトを返します。
**パラメータ**
**戻り値**
### exchange
完全に署名された交換トランザクションをブロックチェーンに送信します。これは、`finalizeExchange` が完了した後、どちらかの当事者が呼び出すことができます。
**パラメータ**
**戻り値**
**例 (完全な交換フロー)**
```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('Exchange tx hash:', txHash);
```
---
## ステーキング
### stake
トークンおよび/またはアセットを受信者アドレスにステークします。ステーキングはリソースをロックし、多くの場合、報酬と引き換えに、またはセキュリティを提供するために行われます。
**パラメータ**
**戻り値**
**例**
```javascript 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
以前にステークされたトークンおよび/またはアセットを取り消し、所有者への返還プロセスを開始します。アセットが請求可能になるまでにアンボンディング期間がある場合があることに注意してください。
**パラメータ**
**戻り値**
**例**
```javascript 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
正常に取り消され、アンボンディング期間が経過したステークからアイテムを請求します。
**パラメータ**
**戻り値**
**例**
```javascript 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
指定されたスラッシャーが、通常は不正行為に対してステークにペナルティを課すことを許可します。スラッシュされたアセットは、指定された保管庫アドレスに転送されます。
**パラメータ**
**戻り値**
**例**
```javascript 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);
```