feat: Added foundry deploy script #1044

fusmanii · 2025-06-11T19:32:06Z

First attempt at deploy script migration to foundry. Just did one deploy script and looking for feedback.

List of changes:

Created DeployHubPool.s.sol and script/DeployEthereumSpokePool.s.sol inside script folder
Created DeployConstants.sol inside script folder that works similar to deploy/consts.ts by providing third party smart contract addresses
Created DeploymentUtils.sol inside script that works similar to utils/utils.hre.ts
Contract can be deployed using forge script script/DeployHubPool.s.sol:DeployHubPool --rpc-url $RPC_URL --broadcast --verify -vvvv which deploys and verifies the contract and adds the deploy info in the broadcast folder
Created a script script/extract_foundry_addresses.sh that extracts all the deployed addresses from the broadcast folder and puts it in a json, an md file and a sol file (similar to deployments.json)

Looking for feedback on the proposed flow and how I can make this better and address some of the short comings of the current deployment flow

Fixes https://linear.app/uma/issue/UMA-2906/contracts-migrate-smart-contract-deploy-to-foundry

nicholaspai · 2025-06-11T19:38:35Z

broadcast/deployed-addresses.md

+
+## Mainnet (Chain ID: 1)
+
+### DeployPermissionSplitterProxy.s.sol


Are these just examples or does this .md file also get auto updated?

This file also gets auto updated (which is a bit easier to read than the json file)

nicholaspai · 2025-06-11T19:50:11Z

script/ExtractDeployedFoundryAddresses.py

+from pathlib import Path
+
+
+def find_broadcast_files(broadcast_dir: Path) -> list:


Can this script run well in the github CI? I think that'd be an ideal end result of this script. Also I know you're probably more familiar with python but does this script require other dependencies? I am wary of adding more dependencies especially since we already have typescript set up..but its not a big deal. This file so far isn't part of the CI/hot path so its fine

changed it to a ts script instead

nicholaspai

I think this is a great start.

script/DeployConstants.sol

mrice32 · 2025-06-20T15:16:23Z

script/ExtractDeployedFoundryAddresses.py

@@ -0,0 +1,223 @@
+#!/usr/bin/env python3


Why python?

changed it to ts

mrice32 · 2025-06-20T15:33:23Z

script/DeployConstants.sol

+
+/**
+ * @title DeployConstants
+ * @notice Contains constants used in deployment scripts, converted from consts.ts


Could we read this in via one or more json configuration files? Two advantages:

Config/code split so it's clear (in the future) which changes are configuration and which changes are logical.

More flexibility: it will allow us to pull in this info from somewhere else easily. For instance, the json could be generated/updated from an API OR we could import one or more of the config jsons from a common package (like our constants package or something).

Thoughts?

Mainly because dealing with json inside a foundry script is not trivial, I also have deployed-addresses.json that is generated regarding your second point

Don't they have utilities for that that makes it fairly trivial if the json is well structured? I may be missing some additional complexity (I haven't tried to use these utils before)

https://getfoundry.sh/reference/cheatcodes/parse-json/?highlight=json
https://getfoundry.sh/reference/cheatcodes/parse-json-keys

updated to using perse-json, much cleaner now :)

Thoughts on expanding this, s.t. the Constants.sol values are read in from json as well?

Constants are currently in a ts file, but I can create a json for constants that Constants.sol uses

socket-security · 2025-06-22T19:42:03Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@openzeppelin/foundry-upgrades@0.4.0

View full report

Signed-off-by: Faisal Usmani <[email protected]>

linear · 2025-06-23T15:16:56Z

UMA-2906 [contracts] Migrate smart contract deploy to foundry

bmzig · 2025-06-23T15:36:55Z

script/Constants.sol

+    WETH9Interface constant WETH_SCROLL = WETH9Interface(0x5300000000000000000000000000000000000004);
+    WETH9Interface constant WETH_UNICHAIN = WETH9Interface(0x4200000000000000000000000000000000000006);
+    WETH9Interface constant WETH_UNICHAIN_SEPOLIA = WETH9Interface(0x4200000000000000000000000000000000000006);
+    WETH9Interface constant WETH_ALEPH_ZERO = WETH9Interface(0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2); // Assuming bridged WETH


This also looks wrong. Maybe we should name this wrapped native token so that it aligns with the var names in the spoke pool constructors (same thing with getWethAddress() below).

Nice catch, updated and renamed to WRAPPED_NATIVE_TOKEN_{CHAINNAME}

bmzig · 2025-06-23T15:36:56Z

script/Constants.sol

+    WETH9Interface constant WETH_OPTIMISM_SEPOLIA = WETH9Interface(0x4200000000000000000000000000000000000006);
+    WETH9Interface constant WETH_BASE = WETH9Interface(0x4200000000000000000000000000000000000006);
+    WETH9Interface constant WETH_BASE_SEPOLIA = WETH9Interface(0x4200000000000000000000000000000000000006);
+    WETH9Interface constant WETH_LENS = WETH9Interface(0x4200000000000000000000000000000000000006);


Suggested change

WETH9Interface constant WETH_LENS = WETH9Interface(0x4200000000000000000000000000000000000006);

WETH9Interface constant WETH_LENS = WETH9Interface(0xE5ecd226b3032910CEaa43ba92EE8232f8237553);

mrice32

#1044 (comment)

Signed-off-by: Faisal Usmani <[email protected]>

fusmanii requested review from mrice32, nicholaspai, pxrl and bmzig as code owners June 11, 2025 19:32

fusmanii force-pushed the fusmanii/foundry-deploy-scripts branch from 64e7247 to 7ebdaf8 Compare June 11, 2025 19:33

nicholaspai reviewed Jun 11, 2025

View reviewed changes

nicholaspai previously approved these changes Jun 11, 2025

View reviewed changes

bmzig reviewed Jun 12, 2025

View reviewed changes

script/DeployConstants.sol Outdated Show resolved Hide resolved

bmzig reviewed Jun 12, 2025

View reviewed changes

script/DeployConstants.sol Outdated Show resolved Hide resolved

fusmanii changed the title ~~feat: Added foundry deploy script for HubPool~~ WIP: Added foundry deploy script for HubPool Jun 13, 2025

fusmanii marked this pull request as draft June 13, 2025 15:15

fusmanii dismissed nicholaspai’s stale review via cb6317a June 18, 2025 18:28

mrice32 reviewed Jun 20, 2025

View reviewed changes

grasphoper self-requested a review June 20, 2025 15:20

mrice32 reviewed Jun 20, 2025

View reviewed changes

fusmanii added 13 commits June 22, 2025 15:43

feat: Added foundry deploy script for HubPool

a8bfb9d

Signed-off-by: Faisal Usmani <[email protected]>

feat: Removed historical deploys from broadcast folder

32879ba

Signed-off-by: Faisal Usmani <[email protected]>

feat: updated gitignore to not add historical deploys

cfe11db

Signed-off-by: Faisal Usmani <[email protected]>

feat: added extract addresses script

3dd83bf

Signed-off-by: Faisal Usmani <[email protected]>

feat: Updated deploy constants to be local vars instad of structs

a425c6a

Signed-off-by: Faisal Usmani <[email protected]>

fix: renamed files to match existing standard

7b5ff5d

Signed-off-by: Faisal Usmani <[email protected]>

feat: Update foundry-std and install OZ upgrades

c324691

Signed-off-by: Faisal Usmani <[email protected]>

feat: Update to forge-std

8c8231f

Signed-off-by: Faisal Usmani <[email protected]>

Moved openzeppelin foundry ungrades back to npm

e9146a7

Signed-off-by: Faisal Usmani <[email protected]>

Changed extract address script to ts

4e8ae8d

Signed-off-by: Faisal Usmani <[email protected]>

Changed foundry output folder to not conflict with harhat

87fbe9c

Signed-off-by: Faisal Usmani <[email protected]>

Removed unused import

cdb774b

Signed-off-by: Faisal Usmani <[email protected]>

Added @openzeppelin/foundry-upgrades

f74851d

Signed-off-by: Faisal Usmani <[email protected]>

fusmanii added 2 commits June 22, 2025 15:43

Added ethereum spoke pool deploy script

c3b5639

Signed-off-by: Faisal Usmani <[email protected]>

Added foundry readmy

84ccd43

Signed-off-by: Faisal Usmani <[email protected]>

fusmanii force-pushed the fusmanii/foundry-deploy-scripts branch from 72e2502 to 84ccd43 Compare June 22, 2025 19:43

fusmanii changed the title ~~WIP: Added foundry deploy script for HubPool~~ feat: Added foundry deploy script for HubPool Jun 23, 2025

fusmanii marked this pull request as ready for review June 23, 2025 13:56

fusmanii requested review from bmzig, mrice32 and nicholaspai June 23, 2025 14:47

fusmanii changed the title ~~feat: Added foundry deploy script for HubPool~~ feat: Added foundry deploy script Jun 23, 2025

bmzig reviewed Jun 23, 2025

View reviewed changes

mrice32 reviewed Jun 23, 2025

View reviewed changes

fusmanii added 4 commits June 24, 2025 11:24

Using parseJson instead of hardcoding addresses

f5b6acf

Signed-off-by: Faisal Usmani <[email protected]>

Fixed WETH address typos

f63964e

Signed-off-by: Faisal Usmani <[email protected]>

Updated added out folder to clean script command

2cd1c3d

Signed-off-by: Faisal Usmani <[email protected]>

Updated Readme

6b82900

Signed-off-by: Faisal Usmani <[email protected]>

fusmanii force-pushed the fusmanii/foundry-deploy-scripts branch from 1a9787a to 6b82900 Compare June 24, 2025 15:24

fusmanii added 2 commits June 30, 2025 10:55

Moved cosntants to json file

8c4f90d

Signed-off-by: Faisal Usmani <[email protected]>

Fixed script that use the contracts script

6aec3c4

Signed-off-by: Faisal Usmani <[email protected]>

fusmanii force-pushed the fusmanii/foundry-deploy-scripts branch from 300516f to 6aec3c4 Compare June 30, 2025 14:55

fusmanii requested review from bmzig and mrice32 June 30, 2025 14:57


		## Mainnet (Chain ID: 1)

		### DeployPermissionSplitterProxy.s.sol

		from pathlib import Path


		def find_broadcast_files(broadcast_dir: Path) -> list:

	WETH9Interface constant WETH_LENS = WETH9Interface(0x4200000000000000000000000000000000000006);
	WETH9Interface constant WETH_LENS = WETH9Interface(0xE5ecd226b3032910CEaa43ba92EE8232f8237553);

feat: Added foundry deploy script #1044

Are you sure you want to change the base?

feat: Added foundry deploy script #1044

Uh oh!

Conversation

fusmanii commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicholaspai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrice32 Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrice32 Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

socket-security bot commented Jun 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linear bot commented Jun 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrice32 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fusmanii commented Jun 11, 2025 •

edited

Loading

mrice32 Jun 23, 2025 •

edited

Loading

mrice32 Jun 25, 2025 •

edited

Loading

socket-security bot commented Jun 22, 2025 •

edited

Loading