Skip to content

README.md

Latest commit

 

History

History
77 lines (61 loc) · 4.01 KB

README.md

File metadata and controls

77 lines (61 loc) · 4.01 KB

RustChain Documentation

RustChain is a Proof-of-Antiquity blockchain that rewards vintage hardware with higher mining multipliers. The network uses 6 hardware fingerprint checks to prevent VMs and emulators from earning rewards.

Quick Links

Document Description
Developer Tutorial 🆕 Comprehensive guide: setup, mining, transactions, examples
Protocol Specification Full RIP-200 consensus protocol
Mechanism Spec + Falsification Matrix One-page claim-to-test map with break conditions
API Reference All endpoints with curl examples
Build Guide Local Python and Rust build commands
Local Devnet Run a single-node development server
CLI Wallet Walkthrough Create a wallet and simulate a transaction
Glossary Terms and definitions
Tokenomics RTC supply and distribution
FAQ & Troubleshooting Common setup/runtime issues and recovery steps
Wallet User Guide Wallet basics, balance checks, and safe operations
Contributing Guide Contribution workflow, PR checklist, and bounty submission notes
Smart Contract Developer Guide Contract quickstart, lifecycle, deployment, and security checklist
Reward Analytics Dashboard Charts and API for RTC reward transparency
Cross-Node Sync Validator Multi-node consistency checks and discrepancy reports
Discord Leaderboard Bot Webhook bot setup and usage
Chinese Documentation Community-maintained Chinese documentation entry point
Chinese API Quick Reference Chinese quick reference for common public API queries
Japanese Quickstart (日本語) Community-maintained Japanese quickstart guide

Live Network

  • Primary Node: https://rustchain.org
  • Explorer: https://rustchain.org/explorer/
  • Health Check: curl -fsS https://rustchain.org/health
  • Network Status Page: docs/network-status.html (GitHub Pages-hostable status dashboard)

Current Stats

# Check node health
curl -fsS https://rustchain.org/health | jq .

# List active miners
curl -fsS https://rustchain.org/api/miners | jq .

# Current epoch info
curl -fsS https://rustchain.org/epoch | jq .

Architecture Overview

┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│  Vintage Miner  │────▶│ Attestation Node │────▶│  Ergo Anchor    │
│  (G4/G5/SPARC)  │     │  (rustchain.org)  │     │ (Immutability)  │
└─────────────────┘     └──────────────────┘     └─────────────────┘
        │                        │
        │ Hardware Fingerprint   │ Epoch Settlement
        │ (6 checks)             │ Hash
        ▼                        ▼
   ┌─────────┐              ┌─────────┐
   │ RTC     │              │ Ergo    │
   │ Rewards │              │ Chain   │
   └─────────┘              └─────────┘

Getting Started

  1. Check if your hardware qualifies: See CPU Antiquity Guide
  2. Install the miner: See INSTALL.md
  3. Register your wallet: Submit attestation to earn RTC

Bounties

Active bounties: github.com/Scottcjn/rustchain-bounties

Documentation maintained by the RustChain community.