Release/2023-09-15

.github/workflows/ci.yml

@@ -17,8 +17,6 @@ jobs:
         with:
           node-version: 16
           cache: npm
-      - name: npm latest
-        run: npm i -g npm@8 && npm i -g npm@latest
       - name: Install
         run: npm install
       - name: Build
@@ -37,8 +35,6 @@ jobs:
         with:
           node-version: 16
           cache: npm
-      - name: npm latest
-        run: npm i -g npm
       - name: Install
         run: npm install
       - name: Build
@@ -53,15 +49,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [16, 18, 20]
+        node: [16, 18, 20.5]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
           cache: npm
-      - name: npm latest
-        run: npm i -g npm
       - name: Install
         run: npm install
       - name: Build
@@ -80,8 +74,6 @@ jobs:
         with:
           node-version: 16
           cache: npm
-      - name: npm latest
-        run: npm i -g npm
       - name: Install
         run: npm install
       - name: Build

README.md

@@ -1,4 +1,4 @@
-[![npm](https://img.shields.io/npm/v/@ignored/hardhat-ignition.svg)](https://www.npmjs.com/package/@ignored/hardhat-ignition) [![hardhat](https://hardhat.org/buidler-plugin-badge.svg?1)](https://hardhat.org)
+[![npm](https://img.shields.io/npm/v/@nomicfoundation/hardhat-ignition.svg)](https://www.npmjs.com/package/@nomicfoundation/hardhat-ignition) [![hardhat](https://hardhat.org/buidler-plugin-badge.svg?1)](https://hardhat.org)
 
 # Ignition
 
@@ -13,19 +13,19 @@ Join our [Hardhat Support Discord server](https://hardhat.org/discord) to stay u
 ## Installation
 
 ```bash
-npm install --save-dev @ignored/hardhat-ignition
+npm install --save-dev @nomicfoundation/hardhat-ignition
 ```
 
 And add the following statement to your `hardhat.config.js`:
 
 ```js
-require("@ignored/hardhat-ignition");
+require("@nomicfoundation/hardhat-ignition");
 ```
 
 Or, if you are using TypeScript, add this to your `hardhat.config.ts`:
 
 ```js
-import "@ignored/hardhat-ignition";
+import "@nomicfoundation/hardhat-ignition";
 ```
 
 ## Getting Started
@@ -44,7 +44,7 @@ See our [Getting started guide](./docs/getting-started-guide.md) for a worked ex
   - [Switching based on the _Network Chain ID_](./docs/creating-modules-for-deployment.md#switching-based-on-the-network-chain-id)
 - [Using Ignition in _Hardhat_ tests](./docs/using-ignition-in-hardhat-tests.md)
 - [Running a deployment](./docs/running-a-deployment.md)
-  - [Visualizing your deployment with the `plan` task](./docs/running-a-deployment.md#visualizing-your-deployment-with-the-plan-task)
+  - [Visualizing your deployment with the `visualize` task](./docs/running-a-deployment.md#visualizing-your-deployment-with-the-visualize-task)
   - [Executing the deployment](./docs/running-a-deployment.md#executing-the-deployment)
 
 ### Examples

docs/creating-modules-for-deployment.md

@@ -29,7 +29,7 @@ An **Ignition** deployment is composed of modules. A module is a special javascr
 For example, this is a minimal module `MyModule` that deploys an instance of a `Token` contract and exposes it to any consumer of `MyModule`:
 
 ```javascript
-const { buildModule } = require("@ignored/hardhat-ignition");
+const { buildModule } = require("@nomicfoundation/hardhat-ignition");
 
 module.exports = buildModule("MyModule", (m) => {
   const token = m.contract("Token");
@@ -92,13 +92,13 @@ const b = m.contract("B", [], {
 
 ### Deploying from an artifact
 
-To allow you to use your own mechanism for getting the contract artifact, `contractFromArtifact` supports passing an `Artifact` as the second parameter:
+To allow you to use your own mechanism for getting the contract artifact, `contract` supports passing an `Artifact` as the second parameter:
 
 ```javascript
 const artifact = hre.artifacts.readArtifactSync("Foo");
 
 const userModule = buildModule("MyModule", (m) => {
-  m.contractFromArtifact("Foo", artifact, [0]);
+  m.contract("Foo", artifact, [0]);
 });
 ```
 
@@ -107,7 +107,7 @@ const userModule = buildModule("MyModule", (m) => {
 A user might need to execute a method in a contract that wasn't deployed by Ignition. An existing contract can be leveraged by passing an address and artifact:
 
 ```tsx
-const uniswap = m.contractAtFromArtifact("UniswapRouter", "0x0...", artifact);
+const uniswap = m.contractAt("UniswapRouter", "0x0...", artifact);
 
 m.call(uniswap, "swap", [
   /*...*/

docs/getting-started-guide.md

@@ -40,15 +40,15 @@ $ npx hardhat
 Add **Ignition** to your **Hardhat** project by installing the plugin:
 
 ```bash
-npm install --save-dev @ignored/hardhat-ignition
+npm install --save-dev @nomicfoundation/hardhat-ignition
 ```
 
 Modify your `hardhat.config.js` file, to include **Ignition**:
 
 ```javascript
 require("@nomicfoundation/hardhat-toolbox");
 // ...
-require("@ignored/hardhat-ignition");
+require("@nomicfoundation/hardhat-ignition");
 ```
 
 Create an `./ignition` folder in your project root to contain your deployment modules.
@@ -63,7 +63,7 @@ Add a deployment module under the `./ignition` folder for the example `Lock.sol`
 
 ```js
 // ./ignition/LockModule.js
-const { buildModule } = require("@ignored/hardhat-ignition");
+const { buildModule } = require("@nomicfoundation/hardhat-ignition");
 
 const currentTimestampInSeconds = Math.round(new Date(2023, 0, 1) / 1000);
 const TEN_YEAR_IN_SECS = 10 * 365 * 24 * 60 * 60;

docs/publish.md

@@ -30,5 +30,5 @@ yyyy-mm-dd` release.
 13. On a successful check, `rebase merge` the release branch into `main`
 14. Switch to main branch and pull the latest changes
 15. Git tag the version, `g tag -a v0.x.x -m "v0.x.x"` and push the tag `git push --follow-tags`
-16. Publish `@ignored/ignition-core`, `@ignored/ignition-ui` and `@ignored/hardhat-ignition` : `npm publish -w @ignored/ignition-core -w @ignored/ignition-ui -w @ignored/hardhat-ignition`
+16. Publish `@nomicfoundation/ignition-core`, `@nomicfoundation/ignition-ui` and `@nomicfoundation/hardhat-ignition` : `npm publish -w @nomicfoundation/ignition-core -w @nomicfoundation/ignition-ui -w @nomicfoundation/hardhat-ignition`
 17. Create a release on github off of the pushed tag

docs/running-a-deployment.md

@@ -4,34 +4,34 @@
 
 ### Table of Contents
 
-- [Visualizing your deployment with the `plan` task](./running-a-deployment.md#visualizing-your-deployment-with-the-plan-task)
+- [Visualizing your deployment with the `visualize` task](./running-a-deployment.md#visualizing-your-deployment-with-the-visualize-task)
 - [Executing the deployment](./running-a-deployment.md#executing-the-deployment)
   - [Configuration options](./running-a-deployment.md#configuration-options)
-  <!-- - [Resuming a failed or onhold deployment](./running-a-deployment.md#visualizing-your-deployment-with-the-plan-task) -->
+  <!-- - [Resuming a failed or onhold deployment](./running-a-deployment.md#visualizing-your-deployment-with-the-visualize-task) -->
 
 ---
 
 Once you have built and tested your deployment module, it is time to deploy it! Start by making sure you understand exactly what will be executed on chain.
 
-## Visualizing your deployment with the `plan` task
+## Visualizing your deployment with the `visualize` task
 
-**Ignition** adds a `plan` task to the cli, that will generate a HTML report showing a _dry run_ of the deployment - the contract deploys and contract calls.
+**Ignition** adds a `visualize` task to the cli, that will generate a HTML report showing a _dry run_ of the deployment - the contract deploys and contract calls.
 
-The `plan` task takes one argument, the module to visualize. For example, using the `ENS.js` module from our [ENS example project](../examples/ens/README.md):
+The `visualize` task takes one argument, the module to visualize. For example, using the `ENS.js` module from our [ENS example project](../examples/ens/README.md):
 
 ```bash
-npx hardhat plan ENS
+npx hardhat visualize ENS
 ```
 
-Running `plan` will generate the report based on the given module (in this case `ENS.js`), it will then open the report in your system's default browser:
+Running `visualize` will generate the report based on the given module (in this case `ENS.js`), it will then open the report in your system's default browser:
 
-![Main plan output](images/plan-1.png)
+![Main visualize output](images/visualize-1.png)
 
 The report summarises the contract that will be deployed and the contract calls that will be made.
 
 It shows the dependency graph as it will be executed by Ignition (where a dependency will not be run until all its dependents have successfully completed).
 
-If something in your deployment isn't behaving the way you expected, the `plan` task can be an extremely helpful tool for debugging and verifying that your and **Ignition**'s understanding of the deployment are the same.
+If something in your deployment isn't behaving the way you expected, the `visualize` task can be an extremely helpful tool for debugging and verifying that your and **Ignition**'s understanding of the deployment are the same.
 
 ## Executing the deployment
 

examples/complete/hardhat.config.js

@@ -1,5 +1,5 @@
 require("@nomicfoundation/hardhat-toolbox");
-require("@ignored/hardhat-ignition");
+require("@nomicfoundation/hardhat-ignition");
 
 /** @type import('hardhat/config').HardhatUserConfig */
 module.exports = {

examples/complete/ignition/CompleteModule.js

@@ -1,23 +1,18 @@
 // ./ignition/CompleteModule.js
-const { buildModule } = require("@ignored/hardhat-ignition");
+const { buildModule } = require("@nomicfoundation/hardhat-ignition");
 
 const withLibArtifact = require("../libArtifacts/ContractWithLibrary.json");
 const libArtifact = require("../libArtifacts/BasicLibrary.json");
 
 module.exports = buildModule("CompleteModule", (m) => {
   const basic = m.contract("BasicContract");
   const library = m.library("BasicLibrary");
-  const libFromArtifact = m.libraryFromArtifact("BasicLibrary", libArtifact, {
+  const libFromArtifact = m.library("BasicLibrary", libArtifact, {
     id: "BasicLibrary2",
   });
-  const withLib = m.contractFromArtifact(
-    "ContractWithLibrary",
-    withLibArtifact,
-    [],
-    {
-      libraries: { BasicLibrary: library },
-    }
-  );
+  const withLib = m.contract("ContractWithLibrary", withLibArtifact, [], {
+    libraries: { BasicLibrary: library },
+  });
 
   const call = m.call(basic, "basicFunction", [40]);
   const eventArg = m.readEventArgument(call, "BasicEvent", "eventArg");
@@ -26,14 +21,14 @@ module.exports = buildModule("CompleteModule", (m) => {
   const duplicate = m.contractAt("BasicContract", basic, {
     id: "BasicContract2",
   });
-  const duplicateWithLib = m.contractAtFromArtifact(
+  const duplicateWithLib = m.contractAt(
     "ContractWithLibrary",
     withLib,
     withLibArtifact,
     { id: "ContractWithLibrary2" }
   );
 
-  m.send("test-send", duplicate, 123n);
+  m.send("test_send", duplicate, 123n);
 
   return {
     basic,

examples/complete/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nomicfoundation/ignition-complete-example",
   "private": true,
-  "version": "0.3.0",
+  "version": "0.4.0",
   "scripts": {
     "test": "hardhat test",
     "lint": "npm run prettier -- --check && npm run eslint",
@@ -10,7 +10,7 @@
     "prettier": "prettier \"*.{js,md,json}\" \"ignition/*.{js,md,json}\" \"test/*.{js,md,json}\" \"contracts/**/*.sol\""
   },
   "devDependencies": {
-    "@ignored/hardhat-ignition": "^0.3.0",
+    "@nomicfoundation/hardhat-ignition": "^0.4.0",
     "@nomicfoundation/hardhat-toolbox": "3.0.0",
     "hardhat": "^2.14.0",
     "prettier-plugin-solidity": "1.1.3"

examples/ens/hardhat.config.js

@@ -1,5 +1,5 @@
 require("@nomicfoundation/hardhat-toolbox");
-require("@ignored/hardhat-ignition");
+require("@nomicfoundation/hardhat-ignition");
 
 /**
  * @type import('hardhat/config').HardhatUserConfig

examples/ens/ignition/ENS.js

@@ -1,4 +1,4 @@
-const { buildModule } = require("@ignored/hardhat-ignition");
+const { buildModule } = require("@nomicfoundation/hardhat-ignition");
 
 const namehash = require("eth-ens-namehash");
 const ethers = hre.ethers;
@@ -30,7 +30,7 @@ const resolverModule = buildModule("RESOLVER", (m) => {
   const resolver = m.contract("PublicResolver", [ens, ZERO_ADDRESS]);
 
   m.call(ens, "setSubnodeOwner", [ZERO_HASH, resolverLabel, account], {
-    id: "set-subnode-owner-for-resolver",
+    id: "set_subnode_owner_for_resolver",
   });
 
   m.call(ens, "setResolver", [resolverNode, resolver]);
@@ -50,15 +50,15 @@ const reverseRegistrarModule = buildModule("REVERSEREGISTRAR", (m) => {
   const reverseRegistrar = m.contract("ReverseRegistrar", [ens, resolver]);
 
   m.call(ens, "setSubnodeOwner", [ZERO_HASH, reverseLabel, account], {
-    id: "set-subnode-owner-reverse",
+    id: "set_subnode_owner_reverse",
   });
 
   m.call(
     ens,
     "setSubnodeOwner",
     [reverseTldHash, addrLabel, reverseRegistrar],
     {
-      id: "set-subnode-addr-label",
+      id: "set_subnode_addr_label",
     }
   );
 

examples/ens/ignition/test-registrar.js

@@ -1,4 +1,4 @@
-const { buildModule } = require("@ignored/hardhat-ignition");
+const { buildModule } = require("@nomicfoundation/hardhat-ignition");
 const namehash = require("eth-ens-namehash");
 
 const setupENSRegistry = require("./ENS");
@@ -11,7 +11,7 @@ const ZERO_HASH =
 
 const ACCOUNT_0 = "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266";
 
-module.exports = buildModule("TEST registrar", (m) => {
+module.exports = buildModule("TEST_registrar", (m) => {
   const tld = "test";
   const tldHash = namehash.hash(tld);
   const tldLabel = labelhash(tld);
@@ -22,7 +22,7 @@ module.exports = buildModule("TEST registrar", (m) => {
   const registrar = m.contract("FIFSRegistrar", [ens, tldHash]);
 
   m.call(ens, "setSubnodeOwner", [ZERO_HASH, tldLabel, ACCOUNT_0], {
-    id: "set-subnode-owner-for-registrar",
+    id: "set_subnode_owner_for_registrar",
   });
 
   return { ens, resolver, registrar, reverseRegistrar };

examples/ens/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nomicfoundation/ignition-ens-example",
   "private": true,
-  "version": "0.3.0",
+  "version": "0.4.0",
   "scripts": {
     "test": "hardhat test",
     "lint": "npm run prettier -- --check && npm run eslint",
@@ -10,7 +10,7 @@
     "prettier": "prettier \"*.{js,md,json}\" \"ignition/*.{js,md,json}\" \"test/*.{js,md,json}\" \"contracts/**/*.sol\""
   },
   "devDependencies": {
-    "@ignored/hardhat-ignition": "^0.3.0",
+    "@nomicfoundation/hardhat-ignition": "^0.4.0",
     "@nomicfoundation/hardhat-toolbox": "3.0.0",
     "hardhat": "^2.14.0",
     "prettier-plugin-solidity": "1.1.3"

examples/sample/hardhat.config.js

@@ -1,5 +1,5 @@
 require("@nomicfoundation/hardhat-toolbox");
-require("@ignored/hardhat-ignition");
+require("@nomicfoundation/hardhat-ignition");
 
 /** @type import('hardhat/config').HardhatUserConfig */
 module.exports = {

examples/sample/ignition/LockModule.js

@@ -1,5 +1,5 @@
 // ./ignition/LockModule.js
-const { buildModule } = require("@ignored/hardhat-ignition");
+const { buildModule } = require("@nomicfoundation/hardhat-ignition");
 
 const currentTimestampInSeconds = Math.round(new Date(2023, 0, 1) / 1000);
 const TEN_YEAR_IN_SECS = 10 * 365 * 24 * 60 * 60;

examples/sample/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nomicfoundation/ignition-sample-example",
   "private": true,
-  "version": "0.3.0",
+  "version": "0.4.0",
   "scripts": {
     "test": "hardhat test",
     "lint": "npm run prettier -- --check && npm run eslint",
@@ -10,7 +10,7 @@
     "prettier": "prettier \"*.{js,md,json}\" \"ignition/*.{js,md,json}\" \"test/*.{js,md,json}\" \"contracts/**/*.sol\""
   },
   "devDependencies": {
-    "@ignored/hardhat-ignition": "^0.3.0",
+    "@nomicfoundation/hardhat-ignition": "^0.4.0",
     "@nomicfoundation/hardhat-toolbox": "3.0.0",
     "hardhat": "^2.14.0",
     "prettier-plugin-solidity": "1.1.3"

examples/ts-sample/hardhat.config.ts

@@ -1,7 +1,7 @@
 import type { HardhatUserConfig } from "hardhat/config";
 
+import "@nomicfoundation/hardhat-ignition";
 import "@nomicfoundation/hardhat-toolbox";
-import "@ignored/hardhat-ignition";
 
 const config: HardhatUserConfig = {
   solidity: "0.8.17",

examples/ts-sample/ignition/LockModule.ts

@@ -1,4 +1,4 @@
-import { buildModule } from "@ignored/hardhat-ignition";
+import { buildModule } from "@nomicfoundation/hardhat-ignition";
 import hre from "hardhat";
 
 const currentTimestampInSeconds = Math.round(