hardhat-deploy 2.0.0-next.7 → 2.0.0-next.70

package/src/types.ts

@@ -0,0 +1,9 @@
+export type ArtifactGenerationUserConfig = {
+	// externalArtifacts?: string[];
+	destinations?: {mode?: 'javascript' | 'typescript'; folder?: string}[];
+};
+
+export type ArtifactGenerationConfig = {
+	// externalArtifacts: string[];
+	destinations: {mode: 'javascript' | 'typescript'; folder: string}[];
+};

package/src/utils/files.ts

@@ -0,0 +1,37 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+export type FileTraversed = {
+	name: string;
+	path: string;
+	relativePath: string;
+	mtimeMs: number;
+	directory: boolean;
+};
+
+export function traverse(
+	dir: string,
+	result: any[] = [],
+	topDir?: string,
+	filter?: (name: string, stats: any) => boolean // TODO any is Stats
+): Array<FileTraversed> {
+	fs.readdirSync(dir).forEach((name) => {
+		const fPath = path.resolve(dir, name);
+		const stats = fs.statSync(fPath);
+		if ((!filter && !name.startsWith('.')) || (filter && filter(name, stats))) {
+			const fileStats = {
+				name,
+				path: fPath,
+				relativePath: path.relative(topDir || dir, fPath),
+				mtimeMs: stats.mtimeMs,
+				directory: stats.isDirectory(),
+			};
+			if (fileStats.directory) {
+				result.push(fileStats);
+				return traverse(fPath, result, topDir || dir, filter);
+			}
+			result.push(fileStats);
+		}
+	});
+	return result;
+}

package/src/v1-entry.cjs

@@ -0,0 +1,92 @@
+// This file serves as a CommonJS entry point for hardhat v2
+// It detects v1 users and shows them a migration message
+
+const MIGRATION_URL = 'https://rocketh.dev/hardhat-deploy/documentation/how-to/migration-from-v1.html';
+const V1_INSTALL_CMD = 'npm install hardhat-deploy@1';
+
+function getHardhatVersion() {
+	try {
+		const {execSync} = require('child_process');
+		// Run hardhat --version to get the version
+		const output = execSync('hardhat --version', {encoding: 'utf-8', stdio: 'pipe'});
+		return output.trim();
+	} catch (e) {
+		console.error(e);
+		return 'unknown';
+	}
+}
+
+function detectV1Patterns() {
+	const fs = require('fs');
+	const path = require('path');
+	const reasons = [];
+
+	// Check hardhat.config for v1 patterns
+	const configFiles = ['hardhat.config.js', 'hardhat.config.cjs', 'hardhat.config.ts'];
+
+	for (const configFile of configFiles) {
+		const configPath = path.join(process.cwd(), configFile);
+		if (fs.existsSync(configPath)) {
+			try {
+				const content = fs.readFileSync(configPath, 'utf-8');
+
+				if (content.includes('namedAccounts')) {
+					reasons.push(`Found 'namedAccounts' in ${configFile} - this is a v1 pattern`);
+				}
+
+				if (content.includes("require('hardhat-deploy')") || content.includes('require("hardhat-deploy")')) {
+					reasons.push(
+						`Found require('hardhat-deploy') in ${configFile} - v2 uses ESM: import HardhatDeploy from 'hardhat-deploy'`,
+					);
+				}
+
+				if (content.includes('module.exports')) {
+					reasons.push(`Found 'module.exports' in ${configFile} - v2 uses ESM: export default defineConfig({...})`);
+				}
+			} catch (e) {
+				// Failed to read config - continue
+			}
+		}
+	}
+
+	return reasons;
+}
+
+function throwV1Error() {
+	const hardhatVersion = getHardhatVersion();
+	const reasons = detectV1Patterns();
+
+	let reasonsList = '';
+	if (reasons.length > 0) {
+		reasonsList = '\nYour project uses hardhat-deploy v1 patterns:\n\n' + reasons.map((r) => `  • ${r}`).join('\n');
+	}
+
+	throw new Error(`
+╔══════════════════════════════════════════════════════════════════════════════╗
+║  HARDHAT-DEPLOY V2 - INCOMPATIBLE WITH HARDHAT V2                            ║
+╚══════════════════════════════════════════════════════════════════════════════╝
+
+hardhat-deploy v2 requires hardhat 3.x, but you are using hardhat ${hardhatVersion}.${reasonsList}
+
+hardhat-deploy v2 has MAJOR breaking changes and uses ESM modules.
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+OPTION 1: Install hardhat-deploy v1 (recommended for hardhat v2 projects)
+
+  npm uninstall hardhat-deploy
+  ${V1_INSTALL_CMD}
+
+OPTION 2: Upgrade to hardhat 3.x and hardhat-deploy v2
+
+  Migration guide: ${MIGRATION_URL}
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+`);
+}
+
+// Throw error immediately when loaded by hardhat v2
+throwV1Error();
+
+// Export a dummy function to satisfy hardhat's plugin loading
+module.exports = function () {};

package/templates/basic/README.md

@@ -0,0 +1,44 @@
+# Sample Hardhat 3 Project (`node:test`)
+
+This project showcases a Hardhat 3 project using the [hardhat-deploy](https://github.com/wighawag/hardhat-deploy) plugin (along with the [rocketh](https://github.com/wighawag/rocketh) deployment system) and the native Node.js test runner (`node:test`) .
+
+To learn more about hardhat-deploy and rocketh, please visit the [documentation](https://rocketh.dev).
+
+## Project Overview
+
+This example project includes:
+
+- A simple Hardhat configuration file.
+- Foundry-compatible Solidity unit tests.
+- Built-in mechanism to load deployments in test via hardhat-deploy and rocketh.
+
+## Usage
+
+### Running Tests
+
+To run all the tests in the project, execute the following command:
+
+```bash
+pnpm hardhat test
+```
+
+You can also selectively run the Solidity or `node:test` tests:
+
+```bash
+pnpm hardhat test solidity
+pnpm hardhat test nodejs
+```
+
+### Deploying Contracts
+
+To deploy the contracts to an in-memory network, run:
+
+```bash
+pnpm hardhat deploy
+```
+
+To deploy the contracts to a specific network, use the `--network` option:
+
+```bash
+pnpm hardhat deploy --network <network-name>
+```

package/templates/basic/contracts/Counter.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.28;
+
+contract Counter {
+  uint public x;
+
+  event Increment(uint by);
+
+  function inc() public {
+    x++;
+    emit Increment(1);
+  }
+
+  function incBy(uint by) public {
+    require(by > 0, "incBy: increment should be positive");
+    x += by;
+    emit Increment(by);
+  }
+}

package/templates/basic/contracts/Counter.t.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.28;
+
+import {Counter} from "./Counter.sol";
+import {Test} from "forge-std/Test.sol";
+
+contract CounterTest is Test {
+  Counter counter;
+
+  function setUp() public {
+    counter = new Counter();
+  }
+
+  function test_InitialValue() public view {
+    require(counter.x() == 0, "Initial value should be 0");
+  }
+
+  function testFuzz_Inc(uint8 x) public {
+    for (uint8 i = 0; i < x; i++) {
+      counter.inc();
+    }
+    require(counter.x() == x, "Value after calling inc x times should be x");
+  }
+
+  function test_IncByZero() public {
+    vm.expectRevert();
+    counter.incBy(0);
+  }
+}

package/templates/basic/deploy/01_deploy_counter.ts

@@ -0,0 +1,13 @@
+import { deployScript, artifacts } from "../rocketh/deploy.js";
+
+export default deployScript(
+  async ({ deploy, namedAccounts }) => {
+    const { deployer } = namedAccounts;
+
+    await deploy("Counter", {
+      account: deployer,
+      artifact: artifacts.Counter,
+    });
+  },
+  { tags: ["Counter", "Counter_deploy"] },
+);

package/templates/basic/hardhat.config.ts

@@ -0,0 +1,50 @@
+import { configVariable, defineConfig } from "hardhat/config";
+import hardhatNodeTestRunnerPlugin from "@nomicfoundation/hardhat-node-test-runner";
+import hardhatKeyStorePlugin from "@nomicfoundation/hardhat-keystore";
+import hardhatNetworkHelpersPlugin from "@nomicfoundation/hardhat-network-helpers";
+import hardhatViemPlugin from "@nomicfoundation/hardhat-viem";
+import hardhatViemAssertionsPlugin from "@nomicfoundation/hardhat-viem-assertions";
+import HardhatDeploy from "hardhat-deploy";
+
+export default defineConfig({
+  plugins: [
+    hardhatNodeTestRunnerPlugin,
+    hardhatKeyStorePlugin,
+    hardhatNetworkHelpersPlugin,
+    HardhatDeploy,
+    hardhatViemPlugin,
+    hardhatViemAssertionsPlugin
+  ],
+  solidity: {
+    profiles: {
+      default: {
+        version: "0.8.28",
+      },
+      production: {
+        version: "0.8.28",
+        settings: {
+          optimizer: {
+            enabled: true,
+            runs: 200,
+          },
+        },
+      },
+    },
+  },
+  networks: {
+    hardhatMainnet: {
+      type: "edr-simulated",
+      chainType: "l1",
+    },
+    hardhatOp: {
+      type: "edr-simulated",
+      chainType: "op",
+    },
+    sepolia: {
+      type: "http",
+      chainType: "l1",
+      url: configVariable("SEPOLIA_RPC_URL"),
+      accounts: [configVariable("SEPOLIA_PRIVATE_KEY")],
+    },
+  },
+});

package/templates/basic/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "template-hardhat-node-test-runner",
+  "version": "0.0.0",
+  "description": "A TypeScript Hardhat project using Node Test Runner",
+  "type": "module",
+  "devDependencies": {
+    "@nomicfoundation/hardhat-keystore": "^3.0.3",
+    "@nomicfoundation/hardhat-network-helpers": "^3.0.3",
+    "@nomicfoundation/hardhat-node-test-runner": "^3.0.8",
+    "@nomicfoundation/hardhat-viem": "^3.0.2",
+    "@nomicfoundation/hardhat-viem-assertions": "^3.0.5",
+    "@rocketh/deploy": "^0.17.9",
+    "@rocketh/doc": "^0.17.18",
+    "@rocketh/export": "^0.17.18",
+    "@rocketh/node": "^0.17.18",
+    "@rocketh/proxy": "^0.17.13",
+    "@rocketh/read-execute": "^0.17.9",
+    "@rocketh/verifier": "^0.17.18",
+    "@rocketh/viem": "^0.17.6",
+    "@types/node": "^25.0.10",
+    "forge-std": "foundry-rs/forge-std#v1.9.4",
+    "hardhat": "^3.1.5",
+    "hardhat-deploy": "workspace:*",
+    "rocketh": "^0.17.14",
+    "typescript": "~5.9.3",
+    "viem": "^2.43.0"
+  },
+  "scripts": {
+    "test": "hardhat test"
+  }
+}