Hardhat zip deploy with ignition (#556)

Co-authored-by: Eric Lau <[email protected]>

Author: CoveMB

packages/core/solidity/src/zip-hardhat.test.ts

@@ -47,7 +47,7 @@ test.serial('erc20 full', async t => {
     flashmint: true,
   };
   const c = buildERC20(opts);
-  await runTest(c, t, opts);
+  await runIgnitionTest(c, t, opts);
 });
 
 test.serial('erc721 upgradeable', async t => {
@@ -58,7 +58,7 @@ test.serial('erc721 upgradeable', async t => {
     upgradeable: 'uups',
   };
   const c = buildERC721(opts);
-  await runTest(c, t, opts);
+  await runDeployScriptTest(c, t, opts);
 });
 
 test.serial('erc1155 basic', async t => {
@@ -68,13 +68,13 @@ test.serial('erc1155 basic', async t => {
     uri: 'https://myuri/{id}',
   };
   const c = buildERC1155(opts);
-  await runTest(c, t, opts);
+  await runIgnitionTest(c, t, opts);
 });
 
 test.serial('custom basic', async t => {
   const opts: GenericOptions = { kind: 'Custom', name: 'My Contract' };
   const c = buildCustom(opts);
-  await runTest(c, t, opts);
+  await runIgnitionTest(c, t, opts);
 });
 
 test.serial('custom upgradeable', async t => {
@@ -84,18 +84,26 @@ test.serial('custom upgradeable', async t => {
     upgradeable: 'transparent',
   };
   const c = buildCustom(opts);
-  await runTest(c, t, opts);
+  await runDeployScriptTest(c, t, opts);
 });
 
-async function runTest(c: Contract, t: ExecutionContext<Context>, opts: GenericOptions) {
+async function runDeployScriptTest(c: Contract, t: ExecutionContext<Context>, opts: GenericOptions) {
   const zip = await zipHardhat(c, opts);
 
-  assertLayout(zip, c, t);
-  await extractAndRunPackage(zip, c, t);
-  await assertContents(zip, c, t);
+  assertDeployScriptLayout(zip, c, t);
+  await extractAndRunDeployScriptPackage(zip, c, t);
+  await assertDeployScriptContents(zip, c, t);
 }
 
-function assertLayout(zip: JSZip, c: Contract, t: ExecutionContext<Context>) {
+async function runIgnitionTest(c: Contract, t: ExecutionContext<Context>, opts: GenericOptions) {
+  const zip = await zipHardhat(c, opts);
+
+  assertIgnitionLayout(zip, c, t);
+  await extractAndRunIgnitionPackage(zip, c, t);
+  await assertIgnitionContents(zip, c, t);
+}
+
+function assertDeployScriptLayout(zip: JSZip, c: Contract, t: ExecutionContext<Context>) {
   const sorted = Object.values(zip.files)
     .map(f => f.name)
     .sort();
@@ -115,36 +123,62 @@ function assertLayout(zip: JSZip, c: Contract, t: ExecutionContext<Context>) {
   ]);
 }
 
-async function extractAndRunPackage(zip: JSZip, c: Contract, t: ExecutionContext<Context>) {
-  const files = Object.values(zip.files);
+function assertIgnitionLayout(zip: JSZip, c: Contract, t: ExecutionContext<Context>) {
+  const sorted = Object.values(zip.files)
+    .map(f => f.name)
+    .sort();
+  t.deepEqual(sorted, [
+    '.gitignore',
+    'README.md',
+    'contracts/',
+    `contracts/${c.name}.sol`,
+    'hardhat.config.ts',
+    'ignition/',
+    'ignition/modules/',
+    `ignition/modules/${c.name}.ts`,
+    'package-lock.json',
+    'package.json',
+    'test/',
+    'test/test.ts',
+    'tsconfig.json',
+  ]);
+}
+
+function extractAndRun(makeDeployCommand: (c: Contract) => string | null) {
+  return async (zip: JSZip, c: Contract, t: ExecutionContext<Context>) => {
+    const files = Object.values(zip.files);
 
-  const tempFolder = t.context.tempFolder;
+    const tempFolder = t.context.tempFolder;
 
-  const items = Object.values(files);
-  for (const item of items) {
-    if (item.dir) {
-      await fs.mkdir(path.join(tempFolder, item.name));
-    } else {
-      await fs.writeFile(path.join(tempFolder, item.name), await asString(item));
+    const items = Object.values(files);
+    for (const item of items) {
+      if (item.dir) {
+        await fs.mkdir(path.join(tempFolder, item.name));
+      } else {
+        await fs.writeFile(path.join(tempFolder, item.name), await asString(item));
+      }
     }
-  }
 
-  let command = `cd "${tempFolder}" && npm install && npm test`;
-  if (c.constructorArgs === undefined) {
-    // only test deploying the contract if there are no constructor args needed
-    command += ' && npx hardhat run scripts/deploy.ts';
-  }
+    let command = `cd "${tempFolder}" && npm install && npm test`;
+    if (c.constructorArgs === undefined) {
+      // only test deploying the contract if there are no constructor args needed
+      command += ` && ${makeDeployCommand(c)}`;
+    }
 
-  const exec = util.promisify(child.exec);
-  const result = await exec(command);
+    const exec = util.promisify(child.exec);
+    const result = await exec(command);
 
-  t.regex(result.stdout, /1 passing/);
-  if (c.constructorArgs === undefined) {
-    t.regex(result.stdout, /deployed to/);
-  }
+    t.regex(result.stdout, /1 passing/);
+    if (c.constructorArgs === undefined) {
+      t.regex(result.stdout, /deployed to/);
+    }
+  };
 }
 
-async function assertContents(zip: JSZip, c: Contract, t: ExecutionContext<Context>) {
+const extractAndRunDeployScriptPackage = extractAndRun(() => 'npx hardhat run scripts/deploy.ts');
+const extractAndRunIgnitionPackage = extractAndRun(c => `npx hardhat ignition deploy ignition/modules/${c.name}.ts`);
+
+async function assertDeployScriptContents(zip: JSZip, c: Contract, t: ExecutionContext<Context>) {
   const contentComparison = [
     await getItemString(zip, `contracts/${c.name}.sol`),
     await getItemString(zip, 'hardhat.config.ts'),
@@ -156,6 +190,18 @@ async function assertContents(zip: JSZip, c: Contract, t: ExecutionContext<Conte
   t.snapshot(contentComparison);
 }
 
+async function assertIgnitionContents(zip: JSZip, c: Contract, t: ExecutionContext<Context>) {
+  const contentComparison = [
+    await getItemString(zip, `contracts/${c.name}.sol`),
+    await getItemString(zip, 'hardhat.config.ts'),
+    await getItemString(zip, 'package.json'),
+    await getItemString(zip, `ignition/modules/${c.name}.ts`),
+    await getItemString(zip, 'test/test.ts'),
+  ];
+
+  t.snapshot(contentComparison);
+}
+
 async function getItemString(zip: JSZip, key: string) {
   const obj = zip.files[key];
   if (obj === undefined) {

packages/core/solidity/src/zip-hardhat.test.ts.md

@@ -100,23 +100,14 @@ Generated by [AVA](https://avajs.dev).
           "hardhat": "^2.16.1"␊
         }␊
       }`,
-      `import { ethers } from "hardhat";␊
+      `import { buildModule } from "@nomicfoundation/hardhat-ignition/modules";␊
       ␊
-      async function main() {␊
-        const ContractFactory = await ethers.getContractFactory("MyToken");␊
+      export default buildModule("MyTokenModule", (m) => {␊
       ␊
         // TODO: Set addresses for the contract arguments below␊
-        const instance = await ContractFactory.deploy(recipient, defaultAdmin, pauser, minter);␊
-        await instance.waitForDeployment();␊
-      ␊
-        console.log(\`Contract deployed to ${await instance.getAddress()}\`);␊
-      }␊
+        const myToken = m.contract("MyToken", [recipient, defaultAdmin, pauser, minter]);␊
       ␊
-      // We recommend this pattern to be able to use async/await everywhere␊
-      // and properly handle errors.␊
-      main().catch((error) => {␊
-        console.error(error);␊
-        process.exitCode = 1;␊
+        return { myToken };␊
       });␊
       `,
       `import { expect } from "chai";␊
@@ -301,23 +292,14 @@ Generated by [AVA](https://avajs.dev).
           "hardhat": "^2.16.1"␊
         }␊
       }`,
-      `import { ethers } from "hardhat";␊
+      `import { buildModule } from "@nomicfoundation/hardhat-ignition/modules";␊
       ␊
-      async function main() {␊
-        const ContractFactory = await ethers.getContractFactory("MyToken");␊
+      export default buildModule("MyTokenModule", (m) => {␊
       ␊
         // TODO: Set addresses for the contract arguments below␊
-        const instance = await ContractFactory.deploy(initialOwner);␊
-        await instance.waitForDeployment();␊
-      ␊
-        console.log(\`Contract deployed to ${await instance.getAddress()}\`);␊
-      }␊
+        const myToken = m.contract("MyToken", [initialOwner]);␊
       ␊
-      // We recommend this pattern to be able to use async/await everywhere␊
-      // and properly handle errors.␊
-      main().catch((error) => {␊
-        console.error(error);␊
-        process.exitCode = 1;␊
+        return { myToken };␊
       });␊
       `,
       `import { expect } from "chai";␊
@@ -383,23 +365,14 @@ Generated by [AVA](https://avajs.dev).
           "hardhat": "^2.16.1"␊
         }␊
       }`,
-      `import { ethers } from "hardhat";␊
+      `import { buildModule } from "@nomicfoundation/hardhat-ignition/modules";␊
       ␊
-      async function main() {␊
-        const ContractFactory = await ethers.getContractFactory("MyContract");␊
+      export default buildModule("MyContractModule", (m) => {␊
       ␊
         ␊
-        const instance = await ContractFactory.deploy();␊
-        await instance.waitForDeployment();␊
+        const myContract = m.contract("MyContract", []);␊
       ␊
-        console.log(\`Contract deployed to ${await instance.getAddress()}\`);␊
-      }␊
-      ␊
-      // We recommend this pattern to be able to use async/await everywhere␊
-      // and properly handle errors.␊
-      main().catch((error) => {␊
-        console.error(error);␊
-        process.exitCode = 1;␊
+        return { myContract };␊
       });␊
       `,
       `import { expect } from "chai";␊

packages/core/solidity/src/zip-hardhat.test.ts.snap

@@ -147,10 +147,28 @@ main().catch((error) => {
 `;
 };
 
-const readme = `\
+const lowerFirstCharacter = (str: string) => str.charAt(0).toLowerCase() + str.slice(1);
+
+const ignitionModule = (c: Contract) => {
+  const deployArguments = getAddressArgs(c);
+  const contractVariableName = lowerFirstCharacter(c.name);
+
+  return `import { buildModule } from "@nomicfoundation/hardhat-ignition/modules";
+
+export default buildModule("${c.name}Module", (m) => {
+
+  ${deployArguments.length > 0 ? '// TODO: Set addresses for the contract arguments below' : ''}
+  const ${contractVariableName} = m.contract("${c.name}", [${deployArguments.join(', ')}]);
+
+  return { ${contractVariableName} };
+});
+`;
+};
+
+const readme = (c: Contract) => `\
 # Sample Hardhat Project
 
-This project demonstrates a basic Hardhat use case. It comes with a contract generated by [OpenZeppelin Wizard](https://wizard.openzeppelin.com/), a test for that contract, and a script that deploys that contract.
+This project demonstrates a basic Hardhat use case. It comes with a contract generated by [OpenZeppelin Wizard](https://wizard.openzeppelin.com/), a test for that contract, ${c.upgradeable ? 'and a script that deploys that contract' : 'and a Hardhat Ignition module that deploys that contract'}.
 
 ## Installing dependencies
 
@@ -169,7 +187,7 @@ npm test
 You can target any network from your Hardhat config using:
 
 \`\`\`
-npx hardhat run --network <network-name> scripts/deploy.ts
+${c.upgradeable ? 'npx hardhat run --network <network-name> scripts/deploy.ts' : `npx hardhat ignition deploy ignition/modules/${c.name}.ts --network <network-name>`}
 \`\`\`
 `;
 
@@ -196,12 +214,18 @@ export async function zipHardhat(c: Contract, opts?: GenericOptions) {
 
   zip.file(`contracts/${c.name}.sol`, printContract(c));
   zip.file('test/test.ts', test(c, opts));
-  zip.file('scripts/deploy.ts', script(c));
+
+  if (c.upgradeable) {
+    zip.file('scripts/deploy.ts', script(c));
+  } else {
+    zip.file(`ignition/modules/${c.name}.ts`, ignitionModule(c));
+  }
+
   zip.file('.gitignore', gitIgnore);
   zip.file('hardhat.config.ts', hardhatConfig(c.upgradeable));
   zip.file('package.json', JSON.stringify(packageJson, null, 2));
   zip.file(`package-lock.json`, JSON.stringify(packageLock, null, 2));
-  zip.file('README.md', readme);
+  zip.file('README.md', readme(c));
   zip.file('tsconfig.json', tsConfig);
 
   return zip;