fix: verification endpoint alignment with etherscan

packages/api/src/api/contract/contract.controller.spec.ts

@@ -278,7 +278,7 @@ describe("ContractController", () => {
         contractname: "contracts/HelloWorld.sol:HelloWorld",
         compilerversion: "0.8.17",
         optimizationUsed: "1",
-        zkCompilerVersion: "v1.3.14",
+        zksolcVersion: "v1.3.14",
         constructorArguements: "0x94869207468657265210000000000000000000000000000000000000000000000",
         runs: 700,
         libraryname1: "contracts/MiniMath.sol:MiniMath",
@@ -426,7 +426,7 @@ describe("ContractController", () => {
         contractname: "contracts/Greeter.vy:Greeter",
         compilerversion: "0.3.3",
         optimizationUsed: "1",
-        zkCompilerVersion: "v1.3.11",
+        zksolcVersion: "v1.3.11",
       } as unknown as VerifyContractRequestDto;
 
       pipeMock.mockReturnValue(
@@ -442,7 +442,7 @@ describe("ContractController", () => {
         codeFormat: "vyper-multi-file",
         compilerVyperVersion: "0.3.3",
         compilerZkvyperVersion: "v1.3.11",
-        constructorArguments: undefined,
+        constructorArguments: "0x",
         contractAddress: "0x14174c76E073f8efEf5C1FE0dd0f8c2Ca9F21e62",
         contractName: "contracts/Greeter.vy:Greeter",
         optimizationUsed: true,

packages/api/src/api/contract/contract.controller.ts

@@ -32,7 +32,6 @@ import {
   ContractVerificationStatusResponse,
 } from "../types";
 import { VerifyContractResponseDto } from "../dtos/contract/verifyContractResponse.dto";
-
 const entityName = "contract";
 
 export const parseAddressListPipeExceptionFactory = () => new BadRequestException("Missing contract addresses");
@@ -136,6 +135,14 @@ export class ContractController {
       ContractVerificationCodeFormatEnum.solidityJsonInput,
     ].includes(request.codeformat);
 
+    request.zksolcVersion = request.zksolcVersion || request.zkCompilerVersion;
+
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const semver = require("semver");
+    if (semver.gte(request.zksolcVersion, "1.3.23")) {
+      request.compilerversion = `zkVM-${request.compilerversion}-1.0.1`;
+    }
+
     if (isSolidityContract && request.sourceCode instanceof Object) {
       const libraries: { [key: string]: Record<string, string> } = {};
       for (let i = 1; i <= 10; i++) {
@@ -166,21 +173,37 @@ export class ContractController {
       }
     }
 
+    let formatedStringSourceCode = undefined;
+    if (isSolidityContract && typeof request.sourceCode === "string") {
+      try {
+        formatedStringSourceCode = JSON.parse(request.sourceCode);
+        if (formatedStringSourceCode.settings.optimizer?.enabled) {
+          request.optimizationUsed = "1";
+        }
+      } catch (e) {
+        formatedStringSourceCode = request.sourceCode;
+      }
+    }
+
     const { data } = await firstValueFrom<{ data: number }>(
       this.httpService
         .post(`${this.contractVerificationApiUrl}/contract_verification`, {
           codeFormat: request.codeformat,
           contractAddress,
           contractName: request.contractname,
           optimizationUsed: request.optimizationUsed === "1",
-          sourceCode: request.sourceCode,
-          constructorArguments: request.constructorArguements,
+          sourceCode: typeof request.sourceCode === "string" ? formatedStringSourceCode : request.sourceCode,
+          constructorArguments: request.constructorArguements
+            ? request.constructorArguements.slice(0, 2) !== "0x"
+              ? `0x${request.constructorArguements}`
+              : request.constructorArguements
+            : "0x",
           ...(isSolidityContract && {
-            compilerZksolcVersion: request.zkCompilerVersion,
+            compilerZksolcVersion: request.zksolcVersion,
             compilerSolcVersion: request.compilerversion,
           }),
           ...(!isSolidityContract && {
-            compilerZkvyperVersion: request.zkCompilerVersion,
+            compilerZkvyperVersion: request.zksolcVersion,
             compilerVyperVersion: request.compilerversion,
           }),
         })

packages/api/src/api/dtos/contract/verifyContractRequest.dto.ts

@@ -1,7 +1,8 @@
-import { IsInt, IsOptional, Max, Min, IsEnum, IsString, IsNotEmpty, Matches } from "class-validator";
+import { IsInt, IsOptional, Max, Min, IsEnum, IsString, IsNotEmpty, Matches, ValidateIf } from "class-validator";
 import { ApiProperty } from "@nestjs/swagger";
 import { Type } from "class-transformer";
 import { ContractVerificationCodeFormatEnum } from "../../types";
+import { FormatAndValidateCompilerVersion } from "../../../common/decorators/formatAndValidateCompilerVersion";
 
 const fullLibraryNameRegexp = new RegExp("^(.)+:(.)+$");
 
@@ -86,14 +87,27 @@ export class VerifyContractRequestDto {
   })
   @IsString()
   @IsNotEmpty({ message: "Missing Or invalid compilerversion." })
+  @FormatAndValidateCompilerVersion({ message: "Invalid compilerversion format." })
   public compilerversion: string;
 
+  @ApiProperty({
+    name: "zksolcVersion",
+    description: "Zk compiler version",
+    example: "v1.3.14",
+    required: true,
+  })
+  @ValidateIf((o) => !o.zkCompilerVersion || o.zksolcVersion)
+  @IsString()
+  @IsNotEmpty({ message: "Missing zksolcVersion" })
+  public zksolcVersion: string;
+
   @ApiProperty({
     name: "zkCompilerVersion",
     description: "Zk compiler version",
     example: "v1.3.14",
     required: true,
   })
+  @ValidateIf((o) => !o.zksolcVersion || o.zkCompilerVersion)
   @IsString()
   @IsNotEmpty({ message: "Missing zkCompilerVersion" })
   public zkCompilerVersion: string;
@@ -115,19 +129,20 @@ export class VerifyContractRequestDto {
     name: "optimizationUsed",
     description: "0 = No Optimization, 1 = Optimization used",
     example: "1",
-    required: true,
+    required: false,
   })
   @IsEnum(["0", "1"], {
     message: "Invalid optimizationUsed",
   })
-  @IsNotEmpty({ message: "Missing optimizationUsed" })
+  @IsOptional()
   public optimizationUsed: string;
 
   @ApiProperty({
     name: "constructorArguements",
     description: "Contract constructor arguments",
-    example:
-      "0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000094869207468657265210000000000000000000000000000000000000000000000",
+    examples: [
+      "0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000094869207468657265210000000000000000000000000000000000000000000000, 000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000094869207468657265210000000000000000000000000000000000000000000000",
+    ],
     required: false,
   })
   @IsOptional()

packages/api/src/common/decorators/formatAndValidateCompilerVersion.spec.ts

@@ -0,0 +1,35 @@
+import { validate } from "class-validator";
+import { FormatAndValidateCompilerVersion } from "./formatAndValidateCompilerVersion";
+
+class TestDto {
+  constructor(version: string) {
+    this.version = version;
+  }
+
+  @FormatAndValidateCompilerVersion()
+  public version: string;
+}
+
+describe("FormatAndValidateCompilerVersion", () => {
+  it("when version is null returns a validation error", async () => {
+    const errors = await validate(new TestDto(null));
+    expect(errors.length).toBe(1);
+    expect(errors[0].property).toBe("version");
+  });
+
+  it("when version is an empty string returns a validation error", async () => {
+    const errors = await validate(new TestDto(""));
+    expect(errors.length).toBe(1);
+    expect(errors[0].property).toBe("version");
+  });
+
+  it("when version is a valid", async () => {
+    const errors = await validate(new TestDto("2.3.7"));
+    expect(errors.length).toBe(0);
+  });
+
+  it("when version is valid with commit", async () => {
+    const errors = await validate(new TestDto("2.5.7-commit.32"));
+    expect(errors.length).toBe(0);
+  });
+});

packages/api/src/common/decorators/formatAndValidateCompilerVersion.ts

@@ -0,0 +1,43 @@
+import { registerDecorator, ValidationOptions } from "class-validator";
+export function FormatAndValidateCompilerVersion(validationOptions?: ValidationOptions) {
+  return function (object: any, propertyName: string) {
+    registerDecorator({
+      name: "formatAndValidateCompilerVersion",
+      target: object.constructor,
+      propertyName: propertyName,
+      options: validationOptions,
+      validator: {
+        validate(value: any) {
+          return value && typeof value === "string";
+        },
+      },
+    });
+    // Custom setter to format the value
+    Object.defineProperty(object, propertyName, {
+      set(value: string) {
+        const regex = /^(0\.\d+\.\d+(\.\d+)?|zkVM-\d+\.\d+\.\d+(\.\d+)?-\d+\.\d+\.\d+(\.\d+)?)$/;
+        if (value && !regex.test(value)) {
+          let [major, minor, patch] = value.split(".");
+          major = major.slice(1);
+          patch = patch.replace(/\+.*$/, "");
+          minor = minor;
+          const formattedValue = `${major}.${minor}.${patch}`;
+          Object.defineProperty(object, `_${propertyName}`, {
+            value: formattedValue,
+            writable: true,
+            configurable: true,
+          });
+        } else {
+          Object.defineProperty(object, `_${propertyName}`, {
+            value: value,
+            writable: true,
+            configurable: true,
+          });
+        }
+      },
+      get() {
+        return this[`_${propertyName}`];
+      },
+    });
+  };
+}