Skip to main content

Crate hns_hnsr_protocol

Crate hns_hnsr_protocol 

Source
Expand description

Runtime-independent wire types for draft HIP #78 HNSR.

Re-exports§

pub use body::AcceptBody;
pub use body::CloseBody;
pub use body::ConfirmBody;
pub use body::ConfirmedBody;
pub use body::DataBody;
pub use body::ErrorBody;
pub use body::FindNodeBody;
pub use body::GetRouteBody;
pub use body::HnsrErrorCode;
pub use body::IncomingBody;
pub use body::NodesBody;
pub use body::OpenBody;
pub use body::OpenedBody;
pub use body::PutResultBody;
pub use body::PutRouteBody;
pub use body::RenewBody;
pub use body::RoutesBody;
pub use body::SampleRoutesBody;
pub use body::WindowBody;
pub use body::WithdrawBody;
pub use circuit::HnsrActionId;
pub use circuit::HnsrPeerId;
pub use circuit::HnsrRequester;
pub use circuit::HnsrRequesterConfig;
pub use circuit::HnsrRequesterEvent;
pub use circuit::HnsrRequesterSnapshot;
pub use circuit::HnsrRoute;
pub use circuit::HnsrRuntimeError;
pub use circuit::HnsrRuntimeStatus;
pub use circuit::OpaqueRelayConfig;
pub use circuit::OpaqueRelayRuntime;
pub use circuit::OpaqueRelaySnapshot;
pub use circuit::QueuedHnsrRoute;
pub use envelope::HnsrOpcode;
pub use envelope::HnsrPacket;
pub use named::NamedRoutePolicy;
pub use named::NamedRouteRecordV2;
pub use named::NamedRouteTrust;
pub use named::named_route_key;
pub use named::OwnerBoundChatRouteTrust;
pub use named::verify_owner_bound_chat_route;
pub use named_hrm::HrmNamedRoutePolicy;
pub use named_hrm::NamedRouteRecordV3;
pub use named_hrm::named_route_key_v3;
pub use record::EndpointDelegation;
pub use record::RelayTicket;
pub use record::ReserveRequest;
pub use record::RouteRecord;
pub use record::public_key;
pub use record::sign_withdrawal;
pub use record::verify_withdrawal;
pub use requester_hrm::CurrentNamedRouteV3;
pub use requester_hrm::HeldNamedRouteV3OperationLeases;
pub use requester_hrm::HeldNamedRouteV3RequesterLease;
pub use requester_hrm::NamedRouteV3LeaseAcquireError;
pub use requester_hrm::NamedRouteV3LeaseScopeError;
pub use requester_hrm::NamedRouteV3OperationLeaseWitness;
pub use requester_hrm::NamedRouteV3RequesterExpectation;
pub use requester_hrm::NamedRouteV3RequesterLeaseKey;
pub use requester_hrm::NamedRouteV3RequesterLeaseWitness;
pub use requester_hrm::NamedRouteV3RequesterOperationError;
pub use requester_hrm::NamedRouteV3RequesterSnapshot;
pub use requester_hrm::NamedRouteV3RequesterState;
pub use requester_hrm::NamedRouteV3RequesterStorageState;
pub use requester_hrm::ReconfirmedNamedRouteV3RequesterState;
pub use routing::NamedRouteV3LedgerSnapshot;
pub use routing::RendezvousContact;
pub use routing::RouteRecordModel;
pub use routing::RouteStore;
pub use routing::RouteStoreLimits;
pub use routing::compare_distance;
pub use routing::rendezvous_node_id;
pub use routing::route_key;
pub use routing::sample_score;
pub use runtime::ConfirmedReservation;
pub use runtime::EndpointReservation;
pub use runtime::HnsrService;
pub use runtime::RelayConfig;
pub use runtime::RelayLimits;
pub use runtime::RelayService;
pub use runtime::RendezvousService;

Modules§

body
circuit
Runtime-neutral HNSR requester and opaque circuit-relay state machines.
envelope
named
named_hrm
HRM/HNSA-backed version-3 named rendezvous routes.
record
requester_hrm
Durable requester-side downgrade and equivocation observations for current HRM/HNSA-backed named routes.
routing
runtime
Bounded live state machines for HNSR relay reservations and rendezvous publication/lookup.

Structs§

LeasedPersistentRendezvousService
Non-cloneable production rendezvous stage owning the sole-writer lease.
NamedRouteV3LeaseContext
Exact broker context held while loading, committing, and emitting.
NamedRouteV3LeaseLost
The broker no longer recognizes the owned lease as current.
NamedRouteV3StorageNamespace
Exact storage namespace and route-store configuration protected by a lease.

Enums§

HnsrProtocolError
LeasedPersistentRendezvousError
Infrastructure failure from a leased handle-and-emit operation.
LeasedPersistentRouteMutationError
Failure from a leased current-authority route operation.
NamedRouteV3Emission
A wire result delivered to the embedding while the lease is held.
NamedRouteV3GuardedCallbackError
Error reported by storage/load/emission while inside the lease boundary.
NamedRouteV3LedgerExpectation
Exact durable precondition for a V3 admission-ledger proposal.
NamedRouteV3LedgerStorageState
Authenticated external storage state returned by the post-acquisition loader.
NamedRouteV3OpenError
Failure while acquiring the lease and loading authenticated storage.

Constants§

DEFAULT_WINDOW
HNSR_PACKET_TYPE
HNSR_RELAY_SERVICE
HNSR_RENDEZVOUS_SERVICE
HNSR_VERSION
HNS_CHAT_V1
HNS_NODE_V1
HNS_SHAKESCAPE_SWAP_V1
Opaque, end-to-end authenticated Shakescape atomic-swap sessions.
HNS_WEB_V1
MAX_CIRCUITS
MAX_CIRCUIT_QUEUE
MAX_CONTACTS
MAX_DATA_SIZE
MAX_DELEGATION_LIFETIME
MAX_FIND_QUERIES
MAX_PACKET_SIZE
MAX_RECORDS_PER_KEY
MAX_RECORD_SIZE
MAX_ROUTE_LIFETIME
MAX_ROUTING_CONTACTS
MAX_SIGNATURE_SIZE
MAX_STORED_RECORDS
MAX_TICKET_LIFETIME
MAX_WINDOW
MIN_ROUTE_STORES
MIN_WINDOW
ROUTE_REPLICATION

Traits§

NamedRouteV3SoleOwnerLease
A trusted embedding’s RAII proof of sole ownership of one namespace.