Skip to main content

CrossChainReceiveInfo

Struct CrossChainReceiveInfo 

Source
pub struct CrossChainReceiveInfo {
    pub quote_id: String,
    pub deposit_address: String,
    pub deposit_amount: u128,
    pub expected_received_amount: u128,
    pub destination_asset: String,
    pub token_identifier: Option<String>,
    pub service_fee_amount: u128,
    pub service_fee_asset: Option<String>,
    pub service_fee_asset_decimals: Option<u32>,
    pub expires_at: u64,
}
Expand description

Information about the cross-chain receive quote: what the sender deposits and what the receiver is expected to get.

Fields§

§quote_id: String

The provider’s id for this receive. The incoming payment carries the same id in its conversion info, so it can be matched to this receive.

§deposit_address: String

Bare deposit address the sender pays to on the source chain, or the BOLT11 invoice when the sender pays over Lightning.

§deposit_amount: u128

Amount the sender must deposit, in source-asset base units (route.decimals, or sats over Lightning). On FeesExcluded this may differ from the request’s amount because the SDK inflates the deposit to absorb provider fees. Render this value to the sender.

§expected_received_amount: u128

Amount the receiver will see, net of provider fees, in destination-asset base units. Sats when receiving BTC, token base units when receiving a Spark token (e.g. USDB), or stablecoin base units when the receiver is on another chain. The final delivered amount may move within the slippage tolerance.

§destination_asset: String

Symbol of the asset expected_received_amount is denominated in, as the provider reports it: "BTC" for sats, a Spark token symbol (e.g. "USDB"), or the stablecoin when the receiver is on another chain.

§token_identifier: Option<String>

Spark token identifier when the destination is a Spark token. Absent otherwise.

§service_fee_amount: u128

Provider-quoted total fee for this receive, including the partner fee when one is set, in service_fee_asset units.

§service_fee_asset: Option<String>

Ticker for service_fee_amount. Absent when the fee is denominated in sats.

§service_fee_asset_decimals: Option<u32>

Decimals of service_fee_asset, for formatting service_fee_amount. Unset when the fee is in sats or the provider did not report them.

§expires_at: u64

Quote expiry as a unix timestamp in seconds.

Trait Implementations§

Source§

impl Clone for CrossChainReceiveInfo

Source§

fn clone(&self) -> CrossChainReceiveInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CrossChainReceiveInfo

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CrossChainReceiveInfo

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CrossChainReceiveInfo

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> 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.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

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

§

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
§

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> 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 = 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,