Merge pull request #7006 from NomicFoundation/ignition/bytecode-reconciliation

skip bytecode reconciliation for successfully deployed contract futures

Author: kanej

.changeset/fluffy-kangaroos-play.md

@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/ignition-core": patch
+---
+
+Allow Ignition reconciliation of changed bytecode when the contract has been successfully deployed ([#7006](https://github.com/NomicFoundation/hardhat/pull/7006))

v-next/hardhat-ignition-core/src/internal/reconciliation/helpers/reconcile-artifacts.ts

@@ -6,15 +6,16 @@ import type {
   NamedArtifactContractDeploymentFuture,
   NamedArtifactLibraryDeploymentFuture,
 } from "../../../types/module.js";
-import type {
-  ContractAtExecutionState,
-  DeploymentExecutionState,
-} from "../../execution/types/execution-state.js";
 import type {
   ReconciliationContext,
   ReconciliationFutureResultFailure,
 } from "../types.js";
 
+import {
+  ExecutionStatus,
+  type ContractAtExecutionState,
+  type DeploymentExecutionState,
+} from "../../execution/types/execution-state.js";
 import { fail, getBytecodeWithoutMetadata } from "../utils.js";
 
 export async function reconcileArtifacts(
@@ -28,6 +29,10 @@ export async function reconcileArtifacts(
   exState: DeploymentExecutionState | ContractAtExecutionState,
   context: ReconciliationContext,
 ): Promise<ReconciliationFutureResultFailure | undefined> {
+  if (exState.status === ExecutionStatus.SUCCESS) {
+    return;
+  }
+
   const moduleArtifact =
     "artifact" in future
       ? future.artifact

v-next/hardhat-ignition-core/test/reconciliation/futures/reconcileArtifactContractDeployment.ts

@@ -10,6 +10,7 @@ import {
 import { FutureType } from "../../../src/types/module.js";
 import { exampleAccounts } from "../../helpers.js";
 import {
+  ArtifactMapDeploymentLoader,
   assertSuccessReconciliation,
   createDeploymentState,
   mockArtifact,
@@ -360,4 +361,43 @@ describe("Reconciliation - artifact contract", () => {
       },
     ]);
   });
+
+  it("should find changes to a future's artifact bytecode reconciliable if the contract was successfully deployed", async () => {
+    const moduleDefinition = buildModule("Module", (m) => {
+      const contract1 = m.contract("Contract1", mockArtifact, [], {
+        id: "Example",
+      });
+
+      return { contract1 };
+    });
+
+    const reconiliationResult = await reconcile(
+      moduleDefinition,
+      createDeploymentState({
+        ...exampleDeploymentState,
+        id: "Module#Example",
+        status: ExecutionStatus.SUCCESS,
+        contractName: "Contract1",
+        futureType: FutureType.CONTRACT_DEPLOYMENT,
+        result: {
+          type: ExecutionResultType.SUCCESS,
+          address: exampleAddress,
+        },
+      }),
+      new ArtifactMapDeploymentLoader({
+        "./artifact.json": {
+          contractName: "Contract1",
+          bytecode: "0x1234",
+          abi: [],
+          deployedBytecode: "0x5678",
+          _format: "hh3-artifact-1",
+          sourceName: "Contract1.sol",
+          linkReferences: {},
+          deployedLinkReferences: {},
+        },
+      }),
+    );
+
+    assert.deepEqual(reconiliationResult.reconciliationFailures, []);
+  });
 });

v-next/hardhat-ignition-core/test/reconciliation/futures/reconcileArtifactLibraryDeployment.ts

@@ -10,6 +10,7 @@ import {
 import { FutureType } from "../../../src/types/module.js";
 import { exampleAccounts } from "../../helpers.js";
 import {
+  ArtifactMapDeploymentLoader,
   assertSuccessReconciliation,
   createDeploymentState,
   mockArtifact,
@@ -247,4 +248,43 @@ describe("Reconciliation - artifact library", () => {
       },
     ]);
   });
+
+  it("should find changes to a future's artifact bytecode reconciliable if the contract was successfully deployed", async () => {
+    const moduleDefinition = buildModule("Module", (m) => {
+      const contract1 = m.library("Contract1", mockArtifact, {
+        id: "Example",
+      });
+
+      return { contract1 };
+    });
+
+    const reconiliationResult = await reconcile(
+      moduleDefinition,
+      createDeploymentState({
+        ...exampleDeploymentState,
+        id: "Module#Example",
+        status: ExecutionStatus.SUCCESS,
+        contractName: "Contract1",
+        futureType: FutureType.LIBRARY_DEPLOYMENT,
+        result: {
+          type: ExecutionResultType.SUCCESS,
+          address: exampleAddress,
+        },
+      }),
+      new ArtifactMapDeploymentLoader({
+        "./artifact.json": {
+          contractName: "Contract1",
+          bytecode: "0x1234",
+          abi: [],
+          deployedBytecode: "0x5678",
+          _format: "hh3-artifact-1",
+          sourceName: "Contract1.sol",
+          linkReferences: {},
+          deployedLinkReferences: {},
+        },
+      }),
+    );
+
+    assert.deepEqual(reconiliationResult.reconciliationFailures, []);
+  });
 });

v-next/hardhat-ignition-core/test/reconciliation/futures/reconcileNamedContractDeployment.ts

@@ -10,6 +10,7 @@ import {
 import { FutureType } from "../../../src/types/module.js";
 import { exampleAccounts } from "../../helpers.js";
 import {
+  ArtifactMapDeploymentLoader,
   assertSuccessReconciliation,
   createDeploymentState,
   oneAddress,
@@ -393,4 +394,43 @@ describe("Reconciliation - named contract", () => {
       },
     ]);
   });
+
+  it("should find changes to a future's artifact bytecode reconciliable if the contract was successfully deployed", async () => {
+    const moduleDefinition = buildModule("Module", (m) => {
+      const contract1 = m.contract("Contract1", [], {
+        id: "Example",
+      });
+
+      return { contract1 };
+    });
+
+    const reconiliationResult = await reconcile(
+      moduleDefinition,
+      createDeploymentState({
+        ...exampleDeploymentState,
+        id: "Module#Example",
+        status: ExecutionStatus.SUCCESS,
+        contractName: "Contract1",
+        futureType: FutureType.NAMED_ARTIFACT_CONTRACT_DEPLOYMENT,
+        result: {
+          type: ExecutionResultType.SUCCESS,
+          address: exampleAddress,
+        },
+      }),
+      new ArtifactMapDeploymentLoader({
+        "./artifact.json": {
+          contractName: "Contract1",
+          bytecode: "0x1234",
+          abi: [],
+          deployedBytecode: "0x5678",
+          _format: "hh3-artifact-1",
+          sourceName: "Contract1.sol",
+          linkReferences: {},
+          deployedLinkReferences: {},
+        },
+      }),
+    );
+
+    assert.deepEqual(reconiliationResult.reconciliationFailures, []);
+  });
 });

v-next/hardhat-ignition-core/test/reconciliation/futures/reconcileNamedLibraryDeployment.ts

@@ -10,6 +10,7 @@ import {
 import { FutureType } from "../../../src/types/module.js";
 import { exampleAccounts } from "../../helpers.js";
 import {
+  ArtifactMapDeploymentLoader,
   assertSuccessReconciliation,
   createDeploymentState,
   oneAddress,
@@ -235,4 +236,43 @@ describe("Reconciliation - named library", () => {
       },
     ]);
   });
+
+  it("should find changes to a future's artifact bytecode reconciliable if the contract was successfully deployed", async () => {
+    const moduleDefinition = buildModule("Module", (m) => {
+      const contract1 = m.library("Contract1", {
+        id: "Example",
+      });
+
+      return { contract1 };
+    });
+
+    const reconiliationResult = await reconcile(
+      moduleDefinition,
+      createDeploymentState({
+        ...exampleDeploymentState,
+        id: "Module#Example",
+        status: ExecutionStatus.SUCCESS,
+        contractName: "Contract1",
+        futureType: FutureType.NAMED_ARTIFACT_LIBRARY_DEPLOYMENT,
+        result: {
+          type: ExecutionResultType.SUCCESS,
+          address: exampleAddress,
+        },
+      }),
+      new ArtifactMapDeploymentLoader({
+        "./artifact.json": {
+          contractName: "Contract1",
+          bytecode: "0x1234",
+          abi: [],
+          deployedBytecode: "0x5678",
+          _format: "hh3-artifact-1",
+          sourceName: "Contract1.sol",
+          linkReferences: {},
+          deployedLinkReferences: {},
+        },
+      }),
+    );
+
+    assert.deepEqual(reconiliationResult.reconciliationFailures, []);
+  });
 });