Merge pull request #1835 from CounterpartyXCP/apiv2

Add events filter

apiary.apib

@@ -1,4 +1,4 @@
-[//]: # (Generated by genapidoc.py on 2024-05-27 11:58:19.844640. Do not edit manually.)
+[//]: # (Generated by genapidoc.py on 2024-05-30 14:29:26.222649. Do not edit manually.)
 FORMAT: 1A
 HOST: https://api.counterparty.io:4000
 
@@ -6023,11 +6023,13 @@ Returns the dispenses of a dispenser
 
 ## Group Events
 
-### Get All Events [GET /v2/events{?cursor}{&limit}{&offset}{&verbose}]
+### Get All Events [GET /v2/events{?event_name}{&cursor}{&limit}{&offset}{&verbose}]
 
 Returns all events
 
 + Parameters
+    + event_name: `CREDIT,DEBIT` (str, optional) - Comma separated list of events to return
+        + Default: `None`
     + cursor: `10665092` (int, optional) - The last event index to return
         + Default: `None`
     + limit: `5` (int, optional) - The maximum number of events to return

counterparty-core/counterpartycore/lib/api/queries.py

@@ -185,16 +185,23 @@ def get_transactions_by_block(
     )
 
 
-def get_all_events(db, cursor: int = None, limit: int = 100, offset: int = None):
+def get_all_events(
+    db, event_name: str = None, cursor: int = None, limit: int = 100, offset: int = None
+):
     """
     Returns all events
+    :param str event_name: Comma separated list of events to return (e.g. CREDIT,DEBIT)
     :param int cursor: The last event index to return (e.g. 10665092)
     :param int limit: The maximum number of events to return (e.g. 5)
     :param int offset: The number of lines to skip before returning results (overrides the `cursor` parameter)
     """
+    where = None
+    if event_name:
+        where = [{"event": event} for event in event_name.split(",")]
     return select_rows(
         db,
         "messages",
+        where=where,
         cursor_field="event_index",
         last_cursor=cursor,
         limit=limit,