Pease use https://github.com/scaffold-eth/scaffold-eth-2 for a modern v2 version of scaffold-eth-typescript! It has been entire rebuilt with typescript from the ground up!
This is the typescript repo of scaffold-eth. Use scaffold-eth-typescript with:
- A react frontend running with
nextjsorvite. - Solidity toolkit of
hardhatorfoundry - It has the a command line system that allows you to choose a react frontend or solidity toolkit
- You can use the use the template link: scaffold-eth-typescript template
- You can clone the repo with git
git clone https://github.com/scaffold-eth/scaffold-eth-typescript.git
Running the app
-
install your dependencies,
open a new command promptyarn install
-
Create a default
scaffold.config.jsonconfiguration fileyarn create-config
-
start a local hardhat node (chain)
yarn chain
-
Run the app,
open a new command prompt terminal# in a new terminal # compile your contracts yarn compile # deploy your hardhat contracts yarn deploy # start the react app (vite) yarn start
-
Open http://localhost:3000 to see your front end
Scaffold uses scaffold.config.json as a configuration file located in /packages/common/scaffold.config.json. You can create the config file by running the command yarn create-config.
use `-h` with any command for help. e.g. yarn set-react -hYou can change the configuration file to pick different frontends and solidity toolkits.
yarn set-react `nextjs` or `vite`
yarn set-solidity `hardhat` or `foundry`Set your targetNetwork in the config. This is the network the solidity toolkit is deploying against.
Set your availableNetworks in the config. This is the networks the frontend is available in.
You can configure it from the config file or from command line.
yarn set-network -h
yarn set-network 'localhost' 'localhost, mainnet'You can see all the other commands by using yarn scaffold
Everything will be installed with yarn install.
You can use hardhat with right context using
yarn hardhatMake sure you install foundry
-
Make sure you install foundry first. Use
curl -L https://foundry.paradigm.xyz | bashto install foundryupYou can see more details here. https://book.getfoundry.sh/getting-started/installation
-
Run
yarn install:foundryto install or update foundry in the right folder. It will also run forge install automatically with the right context.
You can use foundry commands with the right context
yarn forge
yarn anvil
yarn castThe directories that you'll use are:
packages/solidity-ts/
And one of either:
packages/vite-app-ts/
packages/next-app-ts/Other commands
# rebuild all contracts, incase of inconsistent state
yarn contracts:clean
yarn contracts:build
# run hardhat commands for the workspace, or see all tasks
yarn hardhat 'xxx'
# run forge, anvil or
yarn forge
yarn anvil
yarn castOther folders
# for subgraph checkout README.md in following directories
packages/subgraph/
packages/services/Everything you need to build on Ethereum! 🚀 Quickly experiment with Solidity using a frontend that adapts to your smart contract:
- 🔏 Edit your smart contract
YourContract.solinpackages/solidity-ts/contracts - 📝 Edit your frontend
MainPage.tsxinpackages/vite-app-ts/src - 💼 Edit your deployment scripts in
packages/solidity-ts/deploy/hardhat-deploy - 📱 Open http://localhost:3000 to see the app
- 👷🏽♂️ run
yarn hardhatto get a list of all the tasks. Runyarn hardhat tasknameto run the task.
Check out eth-hooks docs for example of how to use hooks
Tutorial using the CLI
Eth-hooks v4 & scaffold-eth-typescript overview
Register as a builder here and start on some of the challenges and build a portfolio.
🏁 Make sure to click on the typescript tab!
Join the telegram support chat 💬 to ask questions and find others building with 🏗 scaffold-eth!
Check out
- Typescript challenges
- Typescript examples
- Vanilla JS active branches
- Join/fund the 🏰 BuidlGuidl!
Please check out our Gitcoin grant too!