Use DID Update event for Service and Verification Method creation (#34)

Signed-off-by: Alexander Shenshin <[email protected]>

Author: AlexanderShenshin

README.md

@@ -130,7 +130,7 @@ did = HederaDid(client=client, private_key_der="private_key_der")
 
 await did.register()
 
-await did.add_service(
+await did.add_or_update_service(
     id_=f"{did.identifier}#service-1", service_type="LinkedDomains", service_endpoint="https://example.com/vcs"
 )
 ```

docs/dev/getting-started.md

@@ -44,7 +44,7 @@ did = HederaDid(client=client, private_key_der="private_key_der")
 
 await did.register()
 
-await did.add_service(
+await did.add_or_update_service(
     id_=f"{did.identifier}#service-1", service_type="LinkedDomains", service_endpoint="https://example.com/vcs"
 )
 ```

hiero_did_sdk_python/did/did_document.py

@@ -154,7 +154,7 @@ def get_json_payload(self):
 
         return root_object
 
-    async def _process_create_message(self, message: HcsDidMessage):  # noqa: C901
+    async def _process_create_message(self, message: HcsDidMessage):
         event = message.event
 
         match event.event_target:
@@ -208,50 +208,6 @@ async def _process_create_message(self, message: HcsDidMessage):  # noqa: C901
                 self.controller = did_owner_event.get_controller_verification_method()
                 self._public_key = did_owner_event.public_key
                 self._on_activated(message.timestamp)
-            case HcsDidEventTarget.SERVICE:
-                update_service_event = cast(HcsDidUpdateServiceEvent, event)
-                event_id = update_service_event.id_
-
-                if event_id in self.services:
-                    LOGGER.warning(f"Duplicate create Service event ID: {event_id}, skipping event...")
-                    return
-
-                self.services[event_id] = update_service_event.get_service_def()
-                self._on_updated(message.timestamp)
-            case HcsDidEventTarget.VERIFICATION_METHOD:
-                update_verification_method_event = cast(HcsDidUpdateVerificationMethodEvent, event)
-                event_id = update_verification_method_event.id_
-
-                if event_id in self.verification_methods:
-                    LOGGER.warning(f"Duplicate create Verification Method event ID: {event_id}, skipping event...")
-                    return
-
-                self.verification_methods[event_id] = update_verification_method_event.get_verification_method_def()
-                self._on_updated(message.timestamp)
-            case HcsDidEventTarget.VERIFICATION_RELATIONSHIP:
-                update_verification_relationship_event = cast(HcsDidUpdateVerificationRelationshipEvent, event)
-                relationship_type = update_verification_relationship_event.relationship_type
-                event_id = update_verification_relationship_event.id_
-
-                if relationship_type not in self.verification_relationships:
-                    LOGGER.warning(
-                        f"Create verification Relationship event with type {relationship_type} is not supported, skipping event..."
-                    )
-                    return
-
-                if event_id in self.verification_relationships[relationship_type]:
-                    LOGGER.warning(
-                        f"Duplicate create Verification Relationship event ID: {event_id}, skipping event..."
-                    )
-                    return
-
-                self.verification_relationships[relationship_type].append(event_id)
-
-                if event_id not in self.verification_methods:
-                    self.verification_methods[event_id] = (
-                        update_verification_relationship_event.get_verification_method_def()
-                    )
-                self._on_updated(message.timestamp)
             case _:
                 LOGGER.warning(f"Create {event.event_target} operation is not supported, skipping event...")
 
@@ -269,22 +225,12 @@ def _process_update_message(self, message: HcsDidMessage):
                 update_service_event = cast(HcsDidUpdateServiceEvent, event)
                 event_id = update_service_event.id_
 
-                if event_id not in self.services:
-                    LOGGER.warning(f"Service with ID: {event_id} is not found on the document, skipping event...")
-                    return
-
                 self.services[event_id] = update_service_event.get_service_def()
                 self._on_updated(message.timestamp)
             case HcsDidEventTarget.VERIFICATION_METHOD:
                 update_verification_method_event = cast(HcsDidUpdateVerificationMethodEvent, event)
                 event_id = update_verification_method_event.id_
 
-                if event_id not in self.verification_methods:
-                    LOGGER.warning(
-                        f"Verification Method with ID: {event_id} is not found on the document, skipping event..."
-                    )
-                    return
-
                 self.verification_methods[event_id] = update_verification_method_event.get_verification_method_def()
                 self._on_updated(message.timestamp)
             case HcsDidEventTarget.VERIFICATION_RELATIONSHIP:
@@ -294,15 +240,12 @@ def _process_update_message(self, message: HcsDidMessage):
 
                 if relationship_type not in self.verification_relationships:
                     LOGGER.warning(
-                        f"Update verification Relationship event with type {relationship_type} is not supported, skipping event..."
+                        f"Update Verification Relationship event with type {relationship_type} is not supported, skipping event..."
                     )
                     return
 
                 if event_id not in self.verification_relationships[relationship_type]:
-                    LOGGER.warning(
-                        f"Verification Relationship with ID: {event_id} is not found on the document, skipping event..."
-                    )
-                    return
+                    self.verification_relationships[relationship_type].append(event_id)
 
                 self.verification_methods[event_id] = (
                     update_verification_relationship_event.get_verification_method_def()

hiero_did_sdk_python/did/did_document_operation.py

@@ -3,7 +3,6 @@
 
 class DidDocumentOperation(StrEnum):
     CREATE = "create"
-    CREATE_DID_DOCUMENT = "create-did-document"
     UPDATE = "update"
-    DELETE = "delete"
     REVOKE = "revoke"
+    DELETE = "delete"

hiero_did_sdk_python/did/hedera_did.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Literal, cast
+from typing import cast
 
 from hiero_sdk_python import Client, PrivateKey, PublicKey, TopicMessageSubmitTransaction
 from hiero_sdk_python.transaction.transaction import Transaction
@@ -153,29 +153,19 @@ async def delete(self):
 
         await self._submit_transaction(DidDocumentOperation.DELETE, HcsDidDeleteEvent())
 
-    async def add_service(self, id_: str, service_type: DidServiceType, service_endpoint: str):
-        """Add Service to DID document
+    async def add_or_update_service(self, id_: str, service_type: DidServiceType, service_endpoint: str):
+        """Add or update DID document service
 
         Args:
             id_: Service ID to create
             service_type: DID service type
             service_endpoint: Service endpoint
         """
-        await self._add_or_update_service(
-            DidDocumentOperation.CREATE, id_=id_, type_=service_type, service_endpoint=service_endpoint
-        )
+        self._assert_can_submit_transaction()
 
-    async def update_service(self, id_: str, service_type: DidServiceType, service_endpoint: str):
-        """Update existing DID document service
+        hcs_event = HcsDidUpdateServiceEvent(id_=id_, type_=service_type, service_endpoint=service_endpoint)
 
-        Args:
-            id_: Service ID to update
-            service_type: DID service type
-            service_endpoint: Service endpoint
-        """
-        await self._add_or_update_service(
-            DidDocumentOperation.UPDATE, id_=id_, type_=service_type, service_endpoint=service_endpoint
-        )
+        await self._submit_transaction(DidDocumentOperation.UPDATE, hcs_event)
 
     async def revoke_service(self, id_: str):
         """Revoke existing DID document service
@@ -188,52 +178,30 @@ async def revoke_service(self, id_: str):
         hcs_event = HcsDidRevokeServiceEvent(id_)
         await self._submit_transaction(DidDocumentOperation.REVOKE, hcs_event)
 
-    async def add_verification_method(
+    async def add_or_update_verification_method(
         self,
         id_: str,
         controller: str,
         public_key_der: str,
         type_: SupportedKeyType,
     ):
-        """Add verification method to DID document
+        """Add or update DID document verification method
 
         Args:
             id_: Verification method ID to create
             controller: Verification method controller ID
             public_key_der: Verification method public key encoded in DER format
             type_: Verification method key type
         """
-        await self._add_or_update_verification_method(
-            DidDocumentOperation.CREATE,
-            id_=id_,
-            controller=controller,
-            public_key=PublicKey.from_string(public_key_der),
-            type_=type_,
-        )
 
-    async def update_verification_method(
-        self,
-        id_: str,
-        controller: str,
-        public_key_der: str,
-        type_: SupportedKeyType,
-    ):
-        """Update existing DID document verification method
+        self._assert_can_submit_transaction()
 
-        Args:
-            id_: Verification method ID to update
-            controller: Verification method controller ID
-            public_key_der: Verification method public key encoded in DER format
-            type_: Verification method key type
-        """
-        await self._add_or_update_verification_method(
-            DidDocumentOperation.UPDATE,
-            id_=id_,
-            controller=controller,
-            public_key=PublicKey.from_string(public_key_der),
-            type_=type_,
+        hcs_event = HcsDidUpdateVerificationMethodEvent(
+            id_=id_, controller=controller, public_key=PublicKey.from_string(public_key_der), type_=type_
         )
 
+        await self._submit_transaction(DidDocumentOperation.UPDATE, hcs_event)
+
     async def revoke_verification_method(self, id_: str):
         """Revoke existing DID document verification method
 
@@ -245,15 +213,15 @@ async def revoke_verification_method(self, id_: str):
         hcs_event = HcsDidRevokeVerificationMethodEvent(id_)
         await self._submit_transaction(DidDocumentOperation.REVOKE, hcs_event)
 
-    async def add_verification_relationship(
+    async def add_or_update_verification_relationship(
         self,
         id_: str,
         controller: str,
         public_key_der: str,
         relationship_type: VerificationRelationshipType,
         type_: SupportedKeyType,
     ):
-        """Add verification relationship to DID document
+        """Add or update DID document verification relationship
 
         Args:
             id_: Verification relationship ID to create
@@ -262,41 +230,19 @@ async def add_verification_relationship(
             relationship_type: Verification relationship type
             type_: Verification relationship key type
         """
-        await self._add_or_update_verification_relationship(
-            DidDocumentOperation.CREATE,
-            id_=id_,
-            controller=controller,
-            public_key=PublicKey.from_string(public_key_der),
-            relationship_type=relationship_type,
-            type_=type_,
-        )
 
-    async def update_verification_relationship(
-        self,
-        id_: str,
-        controller: str,
-        public_key_der: str,
-        relationship_type: VerificationRelationshipType,
-        type_: SupportedKeyType,
-    ):
-        """Update existing DID document verification relationship
+        self._assert_can_submit_transaction()
 
-        Args:
-            id_: Verification relationship ID to update
-            controller: Verification relationship controller ID
-            public_key_der: Verification relationship public key encoded in DER format
-            relationship_type: Verification relationship type
-            type_: Verification relationship key type
-        """
-        await self._add_or_update_verification_relationship(
-            DidDocumentOperation.UPDATE,
+        hcs_event = HcsDidUpdateVerificationRelationshipEvent(
             id_=id_,
-            public_key=PublicKey.from_string(public_key_der),
             controller=controller,
+            public_key=PublicKey.from_string(public_key_der),
             relationship_type=relationship_type,
             type_=type_,
         )
 
+        await self._submit_transaction(DidDocumentOperation.UPDATE, hcs_event)
+
     async def revoke_verification_relationship(self, id_: str, relationship_type: VerificationRelationshipType):
         """Revoke existing DID document verification relationship
 
@@ -323,27 +269,6 @@ def build_did_transaction(message_submit_transaction: TopicMessageSubmitTransact
 
         await HcsMessageTransaction(self.topic_id, envelope, build_did_transaction).execute(self._client)
 
-    async def _add_or_update_service(
-        self, operation: Literal[DidDocumentOperation.CREATE, DidDocumentOperation.UPDATE], **kwargs
-    ):
-        self._assert_can_submit_transaction()
-
-        await self._submit_transaction(operation, HcsDidUpdateServiceEvent(**kwargs))
-
-    async def _add_or_update_verification_method(
-        self, operation: Literal[DidDocumentOperation.CREATE, DidDocumentOperation.UPDATE], **kwargs
-    ):
-        self._assert_can_submit_transaction()
-
-        await self._submit_transaction(operation, HcsDidUpdateVerificationMethodEvent(**kwargs))
-
-    async def _add_or_update_verification_relationship(
-        self, operation: Literal[DidDocumentOperation.CREATE, DidDocumentOperation.UPDATE], **kwargs
-    ):
-        self._assert_can_submit_transaction()
-
-        await self._submit_transaction(operation, HcsDidUpdateVerificationRelationshipEvent(**kwargs))
-
     async def _handle_resolution_result(self, result: list[HcsDidMessageEnvelope]):
         if not self.identifier:
             raise Exception("Cannot handle DID resolution result: DID identifier is not defined")

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hiero-did-sdk-python"
-version = "0.1.2"
+version = "0.1.3"
 description = "The repository contains the Python SDK for managing DID Documents and Anoncreds Verifiable Credentials registry using Hedera Consensus Service."
 authors = ["Alexander Shenshin <[email protected]>", "Paulo Caldas <[email protected]>"]
 repository = "https://github.com/hiero-ledger/hiero-did-sdk-python"

tests/integration/demo.py

@@ -72,7 +72,7 @@ async def test_demo(self, client: Client):
         )
 
         # Add DID Document service
-        await issuer_did.add_service(
+        await issuer_did.add_or_update_service(
             id_=f"{issuer_did.identifier}#service-1",
             service_type="LinkedDomains",
             service_endpoint="https://example.com/vcs",
@@ -81,7 +81,7 @@ async def test_demo(self, client: Client):
         verification_key = PrivateKey.generate_ed25519()
 
         # Add DID Document Verification Method
-        await issuer_did.add_verification_method(
+        await issuer_did.add_or_update_verification_method(
             id_=f"{issuer_did.identifier}#key-1",
             controller=issuer_did.identifier,
             public_key_der=verification_key.public_key().to_string(),