feat: add `Held` status to exState status #457

kanej · 2023-09-11T13:07:43Z

To support execution strategies returning hold status in the future,
we are adding it into the execution status of exStates.

Resolves #451

TODO

Add the status
Update the return result
Do we need a strategy message now that can return an on hold result?
Do we need rerun rules? Or can they be deferred until we release execution strategies.

kanej · 2023-09-12T09:54:21Z

I am opting to leave the run logic until we are actually exposing strategies that can use held.

packages/core/src/internal/execution/types/execution-result.ts

packages/core/src/internal/deployer.ts

alcuadrado · 2023-09-12T19:40:05Z

packages/core/src/internal/journal/utils/emitExecutionEvent.ts

@@ -217,6 +217,12 @@ function convertExecutionResultToEventResult(
        error: "Transaction reverted",
      };
    }
+    case ExecutionResultType.STRATEGY_HELD: {


Sorry for being repetitive, but held shouldn't be considered an error.

I have added another event result (held), to allow mapping from held to a non-error result. And wired it through the UI.

packages/core/src/internal/journal/utils/emitExecutionEvent.ts

packages/core/src/internal/views/has-execution-failed.ts

packages/hardhat-plugin/src/utils/error-deployment-result-to-exception-message.ts

To support execution strategies returning `held` status in the future, we are adding it into the execution status of exStates. The return result of a deployment can now include a held property listing the futures that have been held and the reason for the hold. This is wired through to the ui as a new sort of Held result instead of treating it as success or failure. Resolves #451

github-actions bot added the status:triaging label Sep 11, 2023

kanej force-pushed the feat/add-hold-status branch from 2e24167 to 2441256 Compare September 11, 2023 13:09

kanej removed the status:triaging label Sep 11, 2023

kanej force-pushed the feat/add-hold-status branch 2 times, most recently from 1b72bdc to ab02ffb Compare September 12, 2023 09:53

kanej commented Sep 12, 2023

View reviewed changes

packages/core/src/internal/execution/types/execution-result.ts Show resolved Hide resolved

kanej commented Sep 12, 2023

View reviewed changes

packages/core/src/internal/execution/types/execution-result.ts Show resolved Hide resolved

kanej marked this pull request as ready for review September 12, 2023 09:59

kanej requested a review from alcuadrado September 12, 2023 09:59

kanej changed the title ~~feat: add Hold status to exState status~~ feat: add Held status to exState status Sep 12, 2023