Skip to main content

LightningClient

Struct LightningClient 

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

QUIC client for sending synapse requests to Bittensor miners.

Manages persistent, authenticated QUIC connections to one or more miners. Each connection is established with a mutual sr25519 handshake; subsequent synapse requests reuse the connection without re-authenticating.

Implementations§

Source§

impl LightningClient

Source

pub fn new(wallet_hotkey: String) -> Self

Creates a client with default configuration. Panics only if defaults are invalid.

Source

pub fn with_config( wallet_hotkey: String, config: LightningClientConfig, ) -> Result<Self>

Creates a client with the given configuration, validating constraints.

Source

pub fn set_signer(&mut self, signer: Box<dyn Signer>)

Sets the Signer used for handshake authentication. Must be called before initialize_connections.

Source

pub fn set_wallet( &mut self, wallet_name: &str, wallet_path: &str, hotkey_name: &str, ) -> Result<()>

Loads the signer from a Bittensor wallet on disk. Requires the btwallet feature.

Source

pub async fn initialize_connections( &mut self, miners: Vec<QuicAxonInfo>, ) -> Result<()>

Opens QUIC connections and performs sr25519 handshakes with the given miners.

Miners sharing an ip:port are multiplexed over a single QUIC connection. If metagraph is configured, a background monitor is also started.

Source

pub async fn create_endpoint(&mut self) -> Result<()>

Creates the QUIC client endpoint bound to 0.0.0.0:0. Called automatically by initialize_connections; only call directly if you need the endpoint before connecting.

Source

pub async fn query_axon( &self, axon_info: QuicAxonInfo, request: QuicRequest, ) -> Result<QuicResponse>

Sends a synapse request to a miner and waits for the full response.

Transparently reconnects if the underlying QUIC connection has died.

Source

pub async fn query_axon_with_timeout( &self, axon_info: QuicAxonInfo, request: QuicRequest, timeout: Duration, ) -> Result<QuicResponse>

Like query_axon but aborts after timeout.

Source

pub async fn query_axon_stream( &self, axon_info: QuicAxonInfo, request: QuicRequest, ) -> Result<StreamingResponse>

Sends a synapse request and returns a StreamingResponse for incremental chunk reading.

Source

pub async fn update_miner_registry( &self, miners: Vec<QuicAxonInfo>, ) -> Result<()>

Reconciles the active miner set: adds new miners, removes stale ones, and opens/closes QUIC connections as needed.

Source

pub async fn get_connection_stats(&self) -> Result<HashMap<String, String>>

Returns a map of connection statistics (total connections, active miners, per-address status).

Source

pub async fn start_metagraph_monitor( &self, monitor_config: MetagraphMonitorConfig, ) -> Result<()>

Starts a background task that periodically syncs the metagraph and updates connections. Requires the subtensor feature.

Source

pub async fn stop_metagraph_monitor(&self)

Stops the metagraph monitor background task if running.

Source

pub async fn close_all_connections(&self) -> Result<()>

Gracefully closes all QUIC connections and clears the miner registry.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

Source§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

Source§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

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<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

Source§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
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
Source§

impl<T> JsonSchemaMaybe for T

Source§

impl<T> MaybeSend for T
where T: Send,