Skip to main content

WalletArrivalsParams

Struct WalletArrivalsParams 

Source
pub struct WalletArrivalsParams {
    pub after_seq: u64,
    pub limit: Option<u32>,
}
Expand description

control.wallet.arrivals — confirmed INCOMING funds recorded since a cursor position.

The answer to “was I just paid?”, which neither a balance nor a coin list can give: a balance moves for the user’s OWN change too, and an unspent-coin list cannot say which of its coins are new. Each row the node returns is a coin it determined ARRIVED — confirmed on chain, above the wallet’s arrival baseline, not previously reported, and not created by spending one of the wallet’s own coins. The determination is the NODE’s; a client MUST NOT re-derive it, because the signals it takes (spent parents, the catch-up baseline) live only in the node’s replica.

§A cursor, not a stream

The control envelope is strictly request→response, so this is polled. A client resumes from WalletArrivalsResult::cursor — the last position it was actually handed — and NEVER from latest; see that field for why the distinction loses a notification when it is collapsed.

§after_seq is unsigned so a rewind is unexpressible

Positions are monotonic and start at 1, so there is no meaning for a negative one. 0 is the beginning of the ledger and is what a client sends when it deliberately wants everything.

Fields§

§after_seq: u64

Return arrivals STRICTLY after this position. 0 starts at the beginning of the ledger, and is also what an omitted field means — the same default the node applies.

§limit: Option<u32>

The page size. None asks for the node’s default rather than a number this client invented; a node clamps whatever it is given to its own maximum.

Trait Implementations§

Source§

impl Clone for WalletArrivalsParams

Source§

fn clone(&self) -> WalletArrivalsParams

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 ControlCall for WalletArrivalsParams

Source§

const METHOD: ControlMethod = ControlMethod::WalletArrivals

The wire method this call invokes.
Source§

type Output = WalletArrivalsResult

The typed result this call returns on success.
Source§

impl Copy for WalletArrivalsParams

Source§

impl Debug for WalletArrivalsParams

Source§

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

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

impl Default for WalletArrivalsParams

Source§

fn default() -> WalletArrivalsParams

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for WalletArrivalsParams

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 Eq for WalletArrivalsParams

Source§

impl PartialEq for WalletArrivalsParams

Source§

fn eq(&self, other: &WalletArrivalsParams) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for WalletArrivalsParams

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

impl StructuralPartialEq for WalletArrivalsParams

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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