feat: write hardhat style artifacts to disk (#38)

tynes · web-flow · commit b092fe5c8f38 · 2022-05-29T18:16:19.000-07:00
* feat: `ForgeArtifacts` can write to disk

Adds a function `writeArtifactsSync` that
accepts an output directory and will write
hardhat style artifacts to disk in that directory.

* feat: write hh style artifacts to disk on build

* test: add tests for writing artifacts to disk

* chore: add changeset
diff --git a/.changeset/strong-cheetahs-call.md b/.changeset/strong-cheetahs-call.md
@@ -0,0 +1,5 @@
+---
+"@foundry-rs/hardhat-forge": patch
+---
+
+Write hh style artifacts to disk
diff --git a/packages/hardhat-forge/src/forge/artifacts.ts b/packages/hardhat-forge/src/forge/artifacts.ts
@@ -28,7 +28,12 @@ import {
 import { ForgeArtifact } from "./types";
 
 export class ForgeArtifacts implements IArtifacts {
-  constructor(private _out: string, private _cache: string) {}
+  constructor(
+    private _root: string,
+    private _sources: string,
+    private _out: string,
+    private _cache: string
+  ) {}
 
   public async readArtifact(name: string): Promise<Artifact> {
     const artifactPath = await this._getArtifactPath(name);
@@ -473,6 +478,32 @@ Please replace "${contractName}" for the correct contract name wherever you are
 
     return undefined;
   }
+
+  /**
+   * Given the path to a directory, hardhat style artifacts will
+   * be written to disk
+   */
+  public writeArtifactsSync(outDir: string) {
+    const paths = this._getArtifactPathsSync();
+    const artifacts = path.relative(this._root, outDir);
+
+    for (const filepath of paths) {
+      const forgeArtifact = fsExtra.readJsonSync(filepath) as ForgeArtifact;
+      const artifact = this.readArtifactSync(path.parse(filepath).name);
+
+      const contractPath = forgeArtifact.ast?.absolutePath;
+      if (!contractPath) {
+        throw new Error(
+          `Must compile with ast to build harhat style artifacts`
+        );
+      }
+
+      const dir = path.join(this._root, artifacts, contractPath);
+      const out = path.join(dir, path.basename(filepath));
+      fsExtra.mkdirpSync(path.dirname(out));
+      fsExtra.writeJsonSync(out, artifact, { spaces: 2 });
+    }
+  }
 }
 
 /**
diff --git a/packages/hardhat-forge/src/index.ts b/packages/hardhat-forge/src/index.ts
@@ -20,6 +20,15 @@ extendEnvironment((hre) => {
       config.cache_path ?? "cache",
       SOLIDITY_FILES_CACHE_FILENAME
     );
-    return new ForgeArtifacts(outDir, cacheDir);
+
+    const artifacts = new ForgeArtifacts(
+      hre.config.paths.root,
+      config.src,
+      outDir,
+      cacheDir
+    );
+
+    artifacts.writeArtifactsSync(hre.config.paths.artifacts);
+    return artifacts;
   });
 });
diff --git a/packages/hardhat-forge/test/fixture-projects/hardhat-project/src/foo/Contract2.sol b/packages/hardhat-forge/test/fixture-projects/hardhat-project/src/foo/Contract2.sol
@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+contract FooBar {
+
+  function example() public {}
+
+}
diff --git a/packages/hardhat-forge/test/helpers.ts b/packages/hardhat-forge/test/helpers.ts
@@ -1,5 +1,7 @@
 import { resetHardhatContext } from "hardhat/plugins-testing";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
+import fsExtra from "fs-extra";
+
 import path from "path";
 
 declare module "mocha" {
@@ -19,3 +21,17 @@ export function useEnvironment(fixtureProjectName: string) {
     resetHardhatContext();
   });
 }
+
+export async function getAllFiles(directory: string, files: string[] = []) {
+  const current = await fsExtra.readdir(directory);
+  for (const file of current) {
+    const next = path.join(directory, file);
+    const info = await fsExtra.stat(next);
+    if (info.isDirectory()) {
+      files = await getAllFiles(next, files);
+    } else {
+      files.push(next);
+    }
+  }
+  return files;
+}
diff --git a/packages/hardhat-forge/test/project.test.ts b/packages/hardhat-forge/test/project.test.ts
@@ -1,5 +1,6 @@
 import { assert } from "chai";
-import { useEnvironment } from "./helpers";
+import path from "path";
+import { useEnvironment, getAllFiles } from "./helpers";
 
 describe("Integration tests", function () {
   this.timeout(300000);
@@ -34,5 +35,18 @@ describe("Integration tests", function () {
       assert.exists(contract.contractName);
       assert.exists(contract.sourceName);
     });
+
+    it("Should write artifacts to disk", async function () {
+      const artifacts = await this.hre.artifacts.getArtifactPaths();
+      const files = await getAllFiles(this.hre.config.paths.artifacts);
+      assert.equal(artifacts.length, files.length);
+
+      for (const file of files) {
+        const name = path.basename(file);
+        assert(artifacts.map((a) => path.basename(a)).includes(name));
+        const artifact = require(file);
+        assert.equal(artifact.contractName, path.basename(name, ".json"));
+      }
+    });
   });
 });

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@foundry-rs/hardhat-forge": patch
 +---
++
 +Write hh style artifacts to disk