A cli and associated contracts to keep track of deployments by name and reuse them in solidity.
It tries to keep compatibility with hardhat-deploy as far as possible (work in progress).
forge-deploy aims at providing the minimal set of function to provide an elegant deployment system for foundry.
The system is modular. The deploy functions provided by default offer a basic set of feature but the system can be extended by custom function easily. See contracts/DefaultDeployerFunction.sol and how this is a simple library that you can provide yourself. The only thing forge-deploy really provide is the specific set of functions in contrats/Deployer.sol to save and get deployments
have a forge project and cd into it
bash
mkdir my-project;
cd my-project;
forge init;
add the forge-deploy package
bash
forge install wighawag/forge-deploy@v0.0.15;
build the cli directly from lib/forge-deploy
bash
cd lib/forge-deploy;
cargo build --release;
cp target/release/forge-deploy ../../forge-deploy;
In the last step above, we also copy it in the project folder for easy access;
This way you can then execute it via the following:
bash
./forge-deploy <command>
add to .gitignore the generated file + the binary we just installed
```bash
cat >> .gitignore < /generated
/deployments/localhost
/deployments/31337 /forge-deploy
EOF
```forge-deploy
forge-deploy cli binary
generate the type-safe deployment functions
bash
./forge-deploy gen-deployer;
add a deploy script
add the file script/Deploy.s.sol with this content:
```solidity // SPDX-License-Identifier: UNLICENSED pragma solidity ^0.8.13;
import "forge-deploy/DeployScript.sol"; import "generated/deployer/DeployerFunctions.g.sol";
contract Deployments is DeployScript { using DeployerFunctions for Deployer;
function deploy() external returns (Counter) { return deployer.deploy_Counter("MyCounter"); } } ```
The deploy function will be called and as the script extends DeployScript (which itself extends Script from forge-std) you ll have access to the deployer variable.
This variable mostly expose save and get functions. Deploy functionality is actually implemented in library like the one provided here: "DeployerFunctions.g.sol", which is actually generated code from the command above: ./forge-deploy gen-deployer;
you also need to allow forge to read and write on certain paths by editing foundry.toml:
```bash
cat >> foundry.toml < fs_permissions = [
{ access = "read", path = "./deployments"},
{ access = "read", path = "./out"},
{ access = "read", path = "./contexts.json"}
]
EOF
``` You might wonder what contexts.json. This is a configuration file. Its name might change in the future, but as of now, it let you configure context (like localhost, sepolia, mainnet) and specify a list of tags that you can then use in your deploy script to trigger diferent execution path.
You can now execute the script via forge script
Note that you need to execute ./forge-deploy sync directly afterward
For example:
bash
forge script script/Counter.s.sol --rpc-url $RPC_URL --broadcast --private-key $DEPLOYER_PRIVATE_KEY -v && ./forge-deploy sync;
with anvil and default account
bash
DEPLOYMENT_CONTEXT=localhost forge script script/Counter.s.sol --rpc-url http://localhost:8545 --broadcast --private-key ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 -v && ./forge-deploy sync;
Note that here we specify the DEPLOYMENT_CONTEXT env variable. This is necessary for localhost which use chain id 31337 as by default forge-deploy will not save the deployment on that chainId (same for 1337). This is so it does not interfere with in-memory tests which also use chainId=31337
The DEPLOYMENT_CONTEXT env var also allows you to segregate different deployment context on the same network. If not specified, the context is the chainId
If you use just, see example in examples/basic with its own justfile
Get anvil started somewhere:
bash
anvil;
then copy and execute this and see the result
```bash
mkdir my-forge-deploy-project;
cd my-forge-deploy-project;
forge init;
forge install wighawag/forge-deploy@v0.0.15;
cd lib/forge-deploy;
cargo build --release;
cp target/release/forge-deploy ../../forge-deploy;
cd ../..;
cat >> foundry.toml < fs_permissions = [
{ access = "read", path = "./deployments"},
{ access = "read", path = "./out"},
{ access = "read", path = "./contexts.json"}
]
EOF
cat >> .gitignore < /generated
/deployments/localhost
/deployments/31337 EOF
./forge-deploy gen-deployer;
cat > script/Deploy.s.sol < import "forge-deploy/DeployScript.sol";
import "generated/deployer/DeployerFunctions.g.sol"; contract Deployments is DeployScript {
using DeployerFunctions for Deployer; }
EOF
DEPLOYMENT_CONTEXT=localhost forge script script/Deploy.s.sol --rpc-url http://localhost:8545 --broadcast --private-key ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 -v && ./forge-deploy sync;
``` One great feature of forge's script that remains in forge-deploy is the ability to use script in tests. This allow you to have your deployment procedure reusable in tests! for example, here is a basic test for Counter. Copy the following content in the existing test/Counter.t.sol and run the test to see it in action: As usual to run the tests you can do the following: Note that the generated solidity is optional. You can instead simply use the default deploy function ```solidity
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.13; import "forge-deploy/DeployScript.sol";
import "forge-deploy/DefaultDeployerFunction.sol";
import "../src/Counter.sol"; contract Deployments is DeployScript {
using DefaultDeployerFunction for Deployer; }
```forge-deploy
function deploy() external returns (Counter) {
return deployer.deploy_Counter("MyCounter");
}
Reusable in tests
solidity
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.13;
import "forge-std/Test.sol";
import "../src/Counter.sol";
import "../script/Deploy.s.sol";
contract CounterTest is Test {
Counter public counter;
function setUp() public {
counter = new Deployments().deploy();
counter.setNumber(0);
}
function testIncrement() public {
counter.increment();
assertEq(counter.number(), 1);
}
function testSetNumber(uint256 x) public {
counter.setNumber(x);
assertEq(counter.number(), x);
}
}
forge test
More info
function deploy() external returns (Counter) {
return Counter(
deployer.deploy(
"MyCounter",
"Counter.sol:Counter", // forge's artifact id
"", // no arguments: empty bytes
DeployOptions({
deterministic: 0, // 0 => no deterministic
proxyOnTag: "", // empty string => no proxy
proxyOwner: address(0)
})
)
);
}