Overview
Understand Opertus, its privacy model, and the path from public assets to private notes.
Opertus is a multi-asset shielded pool for private payments and programmable onchain transactions. Assets are held by a shared contract, while ownership is represented by encrypted notes rather than public account balances.
The chain sees commitments, nullifiers, and assets that publicly enter or leave. It does not see a note's owner or value, or which commitment a nullifier spent. These docs are for developers building wallets and apps on Opertus, and for anyone reviewing the protocol.
Experimental protocol
Opertus is experimental. It has not been audited, and there is no production deployment. Do not use it to secure real funds.
Asset lifecycle
Shield
A deposit moves public assets into the pool and inserts one note commitment. Deposits do not require a proof.
Transfer
A Groth16 proof spends 1, 2, 4, or 8 notes of one token and creates exactly three output notes. No public asset moves.
Compose
The same spend can route a public amount through one external call and shield up to four assets returned by that call.
Unshield
A valid proof publishes nullifiers and sends the public amount, minus protocol fees, to a public recipient.
Every spend conserves value: the inputs equal the outputs plus the public amount.
A note is private ownership
A note is one token and one value, owned by a one-time key and hidden behind a
Poseidon commitment. The pool stores only the commitment. Spending publishes a
nullifier derived from it, so the contract can reject a second spend without
learning which leaf was consumed. ETH uses token ID 0. See
keys and notes for the exact fields and
constructions.
Two keys, two capabilities
One recovery phrase derives independent view and spend branches.
| Capability | Construction | What it allows |
|---|---|---|
| View | secp256k1 | Decrypt notes, read private amounts, and detect spends |
| Spend | BabyJubJub | Derive a note's one-time secret and authorize a proof |
The view key cannot be converted into the spend key. This makes watch-only clients possible, although anyone holding the view key can read the wallet's private transaction data.
What is public
Opertus provides note privacy, not transaction anonymity. Deposits, withdrawals, recipients, external calls, and timing remain public. The privacy model has the full list of what is hidden and what is not.
The stack
Contracts
Hold assets, verify proofs, enforce nullifiers, maintain roots, and execute unshields.
Circuits
Prove note ownership, Merkle inclusion, valid nullifiers, and value conservation.
@opertus/core
Synchronize events, build witnesses, generate proofs, and prepare transactions.
@opertus/wallet
Derive keys, create and scan encrypted notes, and manage local note state.
@opertus/crypto
Implement commitments, nullifiers, stealth ownership, and clone salts.
@opertus/sdk
Talk to the installed wallet for status, balances, and shielded sends.
Choose your next destination
Get started
Install the SDK and read your first balance.
Submit through a relayer
Understand gas submission, private fee notes, and relayer validation.
Understand the protocol
Study trees, spends, executors, fees, and exact key constructions.
Review security
Evaluate the privacy model and deployment threat boundary.
Use the SDK
Find the current integration interfaces and package references.
Trade perpetuals
Hold a leveraged position from a private balance against a hedged vault.