cardano-base-rust
cardano-base
Complete Haskell → Rust Migration: ✅ DONE
This repository contains the pure Rust foundations that back Cardano’s consensus components. The migration from Haskell to Rust is 100% complete, with all C and Haskell code removed.
🔒 Security Update: Comprehensive security hardening completed (Oct 2025). See IMPROVEMENTS_SUMMARY.md for details.
📚 Documentation
Comprehensive documentation is available in the GitHub Wiki
Quick links:
- 📦 All Packages - Overview of all 13 Rust packages
- 🔐 VRF API Reference - Pure Rust VRF implementation guide
- 🚀 Migration Summary - Complete migration journey
- 🛠️ Development Guide - Technical research and decisions
- 🤝 Contributing - How to contribute
🎯 Pure Rust Achievement
This project has achieved 100% pure Rust with:
- ✅ 0 C files (removed 26 files, 9,716 lines)
- ✅ 0 Haskell files (100% migrated)
- ✅ 148 tests passing (100% success rate)
- ✅ Pure Rust VRF (IETF Draft-03 and Draft-13 compliant)
- ✅ Zero unsafe code in critical paths
📦 Workspace Packages
Core Cryptographic
- cardano-crypto-class – Main cryptographic library (VRF, hashing, signatures)
- cardano-vrf-pure – Pure Rust VRF implementation (curve25519-dalek)
Core Data & Serialization
- cardano-base – Base types and utilities
- cardano-binary – CBOR encoding/decoding
- cardano-slotting – Time and slot management
- cardano-strict-containers – Strict evaluation containers
Utilities
- base-deriving-via – Generic deriving helpers
- deepseq – Deep evaluation utilities
- nothunks – Thunk detection for space leak prevention
- heapwords – Heap allocation tracking
- measures – Measurement abstractions
- orphans-deriving-via – Orphan instance helpers
- cardano-git-rev – Git revision tracking
Each package includes comprehensive documentation, unit tests, and integration tests.
🚀 Quick Start
Building
Install a stable Rust toolchain (rustup) and build:
# Build all packages
cargo build --workspace
# Build with optimizations
cargo build --workspace --release
Testing
Run the comprehensive test suite (148 tests):
# All tests
cargo test --workspace
# Specific package
cargo test --package cardano-vrf-pure
# With output
cargo test --workspace -- --nocapture
Documentation
Generate and view documentation:
# Generate docs for all packages
cargo doc --workspace --no-deps --open
# Specific package
cargo doc --package cardano-crypto-class --open
🔐 VRF Implementation
The pure Rust VRF implementation (cardano-vrf-pure) provides:
- IETF VRF Draft-03 (ECVRF-ED25519-SHA512-ELL2, 80-byte proofs)
- IETF VRF Draft-13 (ECVRF-ED25519-SHA512-TAI, 128-byte proofs, batch-compatible)
- 100% Pure Rust using curve25519-dalek v4.1
- Cryptographically Verified with 9 internal security tests
See VRF API Documentation for detailed usage.
🛠️ Development
All packages target Rust edition 2021 and follow standard Rust conventions:
# Check code
cargo check --workspace
# Format code
cargo fmt --all
# Lint code (with security-focused checks)
cargo clippy --workspace --all-targets -- -D warnings
# Security audit
cargo audit
# License/dependency checking
cargo deny check
Code Quality
The workspace enforces strict quality standards:
- Clippy lints: correctness=deny, unwrap_used=warn, panic=warn
- Format checking: rustfmt configuration enforced
- Security scanning: Automated vulnerability detection
- License compliance: Dependency license validation
See SECURITY_PRACTICES.md for security guidelines and PRE_COMMIT_CHECKLIST.md for commit requirements.
🤝 Contributing
We welcome contributions! Please see:
📄 License
This project is dual-licensed under Apache-2.0 and MIT licenses. See LICENSE files in individual packages for details.
🎉 Migration Complete
The Haskell → Rust migration is complete! All functionality has been successfully ported to pure Rust with enhanced type safety, memory safety, and performance.