feat: Etherform workflow improvements by hudsonhrh · Pull Request #6 · BreadchainCoop/etherform

hudsonhrh · 2025-12-04T19:14:06Z

Summary

Major improvements to Etherform CI/CD workflows including deployment profiles, GitHub Environments support, and robust contract verification.

Features

Deployment Profiles (`deployment-foundry-profile`)

Specify a Foundry profile for deployments while keeping CI tests on default profile
Useful when tests fail with high optimizer settings but production needs optimization
Profile applies to deployment, upgrade safety, verification, and flattening steps
Profile validation catches undefined profiles early with helpful error messages

GitHub Environments Support

Deploy jobs now use environment: from network config for per-network secrets
Restructured workflows with two-job pattern (read-config → deploy) to support environment resolution
Secrets (PRIVATE_KEY, RPC_URL) resolve from GitHub Environments based on "environment" field in deploy-networks.json

Robust Contract Verification

Optional verification: Skip if blockscout_url is omitted/empty in network config
Proper failure handling: Verification step fails when all retries are exhausted
Constructor args from broadcast: Extract actual constructor args from broadcast artifacts instead of guessing
Library-linked contracts: Works with contracts that use external libraries (fixes --guess-constructor-args failures)

Commits

Commit	Description
`3ad9cf8`	Add all-in-one `_foundry-cicd.yml` reusable workflow
`3c3048e`	Add `deployment-foundry-profile` input to all workflows
`58ddecd`	Document deployment profiles in README
`77f745e`	Make Blockscout verification optional
`9d2381f`	Fix verification to actually fail when retries exhausted
`7b38f11`	Pass RPC_URL to verification (required for `--guess-constructor-args`)
`b9a5466`	Add GitHub Environments support for per-network secrets
`f5b700a`	Use broadcast artifacts for constructor args in verification
`e82dcdb`	Fix jq parse errors with robust arg handling

Usage

jobs:
  deploy:
    uses: BreadchainCoop/etherform/.github/workflows/_foundry-cicd.yml@main
    with:
      deployment-foundry-profile: 'production'
      deploy-on-pr: true
    secrets:
      PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
      RPC_URL: ${{ secrets.RPC_URL }}

Network config with environments:

{
  "testnets": [{
    "name": "sepolia",
    "blockscout_url": "https://eth-sepolia.blockscout.com",
    "environment": "testnet-sepolia"
  }],
  "mainnets": [{
    "name": "ethereum",
    "blockscout_url": "https://eth.blockscout.com",
    "environment": "production-ethereum"
  }]
}

closes #8, closes #7, closes #4

Tested with integration wit this repo https://github.com/PerpetualOrganizationArchitect/POP/actions/runs/19974105263/job/57286120003?pr=54
🤖 Generated with Claude Code

Add ability to specify a Foundry profile when integrating Etherform workflows. The profile applies to deployment, upgrade safety, and verification steps, while CI tests run with the default profile (optimizer off) to avoid test failures. Profile validation catches undefined profiles early with helpful error messages. 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>

🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>

Verification is now skipped if blockscout_url is not set in network config. This allows deploying to networks without Blockscout support. 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>

Uses process substitution instead of pipe to properly track failures across loop iterations. The step now exits with error code 1 when any contract fails verification after 3 attempts. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

The --guess-constructor-args flag requires an RPC URL to fetch deployed bytecode and determine constructor arguments. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

- Restructure _deploy-testnet.yml into two jobs (read-config + deploy) so environment: can reference the config output - Add read-testnet-config and read-mainnet-config jobs to _foundry-cicd.yml - Deploy jobs now use environment: from network config for secret resolution - Secrets (PRIVATE_KEY, RPC_URL) now resolve from GitHub Environments based on the "environment" field in deploy-networks.json 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

Replace --guess-constructor-args with explicit constructor args extracted from broadcast file. This fixes verification for contracts that use external libraries. Changes: - Extract .arguments from broadcast transactions - Get constructor signature from contract ABI via forge inspect - Encode args with cast abi-encode - Pass encoded args to forge verify-contract --constructor-args - Remove --rpc-url (only needed for guessing) - Gracefully handle contracts without constructor args 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

Fix jq parse errors when processing constructor arguments: - Use jq -e to safely check if arguments array exists - Validate ABI JSON before parsing - Use mapfile to properly handle args with special characters - Pass args as bash array to preserve quoting for cast abi-encode This fixes "Invalid numeric literal" errors when arguments contain hex addresses. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

Convert multiline contract-paths input to properly formatted YAML list for dorny/paths-filter. This fixes the error: "can not read a block mapping entry; a multiline key may not be an implicit key" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

RonTuretzky · 2025-12-07T00:58:35Z

@hudsonhrh can you demonstarte this working with a pr to the foundry-counter-upgradeable repo and include it in here?

RonTuretzky

please rebase off of #13

RonTuretzky · 2025-12-07T00:59:07Z

.github/workflows/_deploy-mainnet.yml


          # Extract and verify each deployed contract with retry logic
-          jq -c '.transactions[] | select(.transactionType == "CREATE")' "$BROADCAST_FILE" | while read -r tx; do
+          # Use process substitution to avoid subshell issues with variable tracking


what is this change? why is it necessary?

RonTuretzky · 2025-12-07T00:59:36Z

.github/workflows/_deploy-mainnet.yml


            echo "Verifying $CONTRACT_NAME at $CONTRACT_ADDR..."

+            # Build constructor args if present


is this info not in the run-latest json?

RonTuretzky · 2025-12-07T01:00:12Z

.github/workflows/_deploy-testnet.yml

 jobs:
-  deploy-testnet:
-    name: Deploy to Testnet
+  read-config:


are we decoupling this so that it can be re-used for testnet/mainnet?

hudsonhrh force-pushed the foundry-profile-input branch from c5a35b6 to 3c3048e Compare December 4, 2025 19:35

hudsonhrh and others added 7 commits December 4, 2025 14:50

docs: add deployment-foundry-profile documentation

58ddecd

🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>

feat: make blockscout verification optional

77f745e

Verification is now skipped if blockscout_url is not set in network config. This allows deploying to networks without Blockscout support. 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>

hudsonhrh changed the title ~~feat: add foundry-profile input to workflows~~ feat: Etherform workflow improvements Dec 5, 2025

hudsonhrh requested review from RonTuretzky and franrolotti December 5, 2025 20:08

hudsonhrh and others added 2 commits December 6, 2025 00:27

Merge branch 'main' into foundry-profile-input

b0f54ff

RonTuretzky requested changes Dec 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Etherform workflow improvements#6

feat: Etherform workflow improvements#6
hudsonhrh wants to merge 10 commits intomainfrom
foundry-profile-input

hudsonhrh commented Dec 4, 2025 •

edited

Loading

Uh oh!

RonTuretzky commented Dec 7, 2025

Uh oh!

RonTuretzky left a comment

Uh oh!

RonTuretzky Dec 7, 2025

Uh oh!

RonTuretzky Dec 7, 2025

Uh oh!

RonTuretzky Dec 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		echo "Verifying $CONTRACT_NAME at $CONTRACT_ADDR..."

		# Build constructor args if present

Conversation

hudsonhrh commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Features

Deployment Profiles (deployment-foundry-profile)

GitHub Environments Support

Robust Contract Verification

Commits

Usage

Uh oh!

RonTuretzky commented Dec 7, 2025

Uh oh!

RonTuretzky left a comment

Choose a reason for hiding this comment

Uh oh!

RonTuretzky Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

RonTuretzky Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

RonTuretzky Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hudsonhrh commented Dec 4, 2025 •

edited

Loading

Deployment Profiles (`deployment-foundry-profile`)