self-review

Author: meiersi-da

daml/splice-amulet-name-service/daml/Splice/Ans.daml

@@ -288,9 +288,6 @@ template AnsEntryContext
           amuletSum = result.amuletSum
 
 
-
-
-
 -- | A ans entry that needs to be renewed continuously.
 -- Renewal recreates this contract with an updated `expiresAt` field.
 template AnsEntry
@@ -303,18 +300,6 @@ template AnsEntry
     expiresAt : Time
   where
     signatory user, dso
-{-
-
-  issuer: dso
-  holder: user
-  validFrom: None
-  validUntil: Some(expiresAt)
-  claims:
-    cns.canton.network/name: name
-    cns.canton.network/<name>/url: url
-    cns.canton.network/<name>/description: description
-
--}
 
     interface instance RegistryV1.CredentialRecord for AnsEntry where
       view = RegistryV1.CredentialRecordView with
@@ -324,6 +309,10 @@ template AnsEntry
         credential = RegistryV1.Credential with
           claims = TM.fromList [
               ("ans.name", name),
+              -- Make the URL and Description fields properties with the CNS name as the subject
+              -- Not namespaced as we expect them to be defined in a CIP
+              --
+              -- TODO: build the separate CIP that builds ANS on top of the DSO credential registry.
               ("ans.url#" <> name, url),
               ("ans.description#" <> name, description)
             ]

daml/splice-amulet-name-service/daml/Splice/AnsV2/AnsCredential.daml

@@ -53,9 +53,7 @@ template AnsCredentialRegistry with
           newRecords
           meta = emptyMetadata
 
-
-
--- | A credential visible to the DSO and served by its Scan service.
+-- | A credential record visible to the DSO and served by its Scan service.
 template AnsCredentialRecord
   with
     dso : Party
@@ -65,6 +63,7 @@ template AnsCredentialRecord
     createdAt : Time
     expiresAt : Time
   where
+    -- TODO: implement validation rules
     -- ensure validEntry this
 
     signatory issuer, holder

daml/splice-api-credential-registry-v1/daml/Splice/Api/Credential/RegistryV1.daml

@@ -28,11 +28,11 @@ data Credential = Credential with
       -- Implementations SHOULD ensure that claims are stored in canonical form without
       -- redundant '#holder' suffixes in keys.
       --
-      -- Keys MUST only contain characters from [a-zA-Z0-9._:-]
-      -- and SHOULD be namespaced in the form `dns.name/key` to avoid
+      -- Keys MUST only contain characters from [a-zA-Z0-9._:-].
+      -- Unless the keys are defined in an official CIP they
+      -- must be namespaced in the form `dns.name/key` to avoid
       -- collisions between different usecases.
 
-
     validFrom : Optional Time
       -- ^ The time from which this credential is valid.
     validUntil : Optional Time