Docs

Start with the quickstart: run a server on your machine, create a mint, mint a note and move it between two purses with the worgl command. Then pick the SDK for your language, or read How it works first if you want the model before the code.

Start

• Quickstart: a server, a mint and a payment between two purses, on your machine.
• Concepts: notes, mints, layers, rotation and holders.
• Choosing a period and layer count: how long notes live, how often they move, and what a ledger costs.

Build

• Rust SDK: worgl-sdk, the holder’s side, and worgl-client, which runs it against a server.
• TypeScript SDK: the same purse for Node and browsers.
• The worgl command: a purse in an encrypted file, for scripts and for trying things out.
• Embedding the library: the issuer itself, inside your own program.

Operate

• Running a server, Running a cluster, Running a faucet
• Mint authorities and keys, Pausing a mint, Backups, Exporting a log for audit

Reference

• HTTP API, Error codes, Note format, Policy fields, Changelog
• Privacy model: what the mint, a payer and a payee each see.