Merge pull request #366 from /issues/349

cnorburn · web-flow · commit 693da345f949 · 2024-09-24T10:54:13.000+01:00
Issues/349 - Refactor of keys from String to Key class
diff --git a/src/main/java/com/casper/sdk/jackson/deserializer/AbstractSerializedKeyTaggedHexDeserializer.java b/src/main/java/com/casper/sdk/jackson/deserializer/AbstractSerializedKeyTaggedHexDeserializer.java
@@ -38,7 +38,7 @@ public T deserialize(final JsonParser p, final DeserializationContext ctxt) thro
         if (strKey.contains("-")) {
             try {
                 //noinspection unchecked
-                return (T) Key.fromKeyString(strKey);
+                return (T) Key.create(strKey);
             } catch (NoSuchKeyTagException e) {
                 throw new CasperClientException("No such key: " + strKey, e);
             }
diff --git a/src/main/java/com/casper/sdk/jackson/serializer/KeySerializer.java b/src/main/java/com/casper/sdk/jackson/serializer/KeySerializer.java
@@ -0,0 +1,20 @@
+package com.casper.sdk.jackson.serializer;
+
+import com.casper.sdk.model.key.Key;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+
+import java.io.IOException;
+
+/**
+ * Desrializer for {@link Key} types.
+ *
+ * @author ian@meywood.com
+ */
+public class KeySerializer extends JsonSerializer<Key> {
+    @Override
+    public void serialize(final Key key, final JsonGenerator gen, final SerializerProvider serializers) throws IOException {
+        gen.writeString(key.toString());
+    }
+}
diff --git a/src/main/java/com/casper/sdk/model/account/Account.java b/src/main/java/com/casper/sdk/model/account/Account.java
@@ -1,6 +1,7 @@
 package com.casper.sdk.model.account;
 
 import com.casper.sdk.model.contract.NamedKey;
+import com.casper.sdk.model.key.AccountHashKey;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -28,7 +29,7 @@ public class Account {
      * account_hash(String) Hex-encoded account hash.
      */
     @JsonProperty("account_hash")
-    private String hash;
+    private AccountHashKey hash;
 
     /**
      * {@link ActionThresholds} that have to be met
diff --git a/src/main/java/com/casper/sdk/model/account/AssociatedKey.java b/src/main/java/com/casper/sdk/model/account/AssociatedKey.java
@@ -1,5 +1,6 @@
 package com.casper.sdk.model.account;
 
+import com.casper.sdk.model.key.AccountHashKey;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -25,7 +26,7 @@ public class AssociatedKey {
      * account_hash(String) Hex-encoded account hash.
      */
     @JsonProperty("account_hash")
-    private String accountHash;
+    private AccountHashKey accountHash;
 
     /**
      * weight(Integer)
diff --git a/src/main/java/com/casper/sdk/model/contract/NamedKey.java b/src/main/java/com/casper/sdk/model/contract/NamedKey.java
@@ -1,5 +1,6 @@
 package com.casper.sdk.model.contract;
 
+import com.casper.sdk.model.key.Key;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -25,7 +26,7 @@ public class NamedKey {
      * key(String) The value of the entry: a casper `Key` type.
      */
     @JsonProperty("key")
-    private String key;
+    private Key key;
 
     /**
      * name(String) The name of the entry.
diff --git a/src/main/java/com/casper/sdk/model/deploy/Operation.java b/src/main/java/com/casper/sdk/model/deploy/Operation.java
@@ -1,5 +1,6 @@
 package com.casper.sdk.model.deploy;
 
+import com.casper.sdk.model.key.Key;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Getter;
@@ -23,7 +24,7 @@ public class Operation {
     /**
      * The formatted string of the `Key`
      */
-    private String key;
+    private Key key;
 
     /**
      * @see OpKind
diff --git a/src/main/java/com/casper/sdk/model/deploy/executionresult/Success.java b/src/main/java/com/casper/sdk/model/deploy/executionresult/Success.java
@@ -1,6 +1,7 @@
 package com.casper.sdk.model.deploy.executionresult;
 
 import com.casper.sdk.model.deploy.ExecutionEffect;
+import com.casper.sdk.model.key.Key;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
@@ -30,7 +31,7 @@ public class Success {
     private ExecutionEffect effect;
 
     /** List of Hex-encoded transfer address. */
-    private List<String> transfers;
+    private List<Key> transfers;
 
     /** The cost of executing the deploy. */
     @JsonSerialize(using = ToStringSerializer.class)
diff --git a/src/main/java/com/casper/sdk/model/entity/Account.java b/src/main/java/com/casper/sdk/model/entity/Account.java
@@ -1,6 +1,10 @@
 package com.casper.sdk.model.entity;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
+import com.casper.sdk.exception.NoSuchKeyTagException;
+import com.casper.sdk.model.key.AccountHashKey;
+import com.casper.sdk.model.key.Key;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.annotation.JsonValue;
 import lombok.*;
 
 /**
@@ -13,9 +17,13 @@
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
+@JsonTypeName("Account")
 public class Account implements EntityAddressKind {
 
-    @JsonProperty("Account")
-    private String account;
+    @JsonValue
+    private AccountHashKey account;
 
+    public Account(final String accountSt) throws NoSuchKeyTagException {
+        this.account = (AccountHashKey) Key.create(accountSt);
+    }
 }
diff --git a/src/main/java/com/casper/sdk/model/entity/AddressableEntity.java b/src/main/java/com/casper/sdk/model/entity/AddressableEntity.java
@@ -30,5 +30,4 @@ public class AddressableEntity implements StateEntity {
     /** The entry points of the addressable entity. */
     @JsonProperty("entry_points")
     private List<EntryPointValue> entryPoints;
-
 }
diff --git a/src/main/java/com/casper/sdk/model/entity/EntityAddr.java b/src/main/java/com/casper/sdk/model/entity/EntityAddr.java
@@ -1,7 +1,6 @@
 package com.casper.sdk.model.entity;
 
 import com.casper.sdk.exception.NoSuchKeyTagException;
-import com.casper.sdk.model.key.KeyTag;
 import com.casper.sdk.model.key.Tag;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
@@ -34,10 +33,10 @@ public static EntityAddr getByTag(byte tag) throws NoSuchKeyTagException {
 
     public static EntityAddr getByKeyName(final String keyName) throws NoSuchKeyTagException {
         // Search in reverse order to get the most specific key eg 'bid-addr-' and 'bid-'
-        for (final EntityAddr entityAddr: values()) {
-           if (entityAddr.getKeyName().equals(keyName)) {
-               return entityAddr;
-           }
+        for (final EntityAddr entityAddr : values()) {
+            if (entityAddr.getKeyName().equals(keyName)) {
+                return entityAddr;
+            }
         }
         throw new NoSuchKeyTagException("No such key name: " + keyName);
     }
diff --git a/src/main/java/com/casper/sdk/model/key/AccountHashKey.java b/src/main/java/com/casper/sdk/model/key/AccountHashKey.java
@@ -0,0 +1,9 @@
+package com.casper.sdk.model.key;
+
+/**
+ * A key for an account hash
+ *
+ * @author ian@meywood.com
+ */
+public class AccountHashKey extends Key {
+}
diff --git a/src/main/java/com/casper/sdk/model/key/ByteCodeKey.java b/src/main/java/com/casper/sdk/model/key/ByteCodeKey.java
@@ -33,7 +33,8 @@ protected void fromStringCustom(final String strKey) {
         final byte[] key = new byte[33];
         final String[] split = strKey.split("-");
         key[0] = byteCodeAddr.getByteTag();
-        System.arraycopy(Hex.decode(split[split.length - 1]), 0, key, 1, 32);
+        final byte[] decode = Hex.decode(split[split.length - 1]);
+        System.arraycopy(decode, 0, key, 1, decode.length);
         setKey(key);
     }
 
diff --git a/src/main/java/com/casper/sdk/model/key/Key.java b/src/main/java/com/casper/sdk/model/key/Key.java
@@ -2,8 +2,10 @@
 
 import com.casper.sdk.exception.NoSuchKeyTagException;
 import com.casper.sdk.jackson.deserializer.KeyDeserializer;
+import com.casper.sdk.jackson.serializer.KeySerializer;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.syntifi.crypto.key.hash.Blake2b;
 import dev.oak3.sbs4j.DeserializerBuffer;
 import dev.oak3.sbs4j.util.ByteUtils;
@@ -22,6 +24,7 @@
  * @since 0.0.1
  */
 @JsonDeserialize(using = KeyDeserializer.class)
+@JsonSerialize(using = KeySerializer.class)
 @NoArgsConstructor
 @EqualsAndHashCode(callSuper = true)
 public class Key extends AbstractSerializedKeyTaggedHex<KeyTag> {
@@ -40,7 +43,8 @@ public static Key deserialize(final DeserializerBuffer deser) throws NoSuchKeyTa
         }
     }
 
-    public static Key fromKeyString(final String strKey) throws NoSuchKeyTagException {
+    @JsonCreator
+    public static Key create(final String strKey) throws NoSuchKeyTagException {
         final KeyTag keyTag = KeyTag.getByKeyName(strKey);
         try {
             final Key key = keyTag.getKeyClass().getDeclaredConstructor().newInstance();
@@ -67,13 +71,6 @@ public String generateAccountHash(final boolean includePrefix) throws IOExceptio
         return (includePrefix ? "account-hash-" : "") + ByteUtils.encodeHexString(Blake2b.digest(byteArrayOutputStream.toByteArray(), 32));
     }
 
-    @JsonCreator
-    public void createKey(final String key) throws NoSuchKeyTagException {
-        Key obj = Key.fromTaggedHexString(key);
-        this.setTag(obj.getTag());
-        this.setKey(obj.getKey());
-    }
-
     @Override
     public String toString() {
         return getTag().getKeyName() + ByteUtils.encodeHexString(this.getKey());
@@ -87,5 +84,4 @@ protected void fromStringCustom(final String strKey) {
         final String[] split = strKey.split("-");
         this.setKey(ByteUtils.parseHexString(split[split.length - 1]));
     }
-
 }
diff --git a/src/main/java/com/casper/sdk/model/key/KeyTag.java b/src/main/java/com/casper/sdk/model/key/KeyTag.java
@@ -17,7 +17,7 @@
  */
 @Getter
 public enum KeyTag implements Tag {
-    ACCOUNT((byte) 0x00, Key.class, "account-hash-"),
+    ACCOUNT((byte) 0x00, AccountHashKey.class, "account-hash-"),
     HASH((byte) 0x01, Key.class, "hash-", "contract-"),
     UREF((byte) 0x02, URefKey.class, "uref-"),
     TRANSFER((byte) 0x03, Key.class, "transfer-"),
diff --git a/src/main/java/com/casper/sdk/model/key/NamedKeyKey.java b/src/main/java/com/casper/sdk/model/key/NamedKeyKey.java
@@ -32,7 +32,7 @@ protected void fromStringCustom(final String strKey) {
         final String[] split = strKey.split("-");
         try {
             final String baseAddrStr = split[2] + "-" + split[3] + "-" + split[4];
-            baseAddr = (AddressableEntityKey) Key.fromKeyString(baseAddrStr);
+            baseAddr = (AddressableEntityKey) Key.create(baseAddrStr);
             stringBytes = Hex.decode(split[5]);
             refreshKey();
         } catch (NoSuchKeyTagException e) {
diff --git a/src/main/java/com/casper/sdk/model/transaction/execution/Effect.java b/src/main/java/com/casper/sdk/model/transaction/execution/Effect.java
@@ -1,5 +1,6 @@
 package com.casper.sdk.model.transaction.execution;
 
+import com.casper.sdk.model.key.Key;
 import com.casper.sdk.model.transaction.kind.Kind;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.*;
@@ -16,9 +17,8 @@
 @Builder
 public class Effect {
 
-    // TODO convert EntityAddr
     @JsonProperty("key")
-    private String key;
+    private Key key;
     @JsonProperty("kind")
     private Kind kind;
 
diff --git a/src/main/java/com/casper/sdk/model/transfer/TransferV1.java b/src/main/java/com/casper/sdk/model/transfer/TransferV1.java
@@ -1,6 +1,7 @@
 package com.casper.sdk.model.transfer;
 
 import com.casper.sdk.annotation.ExcludeFromJacocoGeneratedReport;
+import com.casper.sdk.model.key.AccountHashKey;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.*;
@@ -25,11 +26,11 @@ public class TransferV1 {
 
     /** Hex-encoded account hash. */
     @JsonProperty("to")
-    private String to;
+    private AccountHashKey to;
 
     /** Hex-encoded account hash. */
     @JsonProperty("from")
-    private String from;
+    private AccountHashKey from;
 
     /** Amount transferred */
     @JsonIgnore
diff --git a/src/test/java/com/HowTo.java b/src/test/java/com/HowTo.java
@@ -21,6 +21,7 @@
 import com.casper.sdk.model.entity.AddressableEntity;
 import com.casper.sdk.model.entity.StateEntityResult;
 import com.casper.sdk.model.era.EraInfoData;
+import com.casper.sdk.model.key.Key;
 import com.casper.sdk.model.key.PublicKey;
 import com.casper.sdk.model.reward.GetRewardResult;
 import com.casper.sdk.model.stateroothash.StateRootHashData;
@@ -288,8 +289,8 @@ void getStateEntity() {
         assert stateEntityPublicKey.getEntity() != null;
 
         //By contract identifier
-        final String contractKey = ((AddressableEntity) stateEntityPublicKey.getEntity()).getNamedKeys().get(0).getKey();
-        final StateEntityResult stateEntityContract = casperService.getStateEntity(new EntityAddrIdentifier(contractKey), null);
+        final Key contractKey = ((AddressableEntity) stateEntityPublicKey.getEntity()).getNamedKeys().get(0).getKey();
+        final StateEntityResult stateEntityContract = casperService.getStateEntity(new EntityAddrIdentifier(contractKey.toString()), null);
         assert stateEntityContract.getEntity() != null;
 
     }
diff --git a/src/test/java/com/casper/sdk/model/key/KeyTest.java b/src/test/java/com/casper/sdk/model/key/KeyTest.java
diff --git a/src/test/java/com/casper/sdk/model/transaction/EffectTest.java b/src/test/java/com/casper/sdk/model/transaction/EffectTest.java
diff --git a/src/test/java/com/casper/sdk/service/CasperServiceTests.java b/src/test/java/com/casper/sdk/service/CasperServiceTests.java
diff --git a/src/test/java/com/casper/sdk/service/EventServiceIntegrationTest.java b/src/test/java/com/casper/sdk/service/EventServiceIntegrationTest.java

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public T deserialize(final JsonParser p, final DeserializationContext ctxt) thro`
`38`	`38`	`if (strKey.contains("-")) {`
`39`	`39`	`try {`
`40`	`40`	`//noinspection unchecked`
`41`		`- return (T) Key.fromKeyString(strKey);`
	`41`	`+ return (T) Key.create(strKey);`
`42`	`42`	`} catch (NoSuchKeyTagException e) {`
`43`	`43`	`throw new CasperClientException("No such key: " + strKey, e);`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,5 +30,4 @@ public class AddressableEntity implements StateEntity {`
`30`	`30`	`/** The entry points of the addressable entity. */`
`31`	`31`	`@JsonProperty("entry_points")`
`32`	`32`	`private List<EntryPointValue> entryPoints;`
`33`		`-`
`34`	`33`	`}`