Skip to content

Latest commit

 

History

History
115 lines (76 loc) · 3.73 KB

README.md

File metadata and controls

115 lines (76 loc) · 3.73 KB
Raw

Requirements

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

Install scarb

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

scarb --version

If your local Scarb version is not 2.5.4, you need to install it.

Installation Process

To install Scarb, please refer to the installation instructions. We strongly recommend that you install Scarb via asdf, a CLI tool that can manage multiple language runtime versions on a per-project basis. This will ensure that the version of Scarb you use to work on a project always matches the one defined in the project settings, avoiding problems related to version mismatches.

Please refer to the asdf documentation to install all prerequisites.

Once you have asdf installed locally, you can download Scarb plugin with the following command:

asdf plugin add scarb

This will allow you to download specific versions. You can choose the same version as the Dojo's Cairo version, for example, 2.5.4, with the following command:

asdf install scarb 2.5.4

and set a global version:

asdf global scarb 2.5.4

Otherwise, you can simply run the following command in your terminal, and follow the onscreen instructions. This will install the version 2.5.4 of Scarb.

curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh -s -- -v 2.5.4

Compatible versions

  • scarb - v2.5.4
  • cairo - v2.5.4
  • starknet - v2.5.4
  • sierra - v1.4.0
  • rpc - v0.5.1

Quickstart

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

  1. Clone this repo and install dependencies
git clone https://github.com/Quantum3-Labs/scaffold-stark-2 --recurse-submodules
cd scaffold-stark-2
yarn install
  1. Prepare your environment variables. Since we are using localhost(devnet), you can skip this step!. But if you want use the .env file, you can fill the envs related to devnet with any predeployed contract address and private key from starknet-devnet.

Note: You can also use sepolia testnet, to do that, you need to fill the envs related to sepolia testnet with your own contract address and private key.

cp packages/snfoundry/.env.example packages/snfoundry/.env
  1. Run a local network in the first terminal.

Note: You can skip this step if you want to use Sepolia Testnet.

yarn chain

This command starts a local Starknet network using Devnet. The network runs on your local machine and can be used for testing and development.

  1. On a second terminal, deploy the sample contract:
yarn deploy --network {NETWORK_NAME} // when NETWORK_NAME is not specified, it defaults to "devnet"

Note: To use sepolia tesnet, you have to set {NETWORK_NAME} to sepolia.

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

  1. On a third terminal, start your NextJS app:
yarn start

Visit your app on: http://localhost:3000.

video demo here