🏗️ Scaffold-Base

Documentation | Website

Scaffold-Base is a fork of Scaffold-ETH2 ready to ship to Base. This fork provides native support for Base and Base Sepolia testnet, and direct access to the Base faucets.

We highly recommend the Scaffold-ETH2 docs as the primary guideline.

(forked from 🏗 Scaffold-ETH2)

🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.

⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript.

• ✅ Contract Hot Reload: Your frontend auto-adapts to your smart contract as you edit it.
• 🪝 Custom hooks: Collection of React hooks wrapper around wagmi to simplify interactions with smart contracts with typescript autocompletion.
• 🧱 Components: Collection of common web3 components to quickly build your frontend.
• 🔥 Burner Wallet & Local Faucet: Quickly test your application with a burner wallet and local faucet.
• 🔐 Integration with Wallet Providers: Connect to different wallet providers and interact with the Ethereum network.

Requirements

Before you begin, you need to install the following tools:

• Node (>= v18.17)
• Yarn (v1 or v2+)
• Git

Quickstart

To get started with Scaffold-Base, follow the steps below:

1. Clone this repo & install dependencies

git clone https://github.com/BuidlGuidl/scaffold-base
cd scaffold-base
yarn install

2. Run a local network in the first terminal:

yarn chain

This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in hardhat.config.ts.

3. On a second terminal, deploy the test contract:

yarn deploy

This command deploys a test smart contract to the local network. The contract is located in packages/hardhat/contracts and can be modified to suit your needs. The yarn deploy command uses the deploy script located in packages/hardhat/deploy to deploy the contract to the network. You can also customize the deploy script.

4. On a third terminal, start your NextJS app:

yarn start

Visit your app on: http://localhost:3000. You can interact with your smart contract using the Debug Contracts page. You can tweak the app config in packages/nextjs/scaffold.config.ts.

Run smart contract test with yarn hardhat:test

• Edit your smart contract YourContract.sol in packages/hardhat/contracts
• Edit your frontend in packages/nextjs/pages
• Edit your deployment scripts in packages/hardhat/deploy

Redeploy your contracts:

yarn deploy --reset

🔵 Deploy to Base

When you are ready to deploy to Base, generate a deployer account:

yarn generate

Fund the deployer account with ETH on Base at:

yarn account

Deploy to Base:

yarn deploy --network base 

Set your target network to Base:

Change "chains.hardhat" to "chains.base" in targetNetworks from scaffold.config.ts in packages/nextjs

Deploy your app to Vercel:

yarn vercel:yolo --prod

🍽️ Fork Mainnet Base

stop your yarn chain

yarn fork

(now your local hardhat chain is a fork of Base and you can talk to forked Base contracts)

Documentation

Visit our docs to learn how to start building with Scaffold-ETH 2.

To know more about its features, check out our website.

Contributing

Please see CONTRIBUTING.MD for more information and guidelines for contributing to Scaffold-ETH 2.