small additions

hendrikebbers · hendrikebbers · commit ef9c4264c700 · 2025-02-23T15:27:56.000-07:00
diff --git a/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/GsonAbiParser.java b/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/GsonAbiParser.java
@@ -18,7 +18,6 @@ public GsonAbiParser() {
         this.gson = new GsonBuilder()
                 .registerTypeAdapterFactory(new AbiTypeAdapterFactory())
                 .create();
-
     }
 
     public @NonNull AbiModel parse(@NonNull Reader abiReader) throws AbiParserException {
diff --git a/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/AbiEntryTypeAdapter.java b/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/AbiEntryTypeAdapter.java
@@ -12,6 +12,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import org.jspecify.annotations.NonNull;
 
 public class AbiEntryTypeAdapter extends BasicTypeAdapter<AbiEntry> {
 
@@ -20,7 +21,7 @@ public AbiEntryTypeAdapter(Gson gson) {
     }
 
     @Override
-    public AbiEntry read(JsonReader in) throws IOException {
+    public AbiEntry read(@NonNull final JsonReader in) throws IOException {
         final JsonObject abiEntryObject = readObject(in);
         final AbiEntryType type = getStringValue(abiEntryObject, "type")
                 .map(AbiEntryType::of)
diff --git a/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/AbiModelTypeAdapter.java b/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/AbiModelTypeAdapter.java
@@ -18,7 +18,7 @@ public AbiModelTypeAdapter(@NonNull Gson gson) {
     }
 
     @Override
-    public AbiModel read(JsonReader in) throws IOException {
+    public AbiModel read(@NonNull final JsonReader in) throws IOException {
         JsonArray array = readArray(in);
         final List<AbiEntry> entries = new ArrayList<>();
         array.forEach(jsonElement -> {
diff --git a/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/AbiParameterTypeAdapter.java b/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/AbiParameterTypeAdapter.java
@@ -9,6 +9,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import org.jspecify.annotations.NonNull;
 
 public class AbiParameterTypeAdapter extends BasicTypeAdapter<AbiParameter> {
 
@@ -17,7 +18,7 @@ public AbiParameterTypeAdapter(Gson gson) {
     }
 
     @Override
-    public AbiParameter read(JsonReader in) throws IOException {
+    public AbiParameter read(@NonNull final JsonReader in) throws IOException {
         final JsonObject parameterObject = readObject(in);
 
         final String name = getStringValue(parameterObject, "name")
diff --git a/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/AbiTypeAdapterFactory.java b/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/AbiTypeAdapterFactory.java
@@ -7,11 +7,14 @@
 import com.openelements.hiero.smartcontract.abi.model.AbiEntry;
 import com.openelements.hiero.smartcontract.abi.model.AbiModel;
 import com.openelements.hiero.smartcontract.abi.model.AbiParameter;
+import java.util.Objects;
+import org.jspecify.annotations.NonNull;
 
 public class AbiTypeAdapterFactory implements TypeAdapterFactory {
 
     @Override
-    public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
+    public <T> TypeAdapter<T> create(@NonNull final Gson gson, @NonNull final TypeToken<T> type) {
+        Objects.requireNonNull(type, "type must not be null");
         if (type.getRawType().equals(AbiModel.class)) {
             return (TypeAdapter<T>) new AbiModelTypeAdapter(gson);
         }
diff --git a/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/BasicTypeAdapter.java b/abi-parser-simple/src/main/java/com/openelements/hiero/smartcontract/abi/simple/implementation/BasicTypeAdapter.java
@@ -21,31 +21,30 @@ public abstract class BasicTypeAdapter<T> extends TypeAdapter<T> {
 
     private final TypeAdapter<JsonArray> arrayTypeAdapter;
 
-
-    public BasicTypeAdapter(final Gson gson) {
+    public BasicTypeAdapter(@NonNull final Gson gson) {
         this.gson = Objects.requireNonNull(gson, "gson");
         objectTypeAdapter = gson.getAdapter(JsonObject.class);
         arrayTypeAdapter = gson.getAdapter(JsonArray.class);
     }
 
-    protected JsonObject readObject(JsonReader in) throws IOException {
+    protected JsonObject readObject(@NonNull final JsonReader in) throws IOException {
         return objectTypeAdapter.read(in);
     }
 
-    protected JsonArray readArray(JsonReader in) throws IOException {
+    protected JsonArray readArray(@NonNull final JsonReader in) throws IOException {
         return arrayTypeAdapter.read(in);
     }
 
-
-    protected <T> T fromJson(JsonElement json, Class<T> classOfT) throws JsonSyntaxException {
+    protected <T> T fromJson(@NonNull final JsonElement json, @NonNull final Class<T> classOfT) throws JsonSyntaxException {
         return gson.fromJson(json, classOfT);
     }
 
-
+    @NonNull
     protected Gson getGson() {
         return gson;
     }
 
+    @NonNull
     protected TypeAdapter<JsonObject> getObjectTypeAdapter() {
         return objectTypeAdapter;
     }
@@ -55,6 +54,7 @@ public void write(JsonWriter out, T value) throws IOException {
         throw new UnsupportedOperationException("Not supported yet.");
     }
 
+    @NonNull
     protected JsonArray getArray(@NonNull final JsonObject jsonObject, @NonNull final String key) {
         Objects.requireNonNull(jsonObject, "jsonObject");
         Objects.requireNonNull(key, "key");
@@ -69,6 +69,7 @@ protected JsonArray getArray(@NonNull final JsonObject jsonObject, @NonNull fina
         return new JsonArray();
     }
 
+    @NonNull
     protected Optional<String> getStringValue(@NonNull final JsonObject jsonObject, @NonNull final String key) {
         Objects.requireNonNull(jsonObject, "jsonObject");
         Objects.requireNonNull(key, "key");
@@ -82,6 +83,7 @@ protected Optional<String> getStringValue(@NonNull final JsonObject jsonObject,
         return Optional.empty();
     }
 
+    @NonNull
     protected Optional<Boolean> getBooleanValue(@NonNull final JsonObject jsonObject, @NonNull final String key) {
         Objects.requireNonNull(jsonObject, "jsonObject");
         Objects.requireNonNull(key, "key");
diff --git a/abi-parser/src/main/java/com/openelements/hiero/smartcontract/abi/model/AbiFunction.java b/abi-parser/src/main/java/com/openelements/hiero/smartcontract/abi/model/AbiFunction.java
@@ -36,6 +36,5 @@ public record AbiFunction(@NonNull AbiEntryType type, @Nullable String name, @No
         Objects.requireNonNull(inputs, "inputs");
         Objects.requireNonNull(outputs, "outputs");
         Objects.requireNonNull(stateMutability, "stateMutability");
-
     }
 }
diff --git a/abi-parser/src/main/java/com/openelements/hiero/smartcontract/abi/model/AbiModel.java b/abi-parser/src/main/java/com/openelements/hiero/smartcontract/abi/model/AbiModel.java
@@ -10,19 +10,24 @@ public record AbiModel(@NonNull List<AbiEntry> entries) {
         Objects.requireNonNull(entries, "entries");
     }
 
+    @NonNull
     public List<AbiFunction> getFunctions() {
         return getEntriesOfType(AbiFunction.class);
     }
 
+    @NonNull
     public List<AbiEvent> getEvents() {
         return getEntriesOfType(AbiEvent.class);
     }
 
+    @NonNull
     public List<AbiError> getErrors() {
         return getEntriesOfType(AbiError.class);
     }
 
-    private <T extends AbiEntry> List<T> getEntriesOfType(Class<T> type) {
+    @NonNull
+    private <T extends AbiEntry> List<T> getEntriesOfType(@NonNull final Class<T> type) {
+        Objects.requireNonNull(type, "type must not be null");
         return entries.stream()
                 .filter(type::isInstance)
                 .map(type::cast)
diff --git a/abi-parser/src/main/java/com/openelements/hiero/smartcontract/abi/util/HexConverter.java b/abi-parser/src/main/java/com/openelements/hiero/smartcontract/abi/util/HexConverter.java
@@ -11,7 +11,7 @@ public class HexConverter {
     @NonNull
     public static String bytesToHex(@NonNull final byte[] bytes) {
         //see https://stackoverflow.com/questions/9655181/java-convert-a-byte-array-to-a-hex-string
-        Objects.requireNonNull(bytes, "bytes");
+        Objects.requireNonNull(bytes, "bytes must not be null");
         final byte[] hexChars = new byte[bytes.length * 2];
         for (int j = 0; j < bytes.length; j++) {
             int v = bytes[j] & 0xFF;
@@ -21,7 +21,9 @@ public static String bytesToHex(@NonNull final byte[] bytes) {
         return new String(hexChars, StandardCharsets.UTF_8).toLowerCase();
     }
 
+    @NonNull
     public static byte[] hexToBytes(@NonNull final String hex) {
+        Objects.requireNonNull(hex, "hex must not be null");
         int len = hex.length();
         byte[] data = new byte[len / 2];
         for (int i = 0; i < len; i += 2) {
diff --git a/abi-parser/src/main/java/com/openelements/hiero/smartcontract/abi/util/KeccakUtil.java b/abi-parser/src/main/java/com/openelements/hiero/smartcontract/abi/util/KeccakUtil.java
@@ -1,11 +1,12 @@
 package com.openelements.hiero.smartcontract.abi.util;
 
 import org.bouncycastle.jcajce.provider.digest.Keccak;
+import org.jspecify.annotations.NonNull;
 
 public class KeccakUtil {
 
-    public static byte[] keccak256(final byte[] data) {
-        Keccak.DigestKeccak kecc = new Keccak.Digest256();
+    public static byte[] keccak256(@NonNull final byte[] data) {
+        final Keccak.DigestKeccak kecc = new Keccak.Digest256();
         kecc.update(data);
         return kecc.digest();
     }
diff --git a/abi-parser/src/test/java/com/openelements/hiero/smartcontract/abi/test/HexConverterTests.java b/abi-parser/src/test/java/com/openelements/hiero/smartcontract/abi/test/HexConverterTests.java
@@ -0,0 +1,32 @@
+package com.openelements.hiero.smartcontract.abi.test;
+
+import com.openelements.hiero.smartcontract.abi.util.HexConverter;
+import java.util.stream.Stream;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+public class HexConverterTests {
+
+    @ParameterizedTest
+    @MethodSource("provideArgumentsForHexToBytesTest")
+    void hexToBytesTest(String hexInput, byte[] expectedBytes) {
+        //given
+        final String hex = "00";
+
+        //when
+        final byte[] bytes = HexConverter.hexToBytes(hex);
+
+        //then
+        Assertions.assertArrayEquals(new byte[]{0x0}, bytes);
+    }
+
+    private static Stream<Arguments> provideArgumentsForHexToBytesTest() {
+        return Stream.of(
+                Arguments.of("00", new byte[]{0x0}),
+                Arguments.of("01", new byte[]{0x1})
+        );
+    }
+}
diff --git a/abi-parser/src/test/java/module-info.java b/abi-parser/src/test/java/module-info.java
@@ -1,5 +1,5 @@
 open module com.openelements.hiero.smartcontract.abi.test {
     requires com.openelements.hiero.smartcontract.abi;
-    requires org.junit.jupiter.api;
     requires org.bouncycastle.provider;
+    requires org.junit.jupiter.params;
 }
diff --git a/pom.xml b/pom.xml
@@ -53,6 +53,9 @@
     <google.auto.version>1.1.1</google.auto.version>
     <gson.version>2.10.1</gson.version>
     <jboss-logging.version>3.6.1.Final</jboss-logging.version>
+    <keccakj.version>1.1.0</keccakj.version>
+    <bouncycastle.version>1.76</bouncycastle.version>
+
     <maven-resources-plugin.version>3.3.1</maven-resources-plugin.version>
     <maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
     <maven-surefire-plugin.version>3.3.1</maven-surefire-plugin.version>
@@ -65,8 +68,6 @@
     <cyclonedx-maven-plugin.version>2.8.0</cyclonedx-maven-plugin.version>
     <jreleaser-maven-plugin.version>1.9.0</jreleaser-maven-plugin.version>
     <versions-maven-plugin.version>2.17.1</versions-maven-plugin.version>
-    <keccakj.version>1.1.0</keccakj.version>
-    <bouncycastle.version>1.76</bouncycastle.version>
   </properties>
 
   <dependencyManagement>

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,6 @@ public GsonAbiParser() {`
`18`	`18`	`this.gson = new GsonBuilder()`
`19`	`19`	`.registerTypeAdapterFactory(new AbiTypeAdapterFactory())`
`20`	`20`	`.create();`
`21`		`-`
`22`	`21`	`}`
`23`	`22`
`24`	`23`	`public @NonNull AbiModel parse(@NonNull Reader abiReader) throws AbiParserException {`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public AbiModelTypeAdapter(@NonNull Gson gson) {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`@Override`
`21`		`- public AbiModel read(JsonReader in) throws IOException {`
	`21`	`+ public AbiModel read(@NonNull final JsonReader in) throws IOException {`
`22`	`22`	`JsonArray array = readArray(in);`
`23`	`23`	`final List<AbiEntry> entries = new ArrayList<>();`
`24`	`24`	`array.forEach(jsonElement -> {`
Original file line number	Diff line number	Diff line change
`@@ -21,31 +21,30 @@ public abstract class BasicTypeAdapter<T> extends TypeAdapter<T> {`
`21`	`21`
`22`	`22`	`private final TypeAdapter<JsonArray> arrayTypeAdapter;`
`23`	`23`
`24`		`-`
`25`		`- public BasicTypeAdapter(final Gson gson) {`
	`24`	`+ public BasicTypeAdapter(@NonNull final Gson gson) {`
`26`	`25`	`this.gson = Objects.requireNonNull(gson, "gson");`
`27`	`26`	`objectTypeAdapter = gson.getAdapter(JsonObject.class);`
`28`	`27`	`arrayTypeAdapter = gson.getAdapter(JsonArray.class);`
`29`	`28`	`}`
`30`	`29`
`31`		`- protected JsonObject readObject(JsonReader in) throws IOException {`
	`30`	`+ protected JsonObject readObject(@NonNull final JsonReader in) throws IOException {`
`32`	`31`	`return objectTypeAdapter.read(in);`
`33`	`32`	`}`
`34`	`33`
`35`		`- protected JsonArray readArray(JsonReader in) throws IOException {`
	`34`	`+ protected JsonArray readArray(@NonNull final JsonReader in) throws IOException {`
`36`	`35`	`return arrayTypeAdapter.read(in);`
`37`	`36`	`}`
`38`	`37`
`39`		`-`
`40`		`- protected <T> T fromJson(JsonElement json, Class<T> classOfT) throws JsonSyntaxException {`
	`38`	`+ protected <T> T fromJson(@NonNull final JsonElement json, @NonNull final Class<T> classOfT) throws JsonSyntaxException {`
`41`	`39`	`return gson.fromJson(json, classOfT);`
`42`	`40`	`}`
`43`	`41`
`44`		`-`
	`42`	`+ @NonNull`
`45`	`43`	`protected Gson getGson() {`
`46`	`44`	`return gson;`
`47`	`45`	`}`
`48`	`46`
	`47`	`+ @NonNull`
`49`	`48`	`protected TypeAdapter<JsonObject> getObjectTypeAdapter() {`
`50`	`49`	`return objectTypeAdapter;`
`51`	`50`	`}`
`@@ -55,6 +54,7 @@ public void write(JsonWriter out, T value) throws IOException {`
`55`	`54`	`throw new UnsupportedOperationException("Not supported yet.");`
`56`	`55`	`}`
`57`	`56`
	`57`	`+ @NonNull`
`58`	`58`	`protected JsonArray getArray(@NonNull final JsonObject jsonObject, @NonNull final String key) {`
`59`	`59`	`Objects.requireNonNull(jsonObject, "jsonObject");`
`60`	`60`	`Objects.requireNonNull(key, "key");`
`@@ -69,6 +69,7 @@ protected JsonArray getArray(@NonNull final JsonObject jsonObject, @NonNull fina`
`69`	`69`	`return new JsonArray();`
`70`	`70`	`}`
`71`	`71`
	`72`	`+ @NonNull`
`72`	`73`	`protected Optional<String> getStringValue(@NonNull final JsonObject jsonObject, @NonNull final String key) {`
`73`	`74`	`Objects.requireNonNull(jsonObject, "jsonObject");`
`74`	`75`	`Objects.requireNonNull(key, "key");`
`@@ -82,6 +83,7 @@ protected Optional<String> getStringValue(@NonNull final JsonObject jsonObject,`
`82`	`83`	`return Optional.empty();`
`83`	`84`	`}`
`84`	`85`
	`86`	`+ @NonNull`
`85`	`87`	`protected Optional<Boolean> getBooleanValue(@NonNull final JsonObject jsonObject, @NonNull final String key) {`
`86`	`88`	`Objects.requireNonNull(jsonObject, "jsonObject");`
`87`	`89`	`Objects.requireNonNull(key, "key");`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,5 @@ public record AbiFunction(@NonNull AbiEntryType type, @Nullable String name, @No`
`36`	`36`	`Objects.requireNonNull(inputs, "inputs");`
`37`	`37`	`Objects.requireNonNull(outputs, "outputs");`
`38`	`38`	`Objects.requireNonNull(stateMutability, "stateMutability");`
`39`		`-`
`40`	`39`	`}`
`41`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,19 +10,24 @@ public record AbiModel(@NonNull List<AbiEntry> entries) {`
`10`	`10`	`Objects.requireNonNull(entries, "entries");`
`11`	`11`	`}`
`12`	`12`
	`13`	`+ @NonNull`
`13`	`14`	`public List<AbiFunction> getFunctions() {`
`14`	`15`	`return getEntriesOfType(AbiFunction.class);`
`15`	`16`	`}`
`16`	`17`
	`18`	`+ @NonNull`
`17`	`19`	`public List<AbiEvent> getEvents() {`
`18`	`20`	`return getEntriesOfType(AbiEvent.class);`
`19`	`21`	`}`
`20`	`22`
	`23`	`+ @NonNull`
`21`	`24`	`public List<AbiError> getErrors() {`
`22`	`25`	`return getEntriesOfType(AbiError.class);`
`23`	`26`	`}`
`24`	`27`
`25`		`- private <T extends AbiEntry> List<T> getEntriesOfType(Class<T> type) {`
	`28`	`+ @NonNull`
	`29`	`+ private <T extends AbiEntry> List<T> getEntriesOfType(@NonNull final Class<T> type) {`
	`30`	`+ Objects.requireNonNull(type, "type must not be null");`
`26`	`31`	`return entries.stream()`
`27`	`32`	`.filter(type::isInstance)`
`28`	`33`	`.map(type::cast)`