Merge pull request #5666 from ghubstan/08-handle-extradata-in-editoffer

Adjust API 'editoffer' to PR 5651 (include extraData field when editing offer)

apitest/docs/api-beta-test-guide.md

@@ -408,8 +408,118 @@ The offer will be removed from other Bisq users' offer views, and paid transacti
 
 ### Editing an Existing Offer
 
-Editing existing offers is not yet supported.  You can cancel and re-create an offer, but paid transaction fees
-for the canceled offer will be forfeited.
+Offers you create can be edited in various ways:
+
+- Disable or re-enable an offer.
+- Change an offer's price model and disable (or re-enable) it.
+- Change a market price margin based offer to a fixed price offer.
+- Change a market price margin based offer's price margin.
+- Change, set, or remove a trigger price on a market price margin based offer.
+- Change a market price margin based offer's price margin and trigger price.
+- Change a market price margin based offer's price margin and remove its trigger price.
+- Change a fixed price offer to a market price margin based offer.
+- Change a fixed price offer's fixed price.
+
+_Note: the API does not support editing an offer's payment account._
+
+The subsections below contain examples related to specific use cases.
+
+#### Enable and Disable Offer
+
+Existing offers you create can be disabled (removed from offer book) and re-enabled (re-published to offer book).
+
+To disable an offer:
+```
+./bisq-cli --password=xyz --port=9998 editoffer \
+    --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
+    --enable=false
+```
+
+To enable an offer:
+```
+./bisq-cli --password=xyz --port=9998 editoffer \
+    --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
+    --enable=true
+```
+
+#### Change Offer Pricing Model
+The `editoffer` command can be used to change an existing market price margin based offer to a fixed price offer,
+and vice-versa.
+
+##### Change Market Price Margin Based to Fixed Price Offer
+Suppose you used `createoffer` to create a market price margin based offer as follows:
+```
+$ ./bisq-cli --password=xyz --port=9998 createoffer \
+    --payment-account=f3c1ec8b-9761-458d-b13d-9039c6892413 \
+    --direction=SELL \
+    --currency-code=JPY \
+    --amount=0.125 \
+    --market-price-margin=0.5 \
+    --security-deposit=15.0 \
+    --fee-currency=BSQ
+```
+To change the market price margin based offer to a fixed price offer:
+```
+./bisq-cli --password=xyz --port=9998 editoffer \
+    --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
+    --fixed-price=3960000.5555
+```
+
+##### Change Fixed Price Offer to Market Price Margin Based Offer
+Suppose you used `createoffer` to create a fixed price offer as follows:
+```
+$ ./bisq-cli --password=xyz --port=9998 createoffer \
+    --payment-account=f3c1ec8b-9761-458d-b13d-9039c6892413 \
+    --direction=SELL \
+    --currency-code=JPY \
+    --amount=0.125 \
+    --fixed-price=3960000.0000 \
+    --security-deposit=15.0 \
+    --fee-currency=BSQ
+```
+To change the fixed price offer to a market price margin based offer:
+```
+./bisq-cli --password=xyz --port=9998 editoffer \
+    --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
+    --market-price-margin=0.5
+```
+Alternatively, you can also set a trigger price on the re-published, market price margin based offer.
+A trigger price on a SELL offer causes the offer to be automatically disabled when the market price
+falls below the trigger price.  In the `editoffer` example below, the SELL offer will be disabled when
+the JPY market price falls below 3960000.0000.
+
+```
+./bisq-cli --password=xyz --port=9998 editoffer \
+    --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
+    --market-price-margin=0.5 \
+    --trigger-price=3960000.0000
+```
+On a BUY offer, a trigger price causes the BUY offer to be automatically disabled when the market price
+rises above the trigger price.
+
+_Note: Disabled offers never automatically re-enable; they can only be manually re-enabled via
+`editoffer --offer-id=<id> --enable=true`._
+
+#### Remove Trigger Price
+To remove a trigger price on a market price margin based offer, set the trigger price to 0:
+```
+./bisq-cli --password=xyz --port=9998 editoffer \
+    --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
+    --trigger-price=0
+```
+
+#### Change Disabled Offer's Pricing Model and Enable It
+You can use `editoffer` to simultaneously change an offer's price details and disable or re-enable it.
+
+Suppose you have a disabled, fixed price offer, and want to change it to a market price margin based offer, set
+a trigger price, and re-enable it:
+```
+./bisq-cli --password=xyz --port=9998 editoffer \
+    --offer-id=83e8b2e2-51b6-4f39-a748-3ebd29c22aea \
+    --market-price-margin=0.5 \
+    --trigger-price=3960000.0000 \
+    --enable=true
+```
 
 ### Taking Offers
 

apitest/src/test/java/bisq/apitest/method/offer/AbstractOfferTest.java

@@ -17,14 +17,13 @@
 
 package bisq.apitest.method.offer;
 
-import bisq.core.monetary.Altcoin;
-
 import protobuf.PaymentAccount;
 
-import org.bitcoinj.utils.Fiat;
-
 import java.math.BigDecimal;
 
+import java.util.function.BiFunction;
+import java.util.function.Function;
+
 import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
 
@@ -37,10 +36,7 @@
 import static bisq.apitest.config.BisqAppConfig.arbdaemon;
 import static bisq.apitest.config.BisqAppConfig.bobdaemon;
 import static bisq.apitest.config.BisqAppConfig.seednode;
-import static bisq.common.util.MathUtils.roundDouble;
-import static bisq.common.util.MathUtils.scaleDownByPowerOf10;
-import static bisq.core.locale.CurrencyUtil.isCryptoCurrency;
-import static java.math.RoundingMode.HALF_UP;
+import static bisq.common.util.MathUtils.exactMultiply;
 
 
 
@@ -49,6 +45,10 @@
 @Slf4j
 public abstract class AbstractOfferTest extends MethodTest {
 
+    protected static final int ACTIVATE_OFFER = 1;
+    protected static final int DEACTIVATE_OFFER = 0;
+    protected static final long NO_TRIGGER_PRICE = 0;
+
     @Setter
     protected static boolean isLongRunningTest;
 
@@ -67,6 +67,35 @@ public static void setUp() {
     }
 
 
+    // Mkt Price Margin value of offer returned from server is scaled down by 10^-2.
+    protected final Function<Double, Double> scaledDownMktPriceMargin = (mktPriceMargin) ->
+            exactMultiply(mktPriceMargin, 0.01);
+
+    // Price value of fiat offer returned from server will be scaled up by 10^4.
+    protected final Function<BigDecimal, Long> scaledUpFiatOfferPrice = (price) -> {
+        BigDecimal factor = new BigDecimal(10).pow(4);
+        return price.multiply(factor).longValue();
+    };
+
+    // Price value of altcoin offer returned from server will be scaled up by 10^8.
+    protected final Function<String, Long> scaledUpAltcoinOfferPrice = (altcoinPriceAsString) -> {
+        BigDecimal factor = new BigDecimal(10).pow(8);
+        BigDecimal priceAsBigDecimal = new BigDecimal(altcoinPriceAsString);
+        return priceAsBigDecimal.multiply(factor).longValue();
+    };
+
+    protected final BiFunction<Double, Double, Long> calcPriceAsLong = (base, delta) -> {
+        var priceAsDouble = new BigDecimal(base).add(new BigDecimal(delta)).doubleValue();
+        return Double.valueOf(exactMultiply(priceAsDouble, 10_000)).longValue();
+    };
+
+    protected final BiFunction<Double, Double, String> calcPriceAsString = (base, delta) -> {
+        var priceAsBigDecimal = new BigDecimal(Double.toString(base))
+                .add(new BigDecimal(Double.toString(delta)));
+        return priceAsBigDecimal.toPlainString();
+    };
+
+    @SuppressWarnings("ConstantConditions")
     public static void createBsqPaymentAccounts() {
         alicesBsqAcct = aliceClient.createCryptoCurrencyPaymentAccount("Alice's BSQ Account",
                 BSQ,
@@ -78,17 +107,6 @@ public static void createBsqPaymentAccounts() {
                 false);
     }
 
-    protected double getScaledOfferPrice(double offerPrice, String currencyCode) {
-        int precision = isCryptoCurrency(currencyCode) ? Altcoin.SMALLEST_UNIT_EXPONENT : Fiat.SMALLEST_UNIT_EXPONENT;
-        return scaleDownByPowerOf10(offerPrice, precision);
-    }
-
-    protected final double getPercentageDifference(double price1, double price2) {
-        return BigDecimal.valueOf(roundDouble((1 - (price1 / price2)), 5))
-                .setScale(4, HALF_UP)
-                .doubleValue();
-    }
-
     @AfterAll
     public static void tearDown() {
         tearDownScaffold();

apitest/src/test/java/bisq/apitest/method/offer/CancelOfferTest.java

@@ -54,7 +54,8 @@ public class CancelOfferTest extends AbstractOfferTest {
                 0.00,
                 getDefaultBuyerSecurityDepositAsPercent(),
                 paymentAccountId,
-                BSQ);
+                BSQ,
+                NO_TRIGGER_PRICE);
     };
 
     @Test

apitest/src/test/java/bisq/apitest/method/offer/CreateBSQOffersTest.java

@@ -39,6 +39,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static protobuf.OfferPayload.Direction.BUY;
 import static protobuf.OfferPayload.Direction.SELL;
 
@@ -70,6 +71,9 @@ public void testCreateBuy1BTCFor20KBSQOffer() {
                 alicesBsqAcct.getId(),
                 MAKER_FEE_CURRENCY_CODE);
         log.info("Sell BSQ (Buy BTC) OFFER:\n{}", formatOfferTable(singletonList(newOffer), BSQ));
+        assertTrue(newOffer.getIsMyOffer());
+        assertTrue(newOffer.getIsMyPendingOffer());
+
         String newOfferId = newOffer.getId();
         assertNotEquals("", newOfferId);
         assertEquals(BUY.name(), newOffer.getDirection());
@@ -86,6 +90,8 @@ public void testCreateBuy1BTCFor20KBSQOffer() {
         genBtcBlockAndWaitForOfferPreparation();
 
         newOffer = aliceClient.getMyOffer(newOfferId);
+        assertTrue(newOffer.getIsMyOffer());
+        assertFalse(newOffer.getIsMyPendingOffer());
         assertEquals(newOfferId, newOffer.getId());
         assertEquals(BUY.name(), newOffer.getDirection());
         assertFalse(newOffer.getUseMarketBasedPrice());
@@ -112,6 +118,9 @@ public void testCreateSell1BTCFor20KBSQOffer() {
                 alicesBsqAcct.getId(),
                 MAKER_FEE_CURRENCY_CODE);
         log.info("SELL 20K BSQ OFFER:\n{}", formatOfferTable(singletonList(newOffer), BSQ));
+        assertTrue(newOffer.getIsMyOffer());
+        assertTrue(newOffer.getIsMyPendingOffer());
+
         String newOfferId = newOffer.getId();
         assertNotEquals("", newOfferId);
         assertEquals(SELL.name(), newOffer.getDirection());
@@ -128,6 +137,8 @@ public void testCreateSell1BTCFor20KBSQOffer() {
         genBtcBlockAndWaitForOfferPreparation();
 
         newOffer = aliceClient.getMyOffer(newOfferId);
+        assertTrue(newOffer.getIsMyOffer());
+        assertFalse(newOffer.getIsMyPendingOffer());
         assertEquals(newOfferId, newOffer.getId());
         assertEquals(SELL.name(), newOffer.getDirection());
         assertFalse(newOffer.getUseMarketBasedPrice());
@@ -154,6 +165,9 @@ public void testCreateBuyBTCWith1To2KBSQOffer() {
                 alicesBsqAcct.getId(),
                 MAKER_FEE_CURRENCY_CODE);
         log.info("BUY 1-2K BSQ OFFER:\n{}", formatOfferTable(singletonList(newOffer), BSQ));
+        assertTrue(newOffer.getIsMyOffer());
+        assertTrue(newOffer.getIsMyPendingOffer());
+
         String newOfferId = newOffer.getId();
         assertNotEquals("", newOfferId);
         assertEquals(BUY.name(), newOffer.getDirection());
@@ -170,6 +184,8 @@ public void testCreateBuyBTCWith1To2KBSQOffer() {
         genBtcBlockAndWaitForOfferPreparation();
 
         newOffer = aliceClient.getMyOffer(newOfferId);
+        assertTrue(newOffer.getIsMyOffer());
+        assertFalse(newOffer.getIsMyPendingOffer());
         assertEquals(newOfferId, newOffer.getId());
         assertEquals(BUY.name(), newOffer.getDirection());
         assertFalse(newOffer.getUseMarketBasedPrice());
@@ -196,6 +212,9 @@ public void testCreateSellBTCFor5To10KBSQOffer() {
                 alicesBsqAcct.getId(),
                 MAKER_FEE_CURRENCY_CODE);
         log.info("SELL 5-10K BSQ OFFER:\n{}", formatOfferTable(singletonList(newOffer), BSQ));
+        assertTrue(newOffer.getIsMyOffer());
+        assertTrue(newOffer.getIsMyPendingOffer());
+
         String newOfferId = newOffer.getId();
         assertNotEquals("", newOfferId);
         assertEquals(SELL.name(), newOffer.getDirection());
@@ -212,6 +231,8 @@ public void testCreateSellBTCFor5To10KBSQOffer() {
         genBtcBlockAndWaitForOfferPreparation();
 
         newOffer = aliceClient.getMyOffer(newOfferId);
+        assertTrue(newOffer.getIsMyOffer());
+        assertFalse(newOffer.getIsMyPendingOffer());
         assertEquals(newOfferId, newOffer.getId());
         assertEquals(SELL.name(), newOffer.getDirection());
         assertFalse(newOffer.getUseMarketBasedPrice());

apitest/src/test/java/bisq/apitest/method/offer/CreateOfferUsingFixedPriceTest.java

@@ -35,6 +35,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static protobuf.OfferPayload.Direction.BUY;
 import static protobuf.OfferPayload.Direction.SELL;
 
@@ -58,6 +59,9 @@ public void testCreateAUDBTCBuyOfferUsingFixedPrice16000() {
                 audAccount.getId(),
                 MAKER_FEE_CURRENCY_CODE);
         log.info("OFFER #1:\n{}", formatOfferTable(singletonList(newOffer), "AUD"));
+        assertTrue(newOffer.getIsMyOffer());
+        assertTrue(newOffer.getIsMyPendingOffer());
+
         String newOfferId = newOffer.getId();
         assertNotEquals("", newOfferId);
         assertEquals(BUY.name(), newOffer.getDirection());
@@ -72,6 +76,8 @@ public void testCreateAUDBTCBuyOfferUsingFixedPrice16000() {
         assertFalse(newOffer.getIsCurrencyForMakerFeeBtc());
 
         newOffer = aliceClient.getMyOffer(newOfferId);
+        assertTrue(newOffer.getIsMyOffer());
+        assertFalse(newOffer.getIsMyPendingOffer());
         assertEquals(newOfferId, newOffer.getId());
         assertEquals(BUY.name(), newOffer.getDirection());
         assertFalse(newOffer.getUseMarketBasedPrice());
@@ -98,6 +104,9 @@ public void testCreateUSDBTCBuyOfferUsingFixedPrice100001234() {
                 usdAccount.getId(),
                 MAKER_FEE_CURRENCY_CODE);
         log.info("OFFER #2:\n{}", formatOfferTable(singletonList(newOffer), "USD"));
+        assertTrue(newOffer.getIsMyOffer());
+        assertTrue(newOffer.getIsMyPendingOffer());
+
         String newOfferId = newOffer.getId();
         assertNotEquals("", newOfferId);
         assertEquals(BUY.name(), newOffer.getDirection());
@@ -112,6 +121,8 @@ public void testCreateUSDBTCBuyOfferUsingFixedPrice100001234() {
         assertFalse(newOffer.getIsCurrencyForMakerFeeBtc());
 
         newOffer = aliceClient.getMyOffer(newOfferId);
+        assertTrue(newOffer.getIsMyOffer());
+        assertFalse(newOffer.getIsMyPendingOffer());
         assertEquals(newOfferId, newOffer.getId());
         assertEquals(BUY.name(), newOffer.getDirection());
         assertFalse(newOffer.getUseMarketBasedPrice());
@@ -138,6 +149,9 @@ public void testCreateEURBTCSellOfferUsingFixedPrice95001234() {
                 eurAccount.getId(),
                 MAKER_FEE_CURRENCY_CODE);
         log.info("OFFER #3:\n{}", formatOfferTable(singletonList(newOffer), "EUR"));
+        assertTrue(newOffer.getIsMyOffer());
+        assertTrue(newOffer.getIsMyPendingOffer());
+
         String newOfferId = newOffer.getId();
         assertNotEquals("", newOfferId);
         assertEquals(SELL.name(), newOffer.getDirection());
@@ -152,6 +166,8 @@ public void testCreateEURBTCSellOfferUsingFixedPrice95001234() {
         assertFalse(newOffer.getIsCurrencyForMakerFeeBtc());
 
         newOffer = aliceClient.getMyOffer(newOfferId);
+        assertTrue(newOffer.getIsMyOffer());
+        assertFalse(newOffer.getIsMyPendingOffer());
         assertEquals(newOfferId, newOffer.getId());
         assertEquals(SELL.name(), newOffer.getDirection());
         assertFalse(newOffer.getUseMarketBasedPrice());