lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

getroute: document cltv argument. 

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
ppa-0.6.1
Rusty Russell 7 years ago
parent
6b740e78bd
commit
461207b886
2 changed files with 7 additions and 6 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 8
      doc/lightning-getroute.7
  2. 5
      doc/lightning-getroute.7.txt

8
doc/lightning-getroute.7
View File

@ -2,12 +2,12 @@
.\" Title: lightning-getroute .\" Title: lightning-getroute
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 01/13/2018 .\" Date: 01/16/2018
.\" Manual: \ \& .\" Manual: \ \&
.\" Source: \ \& .\" Source: \ \&
.\" Language: English .\" Language: English
.\" .\"
.TH "LIGHTNING\-GETROUTE" "7" "01/13/2018" "\ \&" "\ \&" .TH "LIGHTNING\-GETROUTE" "7" "01/16/2018" "\ \&" "\ \&"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * Define some portability stuff .\" * Define some portability stuff
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -31,10 +31,10 @@
lightning-getroute \- Protocol for routing a payment (low\-level)\&. lightning-getroute \- Protocol for routing a payment (low\-level)\&.
.SH "SYNOPSIS" .SH "SYNOPSIS"
.sp .sp
\fBgetroute\fR \fIid\fR \fImsatoshi\fR \fIriskfactor\fR \fBgetroute\fR \fIid\fR \fImsatoshi\fR \fIriskfactor\fR [\fIcltv\fR]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
The \fBgetroute\fR RPC command attempts to find the best route for the payment of \fImsatoshi\fR to lightning node \fIid\fR\&. The \fBgetroute\fR RPC command attempts to find the best route for the payment of \fImsatoshi\fR to lightning node \fIid\fR, such that the payment will arrive at \fIid\fR with \fIcltv\fR\-blocks to spare (default 9)\&.
.sp .sp
There are two considerations for how good a route is: how low the fees are, and how long your payment will get stuck if a node goes down during the process\&. The \fIriskfactor\fR floating\-point field controls this tradeoff; it is the annual cost of your funds being stuck (as a percentage), multiplied by the percentage chance of each node failing\&. There are two considerations for how good a route is: how low the fees are, and how long your payment will get stuck if a node goes down during the process\&. The \fIriskfactor\fR floating\-point field controls this tradeoff; it is the annual cost of your funds being stuck (as a percentage), multiplied by the percentage chance of each node failing\&.
.sp .sp

5
doc/lightning-getroute.7.txt
View File

@ -9,12 +9,13 @@ lightning-getroute - Protocol for routing a payment (low-level).
SYNOPSIS SYNOPSIS
-------- --------
*getroute* 'id' 'msatoshi' 'riskfactor' *getroute* 'id' 'msatoshi' 'riskfactor' ['cltv']
DESCRIPTION DESCRIPTION
----------- -----------
The *getroute* RPC command attempts to find the best route for the payment The *getroute* RPC command attempts to find the best route for the payment
of 'msatoshi' to lightning node 'id'. of 'msatoshi' to lightning node 'id', such that the payment will arrive
at 'id' with 'cltv'-blocks to spare (default 9).
There are two considerations for how good a route is: how low the There are two considerations for how good a route is: how low the
fees are, and how long your payment will get stuck if a node goes down fees are, and how long your payment will get stuck if a node goes down

Write Preview
Loading…
Cancel
Save