Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add DeploymentConfig for network specifc deployments #5

Merged
merged 1 commit into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion script/Deploy.s.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ pragma solidity >=0.8.19 <=0.9.0;

import { Foo } from "../src/Foo.sol";
import { BaseScript } from "./Base.s.sol";
import { DeploymentConfig } from "./DeploymentConfig.s.sol";

contract Deploy is BaseScript {
function run() public broadcast returns (Foo foo) {
function run() public returns (Foo foo, DeploymentConfig deploymentConfig) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, last question - what does the broadcast keyword specify?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

broadcast is a modifier that wraps the function in vm.startBroadcast() and vm.stopBroadcast().

Anything that happens inside these are tx that are broadcast to the network.
We don't want the instantiation of DeploymentConfig() to happen onchain, we only need it to access our configuration values.

That's why I'm removing the broadcast from the main deploy script's run() function. This gives us control over which action should indeed be broadcast.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, okay!

deploymentConfig = new DeploymentConfig(broadcaster);
foo = new Foo();
}
}
39 changes: 39 additions & 0 deletions script/DeploymentConfig.s.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
//// SPDX-License-Identifier: UNLICENSED

pragma solidity >=0.8.19 <=0.9.0;

import { Script } from "forge-std/Script.sol";

contract DeploymentConfig is Script {
error DeploymentConfig_InvalidDeployerAddress();
error DeploymentConfig_NoConfigForChain(uint256);

struct NetworkConfig {
address deployer;
}

NetworkConfig public activeNetworkConfig;

address private deployer;

constructor(address _broadcaster) {
if (block.chainid == 31_337) {
activeNetworkConfig = getOrCreateAnvilEthConfig();
} else {
revert DeploymentConfig_NoConfigForChain(block.chainid);
}
if (_broadcaster == address(0)) revert DeploymentConfig_InvalidDeployerAddress();
deployer = _broadcaster;
}

function getOrCreateAnvilEthConfig() public view returns (NetworkConfig memory) {
return NetworkConfig({ deployer: deployer });
}

// This function is a hack to have it excluded by `forge coverage` until
// https://github.com/foundry-rs/foundry/issues/2988 is fixed.
// See: https://github.com/foundry-rs/foundry/issues/2988#issuecomment-1437784542
// for more info.
// solhint-disable-next-line
function test() public { }
}
8 changes: 7 additions & 1 deletion test/Foo.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,19 @@ pragma solidity >=0.8.19 <0.9.0;

import { Test, console } from "forge-std/Test.sol";

import { Deploy } from "../script/Deploy.s.sol";
import { DeploymentConfig } from "../script/DeploymentConfig.s.sol";
import { Foo } from "../src/Foo.sol";

contract FooTest is Test {
Foo internal foo;
DeploymentConfig internal deploymentConfig;

address internal deployer;

function setUp() public virtual {
foo = new Foo();
Deploy deployment = new Deploy();
(foo, deploymentConfig) = deployment.run();
}

function test_Example() external {
Expand Down