refactor: remove connection protocol (openwallet-foundation#3184)

* refactor: drop argparse references to connections proto Signed-off-by: Daniel Bluhm <[email protected]> * refactor: allow overridding BaseConnectionManager Signed-off-by: Daniel Bluhm <[email protected]> * refactor: move routes for connection management Signed-off-by: Daniel Bluhm <[email protected]> * refactor: remove conn proto routes Signed-off-by: Daniel Bluhm <[email protected]> * refactor: base conn manager references to conn proto Signed-off-by: Daniel Bluhm <[email protected]> * refactor: conn record references to conn proto Signed-off-by: Daniel Bluhm <[email protected]> * refactor: conn record tests Signed-off-by: Daniel Bluhm <[email protected]> * refactor: test base manager Signed-off-by: Daniel Bluhm <[email protected]> * refactor: conductor references to conn proto Signed-off-by: Daniel Bluhm <[email protected]> * refactor: test conductor Signed-off-by: Daniel Bluhm <[email protected]> * refactor: test oob processor Signed-off-by: Daniel Bluhm <[email protected]> * refactor: update mediation route ref Signed-off-by: Daniel Bluhm <[email protected]> * refactor: forward invitation message and handler Signed-off-by: Daniel Bluhm <[email protected]> * refactor: forward invitation request Signed-off-by: Daniel Bluhm <[email protected]> * refactor: forward invite handler tests Signed-off-by: Daniel Bluhm <[email protected]> * refactor: introduction proto message tests Signed-off-by: Daniel Bluhm <[email protected]> * refactor: oob manager Signed-off-by: Daniel Bluhm <[email protected]> * refactor: oob invitation message Signed-off-by: Daniel Bluhm <[email protected]> * refactor: oob manager tests Signed-off-by: Daniel Bluhm <[email protected]> * refactor: routing proto conn proto refs Signed-off-by: Daniel Bluhm <[email protected]> * refactor: endorsement setup conn proto refs Signed-off-by: Daniel Bluhm <[email protected]> * refactor: drop conn proto from scenario tests Signed-off-by: Daniel Bluhm <[email protected]> * refactor: delete conn proto Signed-off-by: Daniel Bluhm <[email protected]> * fix: conductor test failure for static conn create Signed-off-by: Daniel Bluhm <[email protected]> --------- Signed-off-by: Daniel Bluhm <[email protected]>
ff137 · Jan 23, 2025 · 0a1e946 · 0a1e946
1 parent c849183
commit 0a1e946
Show file tree

Hide file tree

Showing 57 changed files with 426 additions and 6,182 deletions.
diff --git a/acapy_agent/config/argparse.py b/acapy_agent/config/argparse.py
@@ -295,15 +295,6 @@ def add_arguments(self, parser: ArgumentParser):
                 "invitation URL. Default: false."
             ),
         )
-        parser.add_argument(
-            "--connections-invite",
-            action="store_true",
-            env_var="ACAPY_CONNECTIONS_INVITE",
-            help=(
-                "After startup, generate and print a new connections protocol "
-                "style invitation URL. Default: false."
-            ),
-        )
         parser.add_argument(
             "--invite-label",
             dest="invite_label",
@@ -441,8 +432,6 @@ def get_settings(self, args: Namespace) -> dict:
             settings["debug.seed"] = args.debug_seed
         if args.invite:
             settings["debug.print_invitation"] = True
-        if args.connections_invite:
-            settings["debug.print_connections_invitation"] = True
         if args.invite_label:
             settings["debug.invite_label"] = args.invite_label
         if args.invite_multi_use:
@@ -1463,24 +1452,12 @@ def add_arguments(self, parser: ArgumentParser):
                 "and send mediation request and set as default mediator."
             ),
         )
-        parser.add_argument(
-            "--mediator-connections-invite",
-            action="store_true",
-            env_var="ACAPY_MEDIATION_CONNECTIONS_INVITE",
-            help=(
-                "Connect to mediator through a connection invitation. "
-                "If not specified, connect using an OOB invitation. "
-                "Default: false."
-            ),
-        )
 
     def get_settings(self, args: Namespace):
         """Extract mediation invitation settings."""
         settings = {}
         if args.mediator_invitation:
             settings["mediation.invite"] = args.mediator_invitation
-        if args.mediator_connections_invite:
-            settings["mediation.connections_invite"] = True
 
         return settings
 

diff --git a/acapy_agent/config/default_context.py b/acapy_agent/config/default_context.py
@@ -3,10 +3,11 @@
 from ..anoncreds.registry import AnonCredsRegistry
 from ..cache.base import BaseCache
 from ..cache.in_memory import InMemoryCache
+from ..connections.base_manager import BaseConnectionManager
 from ..core.event_bus import EventBus
 from ..core.goal_code_registry import GoalCodeRegistry
 from ..core.plugin_registry import PluginRegistry
-from ..core.profile import ProfileManager, ProfileManagerProvider
+from ..core.profile import Profile, ProfileManager, ProfileManagerProvider
 from ..core.protocol_registry import ProtocolRegistry
 from ..protocols.actionmenu.v1_0.base_service import BaseMenuService
 from ..protocols.actionmenu.v1_0.driver_service import DriverMenuService
@@ -117,6 +118,12 @@ async def bind_providers(self, context: InjectionContext):
         context.injector.bind_instance(BaseMenuService, DriverMenuService(context))
         context.injector.bind_instance(BaseIntroductionService, DemoIntroductionService())
 
+        # Allow BaseConnectionManager to be overridden
+        context.injector.bind_provider(
+            BaseConnectionManager,
+            ClassProvider(BaseConnectionManager, ClassProvider.Inject(Profile)),
+        )
+
     async def load_plugins(self, context: InjectionContext):
         """Set up plugin registry and load plugins."""
 
@@ -135,6 +142,7 @@ async def load_plugins(self, context: InjectionContext):
 
         plugin_registry.register_plugin("acapy_agent.ledger")
 
+        plugin_registry.register_plugin("acapy_agent.connections")
         plugin_registry.register_plugin("acapy_agent.messaging.jsonld")
         plugin_registry.register_plugin("acapy_agent.resolver")
         plugin_registry.register_plugin("acapy_agent.settings")

diff --git a/acapy_agent/connections/base_manager.py b/acapy_agent/connections/base_manager.py
@@ -6,6 +6,7 @@
 import json
 import logging
 from typing import Dict, List, Optional, Sequence, Text, Tuple, Union
+import warnings
 
 import pydid
 from base58 import b58decode
@@ -28,10 +29,7 @@
 from ..core.profile import Profile
 from ..did.did_key import DIDKey
 from ..multitenant.base import BaseMultitenantManager
-from ..protocols.connections.v1_0.message_types import ARIES_PROTOCOL as CONN_PROTO
-from ..protocols.connections.v1_0.messages.connection_invitation import (
-    ConnectionInvitation,
-)
+from ..protocols.didexchange.v1_0.message_types import ARIES_PROTOCOL as CONN_PROTO
 from ..protocols.coordinate_mediation.v1_0.models.mediation_record import (
     MediationRecord,
 )
@@ -301,6 +299,8 @@ async def create_did_document(
     ) -> DIDDoc:
         """Create our DID doc for a given DID.
 
+        This method is deprecated and will be removed.
+
         Args:
             did_info (DIDInfo): The DID information (DID and verkey) used in the
                 connection.
@@ -313,6 +313,7 @@ async def create_did_document(
             DIDDoc: The prepared `DIDDoc` instance.
 
         """
+        warnings.warn("create_did_document is deprecated and will be removed soon")
         did_doc = DIDDoc(did=did_info.did)
         did_controller = did_info.did
         did_key = did_info.verkey
@@ -615,7 +616,7 @@ def _extract_key_material_in_base58_format(method: VerificationMethod) -> str:
     async def _fetch_connection_targets_for_invitation(
         self,
         connection: ConnRecord,
-        invitation: Union[ConnectionInvitation, InvitationMessage],
+        invitation: InvitationMessage,
         sender_verkey: str,
     ) -> Sequence[ConnectionTarget]:
         """Get a list of connection targets for an invitation.
@@ -625,48 +626,31 @@ async def _fetch_connection_targets_for_invitation(
 
         Args:
             connection (ConnRecord): The connection record associated with the invitation.
-            invitation (Union[ConnectionInvitation, InvitationMessage]): The connection
+            invitation (InvitationMessage): The connection
                 or OOB invitation retrieved from the connection record.
             sender_verkey (str): The sender's verification key.
 
         Returns:
             Sequence[ConnectionTarget]: A list of `ConnectionTarget` objects
                 representing the connection targets for the invitation.
         """
-        if isinstance(invitation, ConnectionInvitation):
-            # conn protocol invitation
-            if invitation.did:
-                did = invitation.did
-                (
-                    endpoint,
-                    recipient_keys,
-                    routing_keys,
-                ) = await self.resolve_invitation(did)
+        assert invitation.services, "Schema requires services in invitation"
+        oob_service_item = invitation.services[0]
+        if isinstance(oob_service_item, str):
+            (
+                endpoint,
+                recipient_keys,
+                routing_keys,
+            ) = await self.resolve_invitation(oob_service_item)
 
-            else:
-                endpoint = invitation.endpoint
-                recipient_keys = invitation.recipient_keys
-                routing_keys = invitation.routing_keys
         else:
-            # out-of-band invitation
-            oob_service_item = invitation.services[0]
-            if isinstance(oob_service_item, str):
-                (
-                    endpoint,
-                    recipient_keys,
-                    routing_keys,
-                ) = await self.resolve_invitation(oob_service_item)
-
-            else:
-                endpoint = oob_service_item.service_endpoint
-                recipient_keys = [
-                    DIDKey.from_did(k).public_key_b58
-                    for k in oob_service_item.recipient_keys
-                ]
-                routing_keys = [
-                    DIDKey.from_did(k).public_key_b58
-                    for k in oob_service_item.routing_keys
-                ]
+            endpoint = oob_service_item.service_endpoint
+            recipient_keys = [
+                DIDKey.from_did(k).public_key_b58 for k in oob_service_item.recipient_keys
+            ]
+            routing_keys = [
+                DIDKey.from_did(k).public_key_b58 for k in oob_service_item.routing_keys
+            ]
 
         return [
             ConnectionTarget(

diff --git a/acapy_agent/connections/models/conn_record.py b/acapy_agent/connections/models/conn_record.py
@@ -15,16 +15,6 @@
     RAW_ED25519_2018_PUBLIC_KEY_VALIDATE,
     UUID4_EXAMPLE,
 )
-from ...protocols.connections.v1_0.message_types import ARIES_PROTOCOL as CONN_PROTO
-from ...protocols.connections.v1_0.message_types import (
-    CONNECTION_INVITATION,
-    CONNECTION_REQUEST,
-)
-from ...protocols.connections.v1_0.messages.connection_invitation import (
-    ConnectionInvitation,
-)
-from ...protocols.connections.v1_0.messages.connection_request import ConnectionRequest
-from ...protocols.didcomm_prefix import DIDCommPrefix
 from ...protocols.didexchange.v1_0.message_types import ARIES_PROTOCOL as DIDEX_1_1
 from ...protocols.didexchange.v1_0.message_types import DIDEX_1_0
 from ...protocols.didexchange.v1_0.messages.request import DIDXRequest
@@ -44,7 +34,7 @@ class Meta:
 
         schema_class = "MaybeStoredConnRecordSchema"
 
-    SUPPORTED_PROTOCOLS = (CONN_PROTO, DIDEX_1_0, DIDEX_1_1)
+    SUPPORTED_PROTOCOLS = (DIDEX_1_0, DIDEX_1_1)
 
     class Role(Enum):
         """RFC 160 (inviter, invitee) = RFC 23 (responder, requester)."""
@@ -430,7 +420,7 @@ async def retrieve_by_alias(cls, session: ProfileSession, alias: str) -> "ConnRe
     async def attach_invitation(
         self,
         session: ProfileSession,
-        invitation: Union[ConnectionInvitation, OOBInvitation],
+        invitation: OOBInvitation,
     ):
         """Persist the related connection invitation to storage.
 
@@ -447,9 +437,7 @@ async def attach_invitation(
         storage = session.inject(BaseStorage)
         await storage.add_record(record)
 
-    async def retrieve_invitation(
-        self, session: ProfileSession
-    ) -> Union[ConnectionInvitation, OOBInvitation]:
+    async def retrieve_invitation(self, session: ProfileSession) -> OOBInvitation:
         """Retrieve the related connection invitation.
 
         Args:
@@ -462,16 +450,12 @@ async def retrieve_invitation(
             {"connection_id": self.connection_id},
         )
         ser = json.loads(result.value)
-        return (
-            ConnectionInvitation
-            if DIDCommPrefix.unqualify(ser["@type"]) == CONNECTION_INVITATION
-            else OOBInvitation
-        ).deserialize(ser)
+        return OOBInvitation.deserialize(ser)
 
     async def attach_request(
         self,
         session: ProfileSession,
-        request: Union[ConnectionRequest, DIDXRequest],
+        request: DIDXRequest,
     ):
         """Persist the related connection request to storage.
 
@@ -491,7 +475,7 @@ async def attach_request(
     async def retrieve_request(
         self,
         session: ProfileSession,
-    ) -> Union[ConnectionRequest, DIDXRequest]:
+    ) -> DIDXRequest:
         """Retrieve the related connection invitation.
 
         Args:
@@ -503,11 +487,7 @@ async def retrieve_request(
             self.RECORD_TYPE_REQUEST, {"connection_id": self.connection_id}
         )
         ser = json.loads(result.value)
-        return (
-            ConnectionRequest
-            if DIDCommPrefix.unqualify(ser["@type"]) == CONNECTION_REQUEST
-            else DIDXRequest
-        ).deserialize(ser)
+        return DIDXRequest.deserialize(ser)
 
     @property
     def is_ready(self) -> str:
@@ -709,7 +689,7 @@ class Meta:
         validate=validate.OneOf(ConnRecord.SUPPORTED_PROTOCOLS),
         metadata={
             "description": "Connection protocol used",
-            "example": "connections/1.0",
+            "example": "didexchange/1.1",
         },
     )
     rfc23_state = fields.Str(