starknet-contract-verifier

Client for the Voyager Starknet block explorer, that allows you to verify your starknet classes.

Quickstart guide

Scarb

Contract verifier works with Scarb based projects. The tool assumes that scarb command is available in the envirenment and project is building properly by executing scarb bulid.

Supported verisons

Client is version agnostic, the Scarb/Cairo versions support is determined by the server availability. As of writing this (09/01/2025) Cairo up to 2.9.1 is supported with newer versions being added few a slight lag after release.

Project configuration

In order to verify your contract, you'll need to add a tool.voyager table in your Scarb.toml, for example:

[package]
name = "my_project"
version = "0.1.0"

[dependencies]
starknet = ">=2.4.0"

[[target.starknet-contract]]
sierra = true

# Add the following section
[tool.voyager]
my_contract = { path = "src/main.cairo" }

The my_contract field name have to match the name of the contract that we want to verify. The path should point to the file containing cairo module that you wish to verify. In the example above, the cairo contract in question is located at src/main.cairo.

Note that only one contract should be provided in this section as multi contract verification is not supported yet.

Get starknet-contract-verifier

Right now in order to obtain the starknet-contract-verifier, clone this repository:

git clone https://github.com/NethermindEth/starknet-contract-verifier.git
cd starknet-contract-verifier

Setup rust

starknet-contract-verifier is a rust/cargo project. In order to build it you'll need rust and cargo set up. You can do it easily using rustup.

curl https://sh.rustup.rs -sSf | sh -s

Submit your contract

You are good to go, execute:

cargo run -- --network mainnet submit \
  --name <YOUR_CONTRACT_NAME> \
  --hash <YOUR_CONTRACT_CLASS_HASH> \
  --path <PATH_TO_YOUR_SCARB_PROJECT>

When successful you'll be given verification job id, which you can pass to:

cargo run -- --network mainnet status --job <JOB_ID>

to check the verification status. Afterwards visit Voyager website and search for your class hash to see verified badge.

Detailed information

Verification

starknet-contract-verifier provides two subcommands: submit and status. For both cases user needs to select the network with which they want to interact via the --network argument. Possible cases are:

• mainnet, main starknet newtwork,
• sepolia, test network,
• custom, set provide custom addresses via --public and `--private arguments.

Submiting for verification

In order to submit contract for verification user needs to provide several arguments:

• --path, path to directory containing scarb project (If omitted it will use current workingi directory),
• --name, name which will be used in the block explorer for the verified contract,
• --hash, class hash of the declared contract.

there are more options, each of them is documented in the --help output.

If the submission is successful, client will output the verification job id.

Checking job status

User can query the verification job status using status command and providing job id as the --job argument value.