Scaffold-Base is a fork of Scaffold-ETH-2 ready to ship to Base. This fork provides native support for Base and Base Sepolia testnet, direct access to the Base faucets, and coinbase-sdk-wallet beta preconfigured which allows 4337 account abstraction using passkeys.
We highly recommend the Scaffold-ETH-2 docs as the primary guideline.
🧪 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.
Before you begin, you need to install the following tools:
- Node (>= v18.17)
- Yarn (v1 or v2+)
- Git
To get started with Scaffold-Base, follow the steps below:
- Clone this repo & install dependencies
git clone https://github.com/BuidlGuidl/scaffold-base
cd scaffold-base
yarn install
- 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.
- 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.
- 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.
What's next:
- Edit your smart contract
YourContract.solinpackages/hardhat/contracts - Edit your frontend homepage at
packages/nextjs/app/page.tsx. For guidance on routing and configuring pages/layouts checkout the Next.js documentation. - Edit your deployment scripts in
packages/hardhat/deploy - Edit your smart contract test in:
packages/hardhat/test. To run test useyarn hardhat:test
Redeploy your contracts:
yarn deploy --reset
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.tsinpackages/nextjs
Deploy your app to Vercel:
yarn vercel:yolo --prod
stop your
yarn chain
yarn fork
(now your local hardhat chain is a fork of Base and you can talk to forked Base contracts)
Coinbase Smart Wallet will be shown automatically when scaffold.config.ts targetNetworks contains the network baseSepolia.
Since coinbase beta sdk connector for now only works with Base Sepolia.
For interacting with contracts, you can nicely use scaffold-eth custom hooks (wrappers around wagmi) or wagmi hooks directly without needing to change anything.
Visit our docs to learn how to start building with Scaffold-ETH 2.
To know more about its features, check out our website.
Please see CONTRIBUTING.MD for more information and guidelines for contributing to Scaffold-ETH 2.