Skip to main content

Streamlining Python SDK Imports


Previous to this release, your import of the Sindri API client in a python script looked something like this:

from sindri.sindri import Sindri

As a small act of service, we've simplified that to

from sindri import Sindri

No need to update your existing code, as the old version version still works!

Cloning Public Circuits


This release of Sindri's CLI allows you to share and learn from public circuits. Specifically, any version tag of any circuit marked as a public project can be downloaded via the sindri clone command.

All of the circuits in our sindri-resources database are public projects and are available to clone. Try something like:

sindri clone sindri/decision-tree:public

Prove via Public Circuits and Streamlining Proof Lists

Prove via Public Circuits

This release of the API allows you to prove from circuits that have previously been compiled from any other user or team, as long as they are marked public.

All of the circuits in our sindri-resources database are public projects and are available to clone. Try something like:

prove sindri/multiplier2:public '{"X":7, "Y": 3}'

Streamlining Proof Lists

Previously, when you requested a list of proofs from a circuit, the API sent back one bulk response containing all of the details for all proofs. For an older circuit that has built up many proofs over time, this can cause sluggish behavior while your application receives and processes all that data.

As of this release, the proof detail endpoint is the only place where you can retrieve the full data for a proof (including the proof and public fields). You can still incorporate logic into your application that retrieves all of the proofs for a single circuit; you'll just have to separate that process into two steps:

  1. Request all of the proofs for a specific circuit
  2. Loop over the proof_id field and request the proof details for each

Create Proofs via the CLI


Circuit writing is a lot like coding in a compiled language - you can encounter both compile time and runtime errors. Our CLI already enabled you to easily initialize a circuit project and deploy to the Sindri platform via the sindri deploy command. This utility allows you to quickly find compile time errors and address them. The newest release of the CLI can help uncover runtime errors via the sindri proof create command. Running end-to-end compilation through proving tasks in the same command line interface allows you to ensure your proving input is properly formatted and that your circuit behaves like you expect it to.

As an added bonus, you can use this new functionality to quickly benchmark against various circuits and frameworks without context-switching or relying on verbose scripts.

This section in the CLI Quickstart shows you how its done!

Retrieve Smart Contract Artifacts


We added methods to our python SDK that will streamline smart contract development alongside your ZK-app! In particular, you can now retrieve smart contract solidity code for compiled circuits for most frameworks. Within Circom, you can also retrieve the outputs from a proof pre-formatted as calldata.

To see these methods in action, check out Rollkit's zkML Tutorial.

Smart Contracts and Noir JSON Input

EthGlobal's Hackathon gave us invaluable insights - inspiring the following two new features:

Solidity Proof Verifier Smart Contract

Feedback: Co-developing a smart contract verifier alongside a zk-app [backed by Sindri's API] needs to involve fewer intermediate steps.

Many frameworks will generate smart contract code which can verify proofs tied to your specific circuit and verifying key. Previously, Sindri has offered guidance on integrating those contracts within your Sindri workflow. This new release streamlines that process by offering an endpoint to retrieve a solidity smart contract verifier for Circom, Noir, and Gnark circuits! Note that you must use bn254 with your Gnark circuit to enable this functionality. Furthermore, Halo2 verifiers are still under construction.

The easiest way to get started utilizing this feature is via the Python SDK (you'll need release v0.1.0a17 or newer).

Python SDK Smart Contract Generation
import os
from sindri import Sindri
sindri = Sindri(os.getenv("SINDRI_API_KEY", ""))
circuit_id = "" # Fill in the name of your compiled circuit here!
smart_contract_code = sindri.get_circuit_smart_contract_verifier(circuit_id)
with open("Verifier.sol", "w") as f:

JSONified Noir Proof Inputs

Feedback: Requiring Noir circuits to have TOML-formatted proof inputs, while every other framework accepts JSON, inhibits rapid development.

We updated the Sindri API proof-create endpoint to accept JSON-serialized inputs for any framework (TOML input for Noir is still fine!) This allows you to send the Prover.toml file to Sindri while you are developing your Noir circuit locally, but then use JSON-strings in production (avoiding the common "gotchas" surrounding the string parsing of a newline character). For more on Noir support see our Sindri x Nargo work.

A Unified Sindri + Nargo CLI DevEx


A few days ago, we announced the Sindri CLI's incorporation of Trail of Bit's useful command line tool Circomspect for Circom devs. For Noir devs, we are proud to introduce the integration of Nargo commands via the Sindri CLI. You can now access two circuit writing toolkits via a single library install! An example of one possibility that opens up is featured below:

Create a circuit with the Sindri CLI and analyze it with Nargo
npm install -g sindri@latest
sindri init noir-circuit # Go through the Q&A to produce a Noir circuit
cd noir-circuit
sindri x nargo info

Note that there are a number of nargo versions available. The sindri x nargo suite will choose the version matching your noirVersion field in the sindri.json manifest of your circuit directory. If that isn't found (maybe you have not started writing it), the latest available version of Nargo is used. For the full set of commands available, check out the reference docs.

A Unified Sindri + Circomspect CLI DevEx


This is the first of a number of enhancements to the CLI intended to ease frustration while writing circuits via the incorporation of key open-source libraries. Our initial integration builds in the Trail of Bits' Circom analysis tool: Circomspect. Previously, you could use sindri init to create a handful of circuits in different frameworks that are built from scratch via templates. That functionality allows you to quickly get started writing Circom circuits by filling in the essentials. With this new integration, you can use sindri x circomspect to analyze your circuit while its under development.

See the corresponding blog post for an in-depth description and a demo! For the full set of commands available, check out the reference docs.

Non-Blocking Option for Python Methods


If you've used Sindri's Python SDK (possibly by following along with our Python quickstart guide) then you may have noticed a pause when using the create_circuit and prove_circuit methods. Under the hood, these functions are submitting your circuit compile or prove job and polling until the status of the job is complete. While this abstraction is convenient for many cases, your application may have other tasks it can work on independently while Sindri's API processes these requests. For this reason, we added the wait argument to both create_circuit and create_proof.

If you'd like to utilize this "non-blocking" functionality, you can call the methods like so:

python snippet
import os
from sindri import Sindri
sindri = Sindri(os.getenv("SINDRI_API_KEY", ""))
proof_id = sindri.prove_circuit("my-circuit", '{"X": 2, "Y": 2}', wait=False)

The wait argument is assumed to be True if not found. Notice that we did not call create_circuit with wait=False in the code-block above. If we did, the proof would not properly execute because the circuit would not be ready by the time prove_circuit is called.

Extending Noir Version Support

Our initial Noir support was limited to v0.17.0. As the Noir documentation explicitly states:

Noir is in full-speed development. Things break fast, wild, and often.

This release extends our support to more of the latest stable Noir versions, including v0.17.0, v0.18.0, v0.19.4, v0.22.0, v0.23.0. You should indicate which version you are developing with when you upload your circuit to Sindri's API via the noirVersion field in your sindri.json manifest. While we recommend you choose the latest version available, it is more important to match the version of Noir you have installed locally - otherwise the proofs returned from Sindri might not be compatible with your local verifier or smart contract.