feat(ir): Import Graph (nowarp#180)

* feat(idx): Generate unique idx for each element

* chore(cli): Refactor

* fix(dumpCfg): Options description

* feat(imports): Initial version of imports graph

Closes nowarp#60

* fix(changelog)

* chore(changelog): Update

* chore: Update expected outputs of `tactIR.spec.t`

* feat(imports): Improve stdlib handling

* fix(warnings): Path in warnings for multi-contracts configs

* feat(dumpImports): Improve coloring

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- `SendInLoop` detector: PR [#168](https://github.com/nowarp/misti/pulls/168)
+- `CellOverflow` detector: PR [#177](https://github.com/nowarp/misti/pulls/177)
+- Import Graph: PR [#180](https://github.com/nowarp/misti/pulls/180)
+
 ## [0.4.2] - 2024-10-12
 
 ### Fixed
@@ -22,10 +27,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.4.0] - 2024-10-08
 
-### Added
-- `SendInLoop` detector: PR [#168](https://github.com/nowarp/misti/pulls/168)
-- `CellOverflow` detector: PR [#177](https://github.com/nowarp/misti/pulls/177)
-
 ### Added
 - `OptimalMathFunction` detector: Issue [#146](https://github.com/nowarp/misti/issues/146)
 - `DuplicatedCondition` detector: Issue [#147](https://github.com/nowarp/misti/issues/147)

src/cli/driver.ts

@@ -1,4 +1,5 @@
 import { CLIOptions, cliOptionDefaults } from "./options";
+import { MistiTactPath } from "./path";
 import {
   MistiResult,
   ToolOutput,
@@ -41,22 +42,31 @@ export class Driver {
   singleContractProjectManager: SingleContractProjectManager | undefined;
 
   private constructor(tactPath: string | undefined, options: CLIOptions) {
+    let mistiTactPath: MistiTactPath | undefined;
     if (tactPath) {
       const singleContract = tactPath.endsWith(".tact");
       if (!fs.existsSync(tactPath)) {
         throw ExecutionException.make(
           `${singleContract ? "Contract" : "Project"} ${tactPath} is not available.`,
         );
       }
-      this.tactConfigPath = singleContract
-        ? (() => {
-            this.singleContractProjectManager =
-              SingleContractProjectManager.fromContractPath(tactPath);
-            return this.singleContractProjectManager.createTempProjectDir();
-          })()
-        : path.resolve(tactPath); // Tact supports absolute paths only
+      if (singleContract) {
+        this.singleContractProjectManager =
+          SingleContractProjectManager.fromContractPath(tactPath);
+        this.tactConfigPath =
+          this.singleContractProjectManager.createTempProjectDir();
+        mistiTactPath = {
+          kind: "contract",
+          tempConfigPath: path.resolve(this.tactConfigPath),
+          originalPath: path.resolve(tactPath),
+        };
+      } else {
+        // Tact supports absolute paths only
+        this.tactConfigPath = path.resolve(tactPath);
+        mistiTactPath = { kind: "config", path: path.resolve(tactPath) };
+      }
     }
-    this.ctx = new MistiContext(tactPath, options);
+    this.ctx = new MistiContext(mistiTactPath, options);
     this.disabledDetectors = new Set(options.disabledDetectors ?? []);
     this.colorizeOutput = options.colors;
     this.minSeverity = options.minSeverity;

src/cli/index.ts

@@ -2,4 +2,5 @@ export * from "./driver";
 export * from "./result";
 export * from "./types";
 export * from "./options";
+export * from "./path";
 export * from "./cli";

src/cli/options.ts

@@ -62,7 +62,10 @@ export const cliOptions = [
     .default(cliOptionDefaults.tools),
   new Option(
     "--output-path <PATH>",
-    "Directory to save warnings or output generated by tools. If <PATH> is '-', then stdout is used.",
+    [
+      "Directory to save warnings or output generated by tools.",
+      `If <PATH> is ${STDOUT_PATH}, then stdout is used.`,
+    ].join(" "),
   ).default(cliOptionDefaults.outputPath),
   new Option("--list-tools", "List available tools and their options.").default(
     cliOptionDefaults.listTools,

src/cli/path.ts

@@ -0,0 +1,60 @@
+import { unreachable } from "../internals/util";
+import path from "path";
+
+/**
+ * Path to a Tact contract or configuration provided by the user.
+ */
+export type MistiTactPath =
+  | {
+      kind: "config";
+      /**
+       * Absolute path to the tact.config.json.
+       */
+      path: string;
+    }
+  | {
+      kind: "contract";
+      /**
+       * A path to a temporary configuration file generated internally in Misti (absolute).
+       */
+      tempConfigPath: string;
+      /**
+       * A path to the contract as it was specified by the user (absolute).
+       */
+      originalPath: string;
+    };
+
+/**
+ * Returns path to a contract or configuration file as it is provided by the user.
+ */
+export function getOriginalPath(path: MistiTactPath): string {
+  switch (path.kind) {
+    case "config":
+      return path.path;
+    case "contract":
+      return path.originalPath;
+    default:
+      unreachable(path);
+  }
+}
+
+/**
+ * Returns an actual path to a configuration file used in Misti.
+ */
+export function getActualPath(path: MistiTactPath): string {
+  switch (path.kind) {
+    case "config":
+      return path.path;
+    case "contract":
+      return path.tempConfigPath;
+    default:
+      unreachable(path);
+  }
+}
+
+/**
+ * Returns an absolute path to an actual project directory used by Misti.
+ */
+export function getProjectDirectory(tactPath: MistiTactPath): string {
+  return path.dirname(getActualPath(tactPath));
+}

src/internals/context.ts

@@ -2,29 +2,36 @@ import { MistiConfig } from "./config";
 import { DebugLogger, Logger, QuietLogger, TraceLogger } from "./logger";
 import { CLIOptions, cliOptionDefaults } from "../cli";
 import { throwZodError } from "./exceptions";
+import { TactConfigManager } from "./tact/config";
+import { MistiTactPath, getActualPath, getProjectDirectory } from "../cli/path";
 import { execSync } from "child_process";
+import path from "path";
 
 /**
  * Represents the context for a Misti run.
  */
 export class MistiContext {
   logger: Logger;
   config: MistiConfig;
-  /** Indicates whether a Souffle binary is available. */
+
+  /**
+   * Indicates whether a Souffle binary is available.
+   */
   readonly souffleAvailable: boolean;
-  /** Path to a single Tact contract if executed without project config. */
-  readonly singleContractPath: string | undefined;
+
+  /**
+   * Path to the Tact contract/configuration provided by the user.
+   */
+  readonly tactPath: MistiTactPath | undefined;
 
   /**
    * Initializes the context for Misti, setting up configuration and appropriate logger.
    */
   constructor(
-    tactPath: string | undefined,
+    tactPath: MistiTactPath | undefined,
     options: CLIOptions = cliOptionDefaults,
   ) {
-    this.singleContractPath = tactPath?.endsWith(".tact")
-      ? tactPath
-      : undefined;
+    this.tactPath = tactPath;
     this.souffleAvailable = this.checkSouffleInstallation(
       options.souffleBinary,
     );
@@ -77,4 +84,21 @@ export class MistiContext {
       return false;
     }
   }
+
+  /**
+   * Returns entry points taking into account the user's configuration.
+   *
+   * @returns Absolute paths to entrypoint files.
+   */
+  public getEntryPoints(): string[] {
+    if (this.tactPath === undefined) {
+      return [];
+    }
+    const configPath = getActualPath(this.tactPath);
+    const projectDir = getProjectDirectory(this.tactPath);
+    const configManager = new TactConfigManager(this, configPath);
+    return configManager.config.projects.map((project) =>
+      path.resolve(projectDir, project.path),
+    );
+  }
 }

src/internals/ir/builders/astStore.ts

@@ -1,6 +1,6 @@
 import { TactASTStore } from "..";
-import { definedInStdlib } from "./tactStdlib";
 import { MistiContext } from "../../context";
+import { definedInStdlib } from "../../tact/stdlib";
 import { unreachable } from "../../util";
 import {
   AstAsmFunctionDef,