Put structs in the right places

packages/abi-to-sol/src/declarations.test.ts

@@ -14,7 +14,10 @@ describe("collectDeclarations", () => {
         (parameter) => {
           fc.pre(!parameter.type.startsWith("tuple"));
 
-          expect(collectDeclarations(parameter)).toEqual({});
+          expect(collectDeclarations(parameter)).toEqual({
+            signatureDeclarations: {},
+            containerSignatures: {}
+          });
         }
       );
     });
@@ -32,9 +35,9 @@ describe("collectDeclarations", () => {
           );
 
           const declarations = collectDeclarations(parameter);
-          expect(Object.keys(declarations)).toHaveLength(1);
+          expect(Object.keys(declarations.signatureDeclarations)).toHaveLength(1);
 
-          const [declaration] = Object.values(declarations);
+          const [declaration] = Object.values(declarations.signatureDeclarations);
           expect(declaration).toHaveProperty("components");
 
           const {components} = declaration;
@@ -70,7 +73,7 @@ describe("collectDeclarations", () => {
           );
 
           const declarations = collectDeclarations(parameter);
-          expect(Object.keys(declarations)).toHaveLength(2);
+          expect(Object.keys(declarations.signatureDeclarations)).toHaveLength(2);
         }
       );
     });
@@ -85,10 +88,10 @@ describe("collectDeclarations", () => {
 
         const declarations = collectDeclarations(parameter);
 
-        for (const {components} of Object.values(declarations)) {
+        for (const {components} of Object.values(declarations.signatureDeclarations)) {
           for (const {signature} of components) {
             if (signature) {
-              expect(declarations).toHaveProperty(signature);
+              expect(declarations.signatureDeclarations).toHaveProperty(signature);
             }
           }
         }
@@ -104,13 +107,13 @@ describe("collectDeclarations", () => {
     )) {
       describe(`struct ${structName}`, () => {
         it("exists in declarations", () => {
-          expect(declarations).toHaveProperty(signature);
+          expect(declarations.signatureDeclarations).toHaveProperty(signature);
         });
 
         const expectedComponents = (Example.expectedDeclarations as any)[
           structName
         ];
-        const declaration = declarations[signature];
+        const declaration = declarations.signatureDeclarations[signature];
 
         for (const [componentName, component] of Object.entries(
           expectedComponents

packages/abi-to-sol/src/declarations.ts

@@ -16,55 +16,61 @@ export interface Declaration {
 }
 
 export interface Declarations {
-  [signature: string]: Declaration;
+  signatureDeclarations: {
+    [signature: string]: Declaration;
+  };
+  containerSignatures: {
+    [container: string]: string[];
+  }
 }
 
 export class DeclarationsCollector implements Visitor<Declarations> {
   visitAbi({node: nodes}: VisitOptions<Abi.Abi>): Declarations {
     return nodes
       .map((node) => dispatch({node, visitor: this}))
-      .reduce((a, b) => ({...a, ...b}), {});
+      .reduce(mergeDeclarations, emptyDeclarations());
   }
 
   visitEventEntry({node: entry}: VisitOptions<Abi.EventEntry>): Declarations {
     return entry.inputs
       .map((node) => dispatch({node, visitor: this}))
-      .reduce((a, b) => ({...a, ...b}), {});
+      .reduce(mergeDeclarations, emptyDeclarations());
   }
 
   visitFunctionEntry({
     node: entry,
   }: VisitOptions<Abi.FunctionEntry>): Declarations {
     return [...entry.inputs, ...(entry.outputs || [])]
       .map((node) => dispatch({node, visitor: this}))
-      .reduce((a, b) => ({...a, ...b}), {});
+      .reduce(mergeDeclarations, emptyDeclarations());
   }
 
   visitConstructorEntry({
     node: entry,
   }: VisitOptions<Abi.ConstructorEntry>): Declarations {
     return entry.inputs
       .map((node) => dispatch({node, visitor: this}))
-      .reduce((a, b) => ({...a, ...b}), {});
+      .reduce(mergeDeclarations, emptyDeclarations());
   }
 
   visitFallbackEntry({
     node: entry,
   }: VisitOptions<Abi.FallbackEntry>): Declarations {
-    return {};
+    return emptyDeclarations();
   }
 
   visitReceiveEntry({
     node: entry,
   }: VisitOptions<Abi.ReceiveEntry>): Declarations {
-    return {};
+    return emptyDeclarations();
   }
 
   visitParameter({node: parameter}: VisitOptions<Abi.Parameter>): Declarations {
     if (!parameter.type.startsWith("tuple")) {
-      return {};
+      return emptyDeclarations();
     }
 
+    let container = "";
     const components = parameter.components || [];
     const signature = Codec.AbiData.Utils.abiTupleSignature(components);
     const declaration: Declaration = {
@@ -82,22 +88,34 @@ export class DeclarationsCollector implements Visitor<Declarations> {
     if ("internalType" in parameter && parameter.internalType) {
       const match = parameter.internalType.match(/struct ([^\[]+).*/);
       if (match) {
-        // HACK remove
-        declaration.identifier = match[1].replace(/[^0-9a-zA-Z_]/gi, "_");
+        const possiblyQualifiedIdentifier = match[1];
+        const parts = possiblyQualifiedIdentifier.split(".");
+        if (parts.length === 1) {
+          declaration.identifier = parts[0];
+        } else if (parts.length === 2) {
+          container = parts[0];
+          declaration.identifier = parts[1];
+        }
       }
     }
 
     const declarations = {
-      ...components
-        .map((component: Abi.Parameter) =>
-          this.visitParameter({node: component})
-        )
-        .reduce((a, b) => ({...a, ...b}), {}),
-
-      [signature]: declaration,
+      signatureDeclarations: {
+        [signature]: declaration
+      },
+      containerSignatures: {
+        [container]: [signature]
+      }
     };
 
-    return declarations;
+    const componentDeclarations: Declarations = components
+      .map((component: Abi.Parameter) =>
+        this.visitParameter({node: component})
+      )
+      .reduce(mergeDeclarations, emptyDeclarations())
+
+
+    return mergeDeclarations(declarations, componentDeclarations);
   }
 }
 
@@ -106,3 +124,37 @@ export const collectDeclarations = (node: SchemaAbi | Node) =>
     node,
     visitor: new DeclarationsCollector(),
   });
+
+function mergeDeclarations(
+  a: Declarations,
+  b: Declarations
+): Declarations {
+  const declarations: Declarations = {
+    signatureDeclarations: {
+      ...a.signatureDeclarations,
+      ...b.signatureDeclarations
+    },
+    containerSignatures: {
+      ...a.containerSignatures,
+      // add b iteratively separately to merge arrays
+    }
+  };
+
+  for (const [container, signatures] of Object.entries(b.containerSignatures)) {
+    const mergedSignatures = new Set([
+      ...(declarations.containerSignatures[container] || []),
+      ...signatures
+    ])
+
+    declarations.containerSignatures[container] = [...mergedSignatures];
+  }
+
+  return declarations;
+}
+
+function emptyDeclarations(): Declarations {
+  return {
+    signatureDeclarations: {},
+    containerSignatures: {}
+  };
+}