Merge pull request #2076 from Antlion12/TrulyDynamicStructs

Updated TypeReference and TypeDecoder to support decoding of dynamic structs and dynamic struct arrays without a priori Class definitions.
hyperledger · Aug 8, 2024 · bb9dc1c · bb9dc1c
2 parents b73dba0 + ca59055
commit bb9dc1c
Show file tree

Hide file tree

Showing 8 changed files with 587 additions and 32 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 * bump snapshot version to 4.12.1 [#2058](https://github.com/hyperledger/web3j/pull/2058)
 * Update maintainer requirements status [#2064](https://github.com/hyperledger/web3j/pull/2064)
+* Add struct support in java without the need of having a corresponding Java class [#2076](https://github.com/hyperledger/web3j/pull/2076)
 
 ### BREAKING CHANGES
 

diff --git a/abi/src/main/java/org/web3j/abi/TypeDecoder.java b/abi/src/main/java/org/web3j/abi/TypeDecoder.java
diff --git a/abi/src/main/java/org/web3j/abi/TypeReference.java b/abi/src/main/java/org/web3j/abi/TypeReference.java
@@ -14,6 +14,7 @@
 
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
+import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -39,10 +40,17 @@ public abstract class TypeReference<T extends org.web3j.abi.datatypes.Type>
  private final Type type;
  private final boolean indexed;
 
+ protected List<TypeReference<?>> innerTypes;
+
  protected TypeReference() {
  this(false);
  }
 
+ protected TypeReference(boolean indexed, List<TypeReference<?>> innerTypesIn) {
+ this(indexed);
+ this.innerTypes = innerTypesIn;
+ }
+
  protected TypeReference(boolean indexed) {
  Type superclass = getClass().getGenericSuperclass();
  if (superclass instanceof Class) {
@@ -59,10 +67,14 @@ protected TypeReference(boolean indexed) {
  *
  * @return the type wrapped by this Array TypeReference, or null if not Array
  */
- TypeReference getSubTypeReference() {
+ public TypeReference getSubTypeReference() {
  return null;
  }
 
+ public List<TypeReference<?>> getInnerTypes() {
+ return this.innerTypes;
+ }
+
  public int compareTo(TypeReference<T> o) {
  // taken from the blog post comments - this results in an error if the
  // type parameter is left out.
@@ -175,7 +187,7 @@ public static TypeReference makeTypeReference(
  arrayWrappedType =
  new TypeReference<DynamicArray>(indexed) {
  @Override
- TypeReference getSubTypeReference() {
+ public TypeReference getSubTypeReference() {
  return baseTr;
  }
 
@@ -213,7 +225,7 @@ public java.lang.reflect.Type getOwnerType() {
  new TypeReference.StaticArrayTypeReference<StaticArray>(arraySizeInt) {
 
  @Override
- TypeReference getSubTypeReference() {
+ public TypeReference getSubTypeReference() {
  return baseTr;
  }
 

diff --git a/abi/src/main/java/org/web3j/abi/Utils.java b/abi/src/main/java/org/web3j/abi/Utils.java
@@ -92,7 +92,7 @@ public static String getStructType(Class type) {
  public static TypeReference<DynamicArray> getDynamicArrayTypeReference(Class parameter) {
  return new TypeReference<DynamicArray>() {
  @Override
- TypeReference getSubTypeReference() {
+ public TypeReference getSubTypeReference() {
  return TypeReference.create(parameter);
  }
  };

diff --git a/abi/src/main/java/org/web3j/abi/datatypes/DynamicStruct.java b/abi/src/main/java/org/web3j/abi/datatypes/DynamicStruct.java
@@ -18,7 +18,7 @@
 
 public class DynamicStruct extends DynamicArray<Type> implements StructType {
 
- private final List<Class<Type>> itemTypes = new ArrayList<>();
+ public final List<Class<Type>> itemTypes = new ArrayList<>();
 
  public DynamicStruct(List<Type> values) {
  this(Type.class, values);

diff --git a/abi/src/test/java/org/web3j/abi/FunctionReturnDecoderTest.java b/abi/src/test/java/org/web3j/abi/FunctionReturnDecoderTest.java
diff --git a/codegen/src/test/java/org/web3j/codegen/SolidityFunctionWrapperGeneratorTest.java b/codegen/src/test/java/org/web3j/codegen/SolidityFunctionWrapperGeneratorTest.java
@@ -257,7 +257,10 @@ public void testArrayOfStructAndStructCompareJavaFile() throws Exception {
  @Test
  public void testStaticArrayOfStructsInStructGeneration() throws Exception {
  testCodeGeneration(
- "staticarrayofstructsinstruct", "StaticArrayOfStructsInStruct", JAVA_TYPES_ARG, false);
+ "staticarrayofstructsinstruct",
+ "StaticArrayOfStructsInStruct",
+ JAVA_TYPES_ARG,
+ false);
  }
 
  @Test

diff --git a/core/src/main/java/org/web3j/protocol/core/methods/response/AbiDefinition.java b/core/src/main/java/org/web3j/protocol/core/methods/response/AbiDefinition.java
@@ -277,9 +277,9 @@ public void setComponents(final List<NamedType> components) {
 
  public String structIdentifier() {
  return ((internalType == null ? type : internalType.isEmpty() ? type : internalType)
-  + components.stream()
-  .map(NamedType::structIdentifier)
-  .collect(Collectors.joining()));
+ + components.stream()
+ .map(NamedType::structIdentifier)
+ .collect(Collectors.joining()));
  }
 
  public int nestedness() {