How do I run Hardhat with the -- constructor -args parameter?

When working with the Hardhat framework for smart contract development, it is often necessary to pass parameters to the constructor during deployment. The --constructor-args parameter enables you to specify these constructor arguments when executing the hardhat run command.

First, ensure your Hardhat project includes the contracts, and that the constructor requires specific parameters. For example, consider a contract named MyContract with a constructor that accepts two parameters: a string and an integer.

solidity
// contracts/MyContract.sol

pragma solidity ^0.8.0;

contract MyContract {
    string public name;
    uint public age;

    constructor(string memory _name, uint _age) {
        name = _name;
        age = _age;
    }
}

Next, create a deployment script to deploy the contract.

javascript
// scripts/deploy.js

async function main() {
    const [deployer] = await ethers.getSigners();

    console.log("Deploying contracts with the account:", deployer.address);

    const MyContract = await ethers.getContractFactory("MyContract");
    const myContract = await MyContract.deploy("Alice", 30);

    console.log("MyContract deployed to:", myContract.address);
}

main().catch((error) => {
    console.error(error);
    process.exitCode = 1;
});

In this deployment script, we directly pass 'Alice' and 30 as constructor arguments when deploying MyContract. However, if you prefer to pass these values via command-line arguments, you can utilize --constructor-args.

First, create a parameters file that holds the arguments you wish to pass to the constructor.

javascript
// arguments.js

module.exports = ["Alice", 30];

Next, update your deployment script to load parameters from an external file:

javascript
// scripts/deploy.js

async function main() {
    const [deployer] = await ethers.getSigners();
    const args = require("../arguments.js");

    console.log("Deploying contracts with the account:", deployer.address);

    const MyContract = await ethers.getContractFactory("MyContract");
    const myContract = await MyContract.deploy(...args);

    console.log("MyContract deployed to:", myContract.address);
}

main().catch((error) => {
    console.error(error);
    process.exitCode = 1;
});

You can execute your script using the --constructor-args parameter as follows:

bash
npx hardhat run scripts/deploy.js --network yourNetworkName --constructor-args arguments.js

This allows the parameters from the arguments.js file to be passed to the constructor of MyContract, enabling dynamic configuration of constructor arguments through the command line. This is especially valuable for multi-environment deployments or scenarios requiring dynamic input parameters.