hardhat 2.13.0-dev.2 → 2.13.0-dev.3

package/src/internal/artifacts/index.ts

@@ -1,302 +0,0 @@
-import * as os from "os";
-import path from "path";
-
-import {
-  Artifact,
-  Artifacts as IArtifacts,
-  ArtifactsSource,
-  BuildInfo,
-  CompilerInput,
-  CompilerOutput,
-} from "../../types";
-import { parseFullyQualifiedName } from "../../utils/contract-names";
-
-import { ARTIFACT_FORMAT_VERSION } from "../constants";
-import { HardhatError } from "../core/errors";
-import { ERRORS } from "../core/errors-list";
-
-import { CachingSource } from "./caching";
-
-export class Artifacts implements IArtifacts {
-  private readonly _hardhatSource: CachingSource;
-
-  constructor(
-    private readonly _artifactsPath: string,
-    private readonly _extensionSources: ArtifactsSource[] = []
-  ) {
-    this._hardhatSource = new CachingSource(this._artifactsPath);
-  }
-
-  public async readArtifact(
-    contractNameOrFullyQualifiedName: string
-  ): Promise<Artifact> {
-    let artifact: Artifact | undefined = await this._hardhatSource.readArtifact(
-      contractNameOrFullyQualifiedName
-    );
-
-    if (artifact === undefined) {
-      const artifacts: Array<Artifact | undefined> = await Promise.all(
-        this._extensionSources.map((source) =>
-          source.readArtifact(contractNameOrFullyQualifiedName)
-        )
-      );
-
-      artifact = artifacts.find((_artifact) => _artifact !== undefined);
-    }
-
-    if (artifact === undefined) {
-      this._throwNotFound(contractNameOrFullyQualifiedName);
-    }
-
-    return artifact;
-  }
-
-  public readArtifactSync(contractNameOrFullyQualifiedName: string): Artifact {
-    let artifact: Artifact | undefined = this._hardhatSource.readArtifactSync(
-      contractNameOrFullyQualifiedName
-    );
-
-    if (artifact === undefined) {
-      for (const source of this._extensionSources) {
-        artifact = source.readArtifactSync(contractNameOrFullyQualifiedName);
-        if (artifact !== undefined) {
-          break;
-        }
-      }
-    }
-
-    if (artifact === undefined) {
-      this._throwNotFound(contractNameOrFullyQualifiedName);
-    }
-
-    return artifact;
-  }
-
-  public async artifactExists(
-    contractNameOrFullyQualifiedName: string
-  ): Promise<boolean> {
-    const existencesPerSource = await Promise.all(
-      [this._hardhatSource, ...this._extensionSources].map((source) =>
-        source.artifactExists(contractNameOrFullyQualifiedName)
-      )
-    );
-    return existencesPerSource.includes(true);
-  }
-
-  public async getAllFullyQualifiedNames(): Promise<string[]> {
-    return (
-      await Promise.all(
-        [this._hardhatSource, ...this._extensionSources].map((s) =>
-          s.getAllFullyQualifiedNames()
-        )
-      )
-    ).flat();
-  }
-
-  public async getBuildInfo(
-    fullyQualifiedName: string
-  ): Promise<BuildInfo | undefined> {
-    let buildInfo = await this._hardhatSource.getBuildInfo(fullyQualifiedName);
-
-    if (buildInfo === undefined) {
-      const buildInfos: Array<BuildInfo | undefined> = await Promise.all(
-        this._extensionSources.map((source) =>
-          source.getBuildInfo(fullyQualifiedName)
-        )
-      );
-      buildInfo = buildInfos.find((info) => info !== undefined);
-    }
-
-    return buildInfo;
-  }
-
-  public getBuildInfoSync(fullyQualifiedName: string): BuildInfo | undefined {
-    let buildInfo = this._hardhatSource.getBuildInfoSync(fullyQualifiedName);
-
-    if (buildInfo === undefined) {
-      const buildInfos: Array<BuildInfo | undefined> =
-        this._extensionSources.map((source) =>
-          source.getBuildInfoSync(fullyQualifiedName)
-        );
-
-      buildInfo = buildInfos.find((info) => info !== undefined);
-    }
-
-    return buildInfo;
-  }
-
-  public async getArtifactPaths(): Promise<string[]> {
-    return (
-      await Promise.all(
-        [this._hardhatSource, ...this._extensionSources].map((s) =>
-          s.getArtifactPaths()
-        )
-      )
-    ).flat();
-  }
-
-  public async getDebugFilePaths(): Promise<string[]> {
-    return (
-      await Promise.all(
-        [this._hardhatSource, ...this._extensionSources].map((s) =>
-          s.getDebugFilePaths()
-        )
-      )
-    ).flat();
-  }
-
-  public async getBuildInfoPaths(): Promise<string[]> {
-    return (
-      await Promise.all(
-        [this._hardhatSource, ...this._extensionSources].map((s) =>
-          s.getBuildInfoPaths()
-        )
-      )
-    ).flat();
-  }
-
-  public clearCache(): void {
-    for (const source of [this._hardhatSource, ...this._extensionSources]) {
-      source.clearCache();
-    }
-  }
-
-  public disableCache(): void {
-    for (const source of [this._hardhatSource, ...this._extensionSources]) {
-      source.disableCache();
-    }
-  }
-
-  public saveArtifactAndDebugFile(
-    artifact: Artifact,
-    pathToBuildInfo?: string
-  ): Promise<void> {
-    return this._hardhatSource.saveArtifactAndDebugFile(
-      artifact,
-      pathToBuildInfo
-    );
-  }
-
-  public saveBuildInfo(
-    solcVersion: string,
-    solcLongVersion: string,
-    input: CompilerInput,
-    output: CompilerOutput
-  ): Promise<string> {
-    return this._hardhatSource.saveBuildInfo(
-      solcVersion,
-      solcLongVersion,
-      input,
-      output
-    );
-  }
-
-  public formArtifactPathFromFullyQualifiedName(
-    fullyQualifiedName: string
-  ): string {
-    return this._hardhatSource.formArtifactPathFromFullyQualifiedName(
-      fullyQualifiedName
-    );
-  }
-
-  public addValidArtifacts(
-    validArtifacts: Array<{ sourceName: string; artifacts: string[] }>
-  ) {
-    this._hardhatSource.addValidArtifacts(validArtifacts);
-  }
-
-  public async removeObsoleteArtifacts() {
-    return this._hardhatSource.removeObsoleteArtifacts();
-  }
-
-  private _throwNotFound(contractNameOrFullyQualifiedName: string): never {
-    const suggestions = this._hardhatSource.getSuggestions(
-      contractNameOrFullyQualifiedName
-    );
-
-    const uniqueSuggestions = [...new Set(suggestions)].sort();
-
-    const suggestion = this._formatSuggestions(
-      uniqueSuggestions,
-      contractNameOrFullyQualifiedName
-    );
-
-    throw new HardhatError(ERRORS.ARTIFACTS.NOT_FOUND, {
-      contractName: contractNameOrFullyQualifiedName,
-      suggestion,
-    });
-  }
-
-  private _formatSuggestions(names: string[], contractName: string): string {
-    switch (names.length) {
-      case 0:
-        return "";
-      case 1:
-        return `Did you mean "${names[0]}"?`;
-      default:
-        return `We found some that were similar:
-
-${names.map((n) => `  * ${n}`).join(os.EOL)}
-
-Please replace "${contractName}" for the correct contract name wherever you are trying to read its artifact.
-`;
-    }
-  }
-
-  /**
-   * DO NOT DELETE OR CHANGE
-   *
-   * use this.formArtifactPathFromFullyQualifiedName instead
-   * @deprecated until typechain migrates to public version
-   * @see https://github.com/dethcrypto/TypeChain/issues/544
-   */
-  private _getArtifactPathFromFullyQualifiedName(
-    fullyQualifiedName: string
-  ): string {
-    const { sourceName, contractName } =
-      parseFullyQualifiedName(fullyQualifiedName);
-
-    return path.join(this._artifactsPath, sourceName, `${contractName}.json`);
-  }
-}
-
-/**
- * Retrieves an artifact for the given `contractName` from the compilation output.
- *
- * @param sourceName The contract's source name.
- * @param contractName the contract's name.
- * @param contractOutput the contract's compilation output as emitted by `solc`.
- */
-export function getArtifactFromContractOutput(
-  sourceName: string,
-  contractName: string,
-  contractOutput: any
-): Artifact {
-  const evmBytecode = contractOutput.evm?.bytecode;
-  let bytecode: string = evmBytecode?.object ?? "";
-
-  if (bytecode.slice(0, 2).toLowerCase() !== "0x") {
-    bytecode = `0x${bytecode}`;
-  }
-
-  const evmDeployedBytecode = contractOutput.evm?.deployedBytecode;
-  let deployedBytecode: string = evmDeployedBytecode?.object ?? "";
-
-  if (deployedBytecode.slice(0, 2).toLowerCase() !== "0x") {
-    deployedBytecode = `0x${deployedBytecode}`;
-  }
-
-  const linkReferences = evmBytecode?.linkReferences ?? {};
-  const deployedLinkReferences = evmDeployedBytecode?.linkReferences ?? {};
-
-  return {
-    _format: ARTIFACT_FORMAT_VERSION,
-    contractName,
-    sourceName,
-    abi: contractOutput.abi,
-    bytecode,
-    deployedBytecode,
-    linkReferences,
-    deployedLinkReferences,
-  };
-}

package/src/internal/artifacts/mutable.ts

@@ -1,330 +0,0 @@
-import debug from "debug";
-import * as path from "path";
-import fsPromises from "fs/promises";
-
-import fsExtra from "fs-extra";
-
-import { getFullyQualifiedName } from "../../utils/contract-names";
-import { createNonCryptographicHashBasedIdentifier } from "../util/hash";
-import {
-  Artifact,
-  BuildInfo,
-  CompilerInput,
-  CompilerOutput,
-  DebugFile,
-} from "../../types";
-import {
-  BUILD_INFO_DIR_NAME,
-  BUILD_INFO_FORMAT_VERSION,
-  DEBUG_FILE_FORMAT_VERSION,
-} from "../constants";
-import { ReadOnlySource } from "./readonly";
-
-const log = debug("hardhat:core:artifacts");
-
-export class MutableSource extends ReadOnlySource {
-  private _validArtifacts: Array<{ sourceName: string; artifacts: string[] }>;
-
-  constructor(artifactsPath: string) {
-    super(artifactsPath);
-    this._validArtifacts = [];
-  }
-
-  public addValidArtifacts(
-    validArtifacts: Array<{ sourceName: string; artifacts: string[] }>
-  ) {
-    this._validArtifacts.push(...validArtifacts);
-  }
-
-  /**
-   * Remove all artifacts that don't correspond to the current solidity files
-   */
-  public async removeObsoleteArtifacts() {
-    const validArtifactPaths = await Promise.all(
-      this._validArtifacts.flatMap(({ sourceName, artifacts }) =>
-        artifacts.map((artifactName) =>
-          this._getArtifactPath(getFullyQualifiedName(sourceName, artifactName))
-        )
-      )
-    );
-
-    const validArtifactPathsWithoutUndefined = validArtifactPaths.filter(
-      (artifactPath): artifactPath is string => artifactPath !== undefined
-    );
-
-    const validArtifactsPathsSet = new Set<string>(
-      validArtifactPathsWithoutUndefined
-    );
-
-    for (const { sourceName, artifacts } of this._validArtifacts) {
-      for (const artifactName of artifacts) {
-        validArtifactsPathsSet.add(
-          this.formArtifactPathFromFullyQualifiedName(
-            getFullyQualifiedName(sourceName, artifactName)
-          )
-        );
-      }
-    }
-
-    const existingArtifactsPaths = await this.getArtifactPaths();
-
-    await Promise.all(
-      existingArtifactsPaths
-        .filter((artifactPath) => !validArtifactsPathsSet.has(artifactPath))
-        .map((artifactPath) => this._removeArtifactFiles(artifactPath))
-    );
-
-    await this._removeObsoleteBuildInfos();
-  }
-
-  public async saveArtifactAndDebugFile(
-    artifact: Artifact,
-    pathToBuildInfo?: string
-  ) {
-    // artifact
-    const fullyQualifiedName = getFullyQualifiedName(
-      artifact.sourceName,
-      artifact.contractName
-    );
-
-    const artifactPath =
-      this.formArtifactPathFromFullyQualifiedName(fullyQualifiedName);
-
-    await fsExtra.ensureDir(path.dirname(artifactPath));
-
-    await Promise.all([
-      fsExtra.writeJSON(artifactPath, artifact, {
-        spaces: 2,
-      }),
-      (async () => {
-        if (pathToBuildInfo === undefined) {
-          return;
-        }
-
-        // save debug file
-        const debugFilePath = this._getDebugFilePath(artifactPath);
-        const debugFile = this._createDebugFile(artifactPath, pathToBuildInfo);
-
-        await fsExtra.writeJSON(debugFilePath, debugFile, {
-          spaces: 2,
-        });
-      })(),
-    ]);
-  }
-
-  public async saveBuildInfo(
-    solcVersion: string,
-    solcLongVersion: string,
-    input: CompilerInput,
-    output: CompilerOutput
-  ): Promise<string> {
-    const buildInfoDir = path.join(this._artifactsPath, BUILD_INFO_DIR_NAME);
-    await fsExtra.ensureDir(buildInfoDir);
-
-    const buildInfoName = MutableSource._getBuildInfoName(
-      solcVersion,
-      solcLongVersion,
-      input
-    );
-
-    const buildInfo = MutableSource._createBuildInfo(
-      buildInfoName,
-      solcVersion,
-      solcLongVersion,
-      input,
-      output
-    );
-
-    const buildInfoPath = path.join(buildInfoDir, `${buildInfoName}.json`);
-
-    // JSON.stringify of the entire build info can be really slow
-    // in larger projects, so we stringify per part and incrementally create
-    // the JSON in the file.
-    //
-    // We split this code into different curly-brace-enclosed scopes so that
-    // partial JSON strings get out of scope sooner and hence can be reclaimed
-    // by the GC if needed.
-    const file = await fsPromises.open(buildInfoPath, "w");
-    try {
-      {
-        const withoutOutput = JSON.stringify({
-          ...buildInfo,
-          output: undefined,
-        });
-
-        // We write the JSON (without output) except the last }
-        await file.write(withoutOutput.slice(0, -1));
-      }
-
-      {
-        const outputWithoutSourcesAndContracts = JSON.stringify({
-          ...buildInfo.output,
-          sources: undefined,
-          contracts: undefined,
-        });
-
-        // We start writing the output
-        await file.write(',"output":');
-
-        // Write the output object except for the last }
-        await file.write(outputWithoutSourcesAndContracts.slice(0, -1));
-
-        // If there were other field apart from sources and contracts we need
-        // a comma
-        if (outputWithoutSourcesAndContracts.length > 2) {
-          await file.write(",");
-        }
-      }
-
-      // Writing the sources
-      await file.write('"sources":{');
-
-      let isFirst = true;
-      for (const [name, value] of Object.entries(
-        buildInfo.output.sources ?? {}
-      )) {
-        if (isFirst) {
-          isFirst = false;
-        } else {
-          await file.write(",");
-        }
-
-        await file.write(`${JSON.stringify(name)}:${JSON.stringify(value)}`);
-      }
-
-      // Close sources object
-      await file.write("}");
-
-      // Writing the contracts
-      await file.write(',"contracts":{');
-
-      isFirst = true;
-      for (const [name, value] of Object.entries(
-        buildInfo.output.contracts ?? {}
-      )) {
-        if (isFirst) {
-          isFirst = false;
-        } else {
-          await file.write(",");
-        }
-
-        await file.write(`${JSON.stringify(name)}:${JSON.stringify(value)}`);
-      }
-
-      // close contracts object
-      await file.write("}");
-      // close output object
-      await file.write("}");
-      // close build info object
-      await file.write("}");
-    } finally {
-      await file.close();
-    }
-
-    return buildInfoPath;
-  }
-
-  private static _createBuildInfo(
-    id: string,
-    solcVersion: string,
-    solcLongVersion: string,
-    input: CompilerInput,
-    output: CompilerOutput
-  ): BuildInfo {
-    return {
-      id,
-      _format: BUILD_INFO_FORMAT_VERSION,
-      solcVersion,
-      solcLongVersion,
-      input,
-      output,
-    };
-  }
-
-  private _createDebugFile(artifactPath: string, pathToBuildInfo: string) {
-    const relativePathToBuildInfo = path.relative(
-      path.dirname(artifactPath),
-      pathToBuildInfo
-    );
-
-    const debugFile: DebugFile = {
-      _format: DEBUG_FILE_FORMAT_VERSION,
-      buildInfo: relativePathToBuildInfo,
-    };
-
-    return debugFile;
-  }
-
-  private static _getBuildInfoName(
-    solcVersion: string,
-    solcLongVersion: string,
-    input: CompilerInput
-  ): string {
-    const json = JSON.stringify({
-      _format: BUILD_INFO_FORMAT_VERSION,
-      solcVersion,
-      solcLongVersion,
-      input,
-    });
-
-    return createNonCryptographicHashBasedIdentifier(
-      Buffer.from(json)
-    ).toString("hex");
-  }
-
-  /**
-   * Remove the artifact file, its debug file and, if it exists, its build
-   * info file.
-   */
-  private async _removeArtifactFiles(artifactPath: string) {
-    await fsExtra.remove(artifactPath);
-
-    const debugFilePath = this._getDebugFilePath(artifactPath);
-    const buildInfoPath = await ReadOnlySource._getBuildInfoFromDebugFile(
-      debugFilePath
-    );
-
-    await fsExtra.remove(debugFilePath);
-
-    if (buildInfoPath !== undefined) {
-      await fsExtra.remove(buildInfoPath);
-    }
-  }
-
-  /**
-   * Remove all build infos that aren't used by any debug file
-   */
-  private async _removeObsoleteBuildInfos() {
-    const debugFiles = await this.getDebugFilePaths();
-
-    const buildInfos = await Promise.all(
-      debugFiles.map(async (debugFile) => {
-        const buildInfoFile = await ReadOnlySource._getBuildInfoFromDebugFile(
-          debugFile
-        );
-        if (buildInfoFile !== undefined) {
-          return path.resolve(path.dirname(debugFile), buildInfoFile);
-        } else {
-          return undefined;
-        }
-      })
-    );
-
-    const filteredBuildInfos: string[] = buildInfos.filter(
-      (bf): bf is string => typeof bf === "string"
-    );
-
-    const validBuildInfos = new Set<string>(filteredBuildInfos);
-
-    const buildInfoFiles = await this.getBuildInfoPaths();
-
-    await Promise.all(
-      buildInfoFiles
-        .filter((buildInfoFile) => !validBuildInfos.has(buildInfoFile))
-        .map(async (buildInfoFile) => {
-          log(`Removing buildInfo '${buildInfoFile}'`);
-          await fsExtra.unlink(buildInfoFile);
-        })
-    );
-  }
-}