Module v1 

Code implementing version 1 proof-of-work for onion service hosts.

Spec links:

• https://spec.torproject.org/hspow-spec/common-protocol.html
• https://spec.torproject.org/hspow-spec/v1-equix.html

Structs

PowManagerGeneric 🔒

This is responsible for rotating Proof-of-Work seeds and doing verification of PoW solves.

PowManagerStateRecord 🔒

On-disk record of PowManagerGeneric state.

RendRequestOrdByEffort 🔒

Wrapper around RendRequest that implements std::cmp::Ord to sort by [Effort] and time.

RendRequestReceiver 🔒

Implements Stream for incoming RendRequests, using a priority queue system to dequeue high-[Effort] requests first.

RendRequestReceiverInner 🔒

Inner implementation for RendRequestReceiver.

SeedsForTimePeriod 🔒

Information about the current and previous [Seed] for a given TimePeriod.

State 🔒

Internal state for PowManagerGeneric.

Enums

PowError

Error within the PoW subsystem.

PowSolveError 🔒

A PoW solve was invalid.

Constants

EXPIRATION_TIME_MINS_MAX 🔒

Maximum seed expiration time in minutes. See: https://spec.torproject.org/hspow-spec/v1-equix.html#parameter-descriptor

EXPIRATION_TIME_MINS_MIN 🔒

Minimum seed expiration time in minutes. See: https://spec.torproject.org/hspow-spec/v1-equix.html#parameter-descriptor

HS_UPDATE_PERIOD 🔒

How frequently the suggested effort should be recalculated.

PUBLISHER_UPDATE_QUEUE_DEPTH 🔒

Depth of the queue used to signal the publisher that it needs to update a given time period.

SEED_EARLY_ROTATION_TIME 🔒

How soon before a seed’s expiration time we should rotate it and publish a new seed.

SUGGESTED_EFFORT_DEADZONE 🔒

When the suggested effort has changed by less than this much, we don’t republish it.

Traits

MockablePowManager 🔒

Trait to allow mocking PowManagerGeneric in tests.

MockableRendRequest 🔒

Trait to allow mocking RendRequest in tests.

Type Aliases

PowManager 🔒

Proof-of-Work manager type alias for production, using concrete RendRequest.