The SDK is source only. Version 0.1 is a directory in the repository. Nothing is published to crates.io or npm. You build from source.
The public devnet is not an open developer network. It is reached through a gateway that serves admitted cohort wallets, and its browser path relays shielded payments only. Development happens on a local network.
Formats are experimental. Wire formats, account layouts and identifiers are development values and can change without migration.
In this section
- Developer SDKVersion 0.1: runnable offline examples, three crates you can depend on, the Wasm build script, TypeScript types and a JSON-RPC client.
- Your first shielded paymentA tutorial: your own crate builds, proves and verifies a deposit and a private send, offline.
- Build and run the codePrerequisites, the commands from the README, the repository layout, tests, and where the candidate patch series lives.
- Run a local networkStart a disposable two-validator network and send a shielded payment, step by step.
- Crates and command-line toolsEvery crate and binary a developer can use, with its commands, and the browser core.
- RPC and gatewayThe JSON-RPC methods the wallets call and what the gateways allow.
- Protocol referenceInstructions, account layouts, the payment wire format, constants and errors.
- Integration guidelinesHow a client should build, quote, submit and recover a private payment.
- What does not exist yetNo published packages, no open devnet, and what to do instead.
Five minutes: verify a real proof
The smallest useful thing to run needs no network and no funds. It builds a real shielded-payment proof, stages it the way the chain would receive it, and verifies it.
git clone https://github.com/zolanacom/zolana.git
cd zolana
sh tools/dev.sh fetch --locked
sh tools/dev.sh run --offline --locked -p payment-lab -- proof-smoke
On success it prints, among other lines:
Offline synthetic payment fixture; no network, ledger or real funds.
Real Orchard proof, spend signatures and binding signature: verified
Receiver decrypted the payment and sender recovered change.
You need Rust 1.92, a C/C++ toolchain and network access for the one fetch step. The details are on Build and run the code. For six more offline examples that show how to call the libraries yourself, continue with the Developer SDK.
Which part does what
| If you want to | Look at |
|---|---|
| Start from runnable examples, types and a build script | The developer SDK in sdk |
| Verify or encode a payment, or read pool state | native-payments in protocol/payments |
| See how the validator executes a payment | native-payment-program in node/adapter |
| Build proofs and replay history without RPC or files | native-wallet-core in clients/wallet-core |
| Drive a wallet from the command line | native-wallet in clients/wallet |
| Run the same core in a browser | zolana-browser-core in clients/browser-core and the page in clients/browser-wallet |
| Start a local network | tools/localnet.py and native-localnet in node/localnet |
| Understand a design choice | The numbered records in docs/decisions |
Ground rules for these pages
Every command and constant in this section is taken from the public repository. Where a runbook depends on something that is not in the repository, the page says so. Where a number comes from tooling and not from the live network, the page says that too.
The code is under the MIT licence; the vendored Agave snapshot is under Apache-2.0. Nothing here has been independently audited.