@diamondslab/diamonds-hardhat-foundry 1.0.2 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/CHANGELOG.md +160 -0
  2. package/README.md +568 -4
  3. package/contracts/DiamondABILoader.sol +329 -0
  4. package/contracts/DiamondForgeHelpers.sol +309 -85
  5. package/contracts/DiamondFuzzBase.sol +305 -114
  6. package/dist/foundry.d.ts +28 -0
  7. package/dist/foundry.d.ts.map +1 -1
  8. package/dist/foundry.js +82 -1
  9. package/dist/foundry.js.map +1 -1
  10. package/dist/framework/DeploymentManager.d.ts +10 -11
  11. package/dist/framework/DeploymentManager.d.ts.map +1 -1
  12. package/dist/framework/DeploymentManager.js +56 -45
  13. package/dist/framework/DeploymentManager.js.map +1 -1
  14. package/dist/framework/ForgeFuzzingFramework.d.ts +4 -0
  15. package/dist/framework/ForgeFuzzingFramework.d.ts.map +1 -1
  16. package/dist/framework/ForgeFuzzingFramework.js +16 -2
  17. package/dist/framework/ForgeFuzzingFramework.js.map +1 -1
  18. package/dist/framework/HelperGenerator.d.ts.map +1 -1
  19. package/dist/framework/HelperGenerator.js +11 -0
  20. package/dist/framework/HelperGenerator.js.map +1 -1
  21. package/dist/index.d.ts +0 -3
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index.js +0 -8
  24. package/dist/index.js.map +1 -1
  25. package/dist/tasks/deploy.js +3 -2
  26. package/dist/tasks/deploy.js.map +1 -1
  27. package/dist/tasks/generate-helpers.js +6 -4
  28. package/dist/tasks/generate-helpers.js.map +1 -1
  29. package/dist/tasks/init.js +3 -2
  30. package/dist/tasks/init.js.map +1 -1
  31. package/dist/tasks/test.js +13 -2
  32. package/dist/tasks/test.js.map +1 -1
  33. package/dist/templates/DiamondDeployment.sol.template +38 -0
  34. package/dist/templates/ExampleFuzzTest.t.sol.template +118 -0
  35. package/dist/templates/ExampleIntegrationTest.t.sol.template +87 -0
  36. package/dist/templates/ExampleUnitTest.t.sol.template +65 -0
  37. package/dist/types/hardhat.d.ts +1 -1
  38. package/dist/types/hardhat.d.ts.map +1 -1
  39. package/dist/types/hardhat.js +1 -0
  40. package/dist/types/hardhat.js.map +1 -1
  41. package/dist/utils/foundry.d.ts +1 -0
  42. package/dist/utils/foundry.d.ts.map +1 -1
  43. package/dist/utils/foundry.js +3 -0
  44. package/dist/utils/foundry.js.map +1 -1
  45. package/package.json +7 -4
  46. package/src/foundry.ts +104 -0
  47. package/src/framework/DeploymentManager.ts +74 -69
  48. package/src/framework/ForgeFuzzingFramework.ts +23 -1
  49. package/src/framework/HelperGenerator.ts +13 -0
  50. package/src/index.ts +0 -5
  51. package/src/tasks/deploy.ts +3 -1
  52. package/src/tasks/generate-helpers.ts +6 -2
  53. package/src/tasks/init.ts +3 -1
  54. package/src/tasks/test.ts +12 -1
  55. package/src/templates/ExampleFuzzTest.t.sol.template +26 -17
  56. package/src/templates/ExampleIntegrationTest.t.sol.template +9 -1
  57. package/src/templates/ExampleUnitTest.t.sol.template +7 -1
  58. package/src/types/hardhat.ts +1 -1
  59. package/src/utils/foundry.ts +5 -0
@@ -3,7 +3,9 @@ pragma solidity ^0.8.0;
3
3
 
4
4
  import "forge-std/Test.sol";
5
5
  import "forge-std/console.sol";
6
- import "../../helpers/DiamondDeployment.sol";
6
+ import "@diamondslab/diamonds-hardhat-foundry/contracts/DiamondForgeHelpers.sol";
7
+ import "@diamondslab/diamonds-hardhat-foundry/contracts/DiamondABILoader.sol";
8
+ import "../helpers/DiamondDeployment.sol";
7
9
 
8
10
  /**
9
11
  * @title ExampleIntegrationTest
@@ -11,6 +13,9 @@ import "../../helpers/DiamondDeployment.sol";
11
13
  * @dev Tests interactions between multiple facets and Diamond functionality
12
14
  */
13
15
  contract ExampleIntegrationTest is Test {
16
+ using DiamondForgeHelpers for address;
17
+ using DiamondABILoader for string;
18
+
14
19
  address diamond;
15
20
  address deployer;
16
21
 
@@ -23,6 +28,9 @@ contract ExampleIntegrationTest is Test {
23
28
  diamond = DiamondDeployment.diamond();
24
29
  deployer = DiamondDeployment.deployer();
25
30
 
31
+ // Validate Diamond
32
+ DiamondForgeHelpers.assertValidDiamond(diamond);
33
+
26
34
  // Set up test users
27
35
  user1 = makeAddr("user1");
28
36
  user2 = makeAddr("user2");
@@ -3,7 +3,8 @@ pragma solidity ^0.8.0;
3
3
 
4
4
  import "forge-std/Test.sol";
5
5
  import "forge-std/console.sol";
6
- import "../../helpers/DiamondDeployment.sol";
6
+ import "@diamondslab/diamonds-hardhat-foundry/contracts/DiamondForgeHelpers.sol";
7
+ import "../helpers/DiamondDeployment.sol";
7
8
 
8
9
  /**
9
10
  * @title ExampleUnitTest
@@ -11,6 +12,8 @@ import "../../helpers/DiamondDeployment.sol";
11
12
  * @dev This is a template - customize for your specific Diamond implementation
12
13
  */
13
14
  contract ExampleUnitTest is Test {
15
+ using DiamondForgeHelpers for address;
16
+
14
17
  address diamond;
15
18
  address deployer;
16
19
 
@@ -21,6 +24,9 @@ contract ExampleUnitTest is Test {
21
24
 
22
25
  console.log("Diamond deployed at:", diamond);
23
26
  console.log("Deployed by:", deployer);
27
+
28
+ // Validate Diamond deployment
29
+ DiamondForgeHelpers.assertValidDiamond(diamond);
24
30
  }
25
31
 
26
32
  /**
@@ -2,6 +2,7 @@
2
2
  * Type extensions for Hardhat Runtime Environment
3
3
  */
4
4
 
5
+ import "@nomicfoundation/hardhat-ethers";
5
6
  import "hardhat/types/config";
6
7
  import "hardhat/types/runtime";
7
8
  import { DiamondsFoundryConfig } from "../types/config";
@@ -19,6 +20,5 @@ declare module "hardhat/types/config" {
19
20
  declare module "hardhat/types/runtime" {
20
21
  export interface HardhatRuntimeEnvironment {
21
22
  diamondsFoundry: Required<DiamondsFoundryConfig>;
22
- ethers: any; // Will be provided by @nomicfoundation/hardhat-ethers
23
23
  }
24
24
  }
@@ -89,6 +89,7 @@ export async function runForgeTest(options: {
89
89
  matchContract?: string;
90
90
  verbosity?: number;
91
91
  gasReport?: boolean;
92
+ forkUrl?: string;
92
93
  cwd?: string;
93
94
  env?: Record<string, string>;
94
95
  }): Promise<{ success: boolean; output: string }> {
@@ -110,6 +111,10 @@ export async function runForgeTest(options: {
110
111
  args.push("--gas-report");
111
112
  }
112
113
 
114
+ if (options.forkUrl) {
115
+ args.push("--fork-url", options.forkUrl);
116
+ }
117
+
113
118
  try {
114
119
  const result = await execForgeAsync("forge", args, {
115
120
  cwd: options.cwd,