Skip to content

Cyfrin/forge-template

Repository files navigation

Name

Name

About

Getting Started

Requirements

  • git
    • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
  • foundry
    • You'll know you did it right if you can run forge --version and you see a response like forge 0.2.0 (816e00b 2023-03-16T00:05:26.396218Z)
  • just
    • You'll know you did it right if you can run just --version and you see a response like just 1.x.x

Installation

git clone <MY_REPO>
cd <MY_REPO>
just

Quickstart

just test

Usage

Coverage

forge coverage

BattleChain deployment

This template ships with battlechain-lib wired up for deployments to BattleChain (battle-testing layer between testnet and mainnet) and any CreateX-supported EVM chain.

Edit script/BCDeployer.s.sol to set your protocol name, contacts, and recovery address, then deploy via the imported battlechain.just targets:

just bc-deploy script/BCDeployer.s.sol $ACCOUNT $SENDER
just bc-deploy-verify script/BCDeployer.s.sol $ACCOUNT $SENDER
just bc-verify-broadcast script/BCDeployer.s.sol

Where $ACCOUNT is a Foundry keystore account name and $SENDER is its public address. Never commit private keys.

AI-Assisted Development

This project includes tooling for AI-assisted smart contract development via Claude Code.

Skills

  • solskill — production-grade Solidity development guidance (testing, security, code quality)

Install with:

npx skills add cyfrin/solskill

Commands

Slash commands from Trail of Bits' claude-code-config:

Command Description
/fix-issue <number> Plan, implement, test, review, and PR for a GitHub issue
/review-pr <number> Multi-agent PR review, fix findings, and push
/merge-dependabot <org/repo> Evaluate and merge Dependabot PRs with dependency analysis

Audit Scope Details

  • Commit Hash: XXX
  • Files in scope:

You'll need to install tree for linux or mac to run this command

just scope
  • Solc Version: X.X.X
  • Chain(s) to deploy to:
    • XXX
  • ERC20 Token Compatibilities:
    • XXX

Roles

  • Role1:

Known Issues

  • Issue1:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors