No description
  • Rust 88.7%
  • Shell 6.8%
  • TypeScript 3.2%
  • HTML 0.6%
  • Makefile 0.4%
  • Other 0.2%
Find a file
Scott Yeager 7b6b030ec6
Some checks failed
Bootstrap Test / bootstrap (push) Failing after 5s
Test / build-and-test (push) Successful in 5m4s
Add token transfer convenience methods to JS client
2026-02-24 22:53:33 +00:00
.claude Add cluster_manager module and refactor provision module 2026-01-23 07:33:43 +01:00
.forgejo/workflows Use versioned builder image 2026-02-24 02:52:55 +00:00
_archive Remove all Docker functionality and archive to _archive/docker 2026-02-05 10:00:41 +04:00
contracts Make interruptible reservations use a bid system with preemption 2026-02-24 02:55:21 +00:00
docker Update Dockerfile.builder 2026-02-20 21:35:33 +00:00
docs Eliminate unused data items from nodes 2026-02-20 03:50:10 +00:00
examples Make interruptible reservations use a bid system with preemption 2026-02-24 02:55:21 +00:00
js-client Add token transfer convenience methods to JS client 2026-02-24 22:53:33 +00:00
rhaitests Extend DNS to work for groups and identity 2026-02-18 00:43:05 +00:00
scripts Fix bootstrap 2026-02-21 01:11:50 +00:00
specs Fix Makefile cargo and shell compatibility 2026-02-08 07:07:52 +04:00
src Register account with tokens even if it was activated before, on CLI 2026-02-24 22:12:16 +00:00
.env.example Cleanup 2026-02-03 05:36:11 +00:00
.gitignore Add organized Rhai examples and contract documentation 2026-01-21 05:32:54 +01:00
.mcp.json Initial commit: NEAR SPORE token setup with MCP server management 2026-01-01 09:01:48 +01:00
buildenv.sh Rename binary 2026-02-18 01:54:32 +00:00
Cargo.lock Update use of zinit for new version 2026-02-24 19:04:02 +00:00
Cargo.toml Update use of zinit for new version 2026-02-24 19:04:02 +00:00
CLAUDE.md Instructions to make new rhai scripts executable 2026-02-18 06:43:22 +00:00
Makefile revert binary names to heroledger/heroledger_relayer and CI to all branches 2026-02-13 16:00:39 -05:00
README.md update repo location 2026-02-05 00:20:44 +00:00
rust-toolchain.toml Update Cargo.lock dependencies and pin Rust toolchain to 1.93 2026-02-22 06:18:13 +03:00

Hero Ledger

A NEAR-compatible blockchain with its own network, validators, and token economy.

  • 9 Smart Contracts: SPORE, GLD, USDH tokens, SPOREX exchange, DNS, Credit Vault, Groups, KVS, Hosting
  • heroledger CLI: Command-line interface for all operations
  • Rhai Scripting: Automation and testing scripts

Quick Start

Prerequisites: make and curl must be installed.

# Ubuntu/Debian
sudo apt-get install make curl

# macOS
xcode-select --install  # includes make
brew install curl       # if needed

Bootstrap (From Nothing)

git clone https://forge.ourworld.tf/lhumina_code/hero_ledger.git
cd hero_ledger
make bootstrap

This will:

  1. Install system packages (Ubuntu/Debian only)
  2. Install Rust and cargo-near
  3. Build all contracts and CLI
  4. Install binaries to ~/hero/bin
  5. Start local chain and deploy contracts

Development Workflow

make setup           # Install dependencies (once)
make build           # Build debug binary (fast)
make install         # Build and install to ~/hero/bin
make test            # Run smoke + full tests

For optimized builds:

make build-release   # Build release binary
make install-release # Install release binary

Available Targets

make help            # Show all targets

# Setup
make setup           # Install system packages, Rust, cargo-near

# Build
make build           # Debug build (contracts + CLI)
make build-release   # Release build (optimized)
make build-contracts # Build WASM contracts only
make check           # Fast syntax check
make fmt             # Format code
make lint            # Run clippy

# Install
make install         # Debug build to ~/hero/bin
make install-release # Release build to ~/hero/bin

# Chain Management
make bootstrap       # Full setup from nothing
make chain-init      # Initialize single-node chain
make chain-destroy   # Destroy local chain and clean up

# Testing
make test            # Run all tests
make test-smoke      # Quick smoke test
make test-full       # Full system test
make test-unit       # Rust unit tests

make clean           # Remove build artifacts

CLI Usage

# Account operations
heroledger list                              # List accounts
heroledger <account> info                    # Account details
heroledger <account> send SPORE 100 <to>     # Send tokens

# SPOREX Exchange
heroledger <account> x rates                 # View rates
heroledger <account> x fund SPORE 100        # Deposit
heroledger <account> x withdraw SPORE 50     # Withdraw

# KVS (Key-Value Store)
heroledger kvs namespaces                    # List namespaces
heroledger <account> kvs create myapp.config # Create namespace
heroledger <account> kvs set myapp.config key value

# DNS
heroledger dns available example.hero        # Check availability
heroledger <account> dns register example.hero 12  # Register for 12 months

# Groups
heroledger groups list                       # List groups
heroledger <account> groups create mygroup "Description"

# Credit Vault
heroledger credit spenders                   # List spenders
heroledger <account> credit deposit bucket1 100

Run heroledger --help for full command reference.


Smart Contracts

Contract Address Purpose
SPORE my_spore.test.hero Primary token (10B supply, NEP-141/NEP-148)
GLD my_gld.test.hero Digital Gold token
USDH my_usdh.test.hero USD stablecoin
SPOREX sporex.test.hero Token exchange
DNS my_dns.test.hero Domain registration
Credit my_credit.test.hero Pull-based payments
Groups my_groups.test.hero Group management
KVS kvs.test.hero Key-value storage
Hosting my_hosting.test.hero Infrastructure registry

Rhai Scripting

Automate workflows with Rhai scripts:

near_localnet("http://localhost:3030");
near_accounts_dir("./accounts");

let alice = account("my_test_1");
print(`Balance: ${alice.balance_near()} NEAR`);

token_send()
    .from("my_test_1")
    .to("my_test_2")
    .amount(100)
    .token("spore")
    .execute();

Run scripts:

heroledger my_script.rhai
heroledger rhaitests/smoke/test_smoke.rhai      # 9 smoke tests
heroledger rhaitests/system/test_full_system.rhai  # 35 system tests

See the Rhai scripting module in src/rhai/ for more examples.


Testing

make test              # Run smoke + full tests
make test-smoke        # Quick smoke test
make test-full         # Full system test
make test-unit         # Rust unit tests

Project Structure

hero_ledger/
├── contracts/           # 9 smart contracts
├── src/                 # SDK and CLI source
│   ├── bin/             # CLI binaries
│   ├── rhai/            # Rhai scripting engine
│   └── ...
├── rhaitests/           # Test scripts
├── examples/            # Rhai and Rust examples
├── docker/              # Docker configuration
└── docs/                # Documentation

Docker

For containerized deployments, see docker/README.md.

make docker-build-full   # Build full image with neard
make docker-test-full    # Build and run all tests
make docker-build-cli    # Build CLI-only image

Documentation