hopr-api 1.6.1

Common high-level external and internal API traits used by hopr-lib to implement the HOPR protocol
Documentation

hopr-api

Common high-level API traits for the HOPR protocol.

This crate defines the public API surface as traits only — no concrete implementations. Implementations live in the main hoprnet repository.

Modules

All modules are feature-gated:

Feature Module Description
chain chain On-chain operation APIs (accounts, channels, tickets…)
ct ct Cover traffic and probing API traits
db db Node database operation traits
graph graph Network graph topology, QoS, routing costs
network network Network state, peer observations, connectivity
node node High-level HOPR node API traits and state machine
full all Enables all of the above + serde

Usage

[dependencies]
hopr-api = { git = "https://github.com/hoprnet/hopr-api", features = ["full"] }

Development

Requires Nix with flakes enabled.

# Enter development shell
nix develop

# Build
cargo build

# Test
cargo test --lib

# Lint
cargo clippy

# Format
nix fmt

License

GPL-3.0-only