Skip to main content

Getting Started

Let's discover starknet-devnet.

Migration

Migrating to Rust

This Python implementation of Devnet is DEPRECATED and being replaced with a Rust implementation.

Take care

⚠️ Disclaimer ⚠️

  • Devnet should not be used as a replacement for Alpha testnet. After testing on Devnet, be sure to test on testnet (alpha-goerli)!
  • Sending transactions with max_fee set to 0 is supported (not supported on alpha-mainnet or alpha-goerli).
  • The semantics of REJECTED and REVERTED status of a transaction is not the same as on the official testnet:
Tx statusOfficial testnetDevnet
REJECTEDvalidation failed; not included in a blocknot used
REVERTEDvalidation passed but execution failed; included in a blockvalidation or execution failed; not included in a block*

*: dummy zeroes (0) in tx info for block number and tx index

Requirements

Works with Python versions >=3.9 and <3.10.

On Ubuntu/Debian, first run:

$ sudo apt install -y libgmp3-dev

On Mac, you can use brew:

$ brew install gmp

Install

$ pip install starknet-devnet

Run

$ starknet-devnet

For more running possibilities, see this.

Windows installation

Follow this guide: https://www.spaceshard.io/blog/starknet-devnet-windows-tutorial

Upgrade to a newer version

$ pip install --upgrade starknet-devnet