Skip to main content

RustChainClient

Struct RustChainClient 

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

The main RustChain API client.

§Example

use rustchain_client::RustChainClient;

let client = RustChainClient::new("https://rustchain.org")?;
let health = client.health().await?;
println!("{:?}", health);

Implementations§

Source§

impl RustChainClient

Source

pub fn new(base_url: &str) -> Result<Self, Error>

Create a new RustChain API client.

§Arguments
  • base_url - The base URL of the RustChain node (e.g., "https://rustchain.org" or "https://50.28.86.131").

Accepts self-signed certificates, which is common for RustChain nodes.

Source

pub fn with_client(base_url: &str, http: Client) -> Self

Create a client with a custom reqwest::Client.

Source

pub async fn health(&self) -> Result<HealthResponse, Error>

Check node health.

Calls GET /health.

Source

pub async fn epoch(&self) -> Result<EpochResponse, Error>

Get current epoch information.

Calls GET /epoch.

Source

pub async fn miners(&self) -> Result<Vec<Miner>, Error>

List active miners on the network.

Calls GET /api/miners.

Source

pub async fn wallet_balance(&self, wallet: &str) -> Result<WalletBalance, Error>

Check a wallet’s RTC balance.

Calls GET /wallet/balance?miner_id={wallet}.

Source

pub async fn submit_attestation( &self, attestation: &AttestationSubmit, ) -> Result<AttestationResponse, Error>

Submit a mining attestation.

Calls POST /attest/submit.

Source

pub async fn proposals(&self) -> Result<Vec<Proposal>, Error>

List governance proposals.

Calls GET /governance/proposals.

Source

pub async fn proposal(&self, id: u64) -> Result<Proposal, Error>

Get a single governance proposal by ID.

Calls GET /governance/proposal/{id}.

Source

pub async fn vote(&self, vote: &Vote) -> Result<VoteResponse, Error>

Submit a governance vote.

Calls POST /governance/vote.

Source

pub async fn agent_jobs(&self) -> Result<AgentJobsResponse, Error>

List open Agent Economy jobs.

Calls GET /agent/jobs.

Source

pub fn base_url(&self) -> &str

Get the base URL of this client.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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<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