Support Settings (a.k.a. Input JSON Description) in @nomiclabs/hardhat-vyper

.changeset/fluffy-cups-clap.md

@@ -0,0 +1,5 @@
+---
+"@nomiclabs/hardhat-vyper": patch
+---
+
+Added support for vyper settings 'evmVersion' and 'optimize'

packages/hardhat-vyper/README.md

@@ -58,12 +58,23 @@ module.exports = {
 };
 ```
 
-You can also configure multiple versions of the Vyper compiler:
+You can also configure multiple versions of the Vyper compiler, as well as the compiler settings evmVersion and optimize. See the [Vyper docs](https://docs.vyperlang.org/en/v0.3.10/compiling-a-contract.html) for more info.
 
 ```js
 module.exports = {
   vyper: {
-    compilers: [{ version: "0.2.1" }, { version: "0.3.0" }],
+    compilers: [
+      {
+        version: "0.2.1",
+      },
+      {
+        version: "0.3.10",
+        settings: {
+          evmVersion: "paris",
+          optimize: "gas",
+        },
+      },
+    ],
   },
 };
 ```

packages/hardhat-vyper/src/compiler.ts

@@ -1,4 +1,7 @@
 import { exec } from "child_process";
+import semver from "semver";
+import { VyperSettings } from "./types";
+import { VyperPluginError } from "./util";
 
 export class Compiler {
   constructor(private _pathToVyper: string) {}
@@ -7,10 +10,18 @@ export class Compiler {
    *
    * @param inputPaths array of paths to contracts to be compiled
    */
-  public async compile(inputPaths: string[]) {
+  public async compile(
+    inputPaths: string[],
+    compilerVersion: string = "",
+    settings: VyperSettings = {}
+  ) {
     const output: string = await new Promise((resolve, reject) => {
+      const settingsCmd = getSettingsCmd(compilerVersion, settings);
+
       const process = exec(
-        `${this._pathToVyper} -f combined_json ${inputPaths.join(" ")}`,
+        `${this._pathToVyper} ${settingsCmd} -f combined_json ${inputPaths.join(
+          " "
+        )}`,
         {
           maxBuffer: 1024 * 1024 * 500,
         },
@@ -28,3 +39,72 @@ export class Compiler {
     return JSON.parse(output);
   }
 }
+
+function getSettingsCmd(
+  compilerVersion: string,
+  settings: VyperSettings
+): string {
+  let settingsStr =
+    settings.evmVersion !== undefined
+      ? `--evm-version ${settings.evmVersion} `
+      : "";
+
+  settingsStr += getOptimize(compilerVersion, settings.optimize);
+
+  return settingsStr;
+}
+
+function getOptimize(
+  compilerVersion: string,
+  optimize: string | boolean | undefined
+): string {
+  if (compilerVersion === "" && optimize !== undefined) {
+    throw new VyperPluginError(
+      "The 'compilerVersion' parameter must be set when the setting 'optimize' is set."
+    );
+  }
+
+  if (optimize === undefined) {
+    return "";
+  }
+
+  if (typeof optimize === "boolean") {
+    if (optimize) {
+      if (
+        semver.gte(compilerVersion, "0.3.10") ||
+        semver.lt(compilerVersion, "0.3.1")
+      ) {
+        throw new VyperPluginError(
+          `The 'optimize' setting with value 'true' is not supported for versions of the Vyper compiler older than 0.3.1 or newer than 0.3.10. You are currently using version ${compilerVersion}.`
+        );
+      }
+
+      // The optimizer is enabled by default
+      return "";
+    } else {
+      if (semver.lt(compilerVersion, "0.3.1")) {
+        throw new VyperPluginError(
+          `The 'optimize' setting with value 'false' is not supported for versions of the Vyper compiler older than 0.3.1. You are currently using version ${compilerVersion}.`
+        );
+      }
+
+      return semver.lt(compilerVersion, "0.3.10")
+        ? "--no-optimize"
+        : "--optimize none";
+    }
+  }
+
+  if (typeof optimize === "string") {
+    if (semver.gte(compilerVersion, "0.3.10")) {
+      return `--optimize ${optimize}`;
+    }
+
+    throw new VyperPluginError(
+      `The 'optimize' setting, when specified as a string value, is available only starting from the Vyper compiler version 0.3.10. You are currently using version ${compilerVersion}.`
+    );
+  }
+
+  throw new VyperPluginError(
+    `The 'optimize' setting has an invalid type value. Type is: ${typeof optimize}.`
+  );
+}

packages/hardhat-vyper/src/index.ts

@@ -1,7 +1,7 @@
 import type { Artifacts as ArtifactsImpl } from "hardhat/internal/artifacts";
 import type { Artifacts } from "hardhat/types/artifacts";
 import type { VyperFilesCache as VyperFilesCacheT } from "./cache";
-import type { VyperOutput, VyperBuild } from "./types";
+import type { VyperOutput, VyperBuild, VyperSettings } from "./types";
 import type { ResolvedFile } from "./resolver";
 
 import * as os from "os";
@@ -188,13 +188,21 @@ subtask(TASK_COMPILE_VYPER_RUN_BINARY)
     async ({
       inputPaths,
       vyperPath,
+      vyperVersion,
+      settings,
     }: {
       inputPaths: string[];
       vyperPath: string;
+      vyperVersion?: string;
+      settings?: VyperSettings;
     }): Promise<VyperOutput> => {
       const compiler = new Compiler(vyperPath);
 
-      const { version, ...contracts } = await compiler.compile(inputPaths);
+      const { version, ...contracts } = await compiler.compile(
+        inputPaths,
+        vyperVersion,
+        settings
+      );
 
       return {
         version,
@@ -249,36 +257,53 @@ subtask(TASK_COMPILE_VYPER)
         ({ version }) => version
       );
 
-      const versionGroups: Record<string, ResolvedFile[]> = {};
+      const versionsToSettings = Object.fromEntries(
+        config.vyper.compilers.map(({ version, settings }) => [
+          version,
+          settings,
+        ])
+      );
+
+      const versionGroups: Record<
+        string,
+        { files: ResolvedFile[]; settings: VyperSettings }
+      > = {};
       const unmatchedFiles: ResolvedFile[] = [];
 
       for (const file of resolvedFiles) {
-        const hasChanged = vyperFilesCache.hasFileChanged(
-          file.absolutePath,
-          file.contentHash,
-          { version: file.content.versionPragma }
-        );
-
-        if (!hasChanged) continue;
-
         const maxSatisfyingVersion = semver.maxSatisfying(
           configuredVersions,
           file.content.versionPragma
         );
 
-        // check if there are files that don't match any configured compiler
-        // version
+        // check if there are files that don't match any configured compiler version
         if (maxSatisfyingVersion === null) {
           unmatchedFiles.push(file);
           continue;
         }
 
+        const settings = versionsToSettings[maxSatisfyingVersion] ?? {};
+
+        const hasChanged = vyperFilesCache.hasFileChanged(
+          file.absolutePath,
+          file.contentHash,
+          {
+            version: maxSatisfyingVersion,
+            settings,
+          }
+        );
+
+        if (!hasChanged) continue;
+
         if (versionGroups[maxSatisfyingVersion] === undefined) {
-          versionGroups[maxSatisfyingVersion] = [file];
+          versionGroups[maxSatisfyingVersion] = {
+            files: [file],
+            settings,
+          };
           continue;
         }
 
-        versionGroups[maxSatisfyingVersion].push(file);
+        versionGroups[maxSatisfyingVersion].files.push(file);
       }
 
       if (unmatchedFiles.length > 0) {
@@ -297,7 +322,9 @@ ${list}`
         );
       }
 
-      for (const [vyperVersion, files] of Object.entries(versionGroups)) {
+      for (const [vyperVersion, { files, settings }] of Object.entries(
+        versionGroups
+      )) {
         const vyperBuild: VyperBuild = await run(TASK_COMPILE_VYPER_GET_BUILD, {
           quiet,
           vyperVersion,
@@ -312,6 +339,8 @@ ${list}`
           {
             inputPaths: files.map(({ absolutePath }) => absolutePath),
             vyperPath: vyperBuild.compilerPath,
+            vyperVersion,
+            settings,
           }
         );
 
@@ -329,7 +358,10 @@ ${list}`
             lastModificationDate: file.lastModificationDate.valueOf(),
             contentHash: file.contentHash,
             sourceName: file.sourceName,
-            vyperConfig: { version },
+            vyperConfig: {
+              version,
+              settings,
+            },
             versionPragma: file.content.versionPragma,
             artifacts: [artifact.contractName],
           });

packages/hardhat-vyper/src/types.ts

@@ -1,7 +1,13 @@
 export type VyperUserConfig = string | VyperConfig | MultiVyperConfig;
 
+export interface VyperSettings {
+  evmVersion?: string;
+  optimize?: string | boolean;
+}
+
 export interface VyperConfig {
   version: string;
+  settings?: VyperSettings;
 }
 
 export interface MultiVyperConfig {

packages/hardhat-vyper/test/fixture-projects/.gitignore

@@ -1,2 +1,2 @@
-/*/cache
-/*/artifacts
+/**/cache
+/**/artifacts

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-invalid-type/contracts/A.vy

@@ -0,0 +1,5 @@
+# @version 0.3.9
+
+@external
+def test() -> int128:
+  return 42

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-invalid-type/hardhat.config.js

@@ -0,0 +1,15 @@
+require("../../../../src/index");
+
+module.exports = {
+  vyper: {
+    compilers: [
+      {
+        version: "0.3.9",
+        settings: {
+          evmVersion: "paris",
+          optimize: 12,
+        },
+      },
+    ],
+  },
+};

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-set-to-false-always-available-new-versions/contracts/A.vy

@@ -0,0 +1,5 @@
+# @version 0.3.10
+
+@external
+def test() -> int128:
+  return 42

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-set-to-false-always-available-new-versions/hardhat.config.js

@@ -0,0 +1,15 @@
+require("../../../../src/index");
+
+module.exports = {
+  vyper: {
+    compilers: [
+      {
+        version: "0.3.10",
+        settings: {
+          evmVersion: "paris",
+          optimize: false,
+        },
+      },
+    ],
+  },
+};

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-set-to-false-always-available-old-versions/contracts/A.vy

@@ -0,0 +1,5 @@
+# @version 0.3.9
+
+@external
+def test() -> int128:
+  return 42

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-set-to-false-always-available-old-versions/hardhat.config.js

@@ -0,0 +1,15 @@
+require("../../../../src/index");
+
+module.exports = {
+  vyper: {
+    compilers: [
+      {
+        version: "0.3.9",
+        settings: {
+          evmVersion: "paris",
+          optimize: false,
+        },
+      },
+    ],
+  },
+};

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-set-to-false-not-available-old-versions/contracts/A.vy

@@ -0,0 +1,5 @@
+# @version 0.3.0
+
+@external
+def test() -> int128:
+  return 42

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-set-to-false-not-available-old-versions/hardhat.config.js

@@ -0,0 +1,15 @@
+require("../../../../src/index");
+
+module.exports = {
+  vyper: {
+    compilers: [
+      {
+        version: "0.3.0",
+        settings: {
+          evmVersion: "istanbul",
+          optimize: false,
+        },
+      },
+    ],
+  },
+};

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-set-to-true/contracts/A.vy

@@ -0,0 +1,5 @@
+# @version 0.3.9
+
+@external
+def test() -> int128:
+  return 42

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-set-to-true/hardhat.config.js

@@ -0,0 +1,15 @@
+require("../../../../src/index");
+
+module.exports = {
+  vyper: {
+    compilers: [
+      {
+        version: "0.3.9",
+        settings: {
+          evmVersion: "paris",
+          optimize: true,
+        },
+      },
+    ],
+  },
+};

packages/hardhat-vyper/test/fixture-projects/compilation-with-settings-option-variants/optimize-string-not-available-old-versions/contracts/A.vy

@@ -0,0 +1,5 @@
+# @version 0.3.9
+
+@external
+def test() -> int128:
+  return 42