Struct lnrpc::QueryRoutesRequest

pub struct QueryRoutesRequest {
    pub pub_key: String,
    pub amt: i64,
    pub amt_msat: i64,
    pub final_cltv_delta: i32,
    pub fee_limit: Option<FeeLimit>,
    pub ignored_nodes: Vec<Vec<u8>>,
    pub ignored_edges: Vec<EdgeLocator>,
    pub source_pub_key: String,
    pub use_mission_control: bool,
    pub ignored_pairs: Vec<NodePair>,
    pub cltv_limit: u32,
    pub dest_custom_records: HashMap<u64, Vec<u8>>,
    pub outgoing_chan_id: u64,
    pub last_hop_pubkey: Vec<u8>,
    pub route_hints: Vec<RouteHint>,
    pub dest_features: Vec<i32>,
}

Fields

pub_key: String

amt: i64

The amount to send expressed in satoshis.

The fields amt and amt_msat are mutually exclusive.

amt_msat: i64

The amount to send expressed in millisatoshis.

The fields amt and amt_msat are mutually exclusive.

final_cltv_delta: i32

An optional CLTV delta from the current height that should be used for the timelock of the final hop. Note that unlike SendPayment, QueryRoutes does not add any additional block padding on top of final_ctlv_delta. This padding of a few blocks needs to be added manually or otherwise failures may happen when a block comes in while the payment is in flight.

fee_limit: Option<FeeLimit>

The maximum number of satoshis that will be paid as a fee of the payment. This value can be represented either as a percentage of the amount being sent, or as a fixed amount of the maximum fee the user is willing the pay to send the payment.

ignored_nodes: Vec<Vec<u8>>

A list of nodes to ignore during path finding. When using REST, these fields must be encoded as base64.

ignored_edges: Vec<EdgeLocator>

Deprecated. A list of edges to ignore during path finding.

source_pub_key: String

The source node where the request route should originated from. If empty, self is assumed.

use_mission_control: bool

If set to true, edge probabilities from mission control will be used to get the optimal route.

ignored_pairs: Vec<NodePair>

A list of directed node pairs that will be ignored during path finding.

cltv_limit: u32

An optional maximum total time lock for the route. If the source is empty or ourselves, this should not exceed lnd's --max-cltv-expiry setting. If zero, then the value of --max-cltv-expiry is used as the limit.

dest_custom_records: HashMap<u64, Vec<u8>>

An optional field that can be used to pass an arbitrary set of TLV records to a peer which understands the new records. This can be used to pass application specific data during the payment attempt. If the destination does not support the specified recrods, and error will be returned. Record types are required to be in the custom range >= 65536. When using REST, the values must be encoded as base64.

outgoing_chan_id: u64

The channel id of the channel that must be taken to the first hop. If zero, any channel may be used.

last_hop_pubkey: Vec<u8>

The pubkey of the last hop of the route. If empty, any hop may be used.

route_hints: Vec<RouteHint>

Optional route hints to reach the destination through private channels.

dest_features: Vec<i32>

Features assumed to be supported by the final node. All transitive feature dependencies must also be set properly. For a given feature bit pair, either optional or remote may be set, but not both. If this field is nil or empty, the router will try to load destination features from the graph as a fallback.

Implementations

impl QueryRoutesRequest

pub fn dest_features(
    &self
) -> FilterMap<Cloned<Iter<i32>>, fn(_: i32) -> Option<FeatureBit>>

Returns an iterator which yields the valid enum values contained in dest_features.

pub fn push_dest_features(&mut self, value: FeatureBit)

Appends the provided enum value to dest_features.

Trait Implementations

impl Clone for QueryRoutesRequest

fn clone(&self) -> QueryRoutesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryRoutesRequest

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

Formats the value using the given formatter.

impl Default for QueryRoutesRequest

fn default() -> QueryRoutesRequest

Returns the "default value" for a type.

impl Message for QueryRoutesRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<QueryRoutesRequest> for QueryRoutesRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for QueryRoutesRequest