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
impl LightningClient
Sourcepub fn new(wallet_hotkey: String) -> Self
pub fn new(wallet_hotkey: String) -> Self
Creates a client with default configuration. Panics only if defaults are invalid.
Sourcepub fn with_config(
wallet_hotkey: String,
config: LightningClientConfig,
) -> Result<Self>
pub fn with_config( wallet_hotkey: String, config: LightningClientConfig, ) -> Result<Self>
Creates a client with the given configuration, validating constraints.
Sourcepub fn set_signer(&mut self, signer: Box<dyn Signer>)
pub fn set_signer(&mut self, signer: Box<dyn Signer>)
Sets the Signer used for handshake authentication. Must be called before
initialize_connections.
Sourcepub fn set_wallet(
&mut self,
wallet_name: &str,
wallet_path: &str,
hotkey_name: &str,
) -> Result<()>
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.
Sourcepub async fn initialize_connections(
&mut self,
miners: Vec<QuicAxonInfo>,
) -> Result<()>
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.
Sourcepub async fn create_endpoint(&mut self) -> Result<()>
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.
Sourcepub async fn query_axon(
&self,
axon_info: QuicAxonInfo,
request: QuicRequest,
) -> Result<QuicResponse>
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.
Sourcepub async fn query_axon_with_timeout(
&self,
axon_info: QuicAxonInfo,
request: QuicRequest,
timeout: Duration,
) -> Result<QuicResponse>
pub async fn query_axon_with_timeout( &self, axon_info: QuicAxonInfo, request: QuicRequest, timeout: Duration, ) -> Result<QuicResponse>
Like query_axon but aborts after timeout.
Sourcepub async fn query_axon_stream(
&self,
axon_info: QuicAxonInfo,
request: QuicRequest,
) -> Result<StreamingResponse>
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.
Sourcepub async fn update_miner_registry(
&self,
miners: Vec<QuicAxonInfo>,
) -> Result<()>
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.
Sourcepub async fn get_connection_stats(&self) -> Result<HashMap<String, String>>
pub async fn get_connection_stats(&self) -> Result<HashMap<String, String>>
Returns a map of connection statistics (total connections, active miners, per-address status).
Sourcepub async fn start_metagraph_monitor(
&self,
monitor_config: MetagraphMonitorConfig,
) -> Result<()>
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.
Sourcepub async fn stop_metagraph_monitor(&self)
pub async fn stop_metagraph_monitor(&self)
Stops the metagraph monitor background task if running.
Sourcepub async fn close_all_connections(&self) -> Result<()>
pub async fn close_all_connections(&self) -> Result<()>
Gracefully closes all QUIC connections and clears the miner registry.
Auto Trait Implementations§
impl Freeze for LightningClient
impl !RefUnwindSafe for LightningClient
impl Send for LightningClient
impl Sync for LightningClient
impl Unpin for LightningClient
impl UnsafeUnpin for LightningClient
impl !UnwindSafe for LightningClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
Source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
Source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from.