Bittensor Rust SDK

A collection of Rust crates for interacting with the Bittensor blockchain network.

Workspace Structure

This monorepo contains the following crates:

Crate	Description	Crates.io
bittensor-rs	Core SDK for Bittensor chain interactions
bittensor-wallet	Wallet management with Python bindings	-
lightning-tensor	Terminal UI for Bittensor	-

Quick Start

Using bittensor-rs

Add to your Cargo.toml:

[dependencies]
bittensor-rs = "0.1"

use bittensor::{config::BittensorConfig, Service};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Connect to Finney mainnet
    let config = BittensorConfig::finney("my_wallet", "my_hotkey", 1);
    let service = Service::new(config).await?;
    
    // Query metagraph
    let metagraph = service.get_metagraph(1).await?;
    println!("Found {} neurons", metagraph.hotkeys.len());
    
    Ok(())
}

Development

Prerequisites

• Rust 1.70 or later
• Protocol Buffers compiler (protoc)

Building

# Build all crates
cargo build --workspace

# Build with all features
cargo build --workspace --all-features

# Run tests
cargo test --workspace

# Run specific crate tests
cargo test -p bittensor-rs

Using Just (Recommended)

This project includes a justfile for common tasks:

# Install just: https://github.com/casey/just
cargo install just

# See available commands
just --list

Documentation

• bittensor-rs API docs - Full API documentation on docs.rs
• bittensor-wallet README - Wallet crate documentation

Contributing

Contributions are welcome! Please follow these guidelines:

1. Conventional Commits: Use conventional commit format:

   • feat: add new feature
   • fix: resolve bug
   • docs: update documentation
   • chore: maintenance task

2. Pull Requests: All changes should go through PR review

3. Testing: Add tests for new functionality

Release Process

This repository uses release-please for automated releases:

1. Merge PRs with conventional commits to main
2. Release-please automatically creates/updates a release PR with changelog
3. Merge the release PR to trigger a GitHub release
4. The publish workflow automatically publishes to crates.io

License

MIT License - see LICENSE for details.

Related Projects

• Bittensor - Python SDK and CLI
• Subtensor - Bittensor blockchain node