Skip to main content

HttpClient

Struct HttpClient 

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

HTTP client for the AnySwap server API. See the module docs for swap flows.

Implementations§

Source§

impl HttpClient

Source

pub fn new(base_url: &str, wallet: Option<&Wallet>) -> Result<Self, WalletError>

A client for the server at base_url. It signs protected requests with wallet’s identity key; without a wallet, only the public endpoints work.

Source

pub fn subscribe_url(&self) -> Result<String, ClientError>

The signed /v1/subscribe/{user_id} WebSocket URL, auth in the query.

Source

pub async fn get_info(&self) -> Result<InfoResponse, ClientError>

Fetches server info: protocol version, network, and per-chain policies (amount limits, confirmation requirements, swap_fee rates).

Source

pub async fn create_swap( &self, req: &CreateSwapRequest, ) -> Result<(), ClientError>

Initiates a swap. The server may cancel the swap right after creation; the actual state is discovered via HttpClient::get_swap.

Source

pub async fn get_swap(&self, swap_id: Uuid) -> Result<SwapState, ClientError>

Polls the current state of a swap. Convert the response to a typed SwapIn via TryFrom.

Source

pub async fn list_swaps( &self, query: &SwapListQuery, ) -> Result<SwapListResponse, ClientError>

Fetches the paginated swap history for a user.

Source

pub async fn cancel( &self, swap_id: Uuid, req: &CancelRequest, ) -> Result<(), ClientError>

Requests swap cancellation. The outcome is observed via HttpClient::get_swap: Canceled reveals the server’s claim privkey for an immediate keypath refund of any deposit.

Source

pub async fn reveal_claim( &self, swap_id: Uuid, req: &RevealClaimRequest, ) -> Result<(), ClientError>

Reveals the user’s refund privkey after the claim invoice was paid (swap-in only), letting the server claim cooperatively via the keypath instead of the preimage script path.

Source

pub async fn reveal_preimage( &self, swap_id: Uuid, req: &RevealPreimageRequest, ) -> Result<(), ClientError>

Reveals the preimage off-chain (swap-out only) instead of claiming via the script path. The server settles the held invoice and exposes its refund privkey, letting the user finish with a cheap cooperative keypath claim. Reveal only after the opening tx has the required confirmations.

Source§

impl HttpClient

Source

pub fn signals(&self) -> WsSignals

Source§

impl HttpClient

Source

pub async fn subscribe(&self) -> Result<Subscription, WsError>

Trait Implementations§

Source§

impl Clone for HttpClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl ServerClient for HttpClient

Source§

fn get_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<InfoResponse, ClientError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn create_swap<'life0, 'life1, 'async_trait>( &'life0 self, req: &'life1 CreateSwapRequest, ) -> Pin<Box<dyn Future<Output = Result<(), ClientError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn get_swap<'life0, 'async_trait>( &'life0 self, swap_id: Uuid, ) -> Pin<Box<dyn Future<Output = Result<SwapState, ClientError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Source§

fn list_swaps<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 SwapListQuery, ) -> Pin<Box<dyn Future<Output = Result<SwapListResponse, ClientError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn cancel<'life0, 'life1, 'async_trait>( &'life0 self, swap_id: Uuid, req: &'life1 CancelRequest, ) -> Pin<Box<dyn Future<Output = Result<(), ClientError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn reveal_claim<'life0, 'life1, 'async_trait>( &'life0 self, swap_id: Uuid, req: &'life1 RevealClaimRequest, ) -> Pin<Box<dyn Future<Output = Result<(), ClientError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn reveal_preimage<'life0, 'life1, 'async_trait>( &'life0 self, swap_id: Uuid, req: &'life1 RevealPreimageRequest, ) -> Pin<Box<dyn Future<Output = Result<(), ClientError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<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