Bring back UI for execution

packages/core/package.json

@@ -53,7 +53,7 @@
     "@types/fs-extra": "^9.0.13",
     "@types/mocha": "9.1.1",
     "@types/ndjson": "2.0.1",
-    "@types/node": "12.20.25",
+    "@types/node": "^16.0.0",
     "@typescript-eslint/eslint-plugin": "4.31.2",
     "@typescript-eslint/parser": "4.31.2",
     "chai": "^4.3.4",

packages/core/src/index.ts

@@ -12,3 +12,4 @@ export * from "./new-api/types/module";
 export * from "./new-api/types/module-builder";
 export * from "./new-api/types/provider";
 export * from "./new-api/types/serialized-deployment";
+export * from "./new-api/types/execution-events";

packages/core/src/new-api/deploy.ts

@@ -18,6 +18,7 @@ import {
   DeploymentParameters,
   DeploymentResult,
 } from "./types/deployer";
+import { ExecutionEventListener } from "./types/execution-events";
 import { IgnitionModule } from "./types/module";
 import { EIP1193Provider } from "./types/provider";
 
@@ -30,21 +31,21 @@ export async function deploy({
   config = {},
   artifactResolver,
   provider,
+  executionEventListener,
   deploymentDir,
   ignitionModule,
   deploymentParameters,
   accounts,
-  verbose,
   defaultSender,
 }: {
   config?: Partial<DeployConfig>;
   artifactResolver: ArtifactResolver;
   provider: EIP1193Provider;
+  executionEventListener?: ExecutionEventListener;
   deploymentDir?: string;
   ignitionModule: IgnitionModule;
   deploymentParameters: DeploymentParameters;
   accounts: string[];
-  verbose: boolean;
   defaultSender?: string;
 }): Promise<DeploymentResult> {
   await validateStageOne(ignitionModule, artifactResolver);
@@ -61,8 +62,8 @@ export async function deploy({
 
   const deploymentLoader =
     deploymentDir === undefined
-      ? new EphemeralDeploymentLoader(artifactResolver, verbose)
-      : new FileDeploymentLoader(deploymentDir, verbose);
+      ? new EphemeralDeploymentLoader(artifactResolver, executionEventListener)
+      : new FileDeploymentLoader(deploymentDir, executionEventListener);
 
   const executionStrategy = new BasicExecutionStrategy((artifactId) =>
     deploymentLoader.loadArtifact(artifactId)
@@ -85,7 +86,8 @@ export async function deploy({
     executionStrategy,
     jsonRpcClient,
     artifactResolver,
-    deploymentLoader
+    deploymentLoader,
+    executionEventListener
   );
 
   return deployer.deploy(

packages/core/src/new-api/internal/deployer.ts

@@ -9,6 +9,10 @@ import {
   DeploymentResult,
   DeploymentResultContracts,
 } from "../types/deployer";
+import {
+  ExecutionEventListener,
+  ExecutionEventType,
+} from "../types/execution-events";
 
 import { Batcher } from "./batcher";
 import { DeploymentLoader } from "./deployment-loader/types";
@@ -44,7 +48,8 @@ export class Deployer {
     private readonly _executionStrategy: ExecutionStrategy,
     private readonly _jsonRpcClient: JsonRpcClient,
     private readonly _artifactResolver: ArtifactResolver,
-    private readonly _deploymentLoader: DeploymentLoader
+    private readonly _deploymentLoader: DeploymentLoader,
+    private readonly _executionEventListener?: ExecutionEventListener
   ) {
     assertIgnitionInvariant(
       this._config.requiredConfirmations >= 1,
@@ -111,11 +116,14 @@ export class Deployer {
 
     const batches = Batcher.batch(ignitionModule, deploymentState);
 
+    this._emitDeploymentBatchEvent(batches);
+
     const executionEngine = new ExecutionEngine(
       this._deploymentLoader,
       this._artifactResolver,
       this._executionStrategy,
       this._jsonRpcClient,
+      this._executionEventListener,
       this._config.requiredConfirmations,
       this._config.timeBeforeBumpingFees,
       this._config.maxFeeBumps,
@@ -180,6 +188,8 @@ export class Deployer {
     const deploymentState = await loadDeploymentState(this._deploymentLoader);
 
     if (deploymentState === undefined) {
+      this._emitDeploymentStartEvent();
+
       return initializeDeploymentState(chainId, this._deploymentLoader);
     }
 
@@ -190,4 +200,21 @@ export class Deployer {
 
     return deploymentState;
   }
+
+  private _emitDeploymentBatchEvent(batches: string[][]): void {
+    if (this._executionEventListener !== undefined) {
+      this._executionEventListener.BATCH_INITIALIZE({
+        type: ExecutionEventType.BATCH_INITIALIZE,
+        batches,
+      });
+    }
+  }
+
+  private _emitDeploymentStartEvent(): void {
+    if (this._executionEventListener !== undefined) {
+      this._executionEventListener.DEPLOYMENT_START({
+        type: ExecutionEventType.DEPLOYMENT_START,
+      });
+    }
+  }
 }

packages/core/src/new-api/internal/deployment-loader/ephemeral-deployment-loader.ts

@@ -1,4 +1,5 @@
 import { Artifact, ArtifactResolver, BuildInfo } from "../../types/artifact";
+import { ExecutionEventListener } from "../../types/execution-events";
 import { MemoryJournal } from "../journal/memory-journal";
 import { Journal } from "../journal/types";
 import { JournalMessage } from "../new-execution/types/messages";
@@ -23,9 +24,9 @@ export class EphemeralDeploymentLoader implements DeploymentLoader {
 
   constructor(
     private _artifactResolver: ArtifactResolver,
-    private _verbose: boolean
+    private _executionEventListener?: ExecutionEventListener
   ) {
-    this._journal = new MemoryJournal(this._verbose);
+    this._journal = new MemoryJournal(this._executionEventListener);
     this._deployedAddresses = {};
     this._savedArtifacts = {};
   }

packages/core/src/new-api/internal/deployment-loader/file-deployment-loader.ts

@@ -2,6 +2,7 @@ import { ensureDir, pathExists, readFile, writeFile } from "fs-extra";
 import path from "path";
 
 import { Artifact, BuildInfo } from "../../types/artifact";
+import { ExecutionEventListener } from "../../types/execution-events";
 import { FileJournal } from "../journal/file-journal";
 import { Journal } from "../journal/types";
 import { JournalMessage } from "../new-execution/types/messages";
@@ -22,7 +23,7 @@ export class FileDeploymentLoader implements DeploymentLoader {
 
   constructor(
     private readonly _deploymentDirPath: string,
-    private readonly _verbose: boolean
+    private readonly _executionEventListener?: ExecutionEventListener
   ) {
     const artifactsDir = path.join(this._deploymentDirPath, "artifacts");
     const buildInfoDir = path.join(this._deploymentDirPath, "build-info");
@@ -32,7 +33,7 @@ export class FileDeploymentLoader implements DeploymentLoader {
       "deployed_addresses.json"
     );
 
-    this._journal = new FileJournal(journalPath, this._verbose);
+    this._journal = new FileJournal(journalPath, this._executionEventListener);
 
     this._paths = {
       deploymentDir: this._deploymentDirPath,

packages/core/src/new-api/internal/journal/file-journal.ts

@@ -2,11 +2,12 @@
 import fs, { closeSync, constants, openSync, writeFileSync } from "fs";
 import { parse } from "ndjson";
 
+import { ExecutionEventListener } from "../../types/execution-events";
 import { JournalMessage } from "../new-execution/types/messages";
 
 import { Journal } from "./types";
 import { deserializeReplacer } from "./utils/deserialize-replacer";
-import { logJournalableMessage } from "./utils/log";
+import { emitExecutionEvent } from "./utils/emitExecutionEvent";
 import { serializeReplacer } from "./utils/serialize-replacer";
 
 /**
@@ -15,7 +16,10 @@ import { serializeReplacer } from "./utils/serialize-replacer";
  * @beta
  */
 export class FileJournal implements Journal {
-  constructor(private _filePath: string, private _verbose: boolean = false) {}
+  constructor(
+    private _filePath: string,
+    private _executionEventListener?: ExecutionEventListener
+  ) {}
 
   public record(message: JournalMessage): void {
     this._log(message);
@@ -60,8 +64,8 @@ export class FileJournal implements Journal {
   }
 
   private _log(message: JournalMessage): void {
-    if (this._verbose) {
-      return logJournalableMessage(message);
+    if (this._executionEventListener !== undefined) {
+      emitExecutionEvent(message, this._executionEventListener);
     }
   }
 }

packages/core/src/new-api/internal/journal/memory-journal.ts

@@ -1,7 +1,8 @@
+import { ExecutionEventListener } from "../../types/execution-events";
 import { JournalMessage } from "../new-execution/types/messages";
 
 import { Journal } from "./types";
-import { logJournalableMessage } from "./utils/log";
+import { emitExecutionEvent } from "./utils/emitExecutionEvent";
 
 /**
  * An in-memory journal.
@@ -11,7 +12,7 @@ import { logJournalableMessage } from "./utils/log";
 export class MemoryJournal implements Journal {
   private messages: JournalMessage[] = [];
 
-  constructor(private _verbose: boolean = false) {}
+  constructor(private _executionEventListener?: ExecutionEventListener) {}
 
   public record(message: JournalMessage): void {
     this._log(message);
@@ -26,8 +27,8 @@ export class MemoryJournal implements Journal {
   }
 
   private _log(message: JournalMessage): void {
-    if (this._verbose) {
-      return logJournalableMessage(message);
+    if (this._executionEventListener !== undefined) {
+      emitExecutionEvent(message, this._executionEventListener);
     }
   }
 }