Skip to main content

Getting Started

Installing and running​

Check if your Node.js version is >= 14

The fastest way to run Starknet Rivet is with the starknet-run.sh script:

$ ./starknet-run/starknet-run.sh

Arguments can be passed to the starknet devnet container with the --args flag

$ ./starknet-run/starknet-run.sh --args "--timeout 240"

Add the --add-l1 flag to run foundryup as well:

$ ./starknet-run/starknet-run.sh --add-l1

Note: these commands install docker if not already installed!

Optionally:

  • Change or configure the name of your extension on src/manifest.

Running in the browser​

Rivet is a Chrome extension tool built with Vite + React, and Manifest v3

  1. set your Chrome browser in 'Developer mode'
  2. click 'Load unpacked', and select starknet-rivet/build folder
  3. Activate the Rivet extension

Developing​

Run the commands:

$ cd starknet-rivet

$ npm install

$ npm run build

Devnet​

To start local devnet you can also run:

$ npm run devnet

Contribute​

If you spot a problem or room for improvement, check if an issue for it already exists. If not, create a new one. You are welcome to open a PR yourself to close the issue. Once you open a PR, you will see a template with a list of steps - please follow them.