Adding auto generated toString method for structs

.github/workflows/release.yml

@@ -66,7 +66,6 @@ jobs:
       - name: Set up JDK 21
         uses: actions/setup-java@v4
         with:
-          distribution: zulu
           java-version: 21
       - name: Publish Javadocs (gh-pages)
         env:

abi/src/main/java/org/web3j/abi/TypeReference.java

@@ -21,6 +21,11 @@
 import org.web3j.abi.datatypes.AbiTypes;
 import org.web3j.abi.datatypes.DynamicArray;
 import org.web3j.abi.datatypes.StaticArray;
+import org.web3j.abi.datatypes.Struct;
+
+// This file needs to be changed for instances where there are unknonw structs ;
+// This file needs to be changed to support dynaimic struct parsing and then implement dynamci to
+// string to log strucutre
 
 /**
  * Type wrapper to get around limitations of Java's type erasure. This is so that we can pass around
@@ -155,6 +160,45 @@ public int getSize() {
         }
     }
 
+    // Added method that will Enhance TypeReference to support structured metadata for Structs
+    // (especially unknown ones), without affecting arrays or atomic types.
+    public static class StructTypeReference<T extends Struct> extends TypeReference<T> {
+        private final String structName;
+        private final List<String> fieldNames;
+
+        public StructTypeReference(
+                String structName, List<String> fieldNames, List<TypeReference<?>> fieldTypes) {
+            super(false, fieldTypes);
+            this.structName = structName;
+            this.fieldNames = fieldNames;
+        }
+
+        public String getStructName() {
+            return structName;
+        }
+
+        public List<String> getFieldNames() {
+            return fieldNames;
+        }
+
+        public List<TypeReference<?>> getFieldTypes() {
+            return getInnerTypes();
+        }
+
+        @Override
+        public String toString() {
+            StringBuilder sb = new StringBuilder();
+            sb.append("StructType(").append(structName).append(") {");
+            for (int i = 0; i < fieldNames.size(); i++) {
+                sb.append(fieldNames.get(i)).append(": ").append(getFieldTypes().get(i).getType());
+                if (i < fieldNames.size() - 1) sb.append(", ");
+            }
+
+            sb.append("}");
+            return sb.toString();
+        }
+    }
+
     public static TypeReference makeTypeReference(String solidityType)
             throws ClassNotFoundException {
         return makeTypeReference(solidityType, false, false);

abi/src/main/java/org/web3j/abi/datatypes/DynamicStruct.java

@@ -12,8 +12,12 @@
  */
 package org.web3j.abi.datatypes;
 
+import java.lang.reflect.Array;
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.List;
 
 public class DynamicStruct extends DynamicArray<Type> implements StructType {
@@ -66,4 +70,77 @@ public String getTypeAsString() {
         type.append(")");
         return type.toString();
     }
+
+    // overriding toString method in SFWJ file
+    @Override
+    public String toString() {
+        // Try to use reflection
+        try {
+            Field[] declared = getClass().getDeclaredFields();
+            List<Field> publicFields = new ArrayList<>();
+            for (Field f : declared) {
+                int mod = f.getModifiers();
+                if (!Modifier.isStatic(mod) && Modifier.isPublic(mod) && !f.isSynthetic()) {
+                    publicFields.add(f);
+                }
+            }
+
+            if (!publicFields.isEmpty()) {
+                StringBuilder sb = new StringBuilder(getClass().getSimpleName()).append("(");
+                for (int i = 0; i < publicFields.size(); i++) {
+                    Field f = publicFields.get(i);
+                    Object value = f.get(this);
+                    sb.append(f.getName()).append(": ").append(unwrap(value));
+                    if (i < publicFields.size() - 1) sb.append(", ");
+                }
+                sb.append(")");
+                return sb.toString();
+            }
+        } catch (Exception e) {
+            // If reflection fails, fallback below
+        }
+
+        // original behaviour with field0, field1...
+        StringBuilder sb = new StringBuilder("DynamicStruct(");
+        List<Type> values = getValue();
+        for (int i = 0; i < values.size(); i++) {
+            sb.append("field").append(i).append(": ").append(values.get(i));
+            if (i < values.size() - 1) sb.append(", ");
+        }
+        sb.append(")");
+        return sb.toString();
+    }
+
+    private static Object unwrap(Object o) {
+        if (o == null) return null;
+
+        return switch (o) {
+            case DynamicStruct ds -> ds.toString();
+
+            case Type<?> t -> unwrap(t.getValue());
+
+            case Collection<?> col -> {
+                List<Object> out = new ArrayList<>();
+                for (Object e : col) out.add(unwrap(e));
+                yield out;
+            }
+
+            case Object[] arr -> {
+                List<Object> out = new ArrayList<>(arr.length);
+                for (Object e : arr) out.add(unwrap(e));
+                yield out;
+            }
+
+            default -> {
+                if (o.getClass().isArray()) {
+                    int n = Array.getLength(o);
+                    List<Object> out = new ArrayList<>(n);
+                    for (int i = 0; i < n; i++) out.add(unwrap(Array.get(o, i)));
+                    yield out;
+                } else {
+                    yield o;
+                }
+            }
+        };
+    }
 }

abi/src/main/java/org/web3j/abi/datatypes/Struct.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2025 Web3 Labs Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package org.web3j.abi.datatypes;
+
+import java.util.List;
+
+/** Base class for Solidity structs. Should be extended by generated struct wrappers. */
+public abstract class Struct extends DynamicStruct {
+    protected Struct(List<Type> values) {
+        super(values.toArray(new Type[0]));
+    }
+
+    protected Struct(Type... values) {
+        super(values);
+    }
+}

abi/src/test/java/org/web3j/abi/datatypes/DynamicStructTest.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2025 Web3 Labs Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package org.web3j.codegen;
+
+import org.junit.jupiter.api.Test;
+
+import org.web3j.abi.datatypes.Address;
+import org.web3j.abi.datatypes.DynamicStruct;
+import org.web3j.abi.datatypes.generated.Uint256;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class DynamicStructTest {
+
+    @Test
+    public void testToStringForStruct() {
+        Uint256 value1 = new Uint256(123);
+        Address value2 = new Address("0x1234567890123456789012345678901234567890");
+        DynamicStruct struct = new DynamicStruct(value1, value2);
+
+        String output = struct.toString();
+        System.out.println("toString output: " + output);
+
+        // Optional: add assertion
+        // assertTrue(output.contains("field0: 123"));
+        // assertTrue(output.contains("field1: 0x1234567890123456789012345678901234567890"));
+
+        // Assertions
+        //       assertTrue(output.contains("123"));
+        //       assertTrue(output.contains("0x1234567890123456789012345678901234567890"));
+    }
+}

abi/src/test/java/org/web3j/abi/datatypes/TypeReferenceTest.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2025 Web3 Labs Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+import java.util.Arrays;
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+import org.web3j.abi.TypeReference;
+import org.web3j.abi.datatypes.Struct;
+import org.web3j.abi.datatypes.Utf8String;
+import org.web3j.abi.datatypes.generated.Uint256;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class TypeReferenceTest {
+    @Test
+    public void testStructTypeReferenceToString() {
+        List<String> fieldNames = Arrays.asList("name", "balance");
+        List<TypeReference<?>> fieldTypes =
+                Arrays.asList(
+                        TypeReference.create(Utf8String.class),
+                        TypeReference.create(Uint256.class));
+
+        TypeReference.StructTypeReference<Struct> ref =
+                new TypeReference.StructTypeReference<>("User", fieldNames, fieldTypes);
+        // String expected = "StructType(User) {name: class org.web3j.abi.datatypes.Utf8String,
+        // balance: class org.web3j.abi.datatypes.Uint256}";
+        String expected =
+                "StructType(User) {name: class org.web3j.abi.datatypes.Utf8String, balance: class org.web3j.abi.datatypes.generated.Uint256}";
+        // System.out.println("Actual:   " + ref.toString());
+        // System.out.println("Expected: " + expected);
+        assertEquals(expected, ref.toString());
+    }
+}

codegen/src/main/java/org/web3j/codegen/SolidityFunctionWrapper.java

@@ -772,6 +772,7 @@ private List<TypeSpec> buildStructTypes(final List<AbiDefinition> functionDefini
 
             builder.superclass(namedType.isDynamic() ? DynamicStruct.class : StaticStruct.class);
             builder.addMethod(constructorBuilder.build());
+            builder.addMethod(generateToStringMethod(namedType.getComponents())); // Added this line
             if (useNativeJavaTypes
                     && namedType.getComponents().stream()
                             .anyMatch(
@@ -787,6 +788,30 @@ private List<TypeSpec> buildStructTypes(final List<AbiDefinition> functionDefini
         return structs;
     }
 
+    private MethodSpec generateToStringMethod(List<AbiDefinition.NamedType> components) {
+        MethodSpec.Builder builder =
+                MethodSpec.methodBuilder("toString")
+                        .addAnnotation(Override.class)
+                        .addModifiers(Modifier.PUBLIC)
+                        .returns(String.class);
+
+        StringBuilder format = new StringBuilder("\"" + "{ ");
+        List<Object> args = new ArrayList<>();
+
+        for (AbiDefinition.NamedType component : components) {
+            String fieldName =
+                    !SourceVersion.isName(component.getName())
+                            ? "_" + component.getName()
+                            : component.getName();
+            format.append(fieldName).append("='\" + ").append(fieldName).append(" + \"', ");
+        }
+
+        format.append("}\"");
+
+        builder.addStatement("return " + format.toString());
+        return builder.build();
+    }
+
     @NotNull
     private static String getStructName(String internalType) {
         final String fullStructName = internalType.substring(internalType.lastIndexOf(" ") + 1);

codegen/src/test/resources/solidity/arrayofstructandstruct/build/java/ArrayOfStructAndStruct.java

@@ -145,6 +145,11 @@ public Foo(Bool dummy) {
             super(dummy);
             this.dummy = dummy.getValue();
         }
+
+        @Override
+        public String toString() {
+            return "{ dummy='" + dummy + "', }";
+        }
     }
 }
 

codegen/src/test/resources/solidity/arrayofstructclassgeneration/build/java/ArrayOfStructClassGeneration.java

@@ -135,6 +135,11 @@ public Foo(Bool dummy) {
             super(dummy);
             this.dummy = dummy.getValue();
         }
+
+        @Override
+        public String toString() {
+            return "{ dummy='" + dummy + "', }";
+        }
     }
 }
 

codegen/src/test/resources/solidity/arraysinstruct/build/java/ArraysInStruct.java

@@ -271,5 +271,10 @@ public Entity(DynamicBytes bytesField, Bytes32 extraData,
             this.intArrayFieldStatic = intArrayFieldStatic.getValue().stream().map(v -> v.getValue()).collect(Collectors.toList());
             this.addressArrayFieldStatic = addressArrayFieldStatic.getValue().stream().map(v -> v.getValue()).collect(Collectors.toList());
         }
+
+        @Override
+        public String toString() {
+            return "{ bytesField='" + bytesField + "', extraData='" + extraData + "', stringArrayField='" + stringArrayField + "', bytesArrayField='" + bytesArrayField + "', bytes2ArrayField='" + bytes2ArrayField + "', bytes32ArrayField='" + bytes32ArrayField + "', unitArrayField='" + unitArrayField + "', unit256ArrayField='" + unit256ArrayField + "', boolField='" + boolField + "', intArrayField='" + intArrayField + "', addressArrayField='" + addressArrayField + "', stringArrayFieldStatic='" + stringArrayFieldStatic + "', bytesArrayFieldStatic='" + bytesArrayFieldStatic + "', bytes2ArrayFieldStatic='" + bytes2ArrayFieldStatic + "', bytes32ArrayFieldStatic='" + bytes32ArrayFieldStatic + "', unitArrayFieldStatic='" + unitArrayFieldStatic + "', unit256ArrayFieldStatic='" + unit256ArrayFieldStatic + "', boolFieldStatic='" + boolFieldStatic + "', intArrayFieldStatic='" + intArrayFieldStatic + "', addressArrayFieldStatic='" + addressArrayFieldStatic + "', }";
+        }
     }
 }

codegen/src/test/resources/solidity/onlyinarraystruct/build/java/OnlyInArrayStruct.java

@@ -122,5 +122,10 @@ public Foo(Utf8String id, Utf8String name) {
             this.id = id.getValue();
             this.name = name.getValue();
         }
+
+        @Override
+        public String toString() {
+            return "{ id='" + id + "', name='" + name + "', }";
+        }
     }
 }

codegen/src/test/resources/solidity/sameinnerstructname/build/java/SameInnerStructName.java

@@ -136,6 +136,11 @@ public Foo_Info(Bool dummy) {
             super(dummy);
             this.dummy = dummy.getValue();
         }
+
+        @Override
+        public String toString() {
+            return "{ dummy='" + dummy + "', }";
+        }
     }
 
     public static class Bar_Info extends StaticStruct {
@@ -150,6 +155,11 @@ public Bar_Info(Bool dummy) {
             super(dummy);
             this.dummy = dummy.getValue();
         }
+
+        @Override
+        public String toString() {
+            return "{ dummy='" + dummy + "', }";
+        }
     }
 }