AMMWithdraw

[ソース]

(AMM amendment)

AMMの流動性プロバイダトークン（LPトークン）を返却することで、自動マーケットメーカー(AMM)インスタンスから資産を引き出します。

AMMWithdraw JSONの例

{
    "Account" : "rJVUeRqDFNs2xqA7ncVE6ZoAhPUoaJJSQm",
    "Amount" : {
        "currency" : "TST",
        "issuer" : "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd",
        "value" : "5"
    },
    "Amount2" : "50000000",
    "Asset" : {
        "currency" : "TST",
        "issuer" : "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd"
    },
    "Asset2" : {
        "currency" : "XRP"
    },
    "Fee" : "10",
    "Flags" : 1048576,
    "Sequence" : 10,
    "TransactionType" : "AMMWithdraw"
}

AMMWithdraw フィールド

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

注記: ダブルアセット出金の場合、Asset1とAmount1またはAmount2が対応していれば、Asset2はもう一方に対応することが可能です。しかし、両者を一致させることをお勧めします(つまり、Amount2はAsset2で定義されたアセットの金額です)。その方が混乱を招きにくくなります。

AMMWithdrawモード

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

• ダブルアセット出金: AMMのプールから両方の資産をその残高と同じ割合で受け取ります。この出金には手数料はかかりません。
• シングルアセット出金: AMMのプールから1つの資産を受け取ります。AMMは、出金によりプール内の資産残高がどれだけ変動するかによって手数料を算出します。出金のモードによって、手数料が支払われたLPトークンの量から差し引かれるか、出金する資産の量から差し引かれるか決まります。

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

| フラグ名 | フラグ値 | 指定フィール | 意味 | |-----------------|--------------|---------------- ----|---------| | tfLPToken | 0x00010000 | LPTokenInのみ | 指定された量のLPトークンを返却し、LPトークンの発行総数に対する返却されたトークンの割合に基づく金額の両方の資産を受け取ります。 | | tfWithdrawAll | 0x00020000 | なし | LPトークンを 全て 返却し、AMMのプールにある両方の資産を最大限受け取ります。 | | tfTwoAsset | 0x00100000 | AmountとAmount2 | 指定した金額を上限として、AMMの資産の両方を出金します。実際に受け取る金額は、AMMのプールの資産残高の割合と同じになります。 |

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

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

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

シングルアセット出金にかかる手数料は、ダブルアセット出金を行い、AMMを使用して指定しない方の資産を全て交換する場合と同じになるように計算されます。取引手数料は、交換に必要な金額に適用されますが、残りの出金分には適用されません。

AMMの削除

トランザクションがAMMに存在する全ての資産を出金すると、AMMは関連するすべてのトラストラインとともに自動的に削除されます。ただし、1回のトランザクションで削除できるトラストラインの数には制限があります。トラストラインが多すぎる場合、AMMは空の状態でレジャーに残ります。これはAMMDelete トランザクションで削除するか、「空のAMM」に対する特別なダブルアセット入金(AMMDeposit トランザクション)で補充することができます。AMMが空の間は、そのAMMに対する他の操作は無効です。

AMMWithdrawのフラグ

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

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

エラーケース

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