Contract Deployer

A Rust-based CLI tool for deploying smart contracts with TOML configuration files, making deployments consistent, reproducible, and secure across different networks.

✨ Features

🔧 TOML Configuration - Clean, readable configuration format
🌍 Multi-Network Support - Deploy to mainnet, testnets, or local networks
🔐 Secure Authentication - Keystore or private key support
📦 Repository Cloning - Deploy directly from Git repositories
🚀 Real-time Output - See deployment progress as it happens
🔄 Environment Management - Multiple .env files with variable expansion
✅ Automatic Verification - Built-in Etherscan verification
🛠️ Flexible Setup - Custom dependency installation commands

🚀 Quick Start

Installation

# One-line install (macOS/Linux)
curl -fsSL https://raw.githubusercontent.com/0xdavid7/contract-deployer/main/install.sh | bash

Basic Usage

Create configuration file:

cp ~/.contract-deployer/examples/basic-deploy.toml ./deploy.toml

Set up environment variables:

cat > .env << EOF
API_KEY_ETHERSCAN=your_etherscan_api_key
ALCHEMY_API_KEY=your_alchemy_api_key
KEYSTORE_ACCOUNT=your_keystore_account
KEYSTORE_PASSWORD=your_keystore_password
EOF

Deploy your contract:

contract-deployer --config deploy.toml

📋 Configuration

Basic Configuration

[project]
name = "my-smart-contract"
script = "Deploy"                    # Will look for script/Deploy.s.sol
network = "sepolia"                  # Default network
setup_command = "bun install"       # Dependencies installation
repo = "https://github.com/user/contract.git"  # Optional: Git repository

[env]
load_files = [".env"]               # Environment files to load

[networks.sepolia]
chain_id = 11155111
rpc_url = "https://eth-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}"
verify = true

[networks.mainnet]
chain_id = 1
rpc_url = "https://eth-mainnet.g.alchemy.com/v2/${ALCHEMY_API_KEY}"
verify = true

[networks.localhost]
chain_id = 31337
rpc_url = "http://localhost:8545"
verify = false

Environment Variables

# Required
API_KEY_ETHERSCAN=your_etherscan_api_key
ALCHEMY_API_KEY=your_alchemy_api_key

# Authentication (choose one method)
# Method 1: Keystore (recommended)
KEYSTORE_ACCOUNT=your_keystore_account
KEYSTORE_PASSWORD=your_keystore_password

# Method 2: Private key (development)
PRIVATE_KEY=0x_your_private_key

🌍 Supported Networks

Ethereum

Mainnet - Production Ethereum network
Sepolia - Primary Ethereum testnet
Localhost - Local development (Anvil, Hardhat)

Layer 2

Polygon - Polygon PoS chain
Arbitrum - Arbitrum One
Optimism - Optimism mainnet
Base - Coinbase's L2

Other Chains

BSC - Binance Smart Chain
Avalanche - Avalanche C-Chain

See examples/multi-chain.toml for complete network configurations.

💡 Usage Examples

Deploy from Git Repository

# Repository specified in config
contract-deployer --config deploy.toml

# With custom arguments
contract-deployer --config deploy.toml --args "--value" --args "1000000"

Deploy from Local Directory

# No repo specified in config = deploy from current directory
contract-deployer --config local-deploy.toml

Multi-Chain Deployment

# Deploy to multiple networks
contract-deployer --config mainnet-deploy.toml
contract-deployer --config polygon-deploy.toml
contract-deployer --config arbitrum-deploy.toml

Development Workflow

# Start local network
anvil

# Deploy to local network
contract-deployer --config examples/development.toml

# Test and iterate
forge test

# Deploy to testnet
contract-deployer --config testnet-deploy.toml

# Deploy to mainnet
contract-deployer --config mainnet-deploy.toml

📁 Configuration Examples

Basic Deployment (examples/basic-deploy.toml)

Simple configuration for deploying to Ethereum testnets.

Multi-Chain Setup (examples/multi-chain.toml)

Comprehensive setup supporting 15+ networks including Ethereum, Polygon, Arbitrum, Optimism, BSC, and more.

Development Setup (examples/development.toml)

Optimized for local development with Anvil, including pre-configured test accounts and fast deployment.

🔐 Authentication Methods

Keystore (Recommended for Production)

# Create keystore
cast wallet import my-account --interactive

# Use in config
KEYSTORE_ACCOUNT=my-account
KEYSTORE_PASSWORD=secure_password

Private Key (Good for Development)

# Use private key directly
PRIVATE_KEY=

🛠️ Advanced Features

Variable Expansion

[networks.custom]
rpc_url = "https://rpc.${NETWORK_NAME}.example.com/${API_KEY}"

Multiple Environment Files

[env]
load_files = [".env", ".env.local", ".env.${NETWORK}"]

Custom Setup Commands

[project]
setup_command = "npm install && npm run build && forge build"

Network-Specific Variables

[env.additional_vars]
DEPLOYMENT_SALT = "0x1234567890abcdef"
MIN_CONFIRMATION_BLOCKS = "12"

🚨 Common Issues & Solutions

Authentication Failed

# Check keystore exists
cast wallet list

# Verify keystore address
cast wallet address --account your_account

# Test authentication
cast wallet address --account your_account --password your_password

Network Connection Failed

# Test RPC endpoint
curl -X POST -H "Content-Type: application/json" \
  --data '{"jsonrpc":"2.0","method":"eth_chainId","params":[],"id":1}' \
  https://eth-sepolia.g.alchemy.com/v2/YOUR_API_KEY

Contract Verification Failed

# Check Etherscan API key
curl "https://api.etherscan.io/api?module=account&action=balance&address=0x1234&apikey=YOUR_KEY"

# Ensure network supports verification
verify = true  # in network config

Command Not Found

# Check installation
ls ~/.contract-deployer/bin/contract-deployer

# Check PATH
echo $PATH | grep contract-deployer

# Reload shell
source ~/.bashrc  # or ~/.zshrc

🔄 Migration from Foundry Scripts

Before (Foundry)

forge script script/Deploy.s.sol \
  --chain-id 11155111 \
  --rpc-url sepolia \
  --broadcast \
  --verify \
  --account my-account \
  --password my-password

After (Contract Deployer)

# deploy.toml
[project]
name = "my-contract"
script = "Deploy"
network = "sepolia"
setup_command = "forge build"

[networks.sepolia]
chain_id = 11155111
rpc_url = "https://eth-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}"
verify = true

contract-deployer --config deploy.toml

📦 Installation

Supported Platforms

✅ Linux (x86_64, ARM64)
✅ macOS (Intel, Apple Silicon)
❌ Windows (not supported)

Quick Install

curl -fsSL https://raw.githubusercontent.com/0xdavid7/contract-deployer/main/install.sh | bash

Manual Installation

See INSTALLATION.md for detailed installation instructions.

Build from Source

git clone https://github.com/0xdavid7/contract-deployer.git
cd contract-deployer
cargo build --release
cp target/release/contract-deployer ~/.local/bin/

🧪 Development

Prerequisites

Rust 1.70.0+
Git
Foundry (forge, cast, anvil)

Setup

git clone https://github.com/0xdavid7/contract-deployer.git
cd contract-deployer
cargo build

Testing

cargo test

Running Examples

# Start local network
anvil

# Test with development config
cargo run -- --config examples/development.toml

📚 Architecture

contract-deployer/
├── src/
│   ├── main.rs           # Entry point
│   ├── cli.rs            # Command line interface
│   ├── config.rs         # TOML configuration
│   ├── environment.rs    # Environment management
│   └── deployer.rs       # Core deployment logic
├── examples/             # Configuration examples
└── .github/workflows/    # CI/CD pipeline

Key Components

Configuration Parser - Handles TOML parsing and validation
Environment Manager - Loads and expands environment variables
Git Integration - Clones repositories with SSH/HTTPS authentication
Forge Integration - Executes forge scripts with proper authentication
Network Manager - Handles multi-network deployments

🤝 Contributing

Fork the repository
Create a feature branch: git checkout -b feature/amazing-feature
Commit your changes: git commit -m 'Add amazing feature'
Push to the branch: git push origin feature/amazing-feature
Open a Pull Request

Development Guidelines

Follow Rust best practices
Add tests for new features
Update documentation
Ensure CI passes

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Foundry - The underlying deployment infrastructure
Rust Community - For excellent tooling and libraries
Ethereum Ecosystem - For the standards and infrastructure

📞 Support

Documentation: This README and INSTALLATION.md
Issues: GitHub Issues
Discussions: GitHub Discussions

🗺️ Roadmap

Windows Support - Add Windows binaries and installer
Package Managers - Homebrew, Chocolatey, AUR packages
Interactive Mode - CLI wizard for configuration creation
Deployment History - Track and manage past deployments
Multi-sig Support - Enhanced support for multi-signature deployments
Plugin System - Extensible architecture for custom deployment workflows

Deploy smart contracts with confidence!

Name		Name	Last commit message	Last commit date
Latest commit History 13 Commits
.github/workflows		.github/workflows
examples		examples
src		src
.gitignore		.gitignore
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
GUIDE.md		GUIDE.md
INSTALLATION.md		INSTALLATION.md
LICENSE.md		LICENSE.md
README.md		README.md
RELEASE_CHECKLIST.md		RELEASE_CHECKLIST.md
install.sh		install.sh

License

0xdavid7/contract-deployer

Folders and files

Latest commit

History

Repository files navigation