hardhat/src/types/solidity/compilation-job.ts

Hardhat is an extensible developer tool that helps smart contract developers increase productivity by reliably bringing together the tools they want.

import type { CompilerInput } from "./compiler-io.js";
import type { DependencyGraph } from "./dependency-graph.js";
import type { SolcConfig } from "../config.js";

/**
 * A compilation job to be run using solc.
 */
export interface CompilationJob {
  /**
   * The dependency graph of the compilation job, whose root files' artifacts
   * will be emitted.
   */
  dependencyGraph: DependencyGraph;

  /**
   * The solc config to use.
   */
  solcConfig: SolcConfig;

  /**
   * The long version of the solc compiler to be used.
   */
  solcLongVersion: string;

  /**
   * Returns the solc input to be used.
   */
  getSolcInput(): Promise<CompilerInput>;

  /**
   * Returns the build id of the compilation job.
   *
   * The id is guaranteed to be deterministically generated based on the solc
   * input that this compilation job would generate, the solc long version,
   * and the current solidity build info format that Hardhat uses.
   *
   * While deterministic, it shouldn't be expected to be stable across different
   * versions of Hardhat.
   */
  getBuildId(): Promise<string>;
}