Skip to main content

IgcIrohNode

Struct IgcIrohNode 

Source
pub struct IgcIrohNode { /* private fields */ }
Expand description

Runtime handle for an igc-net node.

Holds the iroh endpoint, iroh-blobs filesystem store, gossip handler, and the local flat-file store.

Implementations§

Source§

impl IgcIrohNode

Source

pub async fn start(data_dir: impl Into<PathBuf>) -> Result<Self, NodeError>

Build and start a node rooted at data_dir.

  • Loads or generates the Ed25519 key from data_dir/node.key.
  • Initializes the separate pilot-keys/ directory for pilot identity custody; pilot keys remain distinct from the node transport key.
  • Opens FlatFileStore at data_dir.
  • Binds an iroh Endpoint, starts iroh-blobs and iroh-gossip.
  • Subscribes to the announce gossip topic so remote peers can join the swarm immediately (HyParView state must exist for this to work).
Source

pub async fn close(&self)

Gracefully shut down the node (closes endpoint and router).

Source

pub fn node_id(&self) -> &NodeIdHex

The node’s stable network identity (hex-encoded Ed25519 public key).

Source

pub fn iroh_node_id(&self) -> PublicKey

The node’s iroh PublicKey (EndpointId) — use this for gossip bootstrap when dialling the node directly via iroh.

Source

pub fn endpoint_addr(&self) -> EndpointAddr

The node’s current EndpointAddr as reported by the iroh endpoint.

Right after start() this typically contains wildcard bind addresses (0.0.0.0:PORT) which are not dialable by remote peers. For loopback integration tests use [loopback_endpoint_addr] instead.

Source

pub fn loopback_endpoint_addr(&self) -> Result<EndpointAddr, NodeError>

Build an EndpointAddr with a proper 127.0.0.1:PORT direct address.

Uses the actual bound UDP port from the endpoint and replaces the wildcard 0.0.0.0 bind address with the loopback interface. Pass the result to a peer’s [add_peer_addr] in integration tests so that gossip-bootstrap can dial over loopback without relay infrastructure.

Source

pub fn loopback_addr_str(&self) -> Result<String, NodeError>

Return the node’s loopback endpoint as a "node_id@127.0.0.1:port" string.

Use this to populate a remote peer’s address book (via [add_peer_addr]) for direct loopback connections in tests and private networks that don’t rely on relay-based discovery.

Source

pub fn add_peer_addr(&self, addr: EndpointAddr)

Pre-populate this node’s address book with a peer’s EndpointAddr.

After calling this, the node can dial the peer by its EndpointId alone (e.g., as a gossip bootstrap peer) using the known direct address instead of relay-based discovery.

Source

pub async fn join_pilot_auth_did_gossip_peers( &self, peers: Vec<PublicKey>, ) -> Result<(), NodeError>

Join known peers on the pilot-auth-did governance gossip topic.

Call this after populating peer addresses for direct/private networks. Receiving a governance gossip announcement triggers a pull-sync against the delivering peer over the dedicated governance-sync transport.

Source

pub async fn join_governance_gossip_peers( &self, peers: Vec<PublicKey>, ) -> Result<(), NodeError>

Join known peers on the normative governance gossip topic.

Call this after populating peer addresses for direct/private networks. Received records are validated, persisted idempotently, and then used by local governance state resolution.

Source

pub async fn broadcast_governance_record<T: Serialize>( &self, record: &T, ) -> Result<(), NodeError>

Broadcast a full governance record on the normative governance topic.

Callers must persist the record locally before broadcasting so a local restart does not lose authority that was already advertised.

Source

pub fn store(&self) -> &FlatFileStore

Access the local flat-file store.

Source

pub fn generate_pilot_identity( &self, display_name: impl Into<String>, country: Option<String>, ) -> Result<PilotIdentity, NodeError>

Generate a new registered pilot identity in the multi-pilot key store.

Source

pub async fn register_pilot_identity( &self, display_name: impl Into<String>, country: Option<String>, access_pin: &str, created_at: impl Into<String>, ) -> Result<PilotIdentity, NodeError>

Register a pilot with a local portal credential and publish its initial auth DID.

Source

pub fn load_registered_pilot_identity( &self, pilot_id: &PilotId, ) -> Result<Option<PilotIdentity>, NodeError>

Load a registered pilot identity by stable pilot_id.

Source

pub fn list_registered_pilots( &self, ) -> Result<Vec<PilotPublicIdentityWithProfile>, NodeError>

List registered pilots without exposing private key material.

Source

pub fn load_registered_pilot_profile( &self, pilot_id: &PilotId, ) -> Result<Option<PilotProfile>, NodeError>

Load registered pilot profile metadata.

Source

pub fn verify_pilot_credential( &self, pilot_id: &PilotId, access_pin: &str, ) -> Result<bool, NodeError>

Verify a registered pilot’s local portal credential.

Source

pub fn registered_pilot_store(&self, pilot_id: &PilotId) -> PilotKeyStore

Return the per-pilot store used for pilot-auth-DID rotation.

Source

pub async fn issue_initial_registered_pilot_auth_did_record( &self, pilot_id: &PilotId, created_at: impl Into<String>, ) -> Result<PilotAuthDidRecord, NodeError>

Create and persist the initial pilot-auth-did-record for a registered pilot.

Source

pub async fn rotate_registered_pilot_auth_did( &self, pilot_id: &PilotId, created_at: impl Into<String>, ) -> Result<PilotAuthDidRecord, NodeError>

Rotate the active pilot_auth_did key for a registered pilot.

Source

pub fn governance_store(&self) -> &GovernanceStore

Access the governance store that persists identity governance records.

Source

pub fn resolve_pilot_auth_did_state( &self, pilot_id: &PilotId, ) -> Result<PilotAuthDidState, NodeError>

Resolve the current pilot-auth-DID state using local governance history.

Source

pub fn prepare_pilot_auth_did_sync( &self, request: &PilotAuthDidSyncRequest, ) -> Result<PilotAuthDidSyncResponse, NodeError>

Build a pull-style catch-up response for a peer’s known pilot-auth-DID history.

Source

pub fn build_pilot_auth_did_sync_request( &self, pilot_id: &PilotId, ) -> Result<PilotAuthDidSyncRequest, NodeError>

Build a pull-style catch-up request from the node’s full local pilot-auth-DID history.

Source

pub fn apply_pilot_auth_did_sync( &self, response: &PilotAuthDidSyncResponse, ) -> Result<usize, NodeError>

Apply a pulled batch of pilot-auth-DID governance records to local storage.

Source

pub async fn request_pilot_auth_did_sync_from_peer( &self, peer: PublicKey, request: &PilotAuthDidSyncRequest, ) -> Result<PilotAuthDidSyncResponse, NodeError>

Request a peer’s catch-up response over the governance-sync transport.

Source

pub async fn sync_pilot_auth_did_from_peer( &self, peer: PublicKey, pilot_id: &PilotId, ) -> Result<usize, NodeError>

Pull pilot-auth-DID governance records for pilot_id from a peer and apply them locally.

Source

pub fn resolve_path( &self, igc_hash: &str, ) -> Result<Option<PathBuf>, StoreError>

Resolve a local read-only filesystem path for a BLAKE3-keyed blob.

Returns Some(path) when the blob is present in the flat-file store. The caller may read the file directly in read-only mode; mutation must go through publish() or the store’s put() method.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more