Skip to content

Commit f7a8a05

Browse files
committed
refactor: enhance comments for deployment artifacts and writeBack function
1 parent c72f295 commit f7a8a05

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

script/DeployAll.s.sol

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,13 @@ import {IIBCModuleInitializer} from "@hyperledger-labs/yui-ibc-solidity/contract
3939
import {ILightClient} from "@hyperledger-labs/yui-ibc-solidity/contracts/core/02-client/ILightClient.sol";
4040

4141
contract DeployAll is Script, Config {
42+
// === Deployment artifacts (written back to deployments.toml) ===
4243
IBCHandler public ibcHandler;
4344
MockCrossContract public mockApp;
4445
CrossSimpleModule public crossSimpleModule;
4546
MockClient public mockClient;
4647

48+
// ---------- helpers ----------
4749
function _deployCore() internal returns (IBCHandler) {
4850
console2.log("==> 01_DeployCore");
4951
IBCHandler handler = new IBCHandler(
@@ -148,14 +150,19 @@ contract DeployAll is Script, Config {
148150
}
149151

150152
function _writeBack(address deployer) internal {
153+
// save addresses & metadata to deployments.toml
154+
// (addresses go under <chain>.address.*, meta under <chain>.meta.*)
151155
config.set("ibc_handler", address(ibcHandler));
152156
config.set("mock_cross_contract", address(mockApp));
153157
config.set("cross_simple_module", address(crossSimpleModule));
154158
config.set("mock_client", address(mockClient));
159+
160+
// Meta
155161
config.set("deployer", deployer);
156162
console2.log("\nDeployment complete! Addresses saved to deployments.toml");
157163
}
158164

165+
// ---------- entry ----------
159166
function run() external {
160167
_loadConfig("./deployments.toml", true);
161168

0 commit comments

Comments
 (0)