aljaz/lightning
1
0
Fork 0
mirror of https://github.com/aljazceru/lightning.git synced 2025-12-24 09:34:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: improve explanation of getroute command

Browse Source
This commit is contained in:
Simon Vrouwe
2019-02-16 12:55:44 +02:00
committed by Christian Decker
parent 4fe60ee769
commit 201dd3ce0c
2 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/lightning-getroute.7
View File

@@ -2,12 +2,12 @@
.\" Title: lightning-getroute
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 02/01/2019
.\" Date: 02/16/2019
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "LIGHTNING\-GETROUTE" "7" "02/01/2019" "\ \&" "\ \&"
.TH "LIGHTNING\-GETROUTE" "7" "02/16/2019" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -36,9 +36,9 @@ lightning-getroute \- Command for routing a payment (low\-level)\&.
.sp
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
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)\&.
There are two considerations for how good a route is: how low the fees are, and how long your payment will get stuck in a delayed output 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)\&.
.sp
For example, if you thought the inconvenience of having funds stuck was worth 20% per annum interest, \fIriskfactor\fR would be 20\&.
For example, if you thought the convenience of keeping your funds liquid (not stuck) was worth 20% per annum interest, \fIriskfactor\fR would be 20\&.
.sp
If you didn\(cqt care about risk, \fIriskfactor\fR would be zero\&.
.sp
@@ -75,7 +75,7 @@ risk\-fee = amount x blocks\-timeout x riskfactor / 5259600
.RE
.\}
.sp
Here are the risk fees in millisatoshis, using various parameters\&. I assume a channel charges the default of 1000 millisatoshis plus 1 part\-per\-million\&. Common delay values on the network at 14 and 144\&.
Here are the risk fees in millisatoshis, using various parameters\&. I assume a channel charges the default of 1000 millisatoshis plus 1 part\-per\-million\&. Common to_self_delay values on the network at 14 and 144 blocks\&.
.TS
allbox tab(:);
ltB ltB ltB ltB ltB.

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

@@ -18,13 +18,13 @@ 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
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 in a delayed output if a node goes down
during the process. The 'riskfactor' floating-point field controls
this tradeoff; it is the annual cost of your funds being stuck (as a
percentage).
For example, if you thought the inconvenience of having funds stuck was
worth 20% per annum interest, 'riskfactor' would be 20.
For example, if you thought the convenience of keeping your funds liquid
(not stuck) was worth 20% per annum interest, 'riskfactor' would be 20.
If you didn't care about risk, 'riskfactor' would be zero.
@@ -58,7 +58,7 @@ risk-fee = amount x blocks-timeout x riskfactor / 5259600
Here are the risk fees in millisatoshis, using various parameters. I
assume a channel charges the default of 1000 millisatoshis plus 1
part-per-million. Common delay values on the network at 14 and 144.
part-per-million. Common to_self_delay values on the network at 14 and 144 blocks.
[options="header"]
|=======================