change exception type;

add javadoc comment; improve test;
esaulpaugh · Feb 10, 2025 · 8ce456d · 8ce456d
1 parent c212545
commit 8ce456d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/src/main/java/com/esaulpaugh/headlong/abi/ABIJSON.java b/src/main/java/com/esaulpaugh/headlong/abi/ABIJSON.java
@@ -102,6 +102,15 @@ public static <T extends ABIObject> List<T> parseElements(int flags, String arra
         return parseArray(reader(arrayJson), types, flags);
     }
 
+    /**
+     * Reads and parses the value of the key "abi" as a contract ABI json array.
+     *
+     * @param flags {@link ABIType#FLAGS_NONE} (recommended) or {@link ABIType#FLAG_LEGACY_DECODE}
+     * @param objectJson    the json object containing the "abi" field
+     * @param types the types to allow in the returned {@link List}
+     * @return  the list of ABI objects
+     * @param <T>   the element type
+     */
     public static <T extends ABIObject> List<T> parseABIField(int flags, String objectJson, Set<TypeEnum> types) {
         try (final JsonReader reader = reader(objectJson)) {
             reader.beginObject();
@@ -111,7 +120,7 @@ public static <T extends ABIObject> List<T> parseABIField(int flags, String obje
                 }
                 reader.skipValue();
             }
-            throw new IllegalStateException("abi key not found");
+            throw new IllegalArgumentException("abi key not found");
         } catch (IOException io) {
             throw new IllegalStateException(io);
         }

diff --git a/src/test/java/com/esaulpaugh/headlong/abi/ABIJSONTest.java b/src/test/java/com/esaulpaugh/headlong/abi/ABIJSONTest.java
@@ -936,7 +936,10 @@ public void testUserDefinedValueTypes() {
     }
 
     @Test
-    public void testParseABIField() {
+    public void testParseABIField() throws Throwable {
+        assertThrown(IllegalArgumentException.class, "abi key not found", () -> ABIJSON.parseABIField(FLAGS_NONE, "{}", ABIJSON.ALL));
+        assertThrown(IllegalStateException.class, () -> ABIJSON.parseABIField(FLAGS_NONE, "{\"abi\":null}", ABIJSON.ALL));
+        assertEquals(0, ABIJSON.parseABIField(FLAGS_NONE, "{\"abi\":[]}", ABIJSON.ALL).size());
         final String json = "{\n" +
                 "  \"abi\": [\n" +
                 "    {\n" +