gianalarcon/scaffold-stark-2

Boilerplate to test and develop apps on starknet

Sepolia Network

We are going to follow the below instructions in order to intract with Starknet using Sepolia network

Prerequisites

• Install Argent or Braavos wallet

Quickstart

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

1. Clone this repo & install dependencies

git clone https://github.com/Quantum3-Labs/scaffold-stark-2 --recurse-submodules
cd scaffold-stark-2
yarn install

2. Install Scarb, a package manager to build/compile Cairo language. Version 2.5.4

chmod +x install-scarb.sh
./install-scarb.sh

3. Go to packages/backend/env.example and check the environment variables. Create an .env file in the same directory based on the .env.example file. This is a sensitive step since you have to pass your private key. If you want to replace the RPC_URL_SEPOLIA variable, make sure its specs is 0.5.1 version and it is Sepolia compatible.

4. Deploy the sample contract:

yarn deploy

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

5. On a second terminal, start your NextJS app:

yarn start

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

Goerli Network

Prerequisites

• Install Argent or Braavos wallet

Quickstart

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

1. Clone this repo & install dependencies

git clone https://github.com/Quantum3-Labs/scaffold-stark-2 --recurse-submodules
cd scaffold-stark-2
yarn install

2. Install Scarb, a package manager to build/compile Cairo language. Version 2.5.4

chmod +x install-scarb.sh
./install-scarb.sh

3. Go to packages/backend/env.example and check the environment variavles. Create an .env file in the same directory based on the .env.example file. This is a sensitive step since you have to pass your private key. If you want to replace the rpc_url variable, make sure its specs is 0.5.1 compatible

4. Deploy the sample contract:

yarn goerli-deploy

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

5. On a second terminal, start your NextJS app:

yarn start

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

Devnet demo (Deprecated)

Compatible versions

• snforge - 0.19.0
• sncast - 0.19.0

Prerequisites [Maybe not needed ?]

• Devnet

Docker

docker pull shardlabs/starknet-devnet-rs:2c984aad70e38aa578dd5beb00ee6908ad3952b0-seed0

Cargo

For those who don't have Docker installed, or dont have the enough space to pull the image, you can use the cargo.sh script to install the necessary dependencies.

chmod +x install-cargo.sh
./install-cargo.sh

Quickstart

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

1. Clone this repo & install dependencies

git clone https://github.com/Quantum3-Labs/scaffold-stark-2 --recurse-submodules
cd scaffold-stark-2
yarn install
snfoundryup -v 0.19.0

2. Run a local network in the first terminal:

yarn chain

yarn cargo-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.

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

yarn devnet-deploy

This command deploys a test smart contract to the local network. The contract is located in packages/backend/src and can be modified to suit your needs. The yarn devnet-deploy command uses the deploy script located in packages/backend/scripts_cairo/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.