From 524576b90907a2dbf10c0c2884b43fa6f5c3fcd0 Mon Sep 17 00:00:00 2001 From: Michael Legleux Date: Thu, 11 Apr 2024 12:16:43 -0700 Subject: [PATCH 1/2] Make the amendment requirement consistent with other enabled amendments. --- .../public-api-methods/path-and-order-book-methods/amm_info.md | 2 +- docs/references/protocol/transactions/types/ammbid.md | 2 +- docs/references/protocol/transactions/types/ammcreate.md | 2 +- docs/references/protocol/transactions/types/ammdelete.md | 2 +- docs/references/protocol/transactions/types/ammdeposit.md | 2 +- docs/references/protocol/transactions/types/ammwithdraw.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md index a561fef355..92668e0fa7 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md @@ -13,7 +13,7 @@ labels: The {% code-page-name /%} method gets information about an Automated Market Maker (AMM) instance. -_(Requires the [AMM amendment][])_ +_(Added by the [AMM amendment][])_ ### Request Format diff --git a/docs/references/protocol/transactions/types/ammbid.md b/docs/references/protocol/transactions/types/ammbid.md index 8ea80d5fc3..fad8984ae2 100644 --- a/docs/references/protocol/transactions/types/ammbid.md +++ b/docs/references/protocol/transactions/types/ammbid.md @@ -9,7 +9,7 @@ labels: # AMMBid [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/AMMBid.cpp "Source") -_(Requires the [AMM amendment][])_ +_(Added by the [AMM amendment][])_ Bid on an [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md)'s (AMM's) auction slot. If you win, you can trade against the AMM at a discounted fee until you are outbid or 24 hours have passed. If you are outbid before 24 hours have passed, you are refunded part of the cost of your bid based on how much time remains. diff --git a/docs/references/protocol/transactions/types/ammcreate.md b/docs/references/protocol/transactions/types/ammcreate.md index b8c62a1a66..a55d4cc9ea 100644 --- a/docs/references/protocol/transactions/types/ammcreate.md +++ b/docs/references/protocol/transactions/types/ammcreate.md @@ -9,7 +9,7 @@ labels: # AMMCreate [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/AMMCreate.cpp "Source") -_(Requires the [AMM amendment][])_ +_(Added by the [AMM amendment][])_ Create a new [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md) (AMM) instance for trading a pair of assets ([fungible tokens](../../../../concepts/tokens/index.md) or [XRP](../../../../introduction/what-is-xrp.md)). diff --git a/docs/references/protocol/transactions/types/ammdelete.md b/docs/references/protocol/transactions/types/ammdelete.md index 2f935773eb..ae427e4804 100644 --- a/docs/references/protocol/transactions/types/ammdelete.md +++ b/docs/references/protocol/transactions/types/ammdelete.md @@ -9,7 +9,7 @@ labels: # AMMDelete [[Source]](https://github.com/XRPLF/rippled/blob/develop/src/ripple/app/tx/impl/AMMDelete.cpp "Source") -_(Requires the [AMM amendment][])_ +_(Added by the [AMM amendment][])_ Delete an empty [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md) (AMM) instance that could not be fully deleted automatically. diff --git a/docs/references/protocol/transactions/types/ammdeposit.md b/docs/references/protocol/transactions/types/ammdeposit.md index 612ab3ac99..448358e0eb 100644 --- a/docs/references/protocol/transactions/types/ammdeposit.md +++ b/docs/references/protocol/transactions/types/ammdeposit.md @@ -9,7 +9,7 @@ labels: # AMMDeposit [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/AMMDeposit.cpp "Source") -_(Requires the [AMM amendment][])_ +_(Added by the [AMM amendment][])_ Deposit funds into an [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md) (AMM) instance and receive the AMM's liquidity provider tokens (_LP Tokens_) in exchange. You can deposit one or both of the assets in the AMM's pool. diff --git a/docs/references/protocol/transactions/types/ammwithdraw.md b/docs/references/protocol/transactions/types/ammwithdraw.md index f70089b652..0d1f2d0d9a 100644 --- a/docs/references/protocol/transactions/types/ammwithdraw.md +++ b/docs/references/protocol/transactions/types/ammwithdraw.md @@ -9,7 +9,7 @@ labels: # AMMWithdraw [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/AMMWithdraw.cpp "Source") -_(Requires the [AMM amendment][])_ +_(Added by the [AMM amendment][])_ Withdraw assets from an [Automated Market Maker](../../../../concepts/tokens/decentralized-exchange/automated-market-makers.md) (AMM) instance by returning the AMM's liquidity provider tokens (LP Tokens). From 5dea34266156039a4b9be7913a0aa016b051750f Mon Sep 17 00:00:00 2001 From: Michael Legleux Date: Thu, 11 Apr 2024 12:17:24 -0700 Subject: [PATCH 2/2] Fix some error conditions. --- docs/references/protocol/transactions/types/ammbid.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/references/protocol/transactions/types/ammbid.md b/docs/references/protocol/transactions/types/ammbid.md index fad8984ae2..2d43a331d9 100644 --- a/docs/references/protocol/transactions/types/ammbid.md +++ b/docs/references/protocol/transactions/types/ammbid.md @@ -62,8 +62,6 @@ You bid using the AMM's LP Tokens; the amount of a winning bid is returned to th | `BidMax` | [Currency Amount][] | Amount | No | Pay at most this amount for the slot. If the cost to win the bid is higher than this amount, the transaction fails. If omitted, pay as much as necessary to win the bid. | | `AuthAccounts` | Array | STArray | No | A list of up to 4 additional accounts that you allow to trade at the discounted fee. This cannot include the address of the transaction sender. Each of these objects should be an [Auth Account object](#auth-account-objects). | -You cannot specify both `BidMin` and `BidMax`. - ### Auth Account Objects Each member of the `AuthAccounts` array must be an object with the following field: @@ -76,7 +74,7 @@ Like other "inner objects" that can appear in arrays, the JSON representation of ## Auction Slot Price -If successful, the transaction automatically outbids the previous slot owner and debits the bid price from the sender's LP Tokens. The price to win the auction decreases over time, divided into 20 intervals of 72 minutes each. If the sender does not have enough LP Tokens to win the bid, or the price of the bid is higher than the transaction's `BidMax` value, the transaction fails with a `tecAMM_FAILED_BID` result. +If successful, the transaction automatically outbids the previous slot owner and debits the bid price from the sender's LP Tokens. The price to win the auction decreases over time, divided into 20 intervals of 72 minutes each. If the sender does not have enough LP Tokens to win the bid, or the price of the bid is higher than the transaction's `BidMax` value, the transaction fails with a `tecAMM_INVALID_TOKENS` result. - If the auction slot is currently empty, expired, or in its last interval, the **minimum bid** is **0.001% of the AMM's total LP Tokens balance**.