✨ Pagination support for fetching wallets, connections, cred ex and proof records

app/routes/admin/tenants.py

@@ -33,6 +33,7 @@
     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.tenants import (
     get_wallet_and_assert_valid_group,
     tenant_from_wallet_record,
@@ -304,6 +305,8 @@ async def get_tenant(
 async def get_tenants(
     wallet_name: Optional[str] = None,
     group_id: Optional[str] = group_id_query,
+    limit: Optional[int] = limit_query_parameter,
+    offset: Optional[int] = offset_query_parameter,
     admin_auth: AcaPyAuthVerified = Depends(acapy_auth_tenant_admin),
 ) -> List[Tenant]:
     """Get all tenants, or fetch by wallet name."""
@@ -316,6 +319,8 @@ async def get_tenants(
         wallets = await handle_acapy_call(
             logger=bound_logger,
             acapy_call=admin_controller.multitenancy.get_wallets,
+            limit=limit,
+            offset=offset,
             wallet_name=wallet_name,
             group_id=group_id,
         )

app/routes/connections.py

@@ -7,6 +7,7 @@
 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 shared.log_config import get_logger
 from shared.models.connection_record import (
     Connection,
@@ -134,6 +135,8 @@ async def accept_invitation(
 
 @router.get("", summary="Fetch Connection Records", response_model=List[Connection])
 async def get_connections(
+    limit: Optional[int] = limit_query_parameter,
+    offset: Optional[int] = offset_query_parameter,
     alias: Optional[str] = None,
     connection_protocol: Optional[Protocol] = None,
     invitation_key: Optional[str] = None,
@@ -155,6 +158,8 @@ async def get_connections(
 
     Parameters (Optional):
     ---
+        limit: int - The maximum number of records to retrieve
+        offset: int - The offset to start retrieving records from
         alias: str
         connection_protocol: Protocol: "connections/1.0", "didexchange/1.0"
         invitation_key: str
@@ -176,6 +181,8 @@ async def get_connections(
         connections = await handle_acapy_call(
             logger=logger,
             acapy_call=aries_controller.connection.get_connections,
+            limit=limit,
+            offset=offset,
             alias=alias,
             connection_protocol=connection_protocol,
             invitation_key=invitation_key,

app/routes/issuer.py

@@ -27,6 +27,7 @@
     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.retry_method import coroutine_with_retry_until_value
 from shared.log_config import get_logger
 from shared.models.credential_exchange import (
@@ -333,6 +334,8 @@ async def store_credential(
     response_model=List[CredentialExchange],
 )
 async def get_credentials(
+    limit: Optional[int] = limit_query_parameter,
+    offset: Optional[int] = offset_query_parameter,
     connection_id: Optional[str] = Query(None),
     role: Optional[Role] = Query(None),
     state: Optional[State] = Query(None),
@@ -356,14 +359,16 @@ async def get_credentials(
 
     The following parameters can be set to filter the fetched exchange records: connection_id, role, state, thread_id.
 
-    Parameters:
+    Parameters (Optional):
     ---
-        connection_id: str (Optional)
-        role: Role (Optional): "issuer", "holder"
-        state: State (Optional): "proposal-sent", "proposal-received", "offer-sent", "offer-received",
+        limit: int - The maximum number of records to retrieve
+        offset: int - The offset to start retrieving records from
+        connection_id: str
+        role: Role: "issuer", "holder"
+        state: State: "proposal-sent", "proposal-received", "offer-sent", "offer-received",
                                  "request-sent", "request-received", "credential-issued", "credential-received",
                                  "credential-revoked", "abandoned", "done"
-        thread_id: UUID (Optional)
+        thread_id: UUID
 
     Returns:
     ---
@@ -377,6 +382,8 @@ async def get_credentials(
         bound_logger.debug("Fetching v1 records")
         v1_records = await IssueCredentialFacades.V1.value.get_records(
             controller=aries_controller,
+            limit=limit,
+            offset=offset,
             connection_id=connection_id,
             role=role,
             state=back_to_v1_credential_state(state) if state else None,
@@ -386,6 +393,8 @@ async def get_credentials(
         bound_logger.debug("Fetching v2 records")
         v2_records = await IssueCredentialFacades.V2.value.get_records(
             controller=aries_controller,
+            limit=limit,
+            offset=offset,
             connection_id=connection_id,
             role=role,
             state=state,

app/routes/verifier.py

@@ -19,6 +19,7 @@
     assert_valid_verifier,
     get_verifier_by_version,
 )
+from app.util.pagination import limit_query_parameter, offset_query_parameter
 from shared.log_config import get_logger
 from shared.models.presentation_exchange import (
     PresentationExchange,
@@ -324,11 +325,13 @@ async def reject_proof_request(
     response_model=List[PresentationExchange],
 )
 async def get_proof_records(
-    auth: AcaPyAuth = Depends(acapy_auth_from_header),
+    limit: Optional[int] = limit_query_parameter,
+    offset: Optional[int] = offset_query_parameter,
     connection_id: Optional[str] = None,
     role: Optional[Role] = None,
     state: Optional[State] = None,
     thread_id: Optional[UUID] = None,
+    auth: AcaPyAuth = Depends(acapy_auth_from_header),
 ) -> List[PresentationExchange]:
     """
     Get all presentation exchange records for this tenant
@@ -339,6 +342,8 @@ async def get_proof_records(
 
     Parameters (Optional):
     ---
+        limit: int: The maximum number of records to retrieve
+        offset: int: The offset to start retrieving records from
         connection_id: str
         role: Role: "prover", "verifier"
         state: State: "presentation-received", "presentation-sent", "proposal-received", "proposal-sent",
@@ -358,6 +363,8 @@ async def get_proof_records(
             logger.debug("Fetching v1 proof records")
             v1_records = await VerifierFacade.V1.value.get_proof_records(
                 controller=aries_controller,
+                limit=limit,
+                offset=offset,
                 connection_id=connection_id,
                 role=role,
                 state=back_to_v1_presentation_state(state) if state else None,
@@ -366,6 +373,8 @@ async def get_proof_records(
             logger.debug("Fetching v2 proof records")
             v2_records = await VerifierFacade.V2.value.get_proof_records(
                 controller=aries_controller,
+                limit=limit,
+                offset=offset,
                 connection_id=connection_id,
                 role=role,
                 state=state,

app/services/issuer/acapy_issuer_v1.py

@@ -177,6 +177,8 @@ async def delete_credential_exchange_record(
     async def get_records(
         cls,
         controller: AcaPyClient,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
         connection_id: Optional[str] = None,
         role: Optional[str] = None,
         state: Optional[str] = None,
@@ -187,6 +189,8 @@ async def get_records(
         result = await handle_acapy_call(
             logger=bound_logger,
             acapy_call=controller.issue_credential_v1_0.get_records,
+            limit=limit,
+            offset=offset,
             connection_id=connection_id,
             role=role,
             state=state,

app/services/issuer/acapy_issuer_v2.py

@@ -199,6 +199,8 @@ async def delete_credential_exchange_record(
     async def get_records(
         cls,
         controller: AcaPyClient,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
         connection_id: Optional[str] = None,
         role: Optional[str] = None,
         state: Optional[str] = None,
@@ -209,6 +211,8 @@ async def get_records(
         result = await handle_acapy_call(
             logger=bound_logger,
             acapy_call=controller.issue_credential_v2_0.get_records,
+            limit=limit,
+            offset=offset,
             connection_id=connection_id,
             role=role,
             state=state,

app/services/verifier/acapy_verifier_v1.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import List, Optional
 
 from aries_cloudcontroller import (
     AcaPyClient,
@@ -185,6 +185,8 @@ async def reject_proof_request(
     async def get_proof_records(
         cls,
         controller: AcaPyClient,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
         connection_id: str = None,
         role: str = None,
         state: str = None,
@@ -195,6 +197,8 @@ async def get_proof_records(
             presentation_exchange = await handle_acapy_call(
                 logger=logger,
                 acapy_call=controller.present_proof_v1_0.get_records,
+                limit=limit,
+                offset=offset,
                 connection_id=connection_id,
                 role=role,
                 state=state,

app/services/verifier/acapy_verifier_v2.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import List, Optional
 
 from aries_cloudcontroller import (
     AcaPyClient,
@@ -201,6 +201,8 @@ async def reject_proof_request(
     async def get_proof_records(
         cls,
         controller: AcaPyClient,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
         connection_id: str = None,
         role: str = None,
         state: str = None,
@@ -211,6 +213,8 @@ async def get_proof_records(
             presentation_exchange = await handle_acapy_call(
                 logger=logger,
                 acapy_call=controller.present_proof_v2_0.get_records,
+                limit=limit,
+                offset=offset,
                 connection_id=connection_id,
                 role=role,
                 state=state,

app/tests/e2e/issuer/ld_proof/test_ld_proof_did_key_bbs.py

@@ -130,6 +130,10 @@ async def test_send_jsonld_key_bbs(
     assert_that(received_credential).has_role("holder")
     assert_that(received_credential["credential_exchange_id"]).starts_with("v2")
 
+    # Clean up created offer
+    cred_ex_id = data["credential_exchange_id"]
+    await faber_client.delete(f"{CREDENTIALS_BASE_PATH}/{cred_ex_id}")
+
 
 @pytest.mark.anyio
 async def test_send_jsonld_bbs_oob(
@@ -201,6 +205,10 @@ async def test_send_jsonld_bbs_oob(
         },
     )
 
+    # Clean up created offer
+    cred_ex_id = data["credential_exchange_id"]
+    await faber_client.delete(f"{CREDENTIALS_BASE_PATH}/{cred_ex_id}")
+
 
 @pytest.mark.anyio
 async def test_send_jsonld_request(

app/tests/e2e/issuer/ld_proof/test_ld_proof_did_key_ed25519.py

@@ -126,6 +126,10 @@ async def test_send_jsonld_key_ed25519(
     assert_that(received_credential).has_role("holder")
     assert_that(received_credential["credential_exchange_id"]).starts_with("v2")
 
+    # Clean up created offer
+    cred_ex_id = data["credential_exchange_id"]
+    await faber_client.delete(f"{CREDENTIALS_BASE_PATH}/{cred_ex_id}")
+
 
 @pytest.mark.anyio
 async def test_send_jsonld_oob(
@@ -198,6 +202,10 @@ async def test_send_jsonld_oob(
         },
     )
 
+    # Clean up created offer
+    cred_ex_id = data["credential_exchange_id"]
+    await faber_client.delete(f"{CREDENTIALS_BASE_PATH}/{cred_ex_id}")
+
 
 @pytest.mark.anyio
 async def test_send_jsonld_request(

app/tests/e2e/issuer/ld_proof/test_ld_proof_did_sov.py

@@ -132,6 +132,10 @@ async def test_send_jsonld_credential_sov(
     assert_that(received_credential).has_role("holder")
     assert_that(received_credential["credential_exchange_id"]).starts_with("v2")
 
+    # Clean up created offer
+    cred_ex_id = data["credential_exchange_id"]
+    await faber_client.delete(f"{CREDENTIALS_BASE_PATH}/{cred_ex_id}")
+
 
 @pytest.mark.anyio
 async def test_send_jsonld_oob_sov(
@@ -191,6 +195,10 @@ async def test_send_jsonld_oob_sov(
         state="offer-received",
     )
 
+    # Clean up created offer
+    cred_ex_id = data["credential_exchange_id"]
+    await faber_client.delete(f"{CREDENTIALS_BASE_PATH}/{cred_ex_id}")
+
 
 @pytest.mark.anyio
 async def test_send_jsonld_request_sov(