refactor: replace HabState with Identifier in various classes and methods for consistency

Author: Sotatek-DucPhung

src/main/java/org/cardanofoundation/signify/app/Contacting.java

@@ -19,6 +19,7 @@
 import java.util.Optional;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
 import java.util.concurrent.ExecutionException;
+import org.cardanofoundation.signify.generated.keria.model.Identifier;
 
 public class Contacting {
 
@@ -66,7 +67,7 @@ public Challenge generate() throws LibsodiumException, IOException, InterruptedE
          * @throws Exception if the fetch operation fails
          */
         public Object respond(String name, String recipient, List<String> words) throws IOException, InterruptedException, DigestException, ExecutionException, LibsodiumException {
-            States.HabState hab = this.client.identifiers().get(name)
+            Identifier hab = this.client.identifiers().get(name)
                     .orElseThrow(() -> new IllegalArgumentException("Identifier not found: " + name));
             Exchanging.Exchanges exchanges = this.client.exchanges();
 

src/main/java/org/cardanofoundation/signify/app/Exchanging.java

@@ -19,6 +19,7 @@
 import java.security.DigestException;
 import java.util.*;
 import java.util.concurrent.ExecutionException;
+import org.cardanofoundation.signify.generated.keria.model.Identifier;
 
 public class Exchanging {
     @Getter
@@ -46,7 +47,7 @@ public Exchanges(SignifyClient client) {
          * @return array containing [Serder, signatures, attachment]
          */
         public ExchangeMessageResult createExchangeMessage(
-            HabState sender,
+            Identifier sender,
             String route,
             Map<String, Object> payload,
             Map<String, List<Object>> embeds,
@@ -89,7 +90,7 @@ public ExchangeMessageResult createExchangeMessage(
         public Object send(
             String name,
             String topic,
-            HabState sender,
+            Identifier sender,
             String route,
             Map<String, Object> payload,
             Map<String, List<Object>> embeds,

src/main/java/org/cardanofoundation/signify/app/aiding/CreateIdentifierArgs.java

@@ -6,6 +6,7 @@
 import org.cardanofoundation.signify.cesr.Salter.Tier;
 import org.cardanofoundation.signify.core.Manager.Algos;
 import org.cardanofoundation.signify.core.States.HabState;
+import org.cardanofoundation.signify.generated.keria.model.Identifier;
 
 @Getter
 @Setter
@@ -28,7 +29,7 @@ public class CreateIdentifierArgs {
     private List<Object> rstates;
     private List<Object> prxs;
     private List<Object> nxts;
-    private HabState mhab;
+    private Identifier mhab;
     private List<String> keys;
     private List<String> ndigs;
     private String bran;

…ation/signify/app/aiding/Identifier.java …ify/app/aiding/IdentifierController.javasrc/main/java/org/cardanofoundation/signify/app/aiding/Identifier.java renamed to src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierController.java src/main/java/org/cardanofoundation/signify/app/aiding/Identifier.java renamed to src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierController.java

@@ -28,19 +28,21 @@
 import java.security.DigestException;
 import java.util.*;
 import java.util.concurrent.ExecutionException;
+import org.cardanofoundation.signify.generated.keria.model.Identifier;
+import org.cardanofoundation.signify.generated.keria.model.KeyStateRecord;
 
 import static org.cardanofoundation.signify.cesr.util.CoreUtil.Versionage;
 import static org.cardanofoundation.signify.core.Httping.parseRangeHeaders;
 
-public class Identifier {
+public class IdentifierController {
     public final IdentifierDeps client;
 
     /**
      * Identifier
      *
      * @param client the client dependencies
      */
-    public Identifier(IdentifierDeps client) {
+    public IdentifierController(IdentifierDeps client) {
         this.client = client;
     }
 
@@ -69,7 +71,7 @@ public IdentifierListResponse list(Integer start, Integer end) throws Interrupte
                 range.start(),
                 range.end(),
                 range.total(),
-                Arrays.asList(GeneratedModelMapper.read(response.body(), org.cardanofoundation.signify.generated.keria.model.Identifier[].class))
+                Arrays.asList(Utils.fromJson(response.body(), Identifier[].class))
         );
     }
 
@@ -87,7 +89,7 @@ public IdentifierListResponse list(Integer start) throws IOException, Interrupte
      * @param name Prefix or alias of the identifier
      * @return An Optional containing the HabState if found, or empty if not found
      */
-    public Optional<States.HabState> get(String name) throws InterruptedException, IOException, LibsodiumException {
+    public Optional<Identifier> get(String name) throws InterruptedException, IOException, LibsodiumException {
         final String path = "/identifiers/" + URI.create(name).toASCIIString();
         final String method = "GET";
 
@@ -97,7 +99,7 @@ public Optional<States.HabState> get(String name) throws InterruptedException, I
             return Optional.empty();
         }
 
-        return Optional.of(Utils.fromJson(response.body(), States.HabState.class));
+        return Optional.of(Utils.fromJson(response.body(), Identifier.class));
     }
 
     /**
@@ -107,7 +109,7 @@ public Optional<States.HabState> get(String name) throws InterruptedException, I
      * @param info Information to update for the given identifier
      * @return A HabState to the identifier information after updating
      */
-    public States.HabState update(String name, IdentifierInfo info) throws InterruptedException, IOException, LibsodiumException {
+    public Identifier update(String name, IdentifierInfo info) throws InterruptedException, IOException, LibsodiumException {
         final String path = "/identifiers/" + name;
         final String method = "PUT";
 
@@ -116,7 +118,7 @@ public States.HabState update(String name, IdentifierInfo info) throws Interrupt
             method,
             IdentifierPayloadMapper.buildUpdateNamePayload(info.getName())
         );
-        return GeneratedModelMapper.read(response.body(), States.HabState.class);
+        return Utils.fromJson(response.body(), Identifier.class);
     }
 
     /**
@@ -289,7 +291,7 @@ public EventResult create(String name, CreateIdentifierArgs kargs) throws Interr
      * @throws LibsodiumException if there is an error in the cryptographic operations
      */
     public EventResult addEndRole(String name, String role, String eid, String stamp) throws InterruptedException, DigestException, IOException, LibsodiumException {
-        States.HabState hab = this.get(name)
+        Identifier hab = this.get(name)
             .orElseThrow(() -> new IllegalArgumentException("Identifier not found: " + name));
         String pre = hab.getPrefix();
 
@@ -340,11 +342,11 @@ public EventResult interact(String name, Object data) throws InterruptedExceptio
     }
 
     public InteractionResponse createInteract(String name, Object data) throws InterruptedException, DigestException, IOException, LibsodiumException {
-        States.HabState hab = this.get(name)
+        Identifier hab = this.get(name)
             .orElseThrow(() -> new IllegalArgumentException("Identifier not found: " + name));
         String pre = hab.getPrefix();
 
-        States.State state = hab.getState();
+        KeyStateRecord state = hab.getState();
         int sn = Integer.parseInt(state.getS(), 16);
         String dig = state.getD();
 
@@ -379,12 +381,12 @@ public EventResult rotate(String name, RotateIdentifierArgs kargs) throws Interr
         String ncode = kargs.getNcode() != null ? kargs.getNcode() : MatterCodex.Ed25519_Seed.getValue();
         int ncount = kargs.getNcount() != null ? kargs.getNcount() : 1;
 
-        States.HabState hab = this.get(name)
+        Identifier hab = this.get(name)
             .orElseThrow(() -> new IllegalArgumentException("Identifier not found: " + name));
         String pre = hab.getPrefix();
         boolean delegated = !hab.getState().getDi().isEmpty();
 
-        States.State state = hab.getState();
+        KeyStateRecord state = hab.getState();
         int count = state.getK().size();
         String dig = state.getD();
         int ridx = Integer.parseInt(state.getS(), 16) + 1;
@@ -410,8 +412,8 @@ public EventResult rotate(String name, RotateIdentifierArgs kargs) throws Interr
         // Create new keys for next digests
         List<String> ncodes = kargs.getNcodes() != null ? kargs.getNcodes() : Collections.nCopies(ncount, ncode);
 
-        List<States.State> states = kargs.getStates() == null ? new ArrayList<>() : kargs.getStates();
-        List<States.State> rstates = kargs.getStates() == null ? new ArrayList<>() : kargs.getRstates();
+        List<KeyStateRecord> states = kargs.getStates() == null ? new ArrayList<>() : kargs.getStates();
+        List<KeyStateRecord> rstates = kargs.getStates() == null ? new ArrayList<>() : kargs.getRstates();
         KeeperResult keeperResult = keeper.rotate(
             ncodes,
             transferable,
@@ -449,8 +451,8 @@ public EventResult rotate(String name, RotateIdentifierArgs kargs) throws Interr
         Map<String, Object> jsondata = new LinkedHashMap<>();
         jsondata.put("rot", serder.getKed());
         jsondata.put("sigs", sigs);
-        jsondata.put("smids", !states.isEmpty() ? states.stream().map(States.State::getI).toList() : null);
-        jsondata.put("rmids", !rstates.isEmpty() ? rstates.stream().map(States.State::getI).toList() : null);
+        jsondata.put("smids", !states.isEmpty() ? states.stream().map(KeyStateRecord::getI).toList() : null);
+        jsondata.put("rmids", !rstates.isEmpty() ? rstates.stream().map(KeyStateRecord::getI).toList() : null);
         jsondata.put(keeper.getAlgo().toString(), keeper.getParams().toMap());
 
         HttpResponse<String> res = this.client.fetch(

src/main/java/org/cardanofoundation/signify/app/aiding/IdentifierModelConverter.java

@@ -6,6 +6,7 @@
 import org.cardanofoundation.signify.core.States;
 
 import java.util.List;
+import org.cardanofoundation.signify.generated.keria.model.KeyStateRecord;
 
 @Builder
 @Getter
@@ -20,6 +21,6 @@ public class RotateIdentifierArgs {
     private String ncode;
     private Integer ncount;
     private List<String> ncodes;
-    private List<States.State> states;
-    private List<States.State> rstates;
+    private List<KeyStateRecord> states;
+    private List<KeyStateRecord> rstates;
 }

src/main/java/org/cardanofoundation/signify/app/aiding/RotateIdentifierArgs.java

@@ -16,7 +16,7 @@
 import org.cardanofoundation.signify.app.Exchanging.Exchanges;
 import org.cardanofoundation.signify.app.Grouping.Groups;
 import org.cardanofoundation.signify.app.Notifying.Notifications;
-import org.cardanofoundation.signify.app.aiding.Identifier;
+import org.cardanofoundation.signify.app.aiding.IdentifierController;
 import org.cardanofoundation.signify.app.clienting.exception.HeaderVerificationException;
 import org.cardanofoundation.signify.app.clienting.exception.UnexpectedResponseStatusException;
 import org.cardanofoundation.signify.app.coring.KeyStates;
@@ -61,7 +61,7 @@ public class SignifyClient implements IdentifierDeps, OperationsDeps {
     private String bootUrl;
     private List<ExternalModule> externalModules;
 
-    private Identifier identifierInstance = new Identifier(this);
+    private IdentifierController identifierControllerInstance = new IdentifierController(this);
     private Oobis oobisInstance = new Oobis(this);
     private Operations operationsInstance = new Operations(this);
     private KeyEvents keyEventsInstance = new KeyEvents(this);
@@ -374,8 +374,8 @@ public void approveDelegation() throws DigestException, IOException, Interrupted
      *
      * @return {Identifier}
      */
-    public Identifier identifiers() {
-        return identifierInstance;
+    public IdentifierController identifiers() {
+        return identifierControllerInstance;
     }
 
     /**

src/main/java/org/cardanofoundation/signify/app/clienting/SignifyClient.java

@@ -18,6 +18,7 @@
 import java.net.http.HttpResponse;
 import java.security.DigestException;
 import java.util.*;
+import org.cardanofoundation.signify.generated.keria.model.Identifier;
 
 public class Credentials {
 
@@ -106,7 +107,7 @@ public Optional<Object> state(String ri, String said) throws IOException, Interr
      * Issue a credential
      */
     public IssueCredentialResult issue(String name, CredentialData args) throws IOException, InterruptedException, DigestException, LibsodiumException {
-        final States.HabState hab = this.client.identifiers().get(name)
+        final Identifier hab = this.client.identifiers().get(name)
                 .orElseThrow(() -> new IllegalArgumentException("Identifier not found: " + name));
 
         final boolean estOnly = hab.getState().getC() != null && hab.getState().getC().contains("EO");
@@ -189,7 +190,7 @@ public IssueCredentialResult issue(String name, CredentialData args) throws IOEx
      * @return A promise to the long-running operation
      */
     public RevokeCredentialResult revoke(String name, String said, String datetime) throws IOException, InterruptedException, DigestException, LibsodiumException {
-        final States.HabState hab = this.client.identifiers().get(name)
+        final Identifier hab = this.client.identifiers().get(name)
                 .orElseThrow(() -> new IllegalArgumentException("Identifier not found: " + name));
         final String pre = hab.getPrefix();