hardhat-deploy Documentation

hardhat-deploy provides several advanced deployment capabilities:

• Deterministic deployment: Ensure the same address across different networks.
• Deployment dependency system: Only deploy what is strictly necessary.
• Deployment retrying: Recover from interruptions by saving pending transactions.
• Library linking: Link libraries at the time of deployment.
• Chain configuration export: Export deployed contract addresses and ABIs (via @rocketh/export) for use in web applications.
• Contract verification: Save metadata for full verification via Sourcify or Etherscan.
• Test fixtures: Use deployments as optimized test fixtures via Hardhat helpers.
• Hot Contract Replacement (HCR): Edit contracts and see changes live using proxy patterns.

hardhat-deploy v2 is built on top of rocketh, a framework-agnostic system that provides the core API for saving and loading deployments. While hardhat-deploy provides the Hardhat integration, the actual deployment logic is handled by modular @rocketh packages:

• @rocketh/deploy: Provides the deploy function.
• @rocketh/proxy: Enables declarative proxy deployments.
• @rocketh/diamond: Enables declarative EIP-2535 Diamond deployments.
• @rocketh/read-execute: Provides helpers for reading from and executing transactions on deployed contracts by name.
• @rocketh/viem: Provides integration with the Viem client.

You can use deployScript to define deployment logic in plain TypeScript. The deployViaProxy function allows for declarative proxy deployment, which is useful for upgradeable contracts. You can pass namedAccounts to reference specific roles (like deployer or admin) instead of raw addresses.

import { deployScript, artifacts } from "../rocketh/deploy.js";

export default deployScript(
  async ({ deployViaProxy, namedAccounts }) => {
    const { deployer, admin } = namedAccounts;

    await deployViaProxy(
      "GreetingsRegistry",
      {
        account: deployer,
        artifact: artifacts.GreetingsRegistry,
        args: ["prefix:"],
      },
      {
        owner: admin,
      },
    );
  },
  { tags: ["GreetingsRegistry"] },
);