fix 2d array bug of abiSchemaToJsonSchema in web3-validator (#6836)

EtlesL · Yi Zhang · web-flow · commit 1f81ff097cf5 · 2024-03-20T15:43:37.000+01:00
* fix 2d array bug of abiSchemaToJsonSchema in web3-validator

* fix 2d array bug of abiSchemaToJsonSchema in web3-validator(add comments)

* fix abi json schema test case:
- 123 cannot be uint
- test case("nested tuple object in nested array") has a wrong data structure of tuple[][3]

* fix function abiSchemaToJsonSchema in iterating over arraySizes array to each dimension

* FIX:
1. fix function convertToZod to distinguish tuple and array, add checks in maxItems &amp; minItems
2. revert abiSchemaToJsonSchema of utils and fix
3. add testcases in validator.validate

* UPDATE: contract test

---------

Co-authored-by: Yi Zhang &lt;yi.y.zhang@maplequad.com&gt;
diff --git a/packages/web3-eth-contract/test/unit/contract.test.ts b/packages/web3-eth-contract/test/unit/contract.test.ts
@@ -508,7 +508,7 @@ describe('Contract', () => {
 				expect(error).toBeInstanceOf(Web3ValidatorError);
 				// eslint-disable-next-line jest/no-conditional-expect
 				expect((error as Web3ValidatorError).message).toBe(
-					'Web3 validator found 1 error[s]:\nmust NOT have more than 1 items',
+					'Web3 validator found 2 error[s]:\nmust NOT have more than 1 items\nvalue "true" at "/1" must pass "string" validation',
 				);
 			}
 
diff --git a/packages/web3-validator/CHANGELOG.md b/packages/web3-validator/CHANGELOG.md
@@ -162,4 +162,8 @@ Documentation:
 
 -   Fixed an issue with detecting Uint8Array (#6486)
 
-## [Unreleased]
+## [Unreleased]
+
+### Fixed
+
+- Multi-dimensional arrays(with a fix length) are now handled properly when parsing ABIs (#6798)
diff --git a/packages/web3-validator/src/utils.ts b/packages/web3-validator/src/utils.ts
@@ -177,6 +177,7 @@ export const abiSchemaToJsonSchema = (
 		for (let i = arraySizes.length - 1; i > 0; i -= 1) {
 			childSchema = {
 				type: 'array',
+				$id: abiName,
 				items: [],
 				maxItems: arraySizes[i],
 				minItems: arraySizes[i],
@@ -192,7 +193,7 @@ export const abiSchemaToJsonSchema = (
 				lastSchema.items = [lastSchema.items as JsonSchema, childSchema];
 			} // lastSchema.items is an empty Scheme array, set it to 'childSchema'
 			else if (lastSchema.items.length === 0) {
-				lastSchema.items = childSchema;
+				lastSchema.items = [childSchema];
 			} // lastSchema.items is a non-empty Scheme array, append 'childSchema'
 			else {
 				lastSchema.items.push(childSchema);
@@ -205,43 +206,31 @@ export const abiSchemaToJsonSchema = (
 			nestedTuple.$id = abiName;
 			(lastSchema.items as JsonSchema[]).push(nestedTuple);
 		} else if (baseType === 'tuple' && isArray) {
-			const arraySize = arraySizes[0];
-			const item: JsonSchema = {
-				$id: abiName,
-				type: 'array',
-				items: abiSchemaToJsonSchema(abiComponents, abiName),
-				maxItems: arraySize,
-				minItems: arraySize,
-			};
-
-			if (arraySize < 0) {
-				delete item.maxItems;
-				delete item.minItems;
-			}
-
-			(lastSchema.items as JsonSchema[]).push(item);
+            const arraySize = arraySizes[0];
+            const item: JsonSchema = {
+                type: 'array',
+                $id: abiName,
+                items: abiSchemaToJsonSchema(abiComponents, abiName),
+                ...(arraySize >= 0 && { minItems: arraySize, maxItems: arraySize }),
+            };
+
+            (lastSchema.items as JsonSchema[]).push(item);
 		} else if (isArray) {
-			const arraySize = arraySizes[0];
-			const item: JsonSchema = {
-				type: 'array',
-				$id: abiName,
-				items: convertEthType(String(baseType)),
-				minItems: arraySize,
-				maxItems: arraySize,
-			};
-
-			if (arraySize < 0) {
-				delete item.maxItems;
-				delete item.minItems;
-			}
-
-			(lastSchema.items as JsonSchema[]).push(item);
+		    const arraySize = arraySizes[0];
+            const item: JsonSchema = {
+                type: 'array',
+                $id: abiName,
+                items: convertEthType(abiType),
+                ...(arraySize >= 0 && { minItems: arraySize, maxItems: arraySize }),
+            };
+
+            (lastSchema.items as JsonSchema[]).push(item);
 		} else if (Array.isArray(lastSchema.items)) {
 			// Array of non-tuple items
 			lastSchema.items.push({ $id: abiName, ...convertEthType(abiType) });
 		} else {
 			// Nested object
-			((lastSchema.items as JsonSchema).items as JsonSchema[]).push({
+			(lastSchema.items as JsonSchema[]).push({
 				$id: abiName,
 				...convertEthType(abiType),
 			});
@@ -505,4 +494,4 @@ export function ensureIfUint8Array<T = any>(data: T) {
 		return Uint8Array.from(data as unknown as Uint8Array);
 	}
 	return data;
-}
+}
diff --git a/packages/web3-validator/src/validator.ts b/packages/web3-validator/src/validator.ts
@@ -44,7 +44,9 @@ const convertToZod = (schema: JsonSchema): ZodType => {
 	}
 
 	if (schema?.type === 'array' && schema?.items) {
-		if (Array.isArray(schema.items) && schema.items.length > 0) {
+		if (Array.isArray(schema.items) && schema.items.length > 1
+		    && schema.maxItems !== undefined
+		    && new Set(schema.items.map((item: JsonSchema) => item.$id)).size === schema.items.length) {
 			const arr: Partial<[ZodTypeAny, ...ZodTypeAny[]]> = [];
 			for (const item of schema.items) {
 				const zItem = convertToZod(item);
@@ -54,7 +56,12 @@ const convertToZod = (schema: JsonSchema): ZodType => {
 			}
 			return z.tuple(arr as [ZodTypeAny, ...ZodTypeAny[]]);
 		}
-		return z.array(convertToZod(schema.items as JsonSchema));
+		const nextSchema = Array.isArray(schema.items) ? schema.items[0] : schema.items;
+        let zodArraySchema = z.array(convertToZod(nextSchema));
+
+        zodArraySchema = schema.minItems !== undefined ? zodArraySchema.min(schema.minItems) : zodArraySchema;
+        zodArraySchema = schema.maxItems !== undefined ? zodArraySchema.max(schema.maxItems) : zodArraySchema;
+		return zodArraySchema;
 	}
 
 	if (schema.oneOf && Array.isArray(schema.oneOf)) {
diff --git a/packages/web3-validator/test/fixtures/abi_to_json_schema.ts b/packages/web3-validator/test/fixtures/abi_to_json_schema.ts
diff --git a/packages/web3-validator/test/unit/web3_validator.test.ts b/packages/web3-validator/test/unit/web3_validator.test.ts

Original file line number	Diff line number	Diff line change
`@@ -508,7 +508,7 @@ describe('Contract', () => {`
`508`	`508`	`expect(error).toBeInstanceOf(Web3ValidatorError);`
`509`	`509`	`// eslint-disable-next-line jest/no-conditional-expect`
`510`	`510`	`expect((error as Web3ValidatorError).message).toBe(`
`511`		`- 'Web3 validator found 1 error[s]:\nmust NOT have more than 1 items',`
	`511`	`+ 'Web3 validator found 2 error[s]:\nmust NOT have more than 1 items\nvalue "true" at "/1" must pass "string" validation',`
`512`	`512`	`);`
`513`	`513`	`}`
`514`	`514`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,9 @@ const convertToZod = (schema: JsonSchema): ZodType => {`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`if (schema?.type === 'array' && schema?.items) {`
`47`		`- if (Array.isArray(schema.items) && schema.items.length > 0) {`
	`47`	`+ if (Array.isArray(schema.items) && schema.items.length > 1`
	`48`	`+ && schema.maxItems !== undefined`
	`49`	`+ && new Set(schema.items.map((item: JsonSchema) => item.$id)).size === schema.items.length) {`
`48`	`50`	`const arr: Partial<[ZodTypeAny, ...ZodTypeAny[]]> = [];`
`49`	`51`	`for (const item of schema.items) {`
`50`	`52`	`const zItem = convertToZod(item);`
`@@ -54,7 +56,12 @@ const convertToZod = (schema: JsonSchema): ZodType => {`
`54`	`56`	`}`
`55`	`57`	`return z.tuple(arr as [ZodTypeAny, ...ZodTypeAny[]]);`
`56`	`58`	`}`
`57`		`- return z.array(convertToZod(schema.items as JsonSchema));`
	`59`	`+ const nextSchema = Array.isArray(schema.items) ? schema.items[0] : schema.items;`
	`60`	`+ let zodArraySchema = z.array(convertToZod(nextSchema));`
	`61`	`+`
	`62`	`+ zodArraySchema = schema.minItems !== undefined ? zodArraySchema.min(schema.minItems) : zodArraySchema;`
	`63`	`+ zodArraySchema = schema.maxItems !== undefined ? zodArraySchema.max(schema.maxItems) : zodArraySchema;`
	`64`	`+ return zodArraySchema;`
`58`	`65`	`}`
`59`	`66`
`60`	`67`	`if (schema.oneOf && Array.isArray(schema.oneOf)) {`