Added info to API documentation

Stop sending presence transactions once a trade has started, otherwise trade bots that are in a bad state can keep an offer visible in the list.
Allow tradebot deletion in the BOB_WAITING_FOR_AT_REDEEM state, to work around a bug where a trade can remain in the OFFERING state on chain but the local trade bot can switch to BOB_WAITING_FOR_AT_REDEEM.
2022-01-24 19:22:36 +00:00 · 2022-01-24 18:39:14 +00:00 · 2022-01-24 18:27:02 +00:00
8 changed files with 54 additions and 25 deletions
--- a/src/main/java/org/qortal/api/resource/CrossChainTradeBotResource.java
+++ b/src/main/java/org/qortal/api/resource/CrossChainTradeBotResource.java
@ -244,6 +244,7 @@ public class CrossChainTradeBotResource {
 	@DELETE
 	@Operation(
 		summary = "Delete completed trade",
+		description = "Use the \"tradePrivateKey\" as the request body, which can be found in the GET /crosschain/tradebot response",
 		requestBody = @RequestBody(
 			required = true,
 			content = @Content(
--- a/src/main/java/org/qortal/controller/tradebot/BitcoinACCTv1TradeBot.java
+++ b/src/main/java/org/qortal/controller/tradebot/BitcoinACCTv1TradeBot.java
@ -356,6 +356,7 @@ public class BitcoinACCTv1TradeBot implements AcctTradeBot {

 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
+			case BOB_WAITING_FOR_AT_REDEEM:
 			case ALICE_DONE:
 			case BOB_DONE:
 			case ALICE_REFUNDED:
@ -396,13 +397,16 @@ public class BitcoinACCTv1TradeBot implements AcctTradeBot {
 			}
 		}

+		// Note: for now, we aren't sending presence transactions once a trade has started,
+		// otherwise trade bots that are in a bad state can keep an offer visible in the list
+
 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
 				handleBobWaitingForAtConfirm(repository, tradeBotData);
 				break;

 			case ALICE_WAITING_FOR_P2SH_A:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWaitingForP2shA(repository, tradeBotData, atData, tradeData);
 				break;

@ -412,22 +416,22 @@ public class BitcoinACCTv1TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_WAITING_FOR_AT_LOCK:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWaitingForAtLock(repository, tradeBotData, atData, tradeData);
 				break;

 			case BOB_WAITING_FOR_P2SH_B:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleBobWaitingForP2shB(repository, tradeBotData, atData, tradeData);
 				break;

 			case ALICE_WATCH_P2SH_B:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWatchingP2shB(repository, tradeBotData, atData, tradeData);
 				break;

 			case BOB_WAITING_FOR_AT_REDEEM:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleBobWaitingForAtRedeem(repository, tradeBotData, atData, tradeData);
 				break;

@ -436,12 +440,12 @@ public class BitcoinACCTv1TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_REFUNDING_B:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceRefundingP2shB(repository, tradeBotData, atData, tradeData);
 				break;

 			case ALICE_REFUNDING_A:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceRefundingP2shA(repository, tradeBotData, atData, tradeData);
 				break;

--- a/src/main/java/org/qortal/controller/tradebot/DogecoinACCTv1TradeBot.java
+++ b/src/main/java/org/qortal/controller/tradebot/DogecoinACCTv1TradeBot.java
@ -350,6 +350,7 @@ public class DogecoinACCTv1TradeBot implements AcctTradeBot {

 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
+			case BOB_WAITING_FOR_AT_REDEEM:
 			case ALICE_DONE:
 			case BOB_DONE:
 			case ALICE_REFUNDED:
@ -390,6 +391,9 @@ public class DogecoinACCTv1TradeBot implements AcctTradeBot {
 			}
 		}

+		// Note: for now, we aren't sending presence transactions once a trade has started,
+		// otherwise trade bots that are in a bad state can keep an offer visible in the list
+
 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
 				handleBobWaitingForAtConfirm(repository, tradeBotData);
@ -401,12 +405,12 @@ public class DogecoinACCTv1TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_WAITING_FOR_AT_LOCK:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWaitingForAtLock(repository, tradeBotData, atData, tradeData);
 				break;

 			case BOB_WAITING_FOR_AT_REDEEM:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleBobWaitingForAtRedeem(repository, tradeBotData, atData, tradeData);
 				break;

@ -415,7 +419,7 @@ public class DogecoinACCTv1TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_REFUNDING_A:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceRefundingP2shA(repository, tradeBotData, atData, tradeData);
 				break;

--- a/src/main/java/org/qortal/controller/tradebot/DogecoinACCTv2TradeBot.java
+++ b/src/main/java/org/qortal/controller/tradebot/DogecoinACCTv2TradeBot.java
@ -350,6 +350,7 @@ public class DogecoinACCTv2TradeBot implements AcctTradeBot {

 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
+			case BOB_WAITING_FOR_AT_REDEEM:
 			case ALICE_DONE:
 			case BOB_DONE:
 			case ALICE_REFUNDED:
@ -389,6 +390,9 @@ public class DogecoinACCTv2TradeBot implements AcctTradeBot {
 			}
 		}

+		// Note: for now, we aren't sending presence transactions once a trade has started,
+		// otherwise trade bots that are in a bad state can keep an offer visible in the list
+
 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
 				handleBobWaitingForAtConfirm(repository, tradeBotData);
@ -400,12 +404,12 @@ public class DogecoinACCTv2TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_WAITING_FOR_AT_LOCK:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWaitingForAtLock(repository, tradeBotData, atData, tradeData);
 				break;

 			case BOB_WAITING_FOR_AT_REDEEM:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleBobWaitingForAtRedeem(repository, tradeBotData, atData, tradeData);
 				break;

@ -414,7 +418,7 @@ public class DogecoinACCTv2TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_REFUNDING_A:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceRefundingP2shA(repository, tradeBotData, atData, tradeData);
 				break;

--- a/src/main/java/org/qortal/controller/tradebot/DogecoinACCTv3TradeBot.java
+++ b/src/main/java/org/qortal/controller/tradebot/DogecoinACCTv3TradeBot.java
@ -350,6 +350,7 @@ public class DogecoinACCTv3TradeBot implements AcctTradeBot {

 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
+			case BOB_WAITING_FOR_AT_REDEEM:
 			case ALICE_DONE:
 			case BOB_DONE:
 			case ALICE_REFUNDED:
@ -390,6 +391,9 @@ public class DogecoinACCTv3TradeBot implements AcctTradeBot {
 			}
 		}

+		// Note: for now, we aren't sending presence transactions once a trade has started,
+		// otherwise trade bots that are in a bad state can keep an offer visible in the list
+
 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
 				handleBobWaitingForAtConfirm(repository, tradeBotData);
@ -401,12 +405,12 @@ public class DogecoinACCTv3TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_WAITING_FOR_AT_LOCK:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWaitingForAtLock(repository, tradeBotData, atData, tradeData);
 				break;

 			case BOB_WAITING_FOR_AT_REDEEM:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleBobWaitingForAtRedeem(repository, tradeBotData, atData, tradeData);
 				break;

@ -415,7 +419,7 @@ public class DogecoinACCTv3TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_REFUNDING_A:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceRefundingP2shA(repository, tradeBotData, atData, tradeData);
 				break;

--- a/src/main/java/org/qortal/controller/tradebot/LitecoinACCTv1TradeBot.java
+++ b/src/main/java/org/qortal/controller/tradebot/LitecoinACCTv1TradeBot.java
@ -361,6 +361,7 @@ public class LitecoinACCTv1TradeBot implements AcctTradeBot {

 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
+			case BOB_WAITING_FOR_AT_REDEEM:
 			case ALICE_DONE:
 			case BOB_DONE:
 			case ALICE_REFUNDED:
@ -401,6 +402,9 @@ public class LitecoinACCTv1TradeBot implements AcctTradeBot {
 			}
 		}

+		// Note: for now, we aren't sending presence transactions once a trade has started,
+		// otherwise trade bots that are in a bad state can keep an offer visible in the list
+
 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
 				handleBobWaitingForAtConfirm(repository, tradeBotData);
@ -412,12 +416,12 @@ public class LitecoinACCTv1TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_WAITING_FOR_AT_LOCK:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWaitingForAtLock(repository, tradeBotData, atData, tradeData);
 				break;

 			case BOB_WAITING_FOR_AT_REDEEM:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleBobWaitingForAtRedeem(repository, tradeBotData, atData, tradeData);
 				break;

@ -426,7 +430,7 @@ public class LitecoinACCTv1TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_REFUNDING_A:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceRefundingP2shA(repository, tradeBotData, atData, tradeData);
 				break;

--- a/src/main/java/org/qortal/controller/tradebot/LitecoinACCTv2TradeBot.java
+++ b/src/main/java/org/qortal/controller/tradebot/LitecoinACCTv2TradeBot.java
@ -350,6 +350,7 @@ public class LitecoinACCTv2TradeBot implements AcctTradeBot {

 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
+			case BOB_WAITING_FOR_AT_REDEEM:
 			case ALICE_DONE:
 			case BOB_DONE:
 			case ALICE_REFUNDED:
@ -390,6 +391,9 @@ public class LitecoinACCTv2TradeBot implements AcctTradeBot {
 			}
 		}

+		// Note: for now, we aren't sending presence transactions once a trade has started,
+		// otherwise trade bots that are in a bad state can keep an offer visible in the list
+
 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
 				handleBobWaitingForAtConfirm(repository, tradeBotData);
@ -401,12 +405,12 @@ public class LitecoinACCTv2TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_WAITING_FOR_AT_LOCK:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWaitingForAtLock(repository, tradeBotData, atData, tradeData);
 				break;

 			case BOB_WAITING_FOR_AT_REDEEM:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleBobWaitingForAtRedeem(repository, tradeBotData, atData, tradeData);
 				break;

@ -415,7 +419,7 @@ public class LitecoinACCTv2TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_REFUNDING_A:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceRefundingP2shA(repository, tradeBotData, atData, tradeData);
 				break;

--- a/src/main/java/org/qortal/controller/tradebot/LitecoinACCTv3TradeBot.java
+++ b/src/main/java/org/qortal/controller/tradebot/LitecoinACCTv3TradeBot.java
@ -350,6 +350,7 @@ public class LitecoinACCTv3TradeBot implements AcctTradeBot {

 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
+			case BOB_WAITING_FOR_AT_REDEEM:
 			case ALICE_DONE:
 			case BOB_DONE:
 			case ALICE_REFUNDED:
@ -390,6 +391,9 @@ public class LitecoinACCTv3TradeBot implements AcctTradeBot {
 			}
 		}

+		// Note: for now, we aren't sending presence transactions once a trade has started,
+		// otherwise trade bots that are in a bad state can keep an offer visible in the list
+
 		switch (tradeBotState) {
 			case BOB_WAITING_FOR_AT_CONFIRM:
 				handleBobWaitingForAtConfirm(repository, tradeBotData);
@ -401,12 +405,12 @@ public class LitecoinACCTv3TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_WAITING_FOR_AT_LOCK:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceWaitingForAtLock(repository, tradeBotData, atData, tradeData);
 				break;

 			case BOB_WAITING_FOR_AT_REDEEM:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleBobWaitingForAtRedeem(repository, tradeBotData, atData, tradeData);
 				break;

@ -415,7 +419,7 @@ public class LitecoinACCTv3TradeBot implements AcctTradeBot {
 				break;

 			case ALICE_REFUNDING_A:
-				TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
+				//TradeBot.getInstance().updatePresence(repository, tradeBotData, tradeData);
 				handleAliceRefundingP2shA(repository, tradeBotData, atData, tradeData);
 				break;
Author	SHA1	Message	Date
CalDescent	828aadd32d	Added info to API documentation	2022-01-24 19:22:36 +00:00
CalDescent	f5d3681a95	Stop sending presence transactions once a trade has started, otherwise trade bots that are in a bad state can keep an offer visible in the list.	2022-01-24 18:39:14 +00:00
CalDescent	29bed8e4a0	Allow tradebot deletion in the BOB_WAITING_FOR_AT_REDEEM state, to work around a bug where a trade can remain in the OFFERING state on chain but the local trade bot can switch to BOB_WAITING_FOR_AT_REDEEM.	2022-01-24 18:27:02 +00:00