🐛 Add credential_id on matching proofs (#1349)

* add models to support credential_id

* update return models

* update tests

* remove import

* 🎨

* update test to assert cred_id

* diff on OpenApi spec

Author: cl0ete

app/models/verifier.py

@@ -1,7 +1,12 @@
 from enum import Enum
 from typing import Optional, Union
 
-from aries_cloudcontroller import DIFPresSpec, DIFProofRequest, IndyPresSpec
+from aries_cloudcontroller import (
+    DIFPresSpec,
+    DIFProofRequest,
+    IndyNonRevocationInterval,
+    IndyPresSpec,
+)
 from aries_cloudcontroller import IndyProofRequest as AcaPyIndyProofRequest
 from pydantic import BaseModel, Field, ValidationInfo, field_validator, model_validator
 
@@ -120,3 +125,29 @@ def validate_problem_report(cls, value):
         if value == "":
             raise CloudApiValueError("problem_report cannot be an empty string")
         return value
+
+
+class CredInfo(BaseModel):
+    attrs: dict = Field(default=None, description="Attribute names and value")
+    cred_def_id: str = Field(
+        default=None, description="Credential definition identifier"
+    )
+    referent: str = Field(default=None, description="Credential identifier")
+    credential_id: str = Field(default=None, description="Credential identifier")
+    cred_rev_id: Optional[str] = Field(
+        default=None, description="Credential revocation identifier"
+    )
+    rev_reg_id: Optional[str] = Field(
+        default=None, description="Revocation registry identifier"
+    )
+    schema_id: Optional[str] = Field(default=None, description="Schema identifier")
+
+
+class CredPrecis(BaseModel):
+    cred_info: CredInfo = Field(description="Credential info")
+    interval: Optional[IndyNonRevocationInterval] = Field(
+        default=None, description="Non-revocation interval from presentation request"
+    )
+    presentation_referents: Optional[list] = Field(
+        default=None, description="Presentation referents"
+    )

app/routes/verifier.py

@@ -1,7 +1,6 @@
 from typing import List, Optional
 from uuid import UUID
 
-from aries_cloudcontroller import IndyCredPrecis
 from fastapi import APIRouter, Depends
 
 from app.dependencies.acapy_clients import client_from_auth
@@ -10,6 +9,8 @@
 from app.models.verifier import (
     AcceptProofRequest,
     CreateProofRequest,
+    CredInfo,
+    CredPrecis,
     RejectProofRequest,
     SendProofRequest,
 )
@@ -456,15 +457,15 @@ async def delete_proof(
 @router.get(
     "/proofs/{proof_id}/credentials",
     summary="Get Matching Credentials for a Proof",
-    response_model=List[IndyCredPrecis],
+    response_model=List[CredPrecis],
 )
 async def get_credentials_by_proof_id(
     proof_id: str,
     referent: Optional[str] = None,
     limit: Optional[int] = limit_query_parameter,
     offset: Optional[int] = offset_query_parameter,
     auth: AcaPyAuth = Depends(acapy_auth_from_header),
-) -> List[IndyCredPrecis]:
+) -> List[CredPrecis]:
     """
     Get matching credentials for a presentation exchange
     ---
@@ -486,8 +487,8 @@ async def get_credentials_by_proof_id(
 
     Returns:
     ---
-        List[IndyCredPrecis]
-            A list of applicable Indy credentials
+        List[CredPrecis]
+            A list of applicable credentials
     """
     bound_logger = logger.bind(body={"proof_id": proof_id})
     bound_logger.debug("GET request received: Get credentials for a proof request")
@@ -507,4 +508,13 @@ async def get_credentials_by_proof_id(
         raise
 
     bound_logger.debug("Successfully fetched credentials for proof request.")
-    return result
+    return [
+        CredPrecis(
+            cred_info=CredInfo(
+                **cred.cred_info.model_dump(), credential_id=cred.cred_info.referent
+            ),
+            interval=cred.interval,
+            presentation_referents=cred.presentation_referents,
+        )
+        for cred in result
+    ]

app/tests/e2e/verifier/test_verifier.py

@@ -445,12 +445,14 @@ async def test_get_credentials_for_request(
 
         result = response.json()[0]
         assert "cred_info" in result
+        assert result["cred_info"]["referent"] == result["cred_info"]["credential_id"]
         assert [
             attr
             in [
                 "attrs",
                 "cred_def_info",
                 "referent",
+                "credential_id",
                 "interval",
                 "presentation_referents",
             ]

app/tests/services/verifier/test_verifier.py

@@ -10,6 +10,7 @@
 from app.dependencies.auth import AcaPyAuth
 from app.exceptions.cloudapi_exception import CloudApiException
 from app.main import app
+from app.models.verifier import CredInfo, CredPrecis
 from app.routes.verifier import acapy_auth_from_header, get_credentials_by_proof_id
 from app.services.verifier.acapy_verifier_v2 import VerifierV2
 from app.tests.services.verifier.utils import indy_pres_spec, sample_indy_proof_request
@@ -300,9 +301,25 @@ async def test_get_credentials_by_proof_id(
         "client_from_auth",
         return_value=mock_context_managed_controller(mock_agent_controller),
     )
-    cred_precis = IndyCredPrecis(
-        cred_info=IndyCredInfo(cred_def_id="WgWxqztrNooG92RXvxSTWv:3:CL:20:tag")
-    )
+    cred_precis = [
+        IndyCredPrecis(
+            cred_info=IndyCredInfo(
+                cred_def_id="WgWxqztrNooG92RXvxSTWv:3:CL:20:tag",
+                referent="abcde",
+                attrs={"attr1": "value1"},
+            ),
+        )
+    ]
+    returned_cred_precis = [
+        CredPrecis(
+            cred_info=CredInfo(
+                **cred.cred_info.model_dump(), credential_id=cred.cred_info.referent
+            ),
+            interval=cred.interval,
+            presentation_referents=cred.presentation_referents,
+        )
+        for cred in cred_precis
+    ]
 
     # V2
     when(VerifierV2).get_credentials_by_proof_id(
@@ -311,7 +328,7 @@ async def test_get_credentials_by_proof_id(
         referent=None,
         limit=100,
         offset=0,
-    ).thenReturn(to_async([cred_precis]))
+    ).thenReturn(to_async(cred_precis))
 
     result = await test_module.get_credentials_by_proof_id(
         proof_id="v2-abcd",
@@ -321,7 +338,7 @@ async def test_get_credentials_by_proof_id(
         offset=0,
     )
 
-    assert result == [cred_precis]
+    assert result == returned_cred_precis
     verify(VerifierV2).get_credentials_by_proof_id(
         controller=mock_agent_controller,
         proof_id="v2-abcd",