Javadocs, tidy up, more tests with live CCTL data

Author: cnorburn

src/main/java/com/casper/sdk/model/entity/AddressableEntity.java

@@ -9,6 +9,7 @@
 
 /**
  * An addressable entity.
+ * Methods and type signatures supported by a contract.
  *
  * @author [email protected]
  */

src/main/java/com/casper/sdk/model/entity/contract/ByteCode.java

@@ -0,0 +1,41 @@
+package com.casper.sdk.model.entity.contract;
+
+import com.casper.sdk.model.key.Tag;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.*;
+
+/**
+ * A container for contract's Wasm bytes
+ *
+ * @author [email protected]
+ */
+@Getter
+@Setter
+@Builder
+@AllArgsConstructor
+@NoArgsConstructor
+public class ByteCode {
+
+    /** The type of Byte code */
+    @JsonProperty("kind")
+    private ByteCodes kind;
+    /** Byte code */
+    @JsonProperty("bytes")
+    private String bytes;
+
+    public enum ByteCodes implements Tag {
+        /** Empty byte code */
+        Empty(0),
+        /** Byte code to be executed with the version 1 Casper execution engine */
+        V1CasperWasm(1);
+        private final byte tag;
+        ByteCodes(final int tag) {
+            this.tag = (byte) tag;
+        }
+        @Override
+        public byte getByteTag() {
+            return tag;
+        }
+
+    }
+}

src/main/java/com/casper/sdk/model/entity/contract/DisabledVersions.java

@@ -5,6 +5,8 @@
 import lombok.*;
 
 /**
+ * A key with a name
+ *
  * @author [email protected]
  */
 @Getter

src/main/java/com/casper/sdk/model/entity/contract/NamedKey.java

@@ -6,6 +6,8 @@
 import java.util.List;
 
 /**
+ * Package associated with a native contract implementation
+ *
  * @author [email protected]
  */
 @Getter
@@ -15,16 +17,32 @@
 @NoArgsConstructor
 public class Package {
 
+    /** All versions (enabled & disabled) */
     @JsonProperty("versions")
     private List<Versions> versions;
 
+    /** Collection of disabled entity versions.
+     * The runtime will not permit disabled entity versions to be executed */
     @JsonProperty("disabled_versions")
     private List<Versions> disabledVersions;
 
+    /** Mapping maintaining the set of URefs associated with each "user group".
+     *  This can be used to control access to methods in a particular version of the entity.
+     *  A method is callable by any context which "knows" any of the URefs associated with the method's user group */
     @JsonProperty("groups")
     private List<String> groups;
 
+    /** A flag that determines whether an entity is locked */
     @JsonProperty("lock_status")
     private PackageStatus lockStatus;
 
+    /**
+     * Determines the lock status of the package
+     */
+    public enum PackageStatus {
+        // The package is locked and cannot be versioned
+        Locked,
+        // The package is unlocked and can be versioned
+        Unlocked
+    }
 }

src/main/java/com/casper/sdk/model/entity/contract/Package.java

@@ -4,6 +4,8 @@
 import lombok.*;
 
 /**
+ * Child of {@link Versions}
+ *
  * @author [email protected]
  */
 @Getter
@@ -13,9 +15,11 @@
 @NoArgsConstructor
 public class VersionKey {
 
+    /** Major element of `ProtocolVersion` a `ContractVersion` is compatible with */
     @JsonProperty("protocol_version_major")
     private int protocolVersionMajor;
 
+    /** Automatically incremented value for a contract version within a major `ProtocolVersion` */
     @JsonProperty("entity_version")
     private int entityVersion;
 

src/main/java/com/casper/sdk/model/entity/contract/PackageStatus.java

@@ -3,7 +3,10 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.*;
 
+
 /**
+ * Child of {@link Package}
+ *
  * @author [email protected]
  */
 @Getter
@@ -13,11 +16,12 @@
 @NoArgsConstructor
 public class Versions {
 
+    /** Major element of `ProtocolVersion` combined with `EntityVersion` */
     @JsonProperty("entity_version_key")
     private VersionKey entityVersionKey;
 
+    /** Addressable Entity */
     @JsonProperty("addressable_entity_hash")
     private String addressableEntityHash;
 
-
 }

src/main/java/com/casper/sdk/model/entity/contract/VersionKey.java

@@ -28,7 +28,7 @@ public enum StoredValueTypeData {
     STORED_VALUE_BID("Bid", StoredValueBid.class),
     STORED_VALUE_BID_KIND("BidKind", StoredValueBidKind.class),
     STORED_VALUE_WITHDRAW("Withdraw", StoredValueWithdraw.class),
-    STORED_VALUE_BYTECODE("ByteCode", ByteCode.class),
+    STORED_VALUE_BYTECODE("ByteCode", ByteCodeKind.class),
     STORED_VALUE_ADDRESSABLE_ENTITY("AddressableEntity", AddressableEntityKind.class),
     STORED_VALUE_PACKAGE("Package", PackageKind.class),
     STORED_VALUE_NAMED_KEY("NamedKey", NamedKeyKind.class),

src/main/java/com/casper/sdk/model/entity/contract/Versions.java

@@ -1,11 +1,15 @@
 package com.casper.sdk.model.transaction.kind;
 
+import com.casper.sdk.model.entity.AddressableEntity;
 import com.casper.sdk.model.entity.Entity;
 import com.casper.sdk.model.storedvalue.StoredValue;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.*;
 
 /**
+ * An AddressableEntityKind
+ * See {@link AddressableEntity}
+ *
  * @author [email protected]
  */
 @Getter