Hardhat Developer Workflow Tutorial

.snippets/code/hardhat/dao-js-test-file.js

@@ -0,0 +1,85 @@
+// Import Hardhat and Hardhat Toolbox
+const { ethers } = require("hardhat");
+require("@nomicfoundation/hardhat-toolbox");
+
+// Import Chai to use its assertion functions here
+const { expect } = require("chai");
+
+// Indicate the collator the DAO wants to delegate to
+const targetCollator = "0x4c5A56ed5A4FF7B09aA86560AfD7d383F4831Cce";
+
+// The describe function receives the name of a section of your test suite, and a
+// callback. The callback must define the tests of that section. This callback
+// can't be an async function
+describe("Dao contract", function () {
+  async function deployDao() {
+    // Get the contract factory and signers here
+    const [deployer, member1] = await ethers.getSigners();
+    const delegationDao = await ethers.getContractFactory("DelegationDAO");
+
+    // Deploy the staking DAO and wait for the deployment transaction to be confirmed
+    const deployedDao = await delegationDao.deploy(
+      targetCollator,
+      deployer.address
+    );
+    await deployedDao.deployed();
+
+    // Add a new member to the DAO
+    await deployedDao.grant_member(member1.address);
+
+    // Return the deployed DAO to allow the tests to access and interact with it
+    return { deployedDao };
+  }
+
+  // You can nest calls to create subsections
+  describe("Deployment", function () {
+    // Mocha's it function is used to define each of your tests.
+    // It receives the test name, and a callback function
+    //
+    // If the callback function is async, Mocha will await it
+    it("should store the correct target collator in the DAO", async function () {
+      // Set up our test environment by calling deployDao
+      const { deployedDao } = await deployDao();
+
+      // The expect function receives a value and wraps it in an assertion object.
+      // This test will pass if the DAO stored the correct target collator
+      expect(await deployedDao.target()).to.equal(targetCollator);
+    });
+
+    // The following test cases should be added here
+    it("should initially have 0 funds in the DAO", async function () {
+      const { deployedDao } = await deployDao();
+
+      // This test will pass if the DAO has no funds as expected before any contributions
+      expect(await deployedDao.totalStake()).to.equal(0);
+    });
+
+    it("should not allow non-admins to grant membership", async function () {
+      const { deployedDao } = await deployDao();
+
+      // We ask ethers for two accounts back this time
+      const [deployer, member1] = await ethers.getSigners();
+
+      // We use connect to call grant_member from member1's account instead of admin.
+      // This test will succeed if the function call reverts and fails if the call succeeds
+      await expect(
+        deployedDao
+          .connect(member1)
+          .grant_member("0x0000000000000000000000000000000000000000")
+      ).to.be.reverted;
+    });
+
+    it("should only allow members to access member-only functions", async function () {
+      const { deployedDao } = await deployDao();
+
+      // We ask ethers for two accounts back this time
+      const [deployer, member1] = await ethers.getSigners();
+
+      // This test will succeed if the DAO member can call the member-only function.
+      // We use connect here to call the function from the account of the new member
+      expect(await deployedDao.connect(member1).check_free_balance()).to.equal(
+        0
+      );
+    });
+  });
+});

.snippets/text/hardhat/creating-a-hardhat-project.md

@@ -0,0 +1,27 @@
+You will need to create a Hardhat project if you don't already have one. You can create one by completing the following steps:
+
+1. Create a directory for your project
+    ```
+    mkdir hardhat && cd hardhat
+    ```
+2. Initialize the project which will create a `package.json` file
+    ```
+    npm init -y
+    ```
+3. Install Hardhat
+    ```
+    npm install hardhat
+    ```
+4. Create a project
+    ```
+    npx hardhat
+    ```
+
+    !!! note
+        `npx` is used to run executables installed locally in your project. Although Hardhat can be installed globally, it is recommended to install it locally in each project so that you can control the version on a project by project basis.
+
+5. A menu will appear which will allow you to create a new project or use a sample project. For this example, you can choose **Create an empty hardhat.config.js**
+
+![Hardhat Create Project](/images/builders/build/eth-api/dev-env/hardhat/hardhat-1.png)
+
+This will create a Hardhat config file (`hardhat.config.js`) in your project directory.

.snippets/text/hardhat/hardhat-configuration-file.md

@@ -0,0 +1,6 @@
+Next you can take the following steps to modify the `hardhat.config.js` file and add Moonbase Alpha as a network:
+
+1. Import plugins. The Hardhat Ethers plugin comes out of the box with Hardhat, so you don't need to worry about installing it yourself
+2. Import the `secrets.json` file
+3. Inside the `module.exports`, you need to provide the Solidity version (`0.8.1` according to our contract file)
+4. Add the Moonbase Alpha network configuration

.snippets/text/hardhat/using-the-hardhat-etherscan-plugin.md

@@ -0,0 +1,34 @@
+
+To get started with the Hardhat Etherscan plugin, you will need to first install the plugin library:
+
+```
+npm install --save-dev @nomiclabs/hardhat-etherscan
+```
+
+!!! note
+    Support for Moonbeam-based networks was added in version 3.0.1 of `@nomiclabs/hardhat-etherscan`. You can double check what version you're using by looking under the `devDependencies` section of your `package.json` and updating to version 3.0.1 or greater if needed.
+
+You can add your Moonscan API key to the `secrets.json` file alongside your private key. For this example, you'll need a [Moonbeam Moonscan](https://moonscan.io/){target=_blank} API key. If you want to verify a contract on Moonriver, you'll need a [Moonriver Moonscan](https://moonriver.moonscan.io/){target=_blank} API key.
+
+From within your Hardhat project, open your `hardhat.config.js` file. You'll need to import the `hardhat-etherscan` plugin, your Moonscan API key, and add the config for Etherscan:
+
+```js
+require("@nomiclabs/hardhat-etherscan");
+
+const { privateKey, moonbeamMoonscanAPIKey, moonriverMoonscanAPIKey } = require('./secrets.json');
+
+module.exports = {
+  networks: {
+    moonbeam: { ... },
+    moonriver: { ... },
+    moonbaseAlpha: { ... }
+  },
+  etherscan: {
+    apiKey: {
+      moonbeam: moonbeamMoonscanAPIKey, // Moonbeam Moonscan API Key
+      moonriver: moonriverMoonscanAPIKey, // Moonriver Moonscan API Key
+      moonbaseAlpha: moonbeamMoonscanAPIKey, // Moonbeam Moonscan API Key    
+    }
+  }
+};
+```

builders/build/eth-api/dev-env/hardhat.md

@@ -118,15 +118,10 @@ Then add your private key to it:
 
 Make sure to add the file to your project's `.gitignore`, and to never reveal your private key.
 
-!!! note
+!!! remember
     Please always manage your private keys with a designated secret manager or similar service. Never save or commit your private keys inside your repositories.
 
-Next you can take the following steps to modify the `hardhat.config.js` file and add Moonbase Alpha as a network:
-
-1. Import the Ethers plugin
-2. Import the `secrets.json` file
-3. Inside the `module.exports`, you need to provide the Solidity version (`0.8.1` according to our contract file)
-4. Add the Moonbase Alpha network configuration
+--8<-- 'text/hardhat/hardhat-configuration-file.md'
 
 ```js
 // 1. Import the Ethers plugin required to interact with the contract
@@ -213,7 +208,7 @@ touch deploy.js
 
 Next, you need to write your deployment script which can be done using `ethers`. Because you'll be running it with Hardhat, you don't need to import any libraries.
 
-To get started start, take the following steps:
+To get started, take the following steps:
 
 1. Create a local instance of the contract with the `getContractFactory` method
 2. Use the `deploy` method that exists within this instance to instantiate the smart contract

builders/build/eth-api/verify-contracts/etherscan-plugins.md

@@ -47,39 +47,7 @@ You will then be prompted to enter in an **AppName** for your API key and once y
 
 The example in this section of the guide will be based off of the `Box.sol` contract that was created in the [Using Hardhat to Deploy To Moonbeam](/builders/build/eth-api/dev-env/hardhat/){target=_blank} guide. 
 
-To get started with the Hardhat Etherscan plugin, you will need to first install the plugin library:
-
-```
-npm install --save-dev @nomiclabs/hardhat-etherscan
-```
-
-!!! note
-    Support for Moonbeam-based networks was added in version 3.0.1 of `@nomiclabs/hardhat-etherscan`. You can double check what version you're using by looking under the `devDependencies` section of your `package.json` and updating to version 3.0.1 or greater if needed.
-
-You can add your Moonscan API key to the `secrets.json` file alongside your private key. For this example, you'll need a [Moonbeam Moonscan](https://moonscan.io/){target=_blank} API key. If you want to verify a contract on Moonriver, you'll need a [Moonriver Moonscan](https://moonriver.moonscan.io/){target=_blank} API key.
-
-From within your Hardhat project, open your `hardhat.config.js` file. You'll need to import the `hardhat-etherscan` plugin, your Moonscan API key, and add the config for Etherscan:
-
-```js
-require("@nomiclabs/hardhat-etherscan");
-
-const { privateKey, moonbeamMoonscanAPIKey, moonriverMoonscanAPIKey } = require('./secrets.json');
-
-module.exports = {
-  networks: {
-    moonbeam: { ... },
-    moonriver: { ... },
-    moonbase: { ... }
-  },
-  etherscan: {
-    apiKey: {
-      moonbeam: moonbeamMoonscanAPIKey, // Moonbeam Moonscan API Key
-      moonriver: moonriverMoonscanAPIKey, // Moonriver Moonscan API Key
-      moonbaseAlpha: moonbeamMoonscanAPIKey, // Moonbeam Moonscan API Key    
-    }
-  }
-};
-```
+--8<-- 'text/hardhat/using-the-hardhat-etherscan-plugin.md'
 
 To verify the contract, you will run the `verify` command and pass in the address of the deployed contract and the network where it's deployed:
 

tutorials/.pages

@@ -4,6 +4,6 @@ nav:
   - index.md
   - remote-staking-xcm.md
   - batch-approve-swap.md
+  - hardhat-tutorial.md
   - foundry-start-to-end.md
-  - truffle-dev-life-cycle.md
-
+  - truffle-dev-life-cycle.md