remove required dependencies from multi-ledger code; use consistent r…

…esult format for get_ledger_for_identifier method

Signed-off-by: Andrew Whitehead <[email protected]>

aries_cloudagent/core/conductor.py

@@ -15,7 +15,6 @@
 
 from ..admin.base_server import BaseAdminServer
 from ..admin.server import AdminResponder, AdminServer
-from ..askar.profile import AskarProfile
 from ..config.default_context import ContextBuilder
 from ..config.injection_context import InjectionContext
 from ..config.provider import ClassProvider
@@ -27,12 +26,9 @@
 from ..config.logging import LoggingConfigurator
 from ..config.wallet import wallet_config
 from ..core.profile import Profile
-from ..indy.sdk.profile import IndySdkProfile
 from ..indy.verifier import IndyVerifier
 from ..ledger.base import BaseLedger
 from ..ledger.error import LedgerConfigError, LedgerTransactionError
-from ..ledger.indy import IndySdkLedger
-from ..ledger.indy_vdr import IndyVdrLedger
 from ..ledger.multiple_ledger.base_manager import (
     BaseMultipleLedgerManager,
     MultipleLedgerManagerError,
@@ -67,6 +63,7 @@
 from ..utils.task_queue import CompletedTask, TaskQueue
 from ..vc.ld_proofs.document_loader import DocumentLoader
 from ..wallet.did_info import DIDInfo
+
 from .dispatcher import Dispatcher
 from .util import STARTUP_EVENT_TOPIC, SHUTDOWN_EVENT_TOPIC
 
@@ -139,8 +136,9 @@ async def setup(self):
                         BaseMultipleLedgerManager
                     ).get_write_ledger()
                 )[1]
-                if isinstance(self.root_profile, AskarProfile) and isinstance(
-                    ledger, IndyVdrLedger
+                if (
+                    self.root_profile.BACKEND_NAME == "askar"
+                    and ledger.BACKEND_NAME == "indy_vdr"
                 ):
                     context.injector.bind_instance(BaseLedger, ledger)
                     context.injector.bind_provider(
@@ -150,8 +148,9 @@ async def setup(self):
                             self.root_profile,
                         ),
                     )
-                elif isinstance(self.root_profile, IndySdkProfile) and isinstance(
-                    ledger, IndySdkLedger
+                elif (
+                    self.root_profile.BACKEND_NAME == "indy"
+                    and ledger.BACKEND_NAME == "indy"
                 ):
                     context.injector.bind_instance(BaseLedger, ledger)
                     context.injector.bind_provider(

aries_cloudagent/core/profile.py

@@ -21,8 +21,8 @@
 class Profile(ABC):
     """Base abstraction for handling identity-related state."""
 
-    BACKEND_NAME = None
-    DEFAULT_NAME = "default"
+    BACKEND_NAME: str = None
+    DEFAULT_NAME: str = "default"
 
     def __init__(
         self,

aries_cloudagent/indy/credx/tests/test_cred_issuance.py

@@ -80,7 +80,7 @@ async def setUp(self):
             IndyLedgerRequestsExecutor,
             async_mock.MagicMock(
                 get_ledger_for_identifier=async_mock.CoroutineMock(
-                    return_value=mock_ledger
+                    return_value=(None, mock_ledger)
                 )
             ),
         )

aries_cloudagent/indy/models/pres_preview.py

@@ -352,14 +352,12 @@ def non_revoc(cred_def_id: str) -> IndyNonRevocationInterval:
             if cd_id:
                 if profile:
                     ledger_exec_inst = profile.inject(IndyLedgerRequestsExecutor)
-                    ledger_info = await ledger_exec_inst.get_ledger_for_identifier(
-                        cd_id,
-                        txn_record_type=GET_CRED_DEF,
-                    )
-                    if isinstance(ledger_info, tuple):
-                        ledger = ledger_info[1]
-                    else:
-                        ledger = ledger_info
+                    ledger = (
+                        await ledger_exec_inst.get_ledger_for_identifier(
+                            cd_id,
+                            txn_record_type=GET_CRED_DEF,
+                        )
+                    )[1]
                 if ledger:
                     async with ledger:
                         revoc_support = (await ledger.get_credential_definition(cd_id))[
@@ -413,14 +411,12 @@ def non_revoc(cred_def_id: str) -> IndyNonRevocationInterval:
             if cd_id:
                 if profile:
                     ledger_exec_inst = profile.inject(IndyLedgerRequestsExecutor)
-                    ledger_info = await ledger_exec_inst.get_ledger_for_identifier(
-                        cd_id,
-                        txn_record_type=GET_CRED_DEF,
-                    )
-                    if isinstance(ledger_info, tuple):
-                        ledger = ledger_info[1]
-                    else:
-                        ledger = ledger_info
+                    ledger = (
+                        await ledger_exec_inst.get_ledger_for_identifier(
+                            cd_id,
+                            txn_record_type=GET_CRED_DEF,
+                        )
+                    )[1]
                 if ledger:
                     async with ledger:
                         revoc_support = (await ledger.get_credential_definition(cd_id))[

aries_cloudagent/indy/models/tests/test_pres_preview.py

@@ -403,10 +403,13 @@ async def test_to_indy_proof_request_revo_default_interval(self):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = async_mock.MagicMock(
-                get_credential_definition=async_mock.CoroutineMock(
-                    return_value={"value": {"revocation": {"...": "..."}}}
-                )
+            mock_get_ledger.return_value = (
+                None,
+                async_mock.MagicMock(
+                    get_credential_definition=async_mock.CoroutineMock(
+                        return_value={"value": {"revocation": {"...": "..."}}}
+                    )
+                ),
             )
             indy_proof_req_revo = await pres_preview.indy_proof_request(
                 **{k: INDY_PROOF_REQ[k] for k in ("name", "version", "nonce")},
@@ -443,10 +446,13 @@ async def test_to_indy_proof_request_revo(self):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = async_mock.MagicMock(
-                get_credential_definition=async_mock.CoroutineMock(
-                    return_value={"value": {"revocation": {"...": "..."}}}
-                )
+            mock_get_ledger.return_value = (
+                None,
+                async_mock.MagicMock(
+                    get_credential_definition=async_mock.CoroutineMock(
+                        return_value={"value": {"revocation": {"...": "..."}}}
+                    )
+                ),
             )
             indy_proof_req_revo = await pres_preview.indy_proof_request(
                 **{k: INDY_PROOF_REQ[k] for k in ("name", "version", "nonce")},

aries_cloudagent/indy/sdk/tests/test_verifier.py

@@ -334,7 +334,7 @@ async def test_verify_presentation(self, mock_verify):
         ) as mock_non_revox, async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             INDY_PROOF_REQ_X = deepcopy(INDY_PROOF_REQ_PRED_NAMES)
             verified = await self.verifier.verify_presentation(
                 INDY_PROOF_REQ_X,
@@ -395,7 +395,7 @@ async def test_check_encoding_attr(self, mock_verify):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             mock_verify.return_value = True
             verified = await self.verifier.verify_presentation(
                 INDY_PROOF_REQ_NAME,
@@ -448,7 +448,7 @@ async def test_check_encoding_attr_tamper_encoded(self, mock_verify):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             verified = await self.verifier.verify_presentation(
                 INDY_PROOF_REQ_NAME,
                 INDY_PROOF_X,
@@ -501,7 +501,7 @@ async def test_check_pred_names_tamper_pred_value(self, mock_verify):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             verified = await self.verifier.verify_presentation(
                 deepcopy(INDY_PROOF_REQ_PRED_NAMES),
                 INDY_PROOF_X,
@@ -522,7 +522,7 @@ async def test_check_pred_names_tamper_pred_req_attr(self, mock_verify):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             verified = await self.verifier.verify_presentation(
                 INDY_PROOF_REQ_X,
                 INDY_PROOF_PRED_NAMES,

aries_cloudagent/indy/tests/test_verifier.py

@@ -341,7 +341,7 @@ async def test_check_timestamps(self):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             await self.verifier.check_timestamps(
                 mock_profile,
                 INDY_PROOF_REQ_NAME,
@@ -353,13 +353,16 @@ async def test_check_timestamps(self):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = async_mock.MagicMock(
-                get_credential_definition=async_mock.CoroutineMock(
-                    return_value={
-                        "...": "...",
-                        "value": {"no": "revocation"},
-                    }
-                )
+            mock_get_ledger.return_value = (
+                None,
+                async_mock.MagicMock(
+                    get_credential_definition=async_mock.CoroutineMock(
+                        return_value={
+                            "...": "...",
+                            "value": {"no": "revocation"},
+                        }
+                    )
+                ),
             )
             with self.assertRaises(ValueError) as context:
                 await self.verifier.check_timestamps(
@@ -374,7 +377,7 @@ async def test_check_timestamps(self):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             proof_x = deepcopy(INDY_PROOF_NAME)
             proof_x["identifiers"][0]["timestamp"] = None
             proof_x["identifiers"][0]["rev_reg_id"] = None
@@ -420,7 +423,7 @@ async def test_check_timestamps(self):
         ) as mock_logger, async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             pre_logger_calls = mock_logger.info.call_count
             await self.verifier.check_timestamps(
                 mock_profile,
@@ -437,7 +440,7 @@ async def test_check_timestamps(self):
         with async_mock.patch.object(
             IndyLedgerRequestsExecutor, "get_ledger_for_identifier"
         ) as mock_get_ledger:
-            mock_get_ledger.return_value = self.ledger
+            mock_get_ledger.return_value = (None, self.ledger)
             with self.assertRaises(ValueError) as context:
                 await self.verifier.check_timestamps(
                     mock_profile,

aries_cloudagent/indy/verifier.py

@@ -106,14 +106,12 @@ async def check_timestamps(
             if ident.get("timestamp"):
                 cred_def_id = ident["cred_def_id"]
                 ledger_exec_inst = profile.inject(IndyLedgerRequestsExecutor)
-                ledger_info = await ledger_exec_inst.get_ledger_for_identifier(
-                    cred_def_id,
-                    txn_record_type=GET_CRED_DEF,
-                )
-                if isinstance(ledger_info, tuple):
-                    ledger = ledger_info[1]
-                else:
-                    ledger = ledger_info
+                ledger = (
+                    await ledger_exec_inst.get_ledger_for_identifier(
+                        cred_def_id,
+                        txn_record_type=GET_CRED_DEF,
+                    )
+                )[1]
                 async with ledger:
                     cred_def = await ledger.get_credential_definition(cred_def_id)
                     if not cred_def["value"].get("revocation"):

aries_cloudagent/ledger/base.py

@@ -17,7 +17,7 @@
 class BaseLedger(ABC, metaclass=ABCMeta):
     """Base class for ledger."""
 
-    BACKEND_NAME = None
+    BACKEND_NAME: str = None
 
     async def __aenter__(self) -> "BaseLedger":
         """

aries_cloudagent/ledger/merkel_validation/tests/test_domain_txn_handler.py

@@ -6,8 +6,6 @@
 
 from unittest import TestCase
 
-from aries_cloudagent.ledger.multiple_ledger.base_manager import T
-
 from ..domain_txn_handler import (
     _extract_attr_typed_value,
     parse_attr_txn,

aries_cloudagent/ledger/multiple_ledger/base_manager.py

@@ -1,12 +1,11 @@
 """Manager for multiple ledger."""
 
 from abc import ABC, abstractmethod
-from typing import TypeVar, Optional, Tuple, Mapping
+from typing import Optional, Tuple, Mapping
 
 from ...core.error import BaseError
 from ...core.profile import Profile
-
-T = TypeVar("T")
+from ...ledger.base import BaseLedger
 
 
 class MultipleLedgerManagerError(BaseError):
@@ -20,7 +19,7 @@ def __init__(self, profile: Profile):
         """Initialize Multiple Ledger Manager."""
 
     @abstractmethod
-    async def get_write_ledger(self) -> Tuple[str, T]:
+    async def get_write_ledger(self) -> Tuple[str, BaseLedger]:
         """Return write ledger."""
 
     @abstractmethod
@@ -34,13 +33,13 @@ async def get_nonprod_ledgers(self) -> Mapping:
     @abstractmethod
     async def _get_ledger_by_did(
         self, ledger_id: str, did: str
-    ) -> Optional[Tuple[str, T, bool]]:
+    ) -> Optional[Tuple[str, BaseLedger, bool]]:
         """Build and submit GET_NYM request and process response."""
 
     @abstractmethod
     async def lookup_did_in_configured_ledgers(
         self, did: str, cache_did: bool
-    ) -> Tuple[str, T]:
+    ) -> Tuple[str, BaseLedger]:
         """Lookup given DID in configured ledgers in parallel."""
 
     def extract_did_from_identifier(self, identifier: str) -> str:

aries_cloudagent/ledger/multiple_ledger/ledger_requests_executor.py

@@ -1,11 +1,9 @@
 """Ledger Request Executor."""
-from typing import Tuple, Union, Optional
+from typing import Optional, Tuple
 
 from ...config.base import InjectionError
 from ...core.profile import Profile
 from ...ledger.base import BaseLedger
-from ...ledger.indy import IndySdkLedger
-from ...ledger.indy_vdr import IndyVdrLedger
 from ...ledger.multiple_ledger.base_manager import (
     BaseMultipleLedgerManager,
     MultipleLedgerManagerError,
@@ -41,16 +39,11 @@ def __init__(
 
     async def get_ledger_for_identifier(
         self, identifier: str, txn_record_type: int
-    ) -> Union[
-        Optional[IndyVdrLedger],
-        Optional[IndySdkLedger],
-        Tuple[str, IndyVdrLedger],
-        Tuple[str, IndySdkLedger],
-    ]:
+    ) -> Tuple[Optional[str], Optional[BaseLedger]]:
         """Return ledger info given the record identifier."""
         # For seqNo
         if identifier.isdigit():
-            return self.profile.inject(BaseLedger)
+            return (None, self.profile.inject(BaseLedger))
         elif (
             self.profile.settings.get("ledger.ledger_config_list")
             and len(self.profile.settings.get("ledger.ledger_config_list")) > 0
@@ -66,6 +59,5 @@ async def get_ledger_for_identifier(
                     extracted_did, cache_did=cache_did
                 )
             except (MultipleLedgerManagerError, InjectionError):
-                return self.profile.inject_or(BaseLedger)
-        else:
-            return self.profile.inject_or(BaseLedger)
+                pass
+        return (None, self.profile.inject_or(BaseLedger))