🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on Starknet 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, Starknet.js, Scarb, Starknet-React, Starknet Foundry.

• ✅ Contract Fast Reload: Your frontend auto-adapts to your smart contracts as you deploy them.
• 🪝 Custom hooks: Collection of React hooks wrapper around starknet-react to simplify interactions with smart contracts with typescript autocompletion.
• 🧱 Components: Collection of common web3 components to quickly build your frontend.
• 🔥 Burner Wallet & Prefunded Account: Quickly test your application with a burner wallet and prefunded accounts.
• 🔐 Integration with Wallet Providers: Connect to different wallet providers and interact with Starknet network.

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

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

Tool for installing all the Starknet essentials for development. Starkup will install the latest stable versions of:

• Scarb - Cairo package manager and build toolchain
• Starknet Foundry - Development toolchain for testing on Starknet
• asdf - Version manager to easily switch between tool versions
• Cairo 1.0 extension for VSCode - Syntax highlighting and language support

Currently, starknet-devnet is not supported by starkup and needs to be installed separately (see instructions below).

To install starkup, run the following command:

curl -sSf https://raw.githubusercontent.com/starkware-libs/starkup/main/install.sh | bash

To ensure the proper functioning of scaffold-stark, your Scarb version must be 2.11.4. To accomplish this, first check Scarb version:

scarb --version

If your Scarb version is not 2.11.4, you need to install it. If you already have installed Scarb via starkup, you can setup this specific version with the following command:

asdf install scarb 2.11.4 && asdf set scarb 2.11.4

Otherwise, you can install Scarb 2.11.4 following the instructions.

To ensure the proper functioning of the tests on scaffold-stark, your Starknet Foundry version must be 0.41.0. To accomplish this, first check your Starknet Foundry version:

snforge --version

If your Starknet Foundry version is not 0.41.0, you need to install it. If you already have installed Starknet Foundry via starkup, you can setup this specific version with the following command:

asdf install starknet-foundry 0.41.0 && asdf set starknet-foundry 0.41.0

Otherwise, you can install Starknet Foundry 0.41.0 following the instructions.

To ensure the proper functioning of scaffold-stark, your starknet-devnet version must be 0.4.0. To accomplish this, first check your starknet-devnet version:

starknet-devnet --version

If your starknet-devnet version is not 0.4.0, you need to install it.

• Install starknet-devnet 0.4.0 via asdf (instructions).

• Starknet-devnet - v0.4.0
• Scarb - v2.11.4
• Snforge - v0.41.0
• Cairo - v2.11.4
• Rpc - v0.8.0

As an alternative to installing the tools locally (Scarb, Starknet Foundry, Starknet Devnet), you can use Docker, this is the recommended option for Windows users. Here's what you need to do:

1. Install Docker
2. Install Dev Containers
3. Use the provided devcontainer.json file to set up the environment:
   • The configuration uses the starknetfoundation/starknet-dev:2.11.4 image.
   • This includes all required tools pre-installed, such as Scarb, Starknet Foundry, Starknet Devnet and other dependencies.

To start using the Docker-based setup:

1. Open the project in Visual Studio Code.
2. Select "Reopen in Container".
3. If you need to rebuild the container, open the Command Palette (View -> Command Palette) and choose:
   • Dev Containers: Rebuild and Reopen in Container

Once inside the container, you can start working with all the tools and dependencies pre-configured.

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

1. Install the latest version of Scaffold-Stark

npx create-stark@latest
cd my-dapp-example
yarn install

2. Run a local network in the first terminal.

yarn chain

To run a fork : yarn chain --fork-network <URL> [--fork-block <BLOCK_NUMBER>]

This command starts a local Starknet network using Devnet. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in scaffold.config.ts for your nextjs app.

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

yarn deploy

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

By default Scaffold-Stark takes the first prefunded account from starknet-devnet as a deployer address,

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.

5. Check your environment variables. We have a yarn postinstall script that helps to fill in your environment variables. If the environment variable does not exist, you can fill them it manually to get the app running!

yarn deploy --network sepolia

yarn start

{
 "jsonrpc":"2.0",
 "method":"starknet_specVersion",
 "id":1
}

"devnet": process.env.NEXT_PUBLIC_DEVNET_PROVIDER_URL || process.env.NEXT_PUBLIC_PROVIDER_URL || "",
"sepolia": process.env.NEXT_PUBLIC_SEPOLIA_PROVIDER_URL || process.env.NEXT_PUBLIC_PROVIDER_URL || "",
"mainnet": process.env.NEXT_PUBLIC_MAINNET_PROVIDER_URL || process.env.NEXT_PUBLIC_PROVIDER_URL || ""

yarn COMMAND
npm run COMMAND

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

To know more about its features, check out our website

We welcome contributions to Scaffold-Stark!

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