Service

Struct Service 

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

Central service for Bittensor chain interactions with connection pooling and retry mechanisms

Implementations§

Source§

impl Service

Source

pub async fn new(config: BittensorConfig) -> Result<Self, BittensorError>

Creates a new Service instance with the provided configuration.

§Arguments
  • config - The Bittensor configuration containing network and wallet settings
§Returns
  • Result<Self, BittensorError> - A Result containing either the initialized Service or an error
§Errors
  • NetworkError - If connection to the client network fails
  • WalletError - If wallet key loading or signer creation fails
Source

pub async fn serve_axon( &self, netuid: u16, axon_addr: SocketAddr, ) -> Result<(), BittensorError>

Serves an axon on the Bittensor network with retry logic.

§Arguments
  • netuid - The subnet UID to serve the axon on
  • axon_addr - The socket address where the axon will be served
§Returns
  • Result<(), BittensorError> - A Result indicating success or failure
§Errors
  • TxSubmissionError - If the serve_axon transaction fails to submit
  • MaxRetriesExceeded - If all retry attempts are exhausted
Source

pub async fn set_weights( &self, netuid: u16, weights: Vec<(u16, u16)>, ) -> Result<(), BittensorError>

Sets weights for neurons in the subnet with retry logic.

§Arguments
  • netuid - The subnet UID to set weights for
  • weights - Vector of (uid, weight) pairs representing neuron weights
§Returns
  • Result<(), BittensorError> - A Result indicating success or failure
§Errors
  • TxSubmissionError - If the set_weights transaction fails to submit
  • InvalidWeights - If the weight vector is invalid
  • MaxRetriesExceeded - If all retry attempts are exhausted
Source

pub async fn get_neuron( &self, netuid: u16, uid: u16, ) -> Result<Option<NeuronInfo>, BittensorError>

Gets neuron information for a specific UID in the subnet.

§Arguments
  • netuid - The subnet UID
  • uid - The neuron UID to get information for
§Returns
  • Result<Option<NeuronInfo>, BittensorError> - A Result containing either the neuron info or an error
§Errors
  • RpcError - If the RPC call fails
Source

pub async fn get_metagraph( &self, netuid: u16, ) -> Result<Metagraph, BittensorError>

Gets the complete metagraph for a subnet with circuit breaker protection.

§Arguments
  • netuid - The subnet UID to get the metagraph for
§Returns
  • Result<Metagraph, BittensorError> - A Result containing either the metagraph or an error
§Errors
  • RpcError - If the RPC call fails
  • SubnetNotFound - If the subnet doesn’t exist
  • ServiceUnavailable - If circuit breaker is open
Source

pub async fn get_selective_metagraph( &self, netuid: u16, fields: Vec<u16>, ) -> Result<SelectiveMetagraph, BittensorError>

Retrieves a selective metagraph for a specific subnet, containing only the requested fields.

§Arguments
  • netuid - The subnet UID to get the selective metagraph for
  • fields - Vector of field indices to include in the selective metagraph
§Returns
  • Result<SelectiveMetagraph, BittensorError> - A Result containing either the selective metagraph or an error
§Errors
  • RpcError - If connection to the runtime API fails
  • RpcError - If the selective metagraph call fails
  • RpcError - If no selective metagraph is found for the subnet
§Example
let fields = vec![0, 1, 2]; // Include first three fields
let selective_metagraph = service.get_selective_metagraph(1, fields).await?;
Source

pub async fn get_block_number(&self) -> Result<u64, BittensorError>

Retrieves the current block number from the Bittensor network.

§Returns
  • Result<u64, BittensorError> - A Result containing either the current block number or an error
§Errors
  • RpcError - If connection to the latest block fails
§Example
let block_number = service.get_block_number().await?;
println!("Current block: {}", block_number);
Source

pub fn get_account_id(&self) -> AccountId

Returns the account ID associated with the service’s signer.

§Returns
  • &AccountId - Reference to the signer’s account ID
§Example
let account_id = service.get_account_id();
println!("Account ID: {}", account_id);
Source

pub async fn get_current_block(&self) -> Result<u64, BittensorError>

Get current block number (alias for get_block_number)

Source

pub async fn submit_extrinsic<T>( &self, payload: T, ) -> Result<(), BittensorError>
where T: Payload,

Submit an extrinsic (transaction) to the chain

Source

pub fn get_network(&self) -> &str

Returns the configured network name for this service instance.

§Returns
  • &str - Reference to the network name
§Example
let network = service.get_network();
println!("Connected to network: {}", network);
Source

pub fn get_netuid(&self) -> u16

Returns the configured subnet UID for this service instance.

§Returns
  • u16 - The subnet UID
§Example
let netuid = service.get_netuid();
println!("Subnet UID: {}", netuid);
Source

pub fn sign_data(&self, data: &[u8]) -> Result<String, BittensorError>

Sign data with the service’s signer (hotkey)

This method signs arbitrary data with the validator/miner’s hotkey. The signature can be verified using verify_bittensor_signature.

§Arguments
  • data - The data to sign
§Returns
  • Result<String, BittensorError> - Hex-encoded signature string
§Example
let nonce = "test-nonce-123";
let signature = service.sign_data(nonce.as_bytes())?;
println!("Signature: {}", signature);
Source§

impl Service

Source

pub async fn get_retry_stats(&self) -> RetryStats

Gets retry statistics for monitoring

Source

pub async fn reset_circuit_breaker(&self)

Resets the circuit breaker state (for recovery operations)

Source

pub async fn connection_metrics(&self) -> ConnectionPoolMetrics

Get connection pool metrics for monitoring

Source

pub async fn force_reconnect(&self) -> Result<(), BittensorError>

Force reconnection of all connections

Source

pub async fn shutdown(self)

Gracefully shutdown the service

Trait Implementations§

Source§

impl Drop for Service

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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

Source§

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
Source§

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatedConversion for T

Source§

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
Source§

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
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<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

Source§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
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,