Welcome to Panurus documentation.
- Panurus Overview: Start here to understand the architecture, key concepts (Tokens, Wallets, Privacy), and layers of Panurus.
- Token API: The high-level API for interacting with tokens.
- Token API Usage: API Usage Guide.
- Driver API: The interface for building token drivers.
- Configuration: Panurus configuration.
- Services: Additional services like transaction assembly.
- Upgradability: How to upgrade tokens, drivers, and storage.
- Public Parameters Lifecycle: How public parameters are generated, published, and updated across the network.
- HTLC Deadlines and Clock Synchronisation: The clock-synchronisation assumption that the HTLC claim/reclaim deadline rests on, and the deadline margin it requires of a deployment.
- Selector Resource Limits: How to throttle token selection, either with the opt-in built-in per-wallet rate limiter or by supplying your own limiter or
Locker.
Panurus ships several standalone CLI tools, each living in its own Go module under cmd/.
| Tool | Description |
|---|---|
| tokengen | Generates public parameters, token chaincode packages, and other cryptographic artifacts. Used to pre-configure development and test environments. |
| artifactgen | Topology-driven artifact generation (previously part of tokengen). Kept separate to avoid pulling in the integration/nwo test framework. |
| skicleanup | Diagnostic tool that lists orphaned signer entries and their derived SKIs. Connects directly to an existing Panurus database (SQLite or PostgreSQL). |
If you are developing using Panurus or contributing to Panurus, check out the Development section.
- Evolution Summary (v0.4.0 -> Present): A summary of how the functionalities provided by Panurus have evolved since tag v0.4.0 when it was still called
token-sdk.
- Fabric Smart Client: The underlying platform.
- Fabric Samples: Runnable examples.