Getting Started

Getting Started

Prerequisites

Before using ContractKit, ensure you have:

1. Foundry - Installation Guide

   curl -L https://foundry.paradigm.xyz | bash
   foundryup

2. Claude Code - Get Claude Code

Installation

From Marketplace (Recommended)

# Step 1: Add the marketplace
/plugin marketplace add HCS412/contractkit

# Step 2: Install the plugin
/plugin install contractkit@HCS412/contractkit

Local Development

git clone https://github.com/HCS412/contractkit.git
cd contractkit
claude --plugin-dir ./plugins/contractkit

Your First Project

1. Create a Token

/contractkit:new erc20 MyToken MTK

This creates a new directory contractkit-projects/mytoken with:

• src/Token.sol - Your ERC20 contract
• test/Token.t.sol - Comprehensive tests
• script/Deploy.s.sol - Deployment script
• SECURITY.md - Security considerations
• THREAT_MODEL.md - Threat analysis

2. Run Tests

cd contractkit-projects/mytoken
/contractkit:test

3. Start Local Chain

/contractkit:local

This starts Anvil on port 8545 with pre-funded accounts.

4. Deploy

/contractkit:deploy local

5. Interact

# Check token name
/contractkit:call name

# Mint tokens
/contractkit:call mint --args "0xYourAddress" "1000000000000000000"

# Check balance
/contractkit:call balanceOf --args "0xYourAddress"

Next Steps

• Explore Templates for ERC721, Escrow, and Vault
• Learn about Deployment to testnets
• Read the Commands Reference