## Zellij Development Environment

Zellij is a terminal multiplexer (like tmux) with a preconfigured layout for this template.
Start the full development environment:

This launches:

A local Ethereum node
Auto-compilation on file changes
Auto-deployment on changes
Auto-testing on changes
An interactive shell for running scripts
Configuration
Named Accounts
Configure accounts in contracts/rocketh/config.ts:

### Network Configuration

Networks are configured in contracts/hardhat.config.ts using helper functions:

addNetworksFromEnv(): Auto-configure networks from ETH_NODE_URI_* environment variables

addNetworksFromKnownList(): Add configurations for well-known networks

addForkConfiguration(): Enable forking mode via HARDHAT_FORK env var

Rocketh Extensions
Extensions provide deployment functionality. Configure in contracts/rocketh/config.ts:

const extensions = { ...deployExtension, // Basic deploy function ...readExecuteExtension, // read/execute helpers ...deployProxyExtension, // deployViaProxy for upgradeable contracts ...viemExtension, // viem client integration };

## Writing Deploy Scripts

Deploy scripts are located in contracts/deploy/ and are executed in order (prefixed with numbers):

export default deployScript( async (env) => { const { deployer, admin } = env.namedAccounts;

// Deploy an upgradeable contract const deployment = await env.deployViaProxy( "GreetingsRegistry", { account: deployer, artifact: artifacts.GreetingsRegistry, args: ["prefix:"], }, { owner: admin, linkedData: { / metadata stored with deployment / }, }, );

// Interact with the deployed contract const contract = env.viem.getContract(deployment); const message = await contract.read.messages([deployer]); }, { tags: ["GreetingsRegistry"] }, );

## Writing Tests

TypeScript Tests
Located in contracts/test/, using Node.js test runner and earl assertions:

const { provider, networkHelpers } = await network.connect(); const { deployAll } = setupFixtures(provider);

describe("GreetingsRegistry", function () { it("should set and retrieve messages", async function () { const { env, GreetingsRegistry, unnamedAccounts } = await networkHelpers.loadFixture(deployAll);

const greeter = unnamedAccounts[0]; await env.execute(GreetingsRegistry, { functionName: "setMessage", args: ["hello"], account: greeter, });

const message = await env.read(GreetingsRegistry, { functionName: "messages", args: [greeter], }); expect(message).toEqual("hello"); }); });

### Solidity Tests

Located alongside contracts with .t.sol extension, using forge-std:

contract GreetingsRegistryTest is Test { GreetingsRegistry internal registry;

function setUp() public { registry = new GreetingsRegistry(""); }

function test_setMessageWorks() public { registry.setMessage("hello"); assertEq(registry.messages(address(this)), "hello"); } }

## Linting

Solidity linting is configured with slippy:

## Publishing & Consuming Contracts

Package Exports
The contracts package exposes multiple entry points:

### Using in Another Package

// Import deployment info import GreetingsRegistry from "template-ethereum-contracts/deployments/sepolia/GreetingsRegistry.json";

// Import Solidity sources (for inheritance or verification) // Reference: template-ethereum-contracts/src/GreetingsRegistry/GreetingsRegistry.sol

### Building for Publication

## Environment Variables

| Variable                 | Description                                   |
| ------------------------ | --------------------------------------------- |
| ETH_NODE_URI_<network> | RPC endpoint for the network                  |
| MNEMONIC_<network>     | Mnemonic for account derivation               |
| MNEMONIC               | Fallback mnemonic if network-specific not set |
| ETHERSCAN_API_KEY      | API key for contract verification             |

Set SECRET as the value to use Hardhat's secret store:

## Adding a Web Frontend

Since this is a monorepo, you can easily add a web frontend:
Create a web/ directory with your frontend framework

Add it to pnpm-workspace.yaml:

3. Import contracts in your frontend:
ABIs

- Artifacts

- Deployments

- or event Deploy Scripts

4. Use the export script to generate deployment info: