pkg/

Package ad is an abstract message type that composes the common elements of all ads - nonce ID, public key (identity), expiry and signature.

Package addresses defines the message format that provides the network multi-address of a peer with a given public identity key.

Package intro defines a message type that provides information about an introduction point for a hidden service.

Package load provides a message type that provides information about the current load level of a node identified by its public key.

Package peer provides a message type that provides the base information, identity key and relay rate for an Indra relay.

Package services provides a message type for advertising what kinds of exit services a peer provides to clients, including the port number and the cost per megabyte of data.

Package balance provides an onion layer message that comes in response to a getbalance query, informing the client of the balance of a session, identified by the getbalance nonce.ID.

Package confirmation provides an onion message type that simply returns a confirmation for an associated nonce.ID of a previous message that we want to confirm was received.

Package end is a null tombstone type onion message that indicates there is no more data in the onion (used with encoding only).

Package response provides a message type in response to an Exit message.

Package crypt is an onion message layer which specifies that subsequent content will be encrypted.

Package delay provides an onion message type that allows a client to specify an arbitrary delay time before processing the rest of an onion message.

Package exit is an onion message type that contains a payload intended to be forwarded to the exit service of a relay.

Package forward is an onion message layer that specifies a single redirection for the remainder of the onion.

Package getbalance provides an onion message layer type that makes a request for the current balance of a session.

Package introquery is an onion message that verifies a relay is an introducer for a given hidden service, returning its intro.Ad.

Package ready provides an onion message type that is sent via client provided routing header back to the client after an introducer forwards a route message to initiate a hidden service connection.

Package route provides an onion mesage type that initiates a hidden service connection with a designated introducer who holds the forwarding routing header to send the route message to a hidden service, who replies to the client using their reply routing header with a ready message.

Package services provides a message type for hidden services to send to designated introducer relays.

Package whisper provides a message type for sending a message to a hidden service, or back to a hidden service client.

Package reverse provides a message type for the forwarding directions in a 3 layer routing header.

Package session provides an onion message type that delivers the two session private keys to be associated with a session, for which the hash of the secrets was used as the payment preimage for starting a session.

Package ont defines interfaces for the engine: Ngin and Onion coding.Codec subtypes, and some helpers that use the abstraction.

Package reg is a registry for message types that implement the coding.Codec interface.

Package ciph manages encryption ciphers and encrypting blobs of data.

Package nonce provides a simple interface for generating standard AES encryption nonces that give strong cryptographic entropy to message encryption, as well as 8 byte (64 bit) random private identifiers for references between types.

Package sha256 provides a simple interface for single and double SHA256 hashes, used with secp256k1 signatures, message digest checksums, cloaked public key "addresses" and so on.

Package ads provides a bundle for peer information advertisement types and initial generation of them, and deriving a peer node data structure from the ad set received over the gossip network.

Package consts is a series of constants common to several different onion message types.

Package dispatcher is a network packet send/receive handler for peer to peer connections between relays.

Package magic is a simple specification and error helper for message identifying 4 byte strings that are used for the switching logic of a relay.

Package node is a specification for the in-memory metadata related to an indra network peer.

Package packet handles segmenting messages into uniform sized packets and generating a stream of cipher halves and receiver cloaked addresses to encrypt them with, and reassembling the segments into the original messages.

Package payments provides an abstraction above the implementation for handling Lightning Network payments and storing pending payments awaiting session keys.

Package responses handles waiting for and responding to received responses, including tracking the session billing and custom callback hooks when responses arrive.

Package services defines the base data structure for a service.

Package sess provides the Session Manager, which keeps track of a client's sessions.

Package sessions defines some key data structures relating to the data for sessions, imported by sess package for reading and writing session and circuit metadata.

Package tpt provides the definition of the interface Transport, which is an abstraction used for reading and writing to peers via transport.Transport.

Package transport provides a set of definitions of abstractions that layer above the implementation enabling the use of simple functions that interact on channels to queue and receive messages from the tpt.Transport of which several variants are here implemented.

Package metrics provides a simple logging update of the status of a seed node and its peer and connection counts.

Package log is a logging subsystem that provides code optional location tracing and semi-automated subsystem registration and output control.

Package appdata provides access to the current operating system's proper default application data directory, where we can read and write, and ideally, not have other processes also read and write (as in android/iOS).

Package b32 is an isolated package for storing the based32 cipher set.

Package based32 provides a simplified variant of the standard Bech32 human readable binary codec

Package codec provides a high level abstraction for a customisable binary data encoder with a string encoding.

Package codecer is the interface definition for a Human Readable Binary Transcription Codec

Package cryptorand augments the standard math/rand library with cryptographic entropy seeding.

Package file provides some helpers for working with files and folders, specifically making possibly multi-level deep new directories based on a pathspec and testing whether a file exists.

Package math provides a simple 32 bit unsigned integer minimum function.

Package multi provides several functions for working with multiaddr.Multiaddr and netip.AddrPort types, including public key p2p identifiers.

Package norm is a string comparison library that makes everything lowercase before comparison for case insensitive equality testing.

Package path provides a simple string slice representation for paths, equally usable for filesystems or HD keychain schemes.

Package qu provides observable quit and trigger signal channels that forgive common errors like closing closed channels and signaling closed channels, normally causing a panic.

Package slice is a collection of miscellaneous functions involving slices of bytes, including little-endian encoding for 16, 32 and 64-bit unsigned integers used for serialisation length prefixes and system entropy based hash chain padding.

Package splice is a collection of tools for encoding and decoding variables into byte buffers with a fluent chained method interface.

Package tests provides some helpers for tests.

Package windows provides some tools for handling launching subprocesses on windows using cmd.exe.