feat: enhance deployment artifacts with ABI, bytecode, and metadata (#3618)

Author: silva-fj

tee-worker/omni-executor/aa-contracts/.env.example

@@ -0,0 +1,21 @@
+# Remote deployment configuration example
+# Copy this file to .env and fill in your values
+
+# Required for remote deployments
+RPC_URL=https://eth-sepolia.g.alchemy.com/v2/YOUR_API_KEY
+PRIVATE_KEY=0xYOUR_PRIVATE_KEY
+
+# Optional: For contract verification
+ETHERSCAN_API_KEY=YOUR_ETHERSCAN_API_KEY
+
+# Optional: Environment configuration
+# Valid values: local, staging, production
+# If not set, deployment artifacts will use flat structure for backward compatibility
+DEPLOYMENT_ENV=staging
+
+# Optional: Paymaster configuration
+# Initial deposit amount in wei (default: 1 ether)
+PAYMASTER_INITIAL_DEPOSIT=1000000000000000000
+
+# Optional: Initial bundler address (default: deployer address)
+INITIAL_BUNDLER=0xYOUR_BUNDLER_ADDRESS

tee-worker/omni-executor/aa-contracts/.gitignore

@@ -15,4 +15,6 @@ docs/
 .env
 .env.*
 broadcast/
-deployments/local.json
+
+# Deployment artifacts
+deployments/local/

tee-worker/omni-executor/aa-contracts/DEPLOYMENT.md

@@ -5,8 +5,8 @@ This guide provides comprehensive instructions for deploying Account Abstraction
 ## 📋 Overview
 
 The deployment script deploys three core contracts:
-- **EntryPoint**: The main entry point for ERC-4337 user operations
-- **OmniAccountFactory**: Factory contract for creating OmniAccount smart wallets
+- **EntryPointV1**: The main entry point for ERC-4337 user operations
+- **OmniAccountFactoryV1**: Factory contract for creating OmniAccount smart wallets
 - **SimplePaymaster**: Paymaster contract for sponsoring transactions
 
 ## 🔧 Prerequisites
@@ -30,13 +30,17 @@ The script automatically detects and configures for these networks:
 
 | Network | Chain ID |  Filename |
 |---------|----------|----------|
-| Ethereum Mainnet | 1 | `mainnet.json` |
-| Ethereum Sepolia | 11155111 | `sepolia.json` |
+| Ethereum Mainnet | 1 | `ethereum.json` |
+| Ethereum Sepolia | 11155111 | `ethereum-sepolia.json` |
+| Arbitrum Mainnet | 42161 | `arbitrum.json` |
+| Arbitrum Sepolia | 421614 | `arbitrum-sepolia.json` |
 | BSC Mainnet | 56 | `bsc.json` |
 | BSC Testnet | 97 | `bsc-testnet.json` |
 | Polygon Mainnet | 137 | `polygon.json` |
-| Polygon Mumbai | 80001 | `mumbai.json` |
-| Local Anvil | 1337 | `local.json` |
+| Polygon Mumbai | 80001 | `polygon-mumbai.json` |
+| HyperEVM Mainnet | 999 | `hyperevm.json` |
+| HyperEVM Testnet | 998 | `hyperevm-testnet.json` |
+| Local Anvil | 1337/31337 | `local.json` |
 
 ## ⚙️ Configuration
 
@@ -54,6 +58,7 @@ PAYMASTER_INITIAL_DEPOSIT=1000000000000000000  # 1 ETH in wei (default: 1 ETH)
 INITIALIZE_PAYMASTER=true                      # Whether to initialize paymaster (default: true)
 INITIAL_BUNDLER=0x1234567890abcdef...          # Initial bundler address (default: deployer)
 SAVE_DEPLOYMENT_FILE=true                      # Save deployment file (default: false, set true for official deployments)
+DEPLOYMENT_ENV=staging                         # Environment subdirectory (e.g., staging, production)
 ETHERSCAN_API_KEY=ABC123                       # For contract verification
 ```
 
@@ -73,6 +78,24 @@ forge script script/Deploy.s.sol:Deploy \
     -vvv
 ```
 
+### Using Remote Deployment Script (Recommended)
+
+The `deploy-remote.sh` script handles deployment and automatic ABI enrichment:
+
+```bash
+# Set environment variables in .env
+DEPLOYMENT_ENV=staging  # Optional: staging, production, etc.
+
+# Run the deployment script
+./deploy-remote.sh
+```
+
+This script will:
+1. Deploy all contracts to the specified network
+2. Save enhanced artifacts with addresses and bytecode
+3. Automatically enrich artifacts with ABIs from Foundry build outputs
+4. Save to `deployments/[environment]/[network].json`
+
 
 ### Ethereum Mainnet with Verification
 ```bash
@@ -98,11 +121,11 @@ Chain ID: 97
 Deployer address: 0x...
 Deployer balance: 1.5 ETH
 
-🚀 Deploying EntryPoint...
-✅ EntryPoint deployed at: 0x...
+🚀 Deploying EntryPointV1...
+✅ EntryPointV1 deployed at: 0x...
 
-🚀 Deploying OmniAccountFactory...
-✅ OmniAccountFactory deployed at: 0x...
+🚀 Deploying OmniAccountFactoryV1...
+✅ OmniAccountFactoryV1 deployed at: 0x...
 
 🚀 Deploying SimplePaymaster...
 ✅ SimplePaymaster deployed at: 0x...
@@ -112,33 +135,73 @@ Deployer balance: 1.5 ETH
 
 === DEPLOYMENT COMPLETE ===
 📋 Contract Addresses:
-EntryPoint:          0x...
-OmniAccountFactory:  0x...
-SimplePaymaster:     0x...
+EntryPointV1:          0x...
+OmniAccountFactoryV1:  0x...
+SimplePaymaster:       0x...
 ```
 
-### JSON File
-Location: `deployments/bsc-testnet.json`
+### JSON File (Enhanced Artifacts)
+Location: `deployments/[environment]/[network].json` (e.g., `deployments/staging/bsc-testnet.json`)
+
 ```json
 {
   "network": "BSC Testnet",
   "chainId": 97,
   "timestamp": 1703001234,
+  "blockNumber": 123456,
   "deployer": "0x...",
   "contracts": {
-    "EntryPoint": "0x...",
-    "OmniAccountFactory": "0x...",
-    "SimplePaymaster": "0x..."
+    "EntryPointV1": {
+      "address": "0x...",
+      "abi": [...],  // Full contract ABI
+      "bytecode": "0x608060...",  // Deployed bytecode
+      "metadata": {}
+    },
+    "OmniAccountFactoryV1": {
+      "address": "0x...",
+      "abi": [...],
+      "bytecode": "0x608060...",
+      "metadata": {}
+    },
+    "SimplePaymaster": {
+      "address": "0x...",
+      "abi": [...],
+      "bytecode": "0x608060...",
+      "metadata": {
+        "initialBundler": "0x..."
+      }
+    }
   }
 }
 ```
 
+The artifacts are saved in environment-based subdirectories:
+- **Local**: `deployments/local/`
+- **Staging**: `deployments/staging/`
+- **Production**: `deployments/production/`
+- **No environment**: `deployments/` (backward compatible)
+
 ### Broadcast Files
 Foundry creates detailed transaction logs in:
 ```
 broadcast/Deploy.s.sol/[CHAIN_ID]/run-latest.json
 ```
 
+## 📝 ABI Enrichment
+
+The deployment scripts automatically enrich artifacts with contract ABIs after deployment. If this fails or you need to manually enrich:
+
+```bash
+# Run the ABI enrichment script
+node extract-abis.js
+```
+
+This script:
+- Reads all deployment files from `deployments/`
+- Extracts ABIs from Foundry build artifacts
+- Updates deployment files with full contract ABIs
+- Handles both old (address-only) and new (enhanced) formats
+
 ## 🔍 Contract Verification
 
 ### Automatic Verification
@@ -157,20 +220,20 @@ forge script script/Deploy.s.sol:Deploy \
 If automatic verification fails:
 
 ```bash
-# Verify EntryPoint
+# Verify EntryPointV1
 forge verify-contract \
     --chain-id [CHAIN_ID] \
     --constructor-args $(cast abi-encode "constructor()") \
     [ENTRYPOINT_ADDRESS] \
-    src/core/EntryPoint.sol:EntryPoint \
+    src/core/EntryPointV1.sol:EntryPointV1 \
     --etherscan-api-key $ETHERSCAN_API_KEY
 
 # Verify Factory
 forge verify-contract \
     --chain-id [CHAIN_ID] \
     --constructor-args $(cast abi-encode "constructor(address)" [ENTRYPOINT_ADDRESS]) \
     [FACTORY_ADDRESS] \
-    src/accounts/OmniAccountFactory.sol:OmniAccountFactory \
+    src/accounts/OmniAccountFactoryV1.sol:OmniAccountFactoryV1 \
     --etherscan-api-key $ETHERSCAN_API_KEY
 
 # Verify Paymaster
@@ -186,18 +249,32 @@ forge verify-contract \
 
 ### Deployment Files Management
 
-The script can optionally create deployment files in `deployments/` folder when `SAVE_DEPLOYMENT_FILE=true`. For official deployments:
+The script creates enhanced deployment files when `SAVE_DEPLOYMENT_FILE=true`. For official deployments:
 
 ```bash
 # After successful deployment, commit only official deployment files
-git add deployments/mainnet.json     # For Ethereum mainnet
-git add deployments/bsc.json         # For BSC mainnet  
-git add deployments/bsc-testnet.json # For BSC testnet (if official)
+git add deployments/production/ethereum.json     # For Ethereum mainnet
+git add deployments/production/arbitrum.json     # For Arbitrum mainnet
+git add deployments/staging/bsc-testnet.json     # For BSC testnet staging
 git commit -m "Deploy AA contracts to mainnet"
 
 # Tag official releases
 git tag v1.0.0-mainnet
 git push origin v1.0.0-mainnet
 ```
 
+### Using Deployment Artifacts
+
+```javascript
+// Load deployment artifacts in your application
+const deployment = require('./deployments/staging/arbitrum-sepolia.json');
+
+// Access contract addresses and ABIs
+const entryPointAddress = deployment.contracts.EntryPointV1.address;
+const entryPointABI = deployment.contracts.EntryPointV1.abi;
+
+// Create contract instance (ethers.js example)
+const entryPoint = new ethers.Contract(entryPointAddress, entryPointABI, provider);
+```
+
 **Note**: The `broadcast/` folder is in `.gitignore` and should not be committed as it contains transaction details that change with each deployment run.

tee-worker/omni-executor/aa-contracts/README.md

@@ -5,7 +5,7 @@ Contains Solidity code for ERC-4337 Account Abstraction.
 This project includes code from https://github.com/eth-infinitism/account-abstraction git commit sha: cc3893bcaf2272c163ce89d5eb9eadb8e6b52db7
 licensed under the GNU General Public License v3.0.
 
-## Compiling 
+## Compiling
 
 `forge compile`
 
@@ -29,4 +29,99 @@ This script will:
 
 The script keeps Anvil running after deployment. Press Ctrl+C to stop both the script and Anvil.
 
-Also see [DEPLOYMENT.md](./DEPLOYMENT.md) for more information.
+## Deployment Artifacts
+
+When deploying contracts, the scripts now generate enhanced deployment artifacts in the `deployments/` directory. These artifacts include:
+
+- **Contract Address**: The deployed address of each contract
+- **ABI**: The full Application Binary Interface for contract interaction
+- **Bytecode**: The deployed bytecode for verification purposes
+- **Metadata**: Optional additional information (e.g., configuration parameters)
+
+### Artifact Structure
+
+Deployment artifacts are saved in environment-based subdirectories with network-specific JSON files:
+- Local development: `deployments/local/local.json`
+- Staging: `deployments/staging/ethereum-sepolia.json`, `deployments/staging/arbitrum-sepolia.json`, etc.
+- Production: `deployments/production/ethereum.json`, `deployments/production/arbitrum.json`, etc.
+
+```json
+{
+  "network": "Local Network",
+  "chainId": 31337,
+  "timestamp": 1234567890,
+  "blockNumber": 1,
+  "deployer": "0x...",
+  "contracts": {
+    "EntryPoint": {
+      "address": "0x...",
+      "abi": [...],
+      "bytecode": "0x...",
+      "metadata": {}
+    },
+    // ... other contracts
+  }
+}
+```
+
+### Enabling Artifact Generation
+
+To enable deployment artifact generation, set the `SAVE_DEPLOYMENT_FILE` environment variable:
+
+```bash
+SAVE_DEPLOYMENT_FILE=true forge script script/Deploy.s.sol --rpc-url <RPC_URL> --broadcast
+```
+
+The local deployment script (`./local-deploy.sh`) automatically enables artifact generation.
+
+### Using Deployment Artifacts
+
+Once generated, deployment artifacts can be used to interact with deployed contracts:
+
+```javascript
+const deployment = require('./deployments/local/local.json');
+
+// Get contract address and ABI
+const entryPointAddress = deployment.contracts.EntryPoint.address;
+const entryPointABI = deployment.contracts.EntryPoint.abi;
+
+// Create contract instance (ethers.js example)
+const entryPoint = new ethers.Contract(entryPointAddress, entryPointABI, provider);
+```
+
+### Remote Deployment
+
+For remote deployments, use the provided script template:
+
+```bash
+# Set the environment variables
+# Then run:
+./deploy-remote.sh
+```
+
+The script will:
+1. Deploy contracts to the specified network
+2. Generate deployment artifacts with addresses and bytecode
+3. Enrich artifacts with ABIs from Foundry build outputs
+4. Save the complete artifacts to `deployments/<environment>/<network>.json`
+
+### Artifact Contents
+
+Each deployment artifact includes:
+
+- **network**: Network name (e.g., "Ethereum Sepolia", "Local Network")
+- **chainId**: Chain ID of the deployment network
+- **timestamp**: Unix timestamp of deployment
+- **blockNumber**: Block number at deployment time
+- **deployer**: Address that deployed the contracts
+- **contracts**: Object containing each deployed contract with:
+  - **address**: Deployed contract address
+  - **abi**: Full contract ABI for interaction
+  - **bytecode**: Deployed bytecode for verification
+  - **metadata**: Optional configuration parameters (e.g., paymaster type, initial bundler)
+
+### Verification
+
+The included bytecode can be used to verify deployed contracts on block explorers or to ensure the deployed code matches the source.
+
+Also see [DEPLOYMENT.md](./DEPLOYMENT.md) for more information.

tee-worker/omni-executor/aa-contracts/deploy-local.sh

@@ -55,6 +55,8 @@ deploy_contracts() {
     export PRIVATE_KEY="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"  # Anvil's first private key
     export OMNI_EXECUTOR_SIGNER=$OMNI_EXECUTOR_SIGNER
     export PAYMASTER_TYPE=$PAYMASTER_TYPE
+    export SAVE_DEPLOYMENT_FILE=true  # Enable saving enhanced deployment artifacts
+    export DEPLOYMENT_ENV=local  # Use local environment subdirectory
 
     # Show which paymaster is being deployed
     if [ "$PAYMASTER_TYPE" = "demo" ]; then
@@ -153,6 +155,13 @@ forge compile
 # Deploy contracts
 deploy_contracts
 
+# Enrich deployment artifacts with ABIs if Node.js is available
+if command -v node &> /dev/null && [ -f "$SCRIPT_DIR/extract-abis.js" ]; then
+    echo ""
+    echo "📝 Enriching deployment artifacts with ABIs..."
+    node "$SCRIPT_DIR/extract-abis.js" || echo "⚠️  Failed to enrich ABIs, but deployment was successful"
+fi
+
 # Keep Anvil running if we started it
 if [ "$ANVIL_RUNNING" = false ]; then
     echo ""