Struct TitanClient

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

A client for your HTTP server.

Implementations§

Source§

impl Client

Source

pub fn new(base_url: &str) -> Self

Create a new client with the given base URL (e.g. “http://localhost:3030”).

Source

pub async fn get_status(&self) -> Result<Status, Box<dyn Error>>

GET /status

Source

pub async fn get_tip(&self) -> Result<BlockTip, Box<dyn Error>>

GET /tip

Source

pub async fn get_block(&self, query: &str) -> Result<Block, Box<dyn Error>>

GET /block/{query}

Source

pub async fn get_address( &self, address: &str, ) -> Result<AddressData, Box<dyn Error>>

GET /address/{address}

Source

pub async fn get_transaction( &self, txid: &str, ) -> Result<Transaction, Box<dyn Error>>

GET /tx/{txid} Returns a structured bitcoin Transaction (JSON).

Source

pub async fn get_transaction_with_runes( &self, txid: &str, ) -> Result<Transaction, Box<dyn Error>>

Same as get_transaction but always requests runes (with_runes=true).

Source

pub async fn get_transaction_raw( &self, txid: &str, ) -> Result<Vec<u8>, Box<dyn Error>>

GET /tx/{txid}/raw Returns the raw transaction bytes (content-type: application/octet-stream).

Source

pub async fn get_transaction_hex( &self, txid: &str, ) -> Result<String, Box<dyn Error>>

GET /tx/{txid}/hex Returns a text/plain body containing hex-encoded raw transaction.

Source

pub async fn broadcast_transaction( &self, tx_hex: String, ) -> Result<Txid, Box<dyn Error>>

POST /tx/broadcast Broadcast a raw transaction (in hex form) to the network.

Source

pub async fn get_output( &self, outpoint: &str, ) -> Result<TxOutEntry, Box<dyn Error>>

GET /output/{outpoint}

Source

pub async fn get_inscription( &self, inscription_id: &str, ) -> Result<(HeaderMap, Vec<u8>), Box<dyn Error>>

GET /inscription/{inscription_id} Returns (Headers, Bytes). The server sets content-type and possibly compression, and the body is the raw inscription content.

Source

pub async fn get_runes( &self, pagination: Option<Pagination>, ) -> Result<PaginationResponse<RuneResponse>, Box<dyn Error>>

GET /runes?skip=&limit=

Source

pub async fn get_rune(&self, rune: &str) -> Result<RuneResponse, Box<dyn Error>>

GET /rune/{rune}

Source

pub async fn get_rune_transactions( &self, rune: &str, pagination: Option<Pagination>, ) -> Result<PaginationResponse<Txid>, Box<dyn Error>>

GET /rune/{rune}/transactions?skip=&limit=

Source

pub async fn get_mempool_txids(&self) -> Result<Vec<Txid>, Box<dyn Error>>

GET /mempool/txids

Source

pub async fn get_subscription( &self, id: &str, ) -> Result<Subscription, Box<dyn Error>>

GET /subscription/{id}

Source

pub async fn list_subscriptions( &self, ) -> Result<Vec<Subscription>, Box<dyn Error>>

GET /subscriptions

Source

pub async fn add_subscription( &self, subscription: &Subscription, ) -> Result<Subscription, Box<dyn Error>>

POST /subscription

Source

pub async fn delete_subscription(&self, id: &str) -> Result<(), Box<dyn Error>>

DELETE /subscription/{id}

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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, 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T