@diamondslab/diamonds-hardhat-foundry 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.4] - 2025-12-16
+
+### Fixed
+- Templates from `src/templates/` are now properly copied to `dist/templates/` during build
+- Added `copy-templates` script to ensure all `.template` files are included in the published package
+
 ## [1.0.0] - 2025-12-15
 
 Initial public release of `@diamondslab/diamonds-hardhat-foundry`.

package/dist/templates/DiamondDeployment.sol.template

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/**
+ * @title DiamondDeployment
+ * @notice Deployment data for {{DIAMOND_NAME}} on {{NETWORK_NAME}} (Chain ID: {{CHAIN_ID}})
+ * @dev Auto-generated by diamonds-hardhat-foundry
+ * 
+ * Generated: {{TIMESTAMP}}
+ */
+library DiamondDeployment {
+    // Diamond Contract Address
+    address constant DIAMOND_ADDRESS = {{DIAMOND_ADDRESS}};
+    
+    // Deployer Address
+    address constant DEPLOYER_ADDRESS = {{DEPLOYER_ADDRESS}};
+
+    // Facet Addresses
+{{FACET_ADDRESSES}}
+
+    /**
+     * @notice Get the Diamond contract address
+     * @return The address of the Diamond contract
+     */
+    function diamond() internal pure returns (address) {
+        return DIAMOND_ADDRESS;
+    }
+
+    /**
+     * @notice Get the deployer address
+     * @return The address that deployed the Diamond
+     */
+    function deployer() internal pure returns (address) {
+        return DEPLOYER_ADDRESS;
+    }
+
+{{FACET_GETTERS}}
+}

package/dist/templates/ExampleFuzzTest.t.sol.template

@@ -0,0 +1,109 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "forge-std/Test.sol";
+import "forge-std/console.sol";
+import "../../contracts/DiamondFuzzBase.sol";
+import "../../helpers/DiamondDeployment.sol";
+
+/**
+ * @title ExampleFuzzTest
+ * @notice Example fuzz test for Diamond contract
+ * @dev Uses DiamondFuzzBase for common fuzz testing utilities
+ */
+contract ExampleFuzzTest is DiamondFuzzBase {
+    function setUp() public override {
+        super.setUp();
+        
+        // Load Diamond deployment
+        setDiamondAddress(DiamondDeployment.diamond());
+        
+        // Register facets (customize for your Diamond)
+        // registerFacet("FacetName", DiamondDeployment.facetName());
+        
+        console.log("Fuzz test setup complete");
+        console.log("Diamond:", diamond);
+    }
+
+    /**
+     * @notice Fuzz test with random address input
+     * @param randomAddress Fuzzed address parameter
+     */
+    function testFuzz_AddressInput(address randomAddress) public {
+        // Filter invalid addresses
+        assumeValidAddress(randomAddress);
+        
+        // TODO: Test your Diamond function with fuzzed address
+        // Example:
+        // MyDiamond(diamond).someFunction(randomAddress);
+        
+        assertTrue(true, "Replace with actual fuzz test");
+    }
+
+    /**
+     * @notice Fuzz test with random amount input
+     * @param amount Fuzzed amount parameter
+     */
+    function testFuzz_AmountInput(uint256 amount) public {
+        // Bound the amount to valid range
+        assumeValidAmount(amount);
+        
+        // TODO: Test your Diamond function with fuzzed amount
+        // Example:
+        // MyDiamond(diamond).transfer(user1, amount);
+        
+        assertTrue(true, "Replace with actual fuzz test");
+    }
+
+    /**
+     * @notice Fuzz test with multiple parameters
+     * @param addr Fuzzed address
+     * @param value Fuzzed value
+     * @param data Fuzzed bytes data
+     */
+    function testFuzz_MultipleParams(
+        address addr,
+        uint256 value,
+        bytes memory data
+    ) public {
+        // Filter inputs
+        assumeValidAddress(addr);
+        assumeValidAmount(value);
+        vm.assume(data.length > 0);
+        vm.assume(data.length < 1024); // Reasonable size limit
+        
+        // TODO: Test with multiple fuzzed parameters
+        
+        assertTrue(true, "Replace with actual multi-param fuzz test");
+    }
+
+    /**
+     * @notice Fuzz test for failure conditions
+     * @param badValue Value that should cause revert
+     */
+    function testFuzz_ExpectedRevert(uint256 badValue) public {
+        // Set up conditions for expected revert
+        vm.assume(badValue > type(uint128).max);
+        
+        // TODO: Test that function reverts with invalid input
+        // expectRevertWithMessage("Invalid amount");
+        // MyDiamond(diamond).someFunction(badValue);
+        
+        assertTrue(true, "Replace with actual revert fuzz test");
+    }
+
+    /**
+     * @notice Fuzz test with bounded values
+     * @param rawValue Raw fuzzed value
+     */
+    function testFuzz_BoundedValue(uint256 rawValue) public {
+        // Bound value to specific range (e.g., 1 to 1000)
+        uint256 boundedValue = boundValue(rawValue, 1, 1000);
+        
+        // TODO: Test with bounded value
+        assertGe(boundedValue, 1, "Value should be >= 1");
+        assertLe(boundedValue, 1000, "Value should be <= 1000");
+        
+        assertTrue(true, "Replace with actual bounded fuzz test");
+    }
+}

package/dist/templates/ExampleIntegrationTest.t.sol.template

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "forge-std/Test.sol";
+import "forge-std/console.sol";
+import "../../helpers/DiamondDeployment.sol";
+
+/**
+ * @title ExampleIntegrationTest
+ * @notice Example integration test for Diamond contract
+ * @dev Tests interactions between multiple facets and Diamond functionality
+ */
+contract ExampleIntegrationTest is Test {
+    address diamond;
+    address deployer;
+    
+    // Test users
+    address user1;
+    address user2;
+
+    function setUp() public {
+        // Load Diamond deployment data
+        diamond = DiamondDeployment.diamond();
+        deployer = DiamondDeployment.deployer();
+
+        // Set up test users
+        user1 = makeAddr("user1");
+        user2 = makeAddr("user2");
+        
+        // Fund test users
+        vm.deal(user1, 100 ether);
+        vm.deal(user2, 100 ether);
+
+        console.log("Diamond:", diamond);
+        console.log("User1:", user1);
+        console.log("User2:", user2);
+    }
+
+    /**
+     * @notice Test multi-facet interaction workflow
+     */
+    function test_MultiFacetWorkflow() public {
+        // TODO: Implement your multi-facet workflow test
+        // Example:
+        // 1. User1 calls function on Facet A
+        // 2. Verify state change
+        // 3. User2 calls function on Facet B
+        // 4. Verify combined state
+        
+        vm.startPrank(user1);
+        // Your test logic here
+        vm.stopPrank();
+        
+        assertTrue(true, "Replace with actual integration test");
+    }
+
+    /**
+     * @notice Test cross-facet state management
+     */
+    function test_CrossFacetState() public {
+        // TODO: Test that state is properly shared/isolated between facets
+        
+        assertTrue(true, "Replace with actual state test");
+    }
+
+    /**
+     * @notice Test Diamond upgrade scenario (if applicable)
+     */
+    function test_DiamondUpgrade() public {
+        // TODO: Test facet addition/replacement/removal
+        // This requires diamondCut functionality
+        
+        vm.startPrank(deployer);
+        // Your upgrade logic here
+        vm.stopPrank();
+        
+        assertTrue(true, "Replace with actual upgrade test");
+    }
+}

package/dist/templates/ExampleUnitTest.t.sol.template

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "forge-std/Test.sol";
+import "forge-std/console.sol";
+import "../../helpers/DiamondDeployment.sol";
+
+/**
+ * @title ExampleUnitTest
+ * @notice Example unit test for Diamond contract
+ * @dev This is a template - customize for your specific Diamond implementation
+ */
+contract ExampleUnitTest is Test {
+    address diamond;
+    address deployer;
+
+    function setUp() public {
+        // Load Diamond deployment data
+        diamond = DiamondDeployment.diamond();
+        deployer = DiamondDeployment.deployer();
+
+        console.log("Diamond deployed at:", diamond);
+        console.log("Deployed by:", deployer);
+    }
+
+    /**
+     * @notice Test that Diamond was deployed successfully
+     */
+    function test_DiamondDeployed() public view {
+        // Check that Diamond address is not zero
+        assertNotEq(diamond, address(0), "Diamond address should not be zero");
+        
+        // Check that Diamond has code
+        uint256 codeSize;
+        assembly {
+            codeSize := extcodesize(diamond)
+        }
+        assertGt(codeSize, 0, "Diamond should have code deployed");
+    }
+
+    /**
+     * @notice Test that deployer address is set correctly
+     */
+    function test_DeployerSet() public view {
+        assertNotEq(deployer, address(0), "Deployer address should not be zero");
+    }
+
+    /**
+     * @notice Example test - customize for your Diamond's functionality
+     */
+    function test_ExampleFunctionality() public {
+        // TODO: Add your Diamond-specific tests here
+        // Example:
+        // MyDiamond(diamond).someFunction();
+        // assertEq(result, expectedValue);
+        
+        assertTrue(true, "Replace this with actual test");
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diamondslab/diamonds-hardhat-foundry",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Hardhat plugin that integrates Foundry testing with Diamond proxy contracts, providing deployment helpers and fuzzing support",
   "repository": {
     "type": "git",
@@ -35,7 +35,8 @@
     "prettier": "prettier \"**/*.{js,md,json}\"",
     "pretest": "cd ../.. && yarn build",
     "test": "mocha --recursive \"test/**/*.ts\" --exit",
-    "build": "tsc --build .",
+    "build": "tsc --build . && yarn copy-templates",
+    "copy-templates": "mkdir -p dist/templates && cp src/templates/*.template dist/templates/",
     "prepublishOnly": "yarn build",
     "clean": "rimraf dist"
   },