AMMDeposit

[ソース]

(AMM amendment が必要です。)

自動マーケットメーカー（AMM）インスタンスに資金を預け、AMMの流動性プロバイダートークン（ LPトークン ）を受け取ります。AMMのプールにある資産の一方または両方を預けることができます。

トランザクションが成功すると、LPトークンを保持するためにAMMアカウント(リミット0)にトラストラインが作成されます。

AMMDeposit JSONの例

{
    "Account" : "rJVUeRqDFNs2xqA7ncVE6ZoAhPUoaJJSQm",
    "Amount" : {
        "currency" : "TST",
        "issuer" : "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd",
        "value" : "2.5"
    },
    "Amount2" : "30000000",
    "Asset" : {
        "currency" : "TST",
        "issuer" : "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"
    },
    "Asset2" : {
        "currency" : "XRP"
    },
    "Fee" : "10",
    "Flags" : 1048576,
    "Sequence" : 7,
    "TransactionType" : "AMMDeposit"
}

AMMDeposit フィールド

共通フィールドに加えて、AMMDepositトランザクションは以下のフィールドを使用します。

AMMDepositモード

このトランザクションには5つのモードがあり、どのフラグを指定するかで定義されます。それぞれのモードは、特定のフィールドの組み合わせを必要とし、次の2つのカテゴリに分類されます。

• ダブルアセット入金: AMMのプールにある両方(2つ)の資産を、既存の資産の残高に比例して預けます。この預け入れでは手数料は徴収されません。
• シングルアセット入金: AMMの2つの資産のうち1つだけを預けます。AMMは、この預け入れによってプール内の資産残高がどれだけ変化したかによって、対価として支払われるLPトークンから差し引く手数料を設定します。

以下の項目の組み合わせは、ダブルアセット入金について示しています。

以下の項目の組み合わせは、シングルアセット入金について示しています。

これ以外のフィールドとフラグの組み合わせは無効です。

シングルアセット入金の手数料

シングルアセット入金の手数料は、AMMを使って預け入れ金額の一部を他の資産と交換し、結果的にダブルアセット入金を行った場合と同じになるように計算されます。AMMの取引手数料は、一部の資産の交換に必要な金額には適用されますが、残りの預け入れ金額には適用されません。 例えば、AMMの資産プールがUSDとEURで完全に均等に分割されている場合、100USDを預けようとすると、受け取るLPトークンの量は、50EUR+50USDを預けた場合よりもわずかに少なくなります。

ダブルアセット入金の場合、LPトークンを受け取る数は、以下の計算式で算出できます。

• L: 受け取るLPトークンの量
• T: 預け入れ前のLPトークンの残高合計
• B: 預け入れ資産の額
• F: 取引手数料
• W: プール内の預金資産の重みです。これはすべてのAMMプールで0.5と定義されています（50/50の分割を意味します）ので、Wによる累乗は平方根を取ることと同一です。
• P: 預け入れ前のプール内の預金資産の合計額

空のAMMの場合の特殊なケース

場合によっては、プール内に資産がない状態で AMM が存在することがあります。このような状態の AMM には通常の入金を行うことができません。なぜなら資産間の比率が未定義 (0/0) だからです。その代わりに、フラグ tfTwoAssetIfEmpty と両方の資産の正確な金額を指定した“空AMM”への特殊な入金を行うことができます。これはAMMを作成するAMMCreateトランザクションが行うのと同じように、資産間の比率を直接設定します。ダブルアセット入金と同様に、これは手数料を徴収されません。

AMMが空の場合のみ、「空のAMM」への特別な入金を行うことができます。

AMMDepositのフラグ

AMMDepositトランザクションは、以下のようなFlagsフィールドの値をサポートしています。

これらのフラグのうちの1つのみと、任意のグローバルフラグを指定する必要があります。

エラーケース

すべてのトランザクションで発生する可能性のあるエラーに加えて、AMMDepositトランザクションでは、次のトランザクション結果コードが発生する可能性があります。