docs: update method docstrings and inline comments to explain temporary #3649 workaround

Signed-off-by: Yuki I <[email protected]>

Author: Yuki I

acapy_agent/anoncreds/default/legacy_indy/registry.py

@@ -823,7 +823,8 @@ async def _revoc_reg_entry_with_fix(
                     rev_list.issuer_id,
                     write_ledger=write_ledger,
                     endorser_did=endorser_did,
-                    profile=profile,
+                    # Temporary fix for #3624 / #3649
+                    profile=profile,  # Added profile (#3624 / #3649)
                 )
         except LedgerTransactionError as err:
             if "InvalidClientRequest" in err.roll_up:
@@ -1210,7 +1211,7 @@ async def txn_submit(
         taa_accept: Optional[bool] = None,
         sign_did: DIDInfo = sentinel,
         write_ledger: bool = True,
-        profile: Optional[Profile] = None,
+        profile: Optional[Profile] = None,  # Added profile (#3624 / #3649)
     ) -> str:
         """Submit a transaction to the ledger."""
 
@@ -1223,6 +1224,7 @@ async def txn_submit(
                     "write_ledger": write_ledger,
                 }
 
+                # Temporary fix to include profile to resolve #3624 / #3649
                 if profile is not None:
                     kwargs["profile"] = profile
 

acapy_agent/ledger/base.py

@@ -176,8 +176,17 @@ async def rotate_public_did_keypair(self, next_seed: Optional[str] = None) -> No
         """
 
     @abstractmethod
-    async def get_wallet_public_did(self, profile: Optional[Profile] = None) -> DIDInfo:
-        """Fetch the public DID from the wallet."""
+    async def get_wallet_public_did(
+        # Added profile (#3624 / #3649)
+        self,
+        profile: Optional[Profile] = None,
+    ) -> DIDInfo:
+        """Fetch the public DID from the wallet.
+
+        Args:
+            profile: The profile instance to use for this operation.
+                     Temporary fix for #3624. Ideally obtained via context.
+        """
 
     @abstractmethod
     async def get_txn_author_agreement(self, reload: bool = False):
@@ -194,8 +203,17 @@ async def accept_txn_author_agreement(
         """Save a new record recording the acceptance of the TAA."""
 
     @abstractmethod
-    async def get_latest_txn_author_acceptance(self, profile: Optional[Profile] = None):
-        """Look up the latest TAA acceptance."""
+    async def get_latest_txn_author_acceptance(
+        # Added profile (#3624 / #3649)
+        self,
+        profile: Optional[Profile] = None,
+    ):
+        """Look up the latest TAA acceptance.
+
+        Args:
+            profile: The profile instance to use for this operation.
+                     Temporary fix for #3624. Ideally obtained via context.
+        """
 
     def taa_digest(self, version: str, text: str):
         """Generate the digest of a TAA record."""
@@ -220,9 +238,22 @@ async def txn_submit(
         taa_accept: Optional[bool] = None,
         sign_did: DIDInfo = sentinel,
         write_ledger: bool = True,
-        profile: Optional[Profile] = None,
+        profile: Optional[Profile] = None,  # Added profile (#3624 / #3649)
     ) -> str:
-        """Write the provided (signed and possibly endorsed) transaction to the ledger."""
+        """Write the provided (signed and possibly endorsed) transaction to the ledger.
+
+        Args:
+            request_json: Anoncreds-style ledger transaction as a JSON string.
+            sign: Whether to sign the transaction using using `sign_did`.
+            taa_accept: Accept the Transaction Author Agreement, if required.
+            sign_did: DID to sign with. Required if `sign` is True.
+            write_ledger: whether to write the request to the ledger
+            profile: The profile instance to use for this operation.
+                     Temporary fix for #3624. Ideally obtained via context.
+
+        Returns:
+            str: JSON response from the ledger.
+        """
 
     @abstractmethod
     async def fetch_schema_by_id(self, schema_id: str) -> dict:
@@ -416,9 +447,20 @@ async def send_revoc_reg_entry(
         issuer_did: Optional[str] = None,
         write_ledger: bool = True,
         endorser_did: Optional[str] = None,
-        profile: Optional[Profile] = None,
+        profile: Optional[Profile] = None,  # Added profile (#3624 / #3649)
     ) -> dict:
-        """Publish a revocation registry entry to the ledger."""
+        """Publish a revocation registry entry to the ledger.
+
+        Args:
+            revoc_reg_id: ID of the revocation registry.
+            revoc_def_type: Type of revocation registry (e.g. CL_ACCUM).
+            revoc_reg_entry: Entry data to publish.
+            issuer_did: DID of the issuer writing the entry.
+            write_ledger: If False, prepare but don't submit the entry.
+            endorser_did: DID of the endorser if endorsement is required.
+            profile: The profile instance to use for this operation.
+                     Temporary fix for #3624. Ideally obtained via context.
+        """
 
     async def create_and_send_credential_definition(
         self,

acapy_agent/ledger/indy_vdr.py

@@ -312,7 +312,7 @@ async def _submit(
         taa_accept: Optional[bool] = None,
         sign_did: DIDInfo = sentinel,
         write_ledger: bool = True,
-        profile: Optional[Profile] = None,
+        profile: Optional[Profile] = None,  # Added profile (#3624 / #3649)
     ) -> dict:
         """Sign and submit request to ledger.
 
@@ -323,8 +323,11 @@ async def _submit(
             sign_did: override the signing DID
             write_ledger: whether to write the request to the ledger
             profile: The profile context used for the request
+                     Temporary fix for #3624 to ensure correct wallet/TAA context,
+                     bypassing potentially incorrect self.profile from manager.
         """
 
+        # Temporary fix to use profile if provided, otherwise fallback
         current_profile = profile or self.profile
         if not self.pool_handle:
             raise ClosedPoolError(
@@ -1016,9 +1019,12 @@ async def accept_txn_author_agreement(
             await cache.set(cache_key, acceptance, self.pool.cache_duration)
 
     async def get_latest_txn_author_acceptance(
-        self, profile: Optional[Profile] = None
+        self,
+        profile: Optional[Profile] = None,  # Added profile (#3624 / #3649)
     ) -> dict:
         """Look up the latest TAA acceptance."""
+
+        # Temporary fix to use profile if provided, otherwise fallback
         current_profile = profile or self.profile
         cache_key = TAA_ACCEPTED_RECORD_TYPE + "::" + current_profile.name
         acceptance = self.pool.cache and await self.pool.cache.get(cache_key)
@@ -1240,10 +1246,11 @@ async def send_revoc_reg_entry(
         issuer_did: Optional[str] = None,
         write_ledger: bool = True,
         endorser_did: Optional[str] = None,
-        profile: Optional[Profile] = None,
+        profile: Optional[Profile] = None,  # Added profile (#3624 / #3649)
     ) -> dict:
         """Publish a revocation registry entry to the ledger."""
 
+        # Temporary fix to use profile if provided, otherwise fallback
         current_profile = profile or self.profile
         async with current_profile.session() as session:
             wallet = session.inject(BaseWallet)
@@ -1324,8 +1331,14 @@ async def send_revoc_reg_entry(
                     "Exception when sending revocation registry entry"
                 ) from err
 
-    async def get_wallet_public_did(self, profile: Optional[Profile] = None) -> DIDInfo:
+    async def get_wallet_public_did(
+        # Added profile (#3624 / #3649)
+        self,
+        profile: Optional[Profile] = None,
+    ) -> DIDInfo:
         """Fetch the public DID from the wallet."""
+
+        # Temporary fix to use profile if provided, otherwise fallback
         current_profile = profile or self.profile
         async with current_profile.session() as session:
             wallet = session.inject(BaseWallet)
@@ -1365,7 +1378,7 @@ async def txn_submit(
         taa_accept: Optional[bool] = None,
         sign_did: DIDInfo = sentinel,
         write_ledger: bool = True,
-        profile: Optional[Profile] = None,
+        profile: Optional[Profile] = None,  # Added profile (#3624 / #3649)
     ) -> str:
         """Write the provided (signed and possibly endorsed) transaction to the ledger."""
         kwargs = {
@@ -1375,6 +1388,7 @@ async def txn_submit(
             "write_ledger": write_ledger,
         }
 
+        # Temporary fix to include profile in _submit to resolve error
         if profile:
             kwargs["profile"] = profile