From a391ae7807a18edad27b0611aa14b333bb3d492e Mon Sep 17 00:00:00 2001
From: Matthias <xmatthias@outlook.com>
Date: Mon, 1 Mar 2021 19:50:39 +0100
Subject: [PATCH] Support deleting locks via API

---
 docs/rest-api.md                        |  9 +++++++++
 freqtrade/rpc/api_server/api_schemas.py |  6 ++++++
 freqtrade/rpc/api_server/api_v1.py      | 14 ++++++++++++--
 scripts/rest_client.py                  |  8 ++++++++
 tests/rpc/test_rpc_apiserver.py         | 10 ++++++++++
 5 files changed, 45 insertions(+), 2 deletions(-)

diff --git a/docs/rest-api.md b/docs/rest-api.md
index e2b94f080..c41c3f24c 100644
--- a/docs/rest-api.md
+++ b/docs/rest-api.md
@@ -131,6 +131,7 @@ python3 scripts/rest_client.py --config rest_config.json <command> [optional par
 | `status` | Lists all open trades.
 | `count` | Displays number of trades used and available.
 | `locks` | Displays currently locked pairs.
+| `delete_lock <lock_id>` | Deletes (disables) the lock by id.
 | `profit` | Display a summary of your profit/loss from close trades and some stats about your performance.
 | `forcesell <trade_id>` | Instantly sells the given trade  (Ignoring `minimum_roi`).
 | `forcesell all` | Instantly sells all open trades (Ignoring `minimum_roi`).
@@ -182,6 +183,11 @@ count
 daily
 	Return the amount of open trades.
 
+delete_lock
+	Delete (disable) lock from the database.
+
+        :param lock_id: ID for the lock to delete
+
 delete_trade
 	Delete trade from the database.
         Tries to close open orders. Requires manual handling of this asset on the exchange.
@@ -202,6 +208,9 @@ forcesell
 
         :param tradeid: Id of the trade (can be received via status command)
 
+locks
+	Return current locks
+
 logs
 	Show latest logs.
 
diff --git a/freqtrade/rpc/api_server/api_schemas.py b/freqtrade/rpc/api_server/api_schemas.py
index 2738e5368..244c5540a 100644
--- a/freqtrade/rpc/api_server/api_schemas.py
+++ b/freqtrade/rpc/api_server/api_schemas.py
@@ -210,6 +210,7 @@ class ForceBuyResponse(BaseModel):
 
 
 class LockModel(BaseModel):
+    id: int
     active: bool
     lock_end_time: str
     lock_end_timestamp: int
@@ -224,6 +225,11 @@ class Locks(BaseModel):
     locks: List[LockModel]
 
 
+class DeleteLockRequest(BaseModel):
+    pair: Optional[str]
+    lockid: Optional[int]
+
+
 class Logs(BaseModel):
     log_count: int
     logs: List[List]
diff --git a/freqtrade/rpc/api_server/api_v1.py b/freqtrade/rpc/api_server/api_v1.py
index 90e3a612f..7f1179a0b 100644
--- a/freqtrade/rpc/api_server/api_v1.py
+++ b/freqtrade/rpc/api_server/api_v1.py
@@ -11,7 +11,7 @@ from freqtrade.data.history import get_datahandler
 from freqtrade.exceptions import OperationalException
 from freqtrade.rpc import RPC
 from freqtrade.rpc.api_server.api_schemas import (AvailablePairs, Balances, BlacklistPayload,
-                                                  BlacklistResponse, Count, Daily, DeleteTrade,
+                                                  BlacklistResponse, Count, Daily, DeleteLockRequest, DeleteTrade,
                                                   ForceBuyPayload, ForceBuyResponse,
                                                   ForceSellPayload, Locks, Logs, OpenTradeSchema,
                                                   PairHistory, PerformanceEntry, Ping, PlotConfig,
@@ -136,11 +136,21 @@ def whitelist(rpc: RPC = Depends(get_rpc)):
     return rpc._rpc_whitelist()
 
 
-@router.get('/locks', response_model=Locks, tags=['info'])
+@router.get('/locks', response_model=Locks, tags=['info', 'locks'])
 def locks(rpc: RPC = Depends(get_rpc)):
     return rpc._rpc_locks()
 
 
+@router.delete('/locks/{lockid}', response_model=Locks, tags=['info', 'locks'])
+def delete_lock(lockid: int, rpc: RPC = Depends(get_rpc)):
+    return rpc._rpc_delete_lock(lockid=lockid)
+
+
+@router.post('/locks/delete', response_model=Locks, tags=['info', 'locks'])
+def delete_lock_pair(payload: DeleteLockRequest, rpc: RPC = Depends(get_rpc)):
+    return rpc._rpc_delete_lock(lockid=payload.lockid, pair=payload.pair)
+
+
 @router.get('/logs', response_model=Logs, tags=['info'])
 def logs(limit: Optional[int] = None, rpc: RPC = Depends(get_rpc)):
     return rpc._rpc_get_logs(limit)
diff --git a/scripts/rest_client.py b/scripts/rest_client.py
index b6e66cfa4..90d2e24d4 100755
--- a/scripts/rest_client.py
+++ b/scripts/rest_client.py
@@ -118,6 +118,14 @@ class FtRestClient():
         """
         return self._get("locks")
 
+    def delete_lock(self, lock_id):
+        """Delete (disable) lock from the database.
+
+        :param lock_id: ID for the lock to delete
+        :return: json object
+        """
+        return self._delete("locks/{}".format(lock_id))
+
     def daily(self, days=None):
         """Return the amount of open trades.
 
diff --git a/tests/rpc/test_rpc_apiserver.py b/tests/rpc/test_rpc_apiserver.py
index d7d69d0ae..56a496de2 100644
--- a/tests/rpc/test_rpc_apiserver.py
+++ b/tests/rpc/test_rpc_apiserver.py
@@ -418,6 +418,16 @@ def test_api_locks(botclient):
     assert 'randreason' in (rc.json()['locks'][0]['reason'], rc.json()['locks'][1]['reason'])
     assert 'deadbeef' in (rc.json()['locks'][0]['reason'], rc.json()['locks'][1]['reason'])
 
+    # Test deletions
+    rc = client_delete(client, f"{BASE_URI}/locks/1")
+    assert_response(rc)
+    assert rc.json()['lock_count'] == 1
+
+    rc = client_post(client, f"{BASE_URI}/locks/delete",
+                     data='{"pair": "XRP/BTC"}')
+    assert_response(rc)
+    assert rc.json()['lock_count'] == 0
+
 
 def test_api_show_config(botclient, mocker):
     ftbot, client = botclient