What you can build
Quickstart
Create a shielded account, register, deposit, settle and withdraw with the SDK.
SDK reference
The packages, the
Core class, the request types and the services you supply.Integrate a DeFi protocol
Write an adaptor so users can reach your protocol from a shielded balance.
Private Sub-accounts SDK
Derive Sub-accounts, fund them, buy return gas and bring the money back on HyperEVM.
Relayer API
The HTTP interface of the HyperEVM relayer.
Troubleshooting
Errors from the SDK and the pool, and what causes them.
For agent-assisted developers
Rules and entry points for coding agents working in this repo.
How the pieces fit
The SDK builds, signs and proves. It does not submit the transaction, and it does not ship a data source. You provide both. The quickstart shows where each one plugs in.
Two ways to submit
Deposits always use the wallet path, because the user’s tokens move from their wallet. See Relaying and gas for how the fee works on each path.
Before you start
- Read How Palliora DeFi works. It takes five minutes and the rest of this section assumes it.
- You need Node.js, a wallet key for a test network, and the pool address for that network. Addresses live in Network reference.
- You need the circuit files (the
.wasmand.zkeyfor each circuit). The prover loads them by path.
Package names
The SDK packages are being renamed from@veilnyx-sdk/* to @palliora.org/defi-*. This section uses the new names. Until the rename ships, install the old names and change only the import paths. The mapping is in the Rename map.