Remove throwOnError request parameter and adapt Sourcify response handling logic

Author: manuelwedler

v-next/hardhat-utils/src/internal/request.ts

@@ -30,14 +30,14 @@ export async function generateTempFilePath(filePath: string): Promise<string> {
 
 export async function getBaseRequestOptions(
   requestUrl: string,
-  { extraHeaders, abortSignal, queryParams, throwOnError }: RequestOptions = {},
+  { extraHeaders, abortSignal, queryParams }: RequestOptions = {},
   dispatcherOrDispatcherOptions?: UndiciT.Dispatcher | DispatcherOptions,
 ): Promise<{
   query?: Record<string, any> | undefined;
   signal?: EventEmitter | AbortSignal | undefined;
   dispatcher: UndiciT.Dispatcher;
   headers: Record<string, string>;
-  throwOnError: boolean;
+  throwOnError: true;
 }> {
   const { Dispatcher } = await import("undici");
   const dispatcher =
@@ -51,7 +51,7 @@ export async function getBaseRequestOptions(
   return {
     dispatcher,
     headers: getHeaders(requestUrl, extraHeaders),
-    throwOnError: throwOnError ?? true,
+    throwOnError: true,
     ...(abortSignal !== undefined ? { signal: abortSignal } : {}),
     ...(queryParams !== undefined ? { query: queryParams } : {}),
   };

v-next/hardhat-utils/src/request.ts

@@ -60,7 +60,6 @@ export interface RequestOptions {
   queryParams?: Record<string, any>;
   extraHeaders?: Record<string, string>;
   abortSignal?: AbortSignal | EventEmitter;
-  throwOnError?: boolean;
 }
 
 export interface HttpResponse {

v-next/hardhat-verify/src/internal/sourcify.ts

@@ -23,6 +23,7 @@ import {
   getProxyUrl,
   getRequest,
   postJsonRequest,
+  ResponseStatusCodeError,
   shouldUseProxy,
 } from "@nomicfoundation/hardhat-utils/request";
 
@@ -81,12 +82,36 @@ export class Sourcify implements VerificationProvider {
     try {
       response = await getRequest(
         `${this.apiUrl}/v2/contract/${this.chainId}/${address}`,
-        { throwOnError: false },
+        {},
         this.dispatcherOrDispatcherOptions,
       );
       responseBody = await response.body.json();
     } catch (error) {
       ensureError(error);
+
+      if (
+        error instanceof ResponseStatusCodeError &&
+        isSourcifyLookupResponse(error?.body)
+      ) {
+        // Unverified contracts are returned with status 404
+        return error.body.match !== null;
+      }
+
+      if (
+        error instanceof ResponseStatusCodeError &&
+        isSourcifyErrorResponse(error?.body)
+      ) {
+        throw new HardhatError(
+          HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.EXPLORER_REQUEST_STATUS_CODE_ERROR,
+          {
+            name: this.name,
+            url: this.apiUrl,
+            statusCode: error.statusCode,
+            errorMessage: error.body.message,
+          },
+        );
+      }
+
       throw new HardhatError(
         HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.EXPLORER_REQUEST_FAILED,
         {
@@ -98,18 +123,6 @@ export class Sourcify implements VerificationProvider {
       );
     }
 
-    if (isSourcifyErrorResponse(responseBody)) {
-      throw new HardhatError(
-        HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.EXPLORER_REQUEST_STATUS_CODE_ERROR,
-        {
-          name: this.name,
-          url: this.apiUrl,
-          statusCode: response.statusCode,
-          errorMessage: responseBody.message,
-        },
-      );
-    }
-
     if (!isSourcifyLookupResponse(responseBody)) {
       throw new HardhatError(
         HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_VERIFICATION_UNEXPECTED_RESPONSE,
@@ -149,12 +162,33 @@ export class Sourcify implements VerificationProvider {
       response = await postJsonRequest(
         `${this.apiUrl}/v2/verify/${this.chainId}/${contractAddress}`,
         body,
-        { throwOnError: false },
+        {},
         this.dispatcherOrDispatcherOptions,
       );
       responseBody = await response.body.json();
     } catch (error) {
       ensureError(error);
+
+      if (
+        error instanceof ResponseStatusCodeError &&
+        isSourcifyErrorResponse(error?.body)
+      ) {
+        if (error.body.customCode === "already_verified") {
+          throw new HardhatError(
+            HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_ALREADY_VERIFIED,
+            {
+              contract: contractName,
+              address: contractAddress,
+            },
+          );
+        }
+
+        throw new HardhatError(
+          HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_VERIFICATION_REQUEST_FAILED,
+          { message: error.body.message },
+        );
+      }
+
       throw new HardhatError(
         HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.EXPLORER_REQUEST_FAILED,
         {
@@ -166,23 +200,6 @@ export class Sourcify implements VerificationProvider {
       );
     }
 
-    if (isSourcifyErrorResponse(responseBody)) {
-      if (responseBody.customCode === "already_verified") {
-        throw new HardhatError(
-          HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_ALREADY_VERIFIED,
-          {
-            contract: contractName,
-            address: contractAddress,
-          },
-        );
-      }
-
-      throw new HardhatError(
-        HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_VERIFICATION_REQUEST_FAILED,
-        { message: responseBody.message },
-      );
-    }
-
     if (!isSourcifyVerificationResponse(responseBody)) {
       throw new HardhatError(
         HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_VERIFICATION_UNEXPECTED_RESPONSE,
@@ -208,12 +225,23 @@ export class Sourcify implements VerificationProvider {
     try {
       response = await getRequest(
         `${this.apiUrl}/v2/verify/${guid}`,
-        { throwOnError: false },
+        {},
         this.dispatcherOrDispatcherOptions,
       );
       responseBody = await response.body.json();
     } catch (error) {
       ensureError(error);
+
+      if (
+        error instanceof ResponseStatusCodeError &&
+        isSourcifyErrorResponse(error?.body)
+      ) {
+        throw new HardhatError(
+          HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_VERIFICATION_STATUS_POLLING_FAILED,
+          { message: error.body.message },
+        );
+      }
+
       throw new HardhatError(
         HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.EXPLORER_REQUEST_FAILED,
         {
@@ -225,13 +253,6 @@ export class Sourcify implements VerificationProvider {
       );
     }
 
-    if (isSourcifyErrorResponse(responseBody)) {
-      throw new HardhatError(
-        HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_VERIFICATION_STATUS_POLLING_FAILED,
-        { message: responseBody.message },
-      );
-    }
-
     if (!isSourcifyVerificationStatusResponse(responseBody)) {
       throw new HardhatError(
         HardhatError.ERRORS.HARDHAT_VERIFY.GENERAL.CONTRACT_VERIFICATION_UNEXPECTED_RESPONSE,
@@ -293,6 +314,7 @@ function isSourcifyErrorResponse(
 ): response is SourcifyErrorResponse {
   return (
     typeof response === "object" &&
+    response !== null &&
     "customCode" in response &&
     "message" in response &&
     "errorId" in response
@@ -304,6 +326,7 @@ function isSourcifyLookupResponse(
 ): response is SourcifyLookupResponse {
   return (
     typeof response === "object" &&
+    response !== null &&
     "match" in response &&
     "creationMatch" in response &&
     "runtimeMatch" in response &&
@@ -315,14 +338,19 @@ function isSourcifyLookupResponse(
 function isSourcifyVerificationResponse(
   response: any,
 ): response is SourcifyVerificationResponse {
-  return typeof response === "object" && "verificationId" in response;
+  return (
+    typeof response === "object" &&
+    response !== null &&
+    "verificationId" in response
+  );
 }
 
 function isSourcifyVerificationStatusResponse(
   response: any,
 ): response is SourcifyVerificationStatusResponse {
   return (
     typeof response === "object" &&
+    response !== null &&
     "isJobCompleted" in response &&
     "verificationId" in response &&
     "jobStartTime" in response &&