pub struct WalletReservationsReleaseParams {
pub reservation_id: String,
}Expand description
control.wallet.reservations.release params: free one reservation now, ahead of its TTL.
§The release path is why a reservation is safe at all
A hold with no way out is a wallet that locks itself out of its own funds, which is worse than the double-select it prevents. Two mechanisms keep that impossible and BOTH are required: the TTL bounds every hold whether or not anyone releases it, and this method lets a caller that KNOWS the answer — the spend settled, or was definitively rejected — stop holding the user’s coins over a question the chain has already resolved.
§Releasing an unknown or lapsed id is a SUCCESS
A caller releasing on confirmation cannot know whether the TTL got there first, and making that
race an error would teach callers to ignore the result — which is how a release stops being
called at all. See WalletReservationsReleaseResult.
Fields§
§reservation_id: StringThe handle returned by
reserve.
OPAQUE: a client stores it and sends it back, and MUST NOT parse, derive or construct one. The node mints it, and how it is spelled is free to differ between a hold taken before a broadcast and one recorded for a bundle already in flight.
Trait Implementations§
Source§impl Clone for WalletReservationsReleaseParams
impl Clone for WalletReservationsReleaseParams
Source§fn clone(&self) -> WalletReservationsReleaseParams
fn clone(&self) -> WalletReservationsReleaseParams
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more