Support for filtering /transactions by group-id. (#577)

Author: gmalouf

algosdk/v2client/indexer.py

@@ -477,6 +477,7 @@ def search_transactions(
         address_role=None,
         exclude_close_to=False,
         application_id=None,
+        group_id=None,
         rekey_to=False,
         round_num=None,
         **kwargs
@@ -524,6 +525,7 @@ def search_transactions(
                 to true
             application_id (int, optional): filter for transactions pertaining
                 to an application
+            group_id (bytes, optional): filter transactions by group id
             rekey_to (bool, optional): include results which include the
                 rekey-to field
             round_num (int, optional): alias for block; only specify one of
@@ -566,6 +568,8 @@ def search_transactions(
             query["exclude-close-to"] = "true"
         if application_id:
             query["application-id"] = application_id
+        if group_id:
+            query["group-id"] = base64.b64encode(group_id).decode()
         if rekey_to:
             query["rekey-to"] = "true"
 

tests/steps/other_v2_steps.py

@@ -728,7 +728,7 @@ def parse_asset(context, index):
 
 
 @when(
-    'we make a Search For Transactions call with account "{account:MaybeString}" NotePrefix "{notePrefixB64:MaybeString}" TxType "{txType:MaybeString}" SigType "{sigType:MaybeString}" txid "{txid:MaybeString}" round {block} minRound {minRound} maxRound {maxRound} limit {limit} beforeTime "{beforeTime:MaybeString}" afterTime "{afterTime:MaybeString}" currencyGreaterThan {currencyGreaterThan} currencyLessThan {currencyLessThan} assetIndex {index} addressRole "{addressRole:MaybeString}" ExcluseCloseTo "{excludeCloseTo:MaybeString}" rekeyTo "{rekeyTo:MaybeString}"'
+    'we make a Search For Transactions call with account "{account:MaybeString}" NotePrefix "{notePrefixB64:MaybeString}" TxType "{txType:MaybeString}" SigType "{sigType:MaybeString}" txid "{txid:MaybeString}" round {block} minRound {minRound} maxRound {maxRound} limit {limit} beforeTime "{beforeTime:MaybeString}" afterTime "{afterTime:MaybeString}" currencyGreaterThan {currencyGreaterThan} currencyLessThan {currencyLessThan} assetIndex {index} addressRole "{addressRole:MaybeString}" ExcluseCloseTo "{excludeCloseTo:MaybeString}" groupid "{groupidB64:MaybeString}" rekeyTo "{rekeyTo:MaybeString}"'
 )
 def search_txns(
     context,
@@ -748,6 +748,7 @@ def search_txns(
     index,
     addressRole,
     excludeCloseTo,
+    groupidB64,
     rekeyTo,
 ):
     if notePrefixB64 == "none":
@@ -768,6 +769,8 @@ def search_txns(
         addressRole = None
     if excludeCloseTo == "none":
         excludeCloseTo = None
+    if groupidB64 == "none":
+        groupidB64 = ""
     if rekeyTo == "none":
         rekeyTo = None
     context.response = context.icl.search_transactions(
@@ -788,12 +791,13 @@ def search_txns(
         address=account,
         address_role=addressRole,
         exclude_close_to=excludeCloseTo,
+        group_id=base64.b64decode(groupidB64),
         rekey_to=rekeyTo,
     )
 
 
 @when(
-    'we make a Search For Transactions call with account "{account:MaybeString}" NotePrefix "{notePrefixB64:MaybeString}" TxType "{txType:MaybeString}" SigType "{sigType:MaybeString}" txid "{txid:MaybeString}" round {block} minRound {minRound} maxRound {maxRound} limit {limit} beforeTime "{beforeTime:MaybeString}" afterTime "{afterTime:MaybeString}" currencyGreaterThan {currencyGreaterThan} currencyLessThan {currencyLessThan} assetIndex {index} addressRole "{addressRole:MaybeString}" ExcluseCloseTo "{excludeCloseTo:MaybeString}"'
+    'we make a Search For Transactions call with account "{account:MaybeString}" NotePrefix "{notePrefixB64:MaybeString}" TxType "{txType:MaybeString}" SigType "{sigType:MaybeString}" txid "{txid:MaybeString}" round {block} minRound {minRound} maxRound {maxRound} limit {limit} beforeTime "{beforeTime:MaybeString}" afterTime "{afterTime:MaybeString}" currencyGreaterThan {currencyGreaterThan} currencyLessThan {currencyLessThan} assetIndex {index} addressRole "{addressRole:MaybeString}" ExcluseCloseTo "{excludeCloseTo:MaybeString}" groupid "{groupidB64:MaybeString}"'
 )
 def search_txns2(
     context,
@@ -813,6 +817,7 @@ def search_txns2(
     index,
     addressRole,
     excludeCloseTo,
+    groupidB64,
 ):
     if notePrefixB64 == "none":
         notePrefixB64 = ""
@@ -832,6 +837,8 @@ def search_txns2(
         addressRole = None
     if excludeCloseTo == "none":
         excludeCloseTo = None
+    if groupidB64 == "none":
+        groupidB64 = ""
     context.response = context.icl.search_transactions(
         asset_id=int(index),
         limit=int(limit),
@@ -850,6 +857,7 @@ def search_txns2(
         address=account,
         address_role=addressRole,
         exclude_close_to=excludeCloseTo,
+        group_id=base64.b64decode(groupidB64),
         rekey_to=None,
     )