Documentation
Technical documentation for Shekyl — from getting started to protocol internals.
Getting Started
CLI User Guide
Comprehensive guide to the Shekyl CLI tools: daemon, wallet, staking, mining, multisig, and more.
Installation Guide
Build and install Shekyl from source on Linux, macOS, Windows, and more.
Executables
Overview of all shipped binaries: shekyld, wallet CLI, wallet RPC, and blockchain utilities.
Blockchain Networks
Mainnet, testnet, and stagenet configuration and connection details.
Cryptography
Post-Quantum Cryptography
Hybrid PQC scheme design: Ed25519 + ML-DSA-65 signatures, ML-KEM-768 key encapsulation, and per-output keys.
FCMP++ Full-Chain Membership Proofs
Comprehensive specification for FCMP++: curve tree structure, dual-layer security model, consensus rules, and wallet integration.
PQC Multisig
M-of-N post-quantum multisig: signature-list design, security model, and size analysis.
Merkle Tree
Merkle tree construction for transaction and block integrity verification.
Protocol & Design
Design Concepts
Core architectural concepts: CryptoNote foundations, privacy model, and consensus design.
V3 Rollout
TransactionV3 activation plan, FCMP++ integration, and hard fork coordination.
Upgrade Policy
Feature-driven hard fork policy and network upgrade procedures.
Levin Protocol
P2P network protocol specification for node-to-node communication.
Portable Storage
Binary serialization format used for P2P messages and internal data structures.
Anonymity Networks
Tor and I2P integration for transaction routing and network-level privacy.
Economics & Governance
Genesis Transparency
Genesis block allocation, audit methodology, and supply verification.
Staker Reward Disbursement
Claim-based staker rewards, activation phases, and disbursement mechanics.
Shard Visualization
How archival staking shards get deterministic visual identities in the wallet.
Economy Testnet Readiness
Readiness checklist for economic model testing on testnet.
Development
Compiling, Debugging & Testing
Build targets, debugging tips, and test infrastructure for contributors.
Contributing
How to contribute: code style, pull request workflow, and review process.
Releasing
Release process, tagging, and binary distribution procedures.
Release Checklist
Step-by-step checklist for cutting a new release.
Documentation TODOs & PQC
Tracking document for PQC integration progress and outstanding documentation work.
Internationalization
Translation guide for contributing to Shekyl documentation in other languages.
Reference
Daemon RPC (Rust)
Rust-native RPC interface for shekyld: endpoints, types, and usage examples.
Wallet RPC (Rust)
Rust-native wallet RPC interface: account management, transfers, and signing.
Proxies
Configuring HTTP and SOCKS proxies for shekyld and wallet connections.
Changelog
Full history of changes, features, and fixes across all releases.