Skip to main content

Getting Started

Repositories

Support

Find us on Discord.

Requirements

This project uses Starknet Foundry for testing. To install Starknet Foundry follow these instructions.

Install

We advise that you use nvm to manage your Node versions.

yarn

Test

scarb run test

Gas Reporting

Requires running a local devnet. You should have docker installed, then you can start the devnet by running the following command:

scarb run startDevnet
# in another terminal instance
scarb run updateGasReport

Deployment

Prerequisite

Copy and update the contents of .env.example to .env.

Declare and deploy contracts

Declare and deploy all contracts under src using the account with PRIVATE_KEY and ADDRESS specified in .env

scarb run deployProtocol
scarb run deploySepolia
scarb run deployMainnet