vincenzopalazzo
/
arti
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
arti/crates/tor-netdir
History
Ian Jackson f84d8777db cargo fmt to remove blank lines 
Apparently cargo fmt doesn't like these, which my perl rune didn't
delete.

This commit is precisely the result of `cargo fmt`.
 		2022-10-12 15:29:04 +01:00
..
src cargo fmt to remove blank lines 2022-10-12 15:29:04 +01:00
Cargo.toml Bump crates that have had backward compatible API changes. 2022-10-03 09:52:34 -04:00
README.md Update README.md files (automated). 2022-05-06 09:51:11 -04:00

README.md

tor-netdir

Represents a clients'-eye view of the Tor network.

Overview

The tor-netdir crate wraps objects from tor-netdoc, and combines them to provide a unified view of the relays on the network. It is responsible for representing a client's knowledge of the network's state and who is on it.

This crate is part of Arti, a project to implement Tor in Rust. Its purpose is to expose an abstract view of a Tor network and the relays in it, so that higher-level crates don't need to know about the particular documents that describe the network and its properties.

There are two intended users for this crate. First, producers like [tor-dirmgr] create [NetDir] objects fill them with information from the Tor network directory. Later, consumers like [tor-circmgr] use [NetDir]s to select relays for random paths through the Tor network.

Limitations

Only modern consensus methods and microdescriptor consensuses are supported.

License: MIT OR Apache-2.0