hopr-api 1.6.0

Common high-level external and internal API traits used by hopr-lib to implement the HOPR protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# hopr-api

Common high-level API traits for the [HOPR protocol](https://hoprnet.org/).

This crate defines the public API surface as **traits only** — no concrete implementations.
Implementations live in the main [hoprnet](https://github.com/hoprnet/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

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

## Development

Requires [Nix](https://nixos.org/) with flakes enabled.

```bash
# Enter development shell
nix develop

# Build
cargo build

# Test
cargo test --lib

# Lint
cargo clippy

# Format
nix fmt
```

## License

[GPL-3.0-only](LICENSE)