Support ADA RFC 002 Data Agreement protocol

Messages supported in ADA RFC 002 are:
1. read-data-agreement
2. read-data-agreement-response
3. problem-report

Signed-off-by: George J Padayatti <[email protected]>

Author: georgepadayatti

mydata_did/v1_0/handlers/data_agreement_problem_report_handler.py

@@ -0,0 +1,31 @@
+from aries_cloudagent.messaging.base_handler import BaseHandler, BaseResponder, RequestContext
+
+from ..messages.problem_report import DataAgreementProblemReport
+from ..manager import ADAManager
+
+import json
+
+
+class DataAgreementProblemReportHandler(BaseHandler):
+    """Handle for data-agreements/1.0/problem-report message"""
+
+    async def handle(self, context: RequestContext, responder: BaseResponder):
+        """
+        Message handler logic for data-agreements/1.0/problem-report message.
+        """
+
+        # Assert if received message is of type DataAgreementProblemReport
+        assert isinstance(context.message, DataAgreementProblemReport)
+
+        self._logger.info(
+            "Received create-did message: \n%s",
+            json.dumps(context.message.serialize(), indent=4)
+        )
+
+        # Initialize ADA manager
+        ada_manager = ADAManager(context)
+
+        await ada_manager.process_data_agreement_problem_report_message(
+            data_agreement_problem_report_message=context.message,
+            receipt=context.message_receipt,
+        )

mydata_did/v1_0/handlers/read_data_agreement_handler.py

@@ -19,4 +19,4 @@ async def handle(self, context: RequestContext, responder: BaseResponder):
         self._logger.info("Received read data agreement message: %s", json.dumps(context.message.serialize(), indent=4))
 
         mgr : ADAManager= ADAManager(context)
-        await mgr.process_read_data_agreement_message(context.message, context.message_receipt)
+        await mgr.process_read_data_agreement_message(read_data_agreement_message=context.message, receipt=context.message_receipt)

mydata_did/v1_0/manager.py

@@ -132,29 +132,11 @@ class Meta:
 class DataAgreementProblemReportReason(str, Enum):
     """Supported reason codes."""
 
-    # Triggered when creation of data agreement failed.
-    FAILED_TO_CREATE_DATA_AGREEMENT = "failed_to_create_data_agreement"
-
-    # Triggered when failed to read data agreement.
-    FAILED_TO_READ_DATA_AGREEMENT = "failed_to_read_data_agreement"
-
-    # Triggered when failed to update data agreeement.
-    FAILED_TO_UPDATE_DATA_AGREEMENT = "failed_to_update_data_agreement"
-
-    # Triggered when failed to delete data agreement.
-    FAILED_TO_DELETE_DATA_AGREEMENT = "failed_to_delete_data_agreement"
-
     # Triggered when data agreement was not found.
     DATA_AGREEMENT_NOT_FOUND = "data_agreement_not_found"
 
-    # Triggered when data agreement is already revoked.
-    DATA_AGREEMENT_REVOKED = "data_agreement_revoked"
-
-    # Triggered when data agreement is invalid.
-    DATA_AGREEMENT_INVALID = "invalid_data_agreement"
-
-    # Triggered when data agreement is expired.
-    DATA_AGREEMENT_EXPIRED = "data_agreement_expired"
+    # Triggered when read-data-agreement failed due to processing error.
+    READ_DATA_AGREEMENT_FAILED = "read_data_agreement_failed"
 
 
 class DataAgreementProblemReport(AgentMessage):
@@ -172,17 +154,13 @@ def __init__(
         *,
         problem_code: str = None,
         explain: str = None,
-        from_did,
-        to_did,
-        created_time,
+        from_did: str = None,
+        to_did: str = None,
+        created_time: str = None,
         **kwargs
     ):
         """
         Initialize a DataAgreementProblemReport message instance.
-
-        Args:
-            explain: The localized error explanation
-            problem_code: The standard error identifier
         """
         super().__init__(**kwargs)
         self.explain = explain
@@ -216,7 +194,7 @@ class Meta:
             choices=[dapr.value for dapr in DataAgreementProblemReportReason],
             error="Value {input} must be one of {choices}.",
         ),
-        example=DataAgreementProblemReportReason.FAILED_TO_CREATE_DATA_AGREEMENT.value,
+        example=DataAgreementProblemReportReason.DATA_AGREEMENT_NOT_FOUND.value,
     )
 
 

mydata_did/v1_0/messages/problem_report.py

@@ -54,6 +54,7 @@ def __init__(
         event: typing.List[DataAgreementEvent] = None,
         proof_chain: typing.List[DataAgreementProof] = None,
         principle_did: str = None,
+        proof:  DataAgreementProof = None,
         **kwargs
     ):
         """Data Agreement instance init"""
@@ -78,6 +79,7 @@ def __init__(
         self.proof_chain = proof_chain
         self.principle_did = principle_did
         self.event = event
+        self.proof = proof
 
 
 class DataAgreementInstanceSchema(BaseModelSchema):
@@ -227,3 +229,6 @@ class Meta:
         example="did:mydata:123456789abcdefghi",
         description="Principle did"
     )
+
+    # Data agreement proof
+    proof = fields.Nested(DataAgreementProofSchema, required=False)

mydata_did/v1_0/models/data_agreement_instance_model.py

@@ -1,5 +1,6 @@
 from os import environ
 from typing import Any
+import typing
 
 from marshmallow import fields, validate
 
@@ -29,7 +30,7 @@ class Meta:
     RECORD_TYPE = "data_agreement_crud_didcomm_transaction"
     RECORD_ID_NAME = "da_crud_didcomm_tx_id"
     WEBHOOK_TOPIC = None
-    TAG_NAMES = {"~thread_id", "~message_type"}
+    TAG_NAMES = {"~thread_id", "~message_type", "~connection_id"}
 
     # Message family for the transaction record
     # Create Data Agreement message family
@@ -47,13 +48,15 @@ def __init__(
         da_crud_didcomm_tx_id: str = None,
         thread_id: str = None,
         message_type: str = None,
-        messages_list: dict = None,
+        messages_list: typing.List[dict] = None,
+        connection_id: str = None,
         **kwargs
     ):
         super().__init__(da_crud_didcomm_tx_id, **kwargs)
         self.thread_id = thread_id
         self.message_type = message_type
         self.messages_list = messages_list
+        self.connection_id = connection_id
 
     @property
     def da_crud_didcomm_tx_id(self) -> str:
@@ -71,6 +74,7 @@ def record_value(self) -> dict:
                 "thread_id",
                 "message_type",
                 "messages_list",
+                "connection_id",
             )
         }
 
@@ -106,3 +110,10 @@ class Meta:
     )
     # List of messages in the transaction record
     messages_list = fields.List(fields.Dict(), required=False, description="Messages list")
+
+    # Connection identifier
+    connection_id = fields.Str(
+        required=False,
+        description="Connection identifier",
+        example=UUIDFour.EXAMPLE,
+    )

mydata_did/v1_0/models/exchange_records/data_agreement_didcomm_transaction_record.py

@@ -7,7 +7,7 @@
 from typing import List
 
 from ..utils.regex import MYDATA_DID
-from .data_agreement_model import DataAgreementV1, DataAgreementV1Schema
+from .data_agreement_instance_model import DataAgreementInstanceSchema, DataAgreementInstance
 
 class ReadDataAgreementResponseBody(BaseModel):
     """ReadDataAgreementResponseBody model class"""
@@ -19,7 +19,7 @@ class Meta:
     def __init__(
         self,
         *,
-        data_agreement :DataAgreementV1 = None,
+        data_agreement :DataAgreementInstance = None,
         **kwargs,
     ):
         """
@@ -40,4 +40,4 @@ class Meta:
         model_class = ReadDataAgreementResponseBody
         unknown = EXCLUDE
 
-    data_agreement = fields.Nested(DataAgreementV1Schema())
+    data_agreement = fields.Nested(DataAgreementInstanceSchema())