✨ Add ordering functionality to fetching of askar records

app/pyproject.toml

@@ -9,7 +9,7 @@ package-mode = false
 python = "^3.12"
 
 aiohttp = "~3.10.5"
-aries-cloudcontroller = "==1.0.0"
+aries-cloudcontroller = "==1.0.0b0"
 base58 = "~2.1.1"
 fastapi = "~0.112.0"
 fastapi_websocket_pubsub = "~0.3.8"

app/routes/admin/tenants.py

@@ -33,7 +33,12 @@
     remove_actor_by_id,
 )
 from app.services.trust_registry.util.actor import assert_actor_name
-from app.util.pagination import limit_query_parameter, offset_query_parameter
+from app.util.pagination import (
+    descending_query_parameter,
+    limit_query_parameter,
+    offset_query_parameter,
+    order_by_query_parameter,
+)
 from app.util.tenants import (
     get_wallet_and_assert_valid_group,
     tenant_from_wallet_record,
@@ -307,6 +312,8 @@ async def get_tenants(
     group_id: Optional[str] = group_id_query,
     limit: Optional[int] = limit_query_parameter,
     offset: Optional[int] = offset_query_parameter,
+    order_by: Optional[str] = order_by_query_parameter,
+    descending: bool = descending_query_parameter,
     admin_auth: AcaPyAuthVerified = Depends(acapy_auth_tenant_admin),
 ) -> List[Tenant]:
     """Get all tenants, or fetch by wallet name."""
@@ -321,6 +328,8 @@ async def get_tenants(
             acapy_call=admin_controller.multitenancy.get_wallets,
             limit=limit,
             offset=offset,
+            order_by=order_by,
+            descending=descending,
             wallet_name=wallet_name,
             group_id=group_id,
         )

app/routes/connections.py

@@ -7,7 +7,12 @@
 from app.dependencies.auth import AcaPyAuth, acapy_auth_from_header
 from app.exceptions import handle_acapy_call
 from app.models.connections import AcceptInvitation, CreateInvitation
-from app.util.pagination import limit_query_parameter, offset_query_parameter
+from app.util.pagination import (
+    descending_query_parameter,
+    limit_query_parameter,
+    offset_query_parameter,
+    order_by_query_parameter,
+)
 from shared.log_config import get_logger
 from shared.models.connection_record import (
     Connection,
@@ -137,6 +142,8 @@ async def accept_invitation(
 async def get_connections(
     limit: Optional[int] = limit_query_parameter,
     offset: Optional[int] = offset_query_parameter,
+    order_by: Optional[str] = order_by_query_parameter,
+    descending: bool = descending_query_parameter,
     alias: Optional[str] = None,
     connection_protocol: Optional[Protocol] = None,
     invitation_key: Optional[str] = None,
@@ -160,6 +167,7 @@ async def get_connections(
     ---
         limit: int - The maximum number of records to retrieve
         offset: int - The offset to start retrieving records from
+        descending: bool - Whether to return results in descending order. Results are ordered by record created time.
         alias: str
         connection_protocol: Protocol: "connections/1.0", "didexchange/1.0"
         invitation_key: str
@@ -183,6 +191,8 @@ async def get_connections(
             acapy_call=aries_controller.connection.get_connections,
             limit=limit,
             offset=offset,
+            order_by=order_by,
+            descending=descending,
             alias=alias,
             connection_protocol=connection_protocol,
             invitation_key=invitation_key,

app/routes/issuer.py

@@ -29,7 +29,12 @@
     issuer_from_protocol_version,
 )
 from app.util.did import did_from_credential_definition_id, qualified_did_sov
-from app.util.pagination import limit_query_parameter, offset_query_parameter
+from app.util.pagination import (
+    descending_query_parameter,
+    limit_query_parameter,
+    offset_query_parameter,
+    order_by_query_parameter,
+)
 from app.util.retry_method import coroutine_with_retry_until_value
 from shared.log_config import get_logger
 from shared.models.credential_exchange import (
@@ -338,6 +343,8 @@ async def store_credential(
 async def get_credentials(
     limit: Optional[int] = limit_query_parameter,
     offset: Optional[int] = offset_query_parameter,
+    order_by: Optional[str] = order_by_query_parameter,
+    descending: bool = descending_query_parameter,
     connection_id: Optional[str] = Query(None),
     role: Optional[Role] = Query(None),
     state: Optional[State] = Query(None),
@@ -365,6 +372,7 @@ async def get_credentials(
     ---
         limit: int - The maximum number of records to retrieve
         offset: int - The offset to start retrieving records from
+        descending: bool - Whether to return results in descending order. Results are ordered by record created time.
         connection_id: str
         role: Role: "issuer", "holder"
         state: State: "proposal-sent", "proposal-received", "offer-sent", "offer-received",
@@ -386,6 +394,8 @@ async def get_credentials(
             controller=aries_controller,
             limit=limit,
             offset=offset,
+            order_by=order_by,
+            descending=descending,
             connection_id=connection_id,
             role=role,
             state=back_to_v1_credential_state(state) if state else None,
@@ -397,6 +407,8 @@ async def get_credentials(
             controller=aries_controller,
             limit=limit,
             offset=offset,
+            order_by=order_by,
+            descending=descending,
             connection_id=connection_id,
             role=role,
             state=state,

app/routes/verifier.py

@@ -19,7 +19,12 @@
     assert_valid_verifier,
     get_verifier_by_version,
 )
-from app.util.pagination import limit_query_parameter, offset_query_parameter
+from app.util.pagination import (
+    descending_query_parameter,
+    limit_query_parameter,
+    offset_query_parameter,
+    order_by_query_parameter,
+)
 from shared.log_config import get_logger
 from shared.models.presentation_exchange import (
     PresentationExchange,
@@ -327,6 +332,8 @@ async def reject_proof_request(
 async def get_proof_records(
     limit: Optional[int] = limit_query_parameter,
     offset: Optional[int] = offset_query_parameter,
+    order_by: Optional[str] = order_by_query_parameter,
+    descending: bool = descending_query_parameter,
     connection_id: Optional[str] = None,
     role: Optional[Role] = None,
     state: Optional[State] = None,
@@ -344,6 +351,7 @@ async def get_proof_records(
     ---
         limit: int: The maximum number of records to retrieve
         offset: int: The offset to start retrieving records from
+        descending: bool - Whether to return results in descending order. Results are ordered by record created time.
         connection_id: str
         role: Role: "prover", "verifier"
         state: State: "presentation-received", "presentation-sent", "proposal-received", "proposal-sent",
@@ -365,6 +373,8 @@ async def get_proof_records(
                 controller=aries_controller,
                 limit=limit,
                 offset=offset,
+                order_by=order_by,
+                descending=descending,
                 connection_id=connection_id,
                 role=role,
                 state=back_to_v1_presentation_state(state) if state else None,
@@ -375,6 +385,8 @@ async def get_proof_records(
                 controller=aries_controller,
                 limit=limit,
                 offset=offset,
+                order_by=order_by,
+                descending=descending,
                 connection_id=connection_id,
                 role=role,
                 state=state,
@@ -384,7 +396,7 @@ async def get_proof_records(
         logger.info("Could not fetch proof records: {}.", e)
         raise
 
-    result = v1_records + v2_records
+    result = v1_records + v2_records  # TODO: V1 to be deprecated. No need to re-order
     if result:
         logger.debug("Successfully fetched v1 and v2 records.")
     else:

app/services/issuer/acapy_issuer.py

@@ -120,19 +120,41 @@ async def get_records(
         controller: AcaPyClient,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
+        order_by: Optional[str] = "id",
+        descending: bool = True,
         connection_id: Optional[str] = None,
         role: Optional[str] = None,
         state: Optional[str] = None,
         thread_id: Optional[str] = None,
     ) -> List[CredentialExchange]:
-        """Get list of credential records.
+        """
+        Get a list of credential records.
 
         Parameters:
         -----------
         controller: AcaPyClient
-            The aries_cloudcontroller object
-        connection_id:
-            Filter credential record by connection id
+            The aries_cloudcontroller object used to interact with the ACA-Py API.
+        limit: Optional[int]
+            The maximum number of records to return. If not specified, returns all available records.
+        offset: Optional[int]
+            The starting index from where to return records. Useful for pagination.
+        order_by: Optional[str]
+            The field by which to order the results. Default is "id".
+        descending: bool
+            If True, the results are sorted in descending order. Default is True (descending order).
+        connection_id: Optional[str]
+            Filter by the connection ID associated with the credential records.
+        role: Optional[str]
+            Filter by the role of the agent in the credential exchange (e.g., "issuer", "holder").
+        state: Optional[str]
+            Filter by the state of the credential exchange (e.g., "offer_sent", "credential_issued").
+        thread_id: Optional[str]
+            Filter by the thread ID associated with the credential exchange.
+
+        Returns:
+        --------
+        List[CredentialExchange]
+            A list of credential exchange records.
         """
 
     @classmethod

app/services/issuer/acapy_issuer_v1.py

@@ -179,6 +179,8 @@ async def get_records(
         controller: AcaPyClient,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
+        order_by: Optional[str] = "id",
+        descending: bool = True,
         connection_id: Optional[str] = None,
         role: Optional[str] = None,
         state: Optional[str] = None,
@@ -191,6 +193,8 @@ async def get_records(
             acapy_call=controller.issue_credential_v1_0.get_records,
             limit=limit,
             offset=offset,
+            order_by=order_by,
+            descending=descending,
             connection_id=connection_id,
             role=role,
             state=state,

app/services/issuer/acapy_issuer_v2.py

@@ -201,6 +201,8 @@ async def get_records(
         controller: AcaPyClient,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
+        order_by: Optional[str] = "id",
+        descending: bool = True,
         connection_id: Optional[str] = None,
         role: Optional[str] = None,
         state: Optional[str] = None,
@@ -213,6 +215,8 @@ async def get_records(
             acapy_call=controller.issue_credential_v2_0.get_records,
             limit=limit,
             offset=offset,
+            order_by=order_by,
+            descending=descending,
             connection_id=connection_id,
             role=role,
             state=state,

app/services/verifier/acapy_verifier.py

@@ -1,5 +1,5 @@
 from abc import ABC, abstractmethod
-from typing import List
+from typing import List, Optional
 
 from aries_cloudcontroller import AcaPyClient, IndyCredPrecis
 
@@ -106,20 +106,45 @@ async def reject_proof_request(
     @classmethod
     @abstractmethod
     async def get_proof_records(
-        cls, controller: AcaPyClient
+        cls,
+        controller: AcaPyClient,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        order_by: Optional[str] = "id",
+        descending: bool = True,
+        connection_id: str = None,
+        role: str = None,
+        state: str = None,
+        thread_id: str = None,
     ) -> List[PresentationExchange]:
         """
-        Get all proof records
+        Get all proof records.
 
         Parameters:
         -----------
         controller: AcaPyClient
-            The aries_cloudcontroller object
+            The aries_cloudcontroller object used to interact with the ACA-Py API.
+        limit: Optional[int]
+            The maximum number of records to return. If not specified, returns all available records.
+        offset: Optional[int]
+            The starting index from where to return records. Useful for pagination.
+        order_by: Optional[str]
+            The field by which to order the results. Default is "id".
+        descending: bool
+            If True, the results are sorted in descending order. Default is True (descending order).
+        connection_id: Optional[str]
+            Filter by the connection ID associated with the proof records.
+        role: Optional[str]
+            Filter by the role of the agent in the proof exchange (e.g., "prover", "verifier").
+        state: Optional[str]
+            Filter by the state of the proof exchange (e.g., "request_sent", "presentation_acked").
+        thread_id: Optional[str]
+            Filter by the thread ID associated with the proof exchange.
 
         Returns:
         --------
-        [PresentationExchange]
-            A list of presentation exchange records
+        List[PresentationExchange]
+            A list of presentation exchange records.
         """
 
     @classmethod

app/services/verifier/acapy_verifier_v1.py

@@ -187,6 +187,8 @@ async def get_proof_records(
         controller: AcaPyClient,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
+        order_by: Optional[str] = "id",
+        descending: bool = True,
         connection_id: str = None,
         role: str = None,
         state: str = None,
@@ -199,6 +201,8 @@ async def get_proof_records(
                 acapy_call=controller.present_proof_v1_0.get_records,
                 limit=limit,
                 offset=offset,
+                order_by=order_by,
+                descending=descending,
                 connection_id=connection_id,
                 role=role,
                 state=state,

app/services/verifier/acapy_verifier_v2.py

@@ -203,6 +203,8 @@ async def get_proof_records(
         controller: AcaPyClient,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
+        order_by: Optional[str] = "id",
+        descending: bool = True,
         connection_id: str = None,
         role: str = None,
         state: str = None,
@@ -215,6 +217,8 @@ async def get_proof_records(
                 acapy_call=controller.present_proof_v2_0.get_records,
                 limit=limit,
                 offset=offset,
+                order_by=order_by,
+                descending=descending,
                 connection_id=connection_id,
                 role=role,
                 state=state,