lightning-askrene-reserve

lightning-askrene-reserve -- Command for informing askrene that you are trying a path (EXPERIMENTAL)

SYNOPSIS

askrene-reserve path

DESCRIPTION

WARNING: experimental, so API may change.

The askrene-reserve RPC command tells askrene that a path is being attempted. This allows it to take that into account when other getroutes calls are made. You should call askrene-unreserve after the attempt has completed.

Note that additional properties inside the path elements are ignored, which is useful when used with the result of getroutes.

  • path (array of objects):
    • short_channel_id (short_channel_id): The channel joining these nodes.
    • direction (u32): 0 if this channel is traversed from lesser to greater id, otherwise 1.
    • amount_msat (msat): The amount to send into this hop.

RETURN VALUE

On success, an empty object is returned.

AUTHOR

Rusty Russell <[email protected]> is mainly responsible.

SEE ALSO

lightning-getroutes(7), lightning-askrene-unreserve(7), lightning-askrene-disable-node(7), lightning-askrene-create-channel(7), lightning-askrene-inform-channel(7), lightning-askrene-listlayers(7), lightning-askrene-age(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning