🎨 Rename Anoncreds to AnonCreds (#3573)

* 🎨 Rename Anoncreds to AnonCreds

Signed-off-by: ff137 <[email protected]>

* 🎨 Organize imports

Signed-off-by: ff137 <[email protected]>

* 🎨 Rename Anoncreds to AnonCreds in docs and other files

Signed-off-by: ff137 <[email protected]>

* 🎨 Fix AnoncredsError

Signed-off-by: ff137 <[email protected]>

* 🎨 Rename AnonCreds in swagger titles

Signed-off-by: ff137 <[email protected]>

* 🎨 Include additional renames

Signed-off-by: ff137 <[email protected]>

* 📝 Updated openapi specs

Signed-off-by: ff137 <[email protected]>

* ⏪ Revert renaming owl-agent-test-harness tag

Signed-off-by: ff137 <[email protected]>

---------

Signed-off-by: ff137 <[email protected]>

Author: ff137

.github/workflows/bdd-interop-tests.yml

@@ -84,7 +84,7 @@ jobs:
         run: |
           cd owl-agent-test-harness
           NO_TTY=1 LEDGER_URL_CONFIG=http://test.bcovrin.vonx.io TAILS_SERVER_URL_CONFIG=https://tails.vonx.io ./manage run -d acapy-main -t @critical -t ~@wip -t ~@T004-RFC0211 -t ~@DidMethod_orb -t ~@Transport_NoHttpOutbound -t ~@Anoncreds >> output.txt
-      - name: Run Release or Nightly Interop Tests Anoncreds
+      - name: Run Release or Nightly Interop Tests AnonCreds
         if: (steps.check_if_release.outputs.is_release == 'true' || github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' && steps.check-if-src-changed.outputs.run_tests != 'false')
         run: |
           cd owl-agent-test-harness

Managing-ACA-Py-Doc-Site.md

@@ -67,7 +67,7 @@ are a few files listed below that we don't generate into the documentation site,
 and they can be ignored.
 
 - `assets/README.md`
-- `design/AnoncredsW3CCompatibility.md`
+- `design/AnonCredsW3CCompatibility.md`
 - `design/UpgradeViaApi.md`
 - `features/W3cCredentials.md`
 

acapy_agent/admin/server.py

@@ -65,7 +65,7 @@
     "acapy::keylist::updated": "keylist",
 }
 
-anoncreds_wallets = singletons.IsAnoncredsSingleton().wallets
+anoncreds_wallets = singletons.IsAnonCredsSingleton().wallets
 in_progress_upgrades = singletons.UpgradeInProgressSingleton()
 
 status_paths = ("/status/live", "/status/ready")

acapy_agent/admin/tests/test_admin_server.py

@@ -567,7 +567,7 @@ async def test_upgrade_middleware(self):
             await storage.delete_record(upgrading_record)
 
             # Upgrade in progress with cache
-            singletons.IsAnoncredsSingleton().set_wallet(profile.name)
+            singletons.IsAnonCredsSingleton().set_wallet(profile.name)
             await test_module.upgrade_middleware(request, handler)
 
 

acapy_agent/anoncreds/base.py

@@ -16,7 +16,7 @@
     RevRegDefResult,
 )
 from .models.schema import AnonCredsSchema, GetSchemaResult, SchemaResult
-from .models.schema_info import AnoncredsSchemaInfo
+from .models.schema_info import AnonCredsSchemaInfo
 
 T = TypeVar("T")
 
@@ -138,12 +138,12 @@ async def get_revocation_list(
     @abstractmethod
     async def get_schema_info_by_id(
         self, profile: Profile, schema_id: str
-    ) -> AnoncredsSchemaInfo:
+    ) -> AnonCredsSchemaInfo:
         """Get a schema info from the registry."""
 
 
 class BaseAnonCredsRegistrar(BaseAnonCredsHandler):
-    """Base Anoncreds Registrar."""
+    """Base AnonCreds Registrar."""
 
     @abstractmethod
     async def register_schema(

acapy_agent/anoncreds/default/did_indy/registry.py

@@ -17,7 +17,7 @@
     RevRegDefResult,
 )
 from ...models.schema import AnonCredsSchema, GetSchemaResult, SchemaResult
-from ...models.schema_info import AnoncredsSchemaInfo
+from ...models.schema_info import AnonCredsSchemaInfo
 
 LOGGER = logging.getLogger(__name__)
 
@@ -122,6 +122,6 @@ async def update_revocation_list(
 
     async def get_schema_info_by_id(
         self, profile: Profile, schema_id: str
-    ) -> AnoncredsSchemaInfo:
+    ) -> AnonCredsSchemaInfo:
         """Get a schema info from the registry."""
         return await super().get_schema_info_by_id(schema_id)

acapy_agent/anoncreds/default/did_web/registry.py

@@ -17,7 +17,7 @@
     RevRegDefResult,
 )
 from ...models.schema import AnonCredsSchema, GetSchemaResult, SchemaResult
-from ...models.schema_info import AnoncredsSchemaInfo
+from ...models.schema_info import AnonCredsSchemaInfo
 
 LOGGER = logging.getLogger(__name__)
 
@@ -124,6 +124,6 @@ async def update_revocation_list(
 
     async def get_schema_info_by_id(
         self, profile: Profile, schema_id: str
-    ) -> AnoncredsSchemaInfo:
+    ) -> AnonCredsSchemaInfo:
         """Get a schema info from the registry."""
         return await super().get_schema_info_by_id(schema_id)

acapy_agent/anoncreds/default/legacy_indy/author.py

@@ -6,9 +6,7 @@
 
 from acapy_agent.connections.models.conn_record import ConnRecord
 from acapy_agent.messaging.models.base import BaseModelError
-from acapy_agent.protocols.endorse_transaction.v1_0.util import (
-    get_endorser_connection_id,
-)
+from acapy_agent.protocols.endorse_transaction.v1_0.util import get_endorser_connection_id
 from acapy_agent.storage.error import StorageNotFoundError
 
 

acapy_agent/anoncreds/default/legacy_indy/registry.py

@@ -74,13 +74,8 @@
     RevRegDefState,
     RevRegDefValue,
 )
-from ...models.schema import (
-    AnonCredsSchema,
-    GetSchemaResult,
-    SchemaResult,
-    SchemaState,
-)
-from ...models.schema_info import AnoncredsSchemaInfo
+from ...models.schema import AnonCredsSchema, GetSchemaResult, SchemaResult, SchemaState
+from ...models.schema_info import AnonCredsSchemaInfo
 from ...revocation import (
     CATEGORY_REV_LIST,
     CATEGORY_REV_REG_DEF,
@@ -1233,10 +1228,10 @@ async def txn_submit(
 
     async def get_schema_info_by_id(
         self, profile: Profile, schema_id: str
-    ) -> AnoncredsSchemaInfo:
+    ) -> AnonCredsSchemaInfo:
         """Get schema info by schema id."""
         schema_id_parts = re.match(r"^(\w+):2:([^:]+):([^:]+)$", schema_id)
-        return AnoncredsSchemaInfo(
+        return AnonCredsSchemaInfo(
             issuer_id=schema_id_parts.group(1),
             name=schema_id_parts.group(2),
             version=schema_id_parts.group(3),

acapy_agent/anoncreds/default/legacy_indy/tests/test_registry.py

@@ -16,9 +16,7 @@
 from .....anoncreds.base import AnonCredsSchemaAlreadyExists
 from .....anoncreds.default.legacy_indy import registry as test_module
 from .....anoncreds.issuer import AnonCredsIssuer
-from .....askar.profile_anon import (
-    AskarAnoncredsProfileSession,
-)
+from .....askar.profile_anon import AskarAnonCredsProfileSession
 from .....connections.models.conn_record import ConnRecord
 from .....core.event_bus import EventBus
 from .....ledger.base import BaseLedger
@@ -31,9 +29,7 @@
 from .....protocols.endorse_transaction.v1_0.models.transaction_record import (
     TransactionRecord,
 )
-from .....revocation_anoncreds.models.issuer_cred_rev_record import (
-    IssuerCredRevRecord,
-)
+from .....revocation_anoncreds.models.issuer_cred_rev_record import IssuerCredRevRecord
 from .....tests import mock
 from .....utils.testing import create_test_profile
 from ....models.credential_definition import (
@@ -800,7 +796,7 @@ async def test_txn_submit(self):
             ),
         ),
     )
-    @mock.patch.object(AskarAnoncredsProfileSession, "handle")
+    @mock.patch.object(AskarAnonCredsProfileSession, "handle")
     async def test_register_revocation_list_no_endorsement(
         self, mock_handle, mock_send_revoc_reg_entry
     ):
@@ -1165,7 +1161,7 @@ async def test_fix_ledger_entry(self, *_):
             update=mock.MagicMock(return_value=MockRevListEntry())
         ),
     )
-    @mock.patch.object(AskarAnoncredsProfileSession, "handle")
+    @mock.patch.object(AskarAnonCredsProfileSession, "handle")
     async def test_sync_wallet_rev_list_with_issuer_cred_rev_records(
         self, mock_handle, *_
     ):

acapy_agent/anoncreds/error_messages.py

@@ -1,3 +1,3 @@
 """Error messages for anoncreds."""
 
-ANONCREDS_PROFILE_REQUIRED_MSG = "AnonCreds interface requires AskarAnoncreds profile"
+ANONCREDS_PROFILE_REQUIRED_MSG = "AnonCreds interface requires AskarAnonCreds profile"

acapy_agent/anoncreds/holder.py

@@ -1,4 +1,4 @@
-"""Anoncreds holder implementation."""
+"""AnonCreds holder implementation."""
 
 import asyncio
 import json
@@ -22,7 +22,7 @@
 from pyld.jsonld import JsonLdProcessor
 from uuid_utils import uuid4
 
-from ..askar.profile_anon import AskarAnoncredsProfile
+from ..askar.profile_anon import AskarAnonCredsProfile
 from ..core.error import BaseError
 from ..core.profile import Profile
 from ..storage.vc_holder.base import VCHolder
@@ -78,9 +78,9 @@ def __init__(self, profile: Profile):
         self._profile = profile
 
     @property
-    def profile(self) -> AskarAnoncredsProfile:
+    def profile(self) -> AskarAnonCredsProfile:
         """Accessor for the profile instance."""
-        if not isinstance(self._profile, AskarAnoncredsProfile):
+        if not isinstance(self._profile, AskarAnonCredsProfile):
             raise ValueError(ANONCREDS_PROFILE_REQUIRED_MSG)
 
         return self._profile
@@ -598,10 +598,10 @@ async def create_presentation(
 
         Args:
             presentation_request: Valid indy format presentation request
-            requested_credentials: Anoncreds format requested credentials
-            schemas: Anoncreds formatted schemas JSON
-            credential_definitions: Anoncreds formatted credential definitions JSON
-            rev_states: Anoncreds format revocation states JSON
+            requested_credentials: AnonCreds format requested credentials
+            schemas: AnonCreds formatted schemas JSON
+            credential_definitions: AnonCreds formatted credential definitions JSON
+            rev_states: AnonCreds format revocation states JSON
 
         """
 
@@ -691,9 +691,9 @@ async def create_presentation_w3c(
             presentation_request: Valid indy format presentation request
             requested_credentials_w3c: W3C format requested credentials
             credentials_w3c_metadata: W3C format credential metadata
-            schemas: Anoncreds formatted schemas JSON
-            credential_definitions: Anoncreds formatted credential definitions JSON
-            rev_states: Anoncreds format revocation states JSON
+            schemas: AnonCreds formatted schemas JSON
+            credential_definitions: AnonCreds formatted credential definitions JSON
+            rev_states: AnonCreds format revocation states JSON
 
         """
         present_creds = PresentCredentials()

acapy_agent/anoncreds/issuer.py

@@ -17,7 +17,7 @@
 )
 from aries_askar import AskarError
 
-from ..askar.profile_anon import AskarAnoncredsProfile, AskarAnoncredsProfileSession
+from ..askar.profile_anon import AskarAnonCredsProfile, AskarAnonCredsProfileSession
 from ..core.error import BaseError
 from ..core.event_bus import Event, EventBus
 from ..core.profile import Profile
@@ -91,9 +91,9 @@ def __init__(self, profile: Profile):
         self._profile = profile
 
     @property
-    def profile(self) -> AskarAnoncredsProfile:
+    def profile(self) -> AskarAnonCredsProfile:
         """Accessor for the profile instance."""
-        if not isinstance(self._profile, AskarAnoncredsProfile):
+        if not isinstance(self._profile, AskarAnonCredsProfile):
             raise ValueError(ANONCREDS_PROFILE_REQUIRED_MSG)
 
         return self._profile
@@ -105,7 +105,7 @@ async def notify(self, event: Event):
 
     async def _finish_registration(
         self,
-        txn: AskarAnoncredsProfileSession,
+        txn: AskarAnonCredsProfileSession,
         category: str,
         job_id: str,
         registered_id: str,

acapy_agent/anoncreds/models/credential.py

@@ -17,13 +17,13 @@
 )
 
 
-class AnoncredsAttrValue(BaseModel):
-    """Anoncreds attribute value."""
+class AnonCredsAttrValue(BaseModel):
+    """AnonCreds attribute value."""
 
     class Meta:
-        """Anoncreds attribute value."""
+        """AnonCreds attribute value."""
 
-        schema_class = "AnoncredsAttrValueSchema"
+        schema_class = "AnonCredsAttrValueSchema"
 
     def __init__(
         self, raw: Optional[str] = None, encoded: Optional[str] = None, **kwargs
@@ -34,13 +34,13 @@ def __init__(
         self.encoded = encoded
 
 
-class AnoncredsAttrValueSchema(BaseModelSchema):
-    """Anoncreds attribute value schema."""
+class AnonCredsAttrValueSchema(BaseModelSchema):
+    """AnonCreds attribute value schema."""
 
     class Meta:
-        """Anoncreds attribute value schema metadata."""
+        """AnonCreds attribute value schema metadata."""
 
-        model_class = AnoncredsAttrValue
+        model_class = AnonCredsAttrValue
         unknown = EXCLUDE
 
     raw = fields.Str(required=True, metadata={"description": "Attribute raw value"})
@@ -54,14 +54,14 @@ class Meta:
     )
 
 
-class DictWithAnoncredsAttrValueSchema(fields.Dict):
+class DictWithAnonCredsAttrValueSchema(fields.Dict):
     """Dict with anoncreds attribute value schema."""
 
     def __init__(self, **kwargs):
-        """Initialize the custom schema for a dictionary with AnoncredsAttrValue."""
+        """Initialize the custom schema for a dictionary with AnonCredsAttrValue."""
         super().__init__(
             keys=fields.Str(metadata={"description": "Attribute name"}),
-            values=fields.Nested(AnoncredsAttrValueSchema()),
+            values=fields.Nested(AnonCredsAttrValueSchema()),
             **kwargs,
         )
 
@@ -71,7 +71,7 @@ def _deserialize(self, value, attr, data, **kwargs):
             raise ValidationError("Value must be a dict.")
 
         errors = {}
-        anoncreds_attr_value_schema = AnoncredsAttrValueSchema()
+        anoncreds_attr_value_schema = AnonCredsAttrValueSchema()
 
         for k, v in value.items():
             if isinstance(v, dict):
@@ -85,20 +85,20 @@ def _deserialize(self, value, attr, data, **kwargs):
         return value
 
 
-class AnoncredsCredential(BaseModel):
-    """Anoncreds credential."""
+class AnonCredsCredential(BaseModel):
+    """AnonCreds credential."""
 
     class Meta:
-        """Anoncreds credential metadata."""
+        """AnonCreds credential metadata."""
 
-        schema_class = "AnoncredsCredentialSchema"
+        schema_class = "AnonCredsCredentialSchema"
 
     def __init__(
         self,
         schema_id: Optional[str] = None,
         cred_def_id: Optional[str] = None,
         rev_reg_id: Optional[str] = None,
-        values: Mapping[str, AnoncredsAttrValue] = None,
+        values: Mapping[str, AnonCredsAttrValue] = None,
         signature: Optional[Mapping] = None,
         signature_correctness_proof: Optional[Mapping] = None,
         rev_reg: Optional[Mapping] = None,
@@ -115,13 +115,13 @@ def __init__(
         self.witness = witness
 
 
-class AnoncredsCredentialSchema(BaseModelSchema):
-    """Anoncreds credential schema."""
+class AnonCredsCredentialSchema(BaseModelSchema):
+    """AnonCreds credential schema."""
 
     class Meta:
-        """Anoncreds credential schemametadata."""
+        """AnonCreds credential schemametadata."""
 
-        model_class = AnoncredsCredential
+        model_class = AnonCredsCredential
         unknown = EXCLUDE
 
     schema_id = fields.Str(
@@ -148,7 +148,7 @@ class Meta:
             "example": ANONCREDS_REV_REG_ID_EXAMPLE,
         },
     )
-    values = DictWithAnoncredsAttrValueSchema(
+    values = DictWithAnonCredsAttrValueSchema(
         required=True,
         metadata={"description": "Credential attributes"},
     )