CLI Usage

• Circom Compilation Pipeline
  • Verify a Circom/SnarkJS circuit verifier already deployed on chain
    • Verification Checklist
  • Compile a Circom circuit and deploy its circuit verifier on chain
    • Deployment Checklist
  • Verify a Circom Groth16 multi-verifier already deployed on chain
    • verifiers
    • offset
    • deployed
    • modifier
  • Command Line Arguments
    • -p, --protocol
    • -k, --proving-key
    • -t, --ptau
    • -v, --circom-version
    • -s, --snarkjs-version
    • -i, --instance
    • -r, --resume
    • -c, --config
    • -a, --api-key
    • -b, --browser-wallet
  • Additional Configuration
    • optimization
    • include
    • prime
    • protocol
    • cWitness
    • wasmWitness
  • Verification Errors
    • invalid_diff
    • contract_not_verified
    • invalid_finalZkey
  • More information
• Noir Compilation Pipeline
  • Verify a Noir/Barretenberg circuit verifier already deployed on chain
  • Compile a Noir circuit and deploy its circuit verifier on chain
  • Command Line Arguments
    • -v, --nargo-version
    • -i, --instance
    • -r, --resume
    • -c, --config
    • -a, --api-key
    • -b, --browser-wallet
  • Verification Errors
    • invalid_diff
    • contract_not_verified

Installation

To use the Circuitscan CLI, first install it using npm:

$ npm install -g circuitscan

Login

Generate an API key by connecting your browser wallet at the manage API key page. No transactions are required and this is completely free to use.

Use the login command: circuitscan login <apiKey> to save your generated API Key for later use.

API Key can be specified any of the following ways in order of precedence:

1. Command line argument -a or --api-key

2. CIRCUITSCAN_API_KEY environment variable

3. ~/.circuitscan JSON user configuration { "apiKey": "xxx" }