template-ethereum-contracts

# Ethereum Smart Contract Development Template

A production-ready template for developing EVM smart contracts using [Hardhat v3](https://hardhat.org/) and [hardhat-deploy v2](https://rocketh.dev/hardhat-deploy/) with the [rocketh](https://rocketh.dev/documentation/) deployment system.

The documentation of what this template uses is at [rocketh.dev/hardhat-deploy](https://rocketh.dev/hardhat-deploy/), whose guides are written from this template.

## Why This Template?

### hardhat-deploy + rocketh vs Ignition

While Hardhat's official [Ignition](https://hardhat.org/ignition) plugin offers a robust deployment system, it comes with a rigid DSL that limits flexibility. This template uses **hardhat-deploy + rocketh** which provides:

- **Hot Contract Replacement (HCR)**: The equivalent of HMR (Hot Module Replacement) for smart contracts. Edit your contracts and see changes live while developing your app or game. This uses proxy patterns with a set of conventions to make it work seamlessly (see [Development workflow](https://rocketh.dev/hardhat-deploy/development-workflow/)).
- **Intuitive Deployment Scripts**: Write deployment logic in plain TypeScript.
- **Flexible Proxy Patterns**: Declarative proxy deployment with `deployViaProxy` for upgradeable contracts.
- **Universal Deploy Scripts**: Thanks to rocketh, the deploy script can run in any environment, nide, browser, etc...

### Monorepo Structure

This template is organized as a monorepo, making it easy to:

- Add a web frontend in a separate `web/` folder
- Import contract artifacts, ABIs, and types from the `contracts` package
- Share deployment information across packages
- Publish contracts as an npm package for external consumption

## Project Structure

```
.
├── contracts/                    # Smart contracts package
│   ├── src/                      # Solidity source files
│   ├── deploy/                   # Deployment scripts
│   ├── deployments/              # Deployment artifacts per network
│   ├── generated/                # Auto-generated artifacts and ABIs
│   ├── rocketh/                  # Rocketh configuration
│   │   ├── config.ts             # Account & extension configuration
│   │   ├── deploy.ts             # Deploy script setup
│   │   └── environment.ts        # Environment setup for tests/scripts
│   ├── scripts/                  # Utility scripts
│   └── test/                     # TypeScript tests
├── package.json                  # Root monorepo configuration
└── pnpm-workspace.yaml           # PNPM workspace definition
```

## Initial Setup

### Prerequisites

- [Node.js](https://nodejs.org/) (v22+)
- [pnpm](https://pnpm.io/)

### Installation

```bash
pnpm i
```

We also recommend installing [Zellij](https://zellij.dev/) for an optimal development experience with `pnpm start`.

## Usage

### Compile Contracts

```bash
pnpm contracts:compile
```

This runs both Solidity and TypeScript compilation.

### Watch Mode (Auto-Rebuild)

Run in a separate terminal for automa