Skip to content

Commit 4348f72

Browse files
Leo Weesegitbook-bot
Leo Weese
authored and
gitbook-bot
committed
GITBOOK-496: change request with no subject merged in GitBook
1 parent fcbcd4c commit 4348f72

20 files changed

+312
-210
lines changed

‎lightning-network-tools/aperture/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,19 @@ Aperture is a reverse proxy that acts as a payment and authentication gateway fo
99
Aperture receives incoming connections, verifies the validity of the [L402](../../the-lightning-network/l402/) and either forwards the request to the appropriate end point, or obtains a [Macaroon](../../the-lightning-network/l402/macaroons.md) and sends it together with a Lightning invoice and the HTTP status code 402 Payment Required.
1010

1111
Aperture is currently used in production in Lightning [Loop](../loop/) and [Pool](../pool/).
12+
13+
{% content-ref url="get-aperture.md" %}
14+
[get-aperture.md](get-aperture.md)
15+
{% endcontent-ref %}
16+
17+
{% content-ref url="lnc-backend.md" %}
18+
[lnc-backend.md](lnc-backend.md)
19+
{% endcontent-ref %}
20+
21+
{% content-ref url="mailbox.md" %}
22+
[mailbox.md](mailbox.md)
23+
{% endcontent-ref %}
24+
25+
{% content-ref url="pricing.md" %}
26+
[pricing.md](pricing.md)
27+
{% endcontent-ref %}

‎lightning-network-tools/faraday/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,6 @@ description: >-
1111

1212
It primarily helps users understand how capital is flowing through their node, which is useful to help identify underperforming or drained channels and where to deploy capital most efficiently.
1313

14+
[get-started.md](get-started.md "mention")
15+
16+
[the-faraday-cli.md](the-faraday-cli.md "mention")

‎lightning-network-tools/faraday/the-faraday-cli.md

+60-56
Original file line numberDiff line numberDiff line change
@@ -10,57 +10,59 @@ As soon as Faraday is running, you will be able to make use of frcli. Depending
1010

1111
The reports Faraday generates can sometimes appear intimidating, especially if your node has a large number of older channels which have already seen plenty of activity.
1212

13-
The command `frcli insights` gives us a list of all our channels with detailed information about each of them. LND tracks the uptime of each channel since your last restart. Thus, you will be able to see the `uptime_ratio` calculated as part of the output. You can see the age of the channel measured in blocks (confirmations), the total fees earned through this channel, as well as various metrics that can help you compare the activity of your channels.\
14-
15-
16-
`{` ` "chan_point": "d77dcaccc8db72cf90b48e8d51b9e153f5854ac38d56cd5c496a798406d2d1b4:0",`\
17-
` "monitored_seconds": 23531,`\
18-
` "uptime_seconds": 23526,`\
19-
` "volume_incoming_msat": 103615746,`\
20-
` "volume_outgoing_msat": 46662747,`\
21-
` "fees_earned_msat": 624,`\
22-
` "confirmations": 980,`\
23-
` "uptime_ratio": 0.9997875143427819,`\
24-
` "revenue_per_conf_msat": 0.636734693877551,`\
25-
` "volume_per_conf_msat": 153345.40102040817,`\
26-
` "incoming_vol_per_conf_msat": 105730.3530612245,`\
27-
` "outgoing_vol_per_conf_msat": 47615.04795918367`\
28-
` }`
13+
The command `frcli insights` gives us a list of all our channels with detailed information about each of them. LND tracks the uptime of each channel since your last restart. Thus, you will be able to see the `uptime_ratio` calculated as part of the output. You can see the age of the channel measured in blocks (confirmations), the total fees earned through this channel, as well as various metrics that can help you compare the activity of your channels.
14+
15+
```
16+
{ "chan_point": "d77dcaccc8db72cf90b48e8d51b9e153f5854ac38d56cd5c496a798406d2d1b4:0",
17+
"monitored_seconds": 23531,
18+
"uptime_seconds": 23526,
19+
"volume_incoming_msat": 103615746,
20+
"volume_outgoing_msat": 46662747,
21+
"fees_earned_msat": 624,
22+
"confirmations": 980,
23+
"uptime_ratio": 0.9997875143427819,
24+
"revenue_per_conf_msat": 0.636734693877551,
25+
"volume_per_conf_msat": 153345.40102040817,
26+
"incoming_vol_per_conf_msat": 105730.3530612245,
27+
"outgoing_vol_per_conf_msat": 47615.04795918367
28+
}
29+
```
2930

3031
### More detail with revenue reports
3132

32-
The command frcli revenue will give us more detail. For each channel we can get pair reports, which shows in detail where capital is coming from and going as it passes through our node.\
33-
34-
35-
`{`\
36-
` "target_channel": "b0fe65328fd6b42163c26ce39e3e9752e65fe26a096240387a6b3927834f0756:1",`\
37-
` "pair_reports": {`\
38-
` "513204def516e5e8ad07539cc45da4c769a6a3e15d041740eda4ea549b92880f:0": {`\
39-
` "amount_outgoing_msat": "51007151",`\
40-
` "fees_outgoing_msat": "1051",`\
41-
` "amount_incoming_msat": "0",`\
42-
` "fees_incoming_msat": "0"`\
43-
` },`\
44-
` "6a3db67a5131cb9dea3fef7789a0e3fc4a9a45533e11dda5fda02b58e44b640f:1": {`\
45-
` "amount_outgoing_msat": "1275345969",`\
46-
` "fees_outgoing_msat": "3274",`\
47-
` "amount_incoming_msat": "0",`\
48-
` "fees_incoming_msat": "0"`\
49-
` },`\
50-
` "ba3564949f71aeeac45ef30b4fde0c9f229c4458cc6a794838dfa653f2f38e99:1": {`\
51-
` "amount_outgoing_msat": "21235584",`\
52-
` "fees_outgoing_msat": "1021",`\
53-
` "amount_incoming_msat": "0",`\
54-
` "fees_incoming_msat": "0"`\
55-
` },`\
56-
` "ccdb1a6165fa89a5aa965f4ca0ae843a2c6c2ea03382521787eda131410eb3e4:1": {`\
57-
` "amount_outgoing_msat": "688761000",`\
58-
` "fees_outgoing_msat": "2688",`\
59-
` "amount_incoming_msat": "0",`\
60-
` "fees_incoming_msat": "0"`\
61-
` }`\
62-
` }`\
63-
`}`
33+
The command frcli revenue will give us more detail. For each channel we can get pair reports, which shows in detail where capital is coming from and going as it passes through our node.
34+
35+
```
36+
{
37+
"target_channel": "b0fe65328fd6b42163c26ce39e3e9752e65fe26a096240387a6b3927834f0756:1",
38+
"pair_reports": {
39+
"513204def516e5e8ad07539cc45da4c769a6a3e15d041740eda4ea549b92880f:0": {
40+
"amount_outgoing_msat": "51007151",
41+
"fees_outgoing_msat": "1051",
42+
"amount_incoming_msat": "0",
43+
"fees_incoming_msat": "0"
44+
},
45+
"6a3db67a5131cb9dea3fef7789a0e3fc4a9a45533e11dda5fda02b58e44b640f:1": {
46+
"amount_outgoing_msat": "1275345969",
47+
"fees_outgoing_msat": "3274",
48+
"amount_incoming_msat": "0",
49+
"fees_incoming_msat": "0"
50+
},
51+
"ba3564949f71aeeac45ef30b4fde0c9f229c4458cc6a794838dfa653f2f38e99:1": {
52+
"amount_outgoing_msat": "21235584",
53+
"fees_outgoing_msat": "1021",
54+
"amount_incoming_msat": "0",
55+
"fees_incoming_msat": "0"
56+
},
57+
"ccdb1a6165fa89a5aa965f4ca0ae843a2c6c2ea03382521787eda131410eb3e4:1": {
58+
"amount_outgoing_msat": "688761000",
59+
"fees_outgoing_msat": "2688",
60+
"amount_incoming_msat": "0",
61+
"fees_incoming_msat": "0"
62+
}
63+
}
64+
}
65+
```
6466

6567
For each channel, you can see how many milli-satoshi (msat) were routed to and from each peer. This can help you assess how capital is flowing through the network to and from your node with highest granularity.
6668

@@ -105,14 +107,16 @@ Next, we will use this information to obtain a report on the channel from Farada
105107

106108
`frcli closereport 4fc297d20fa41d62ccb2acecf2ed6cc0b1ce3c6f274c6cb661e0e97bb65a640f 1`
107109

108-
`{`\
109-
` "channel_point": "4fc297d20fa41d62ccb2acecf2ed6cc0b1ce3c6f274c6cb661e0e97bb65a640f:1",`\
110-
` "channel_initiator": true,`\
111-
` "close_type": "Cooperative",`\
112-
` "close_txid": "8f1be0671113423fa19546fae5456b824728a415afd800e759e38bb34794cd1b",`\
113-
` "open_fee": "305",`\
114-
` "close_fee": "1812"`\
115-
`}`
110+
```
111+
{
112+
"channel_point": "4fc297d20fa41d62ccb2acecf2ed6cc0b1ce3c6f274c6cb661e0e97bb65a640f:1",
113+
"channel_initiator": true,
114+
"close_type": "Cooperative",
115+
"close_txid": "8f1be0671113423fa19546fae5456b824728a415afd800e759e38bb34794cd1b",
116+
"open_fee": "305",
117+
"close_fee": "1812"
118+
}
119+
```
116120

117121
### Get the full picture
118122

‎lightning-network-tools/lightning-terminal/README.md

+48
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,18 @@ Through Terminal, you can easily, securely and privately manage your Lightning n
1414
[get-lit.md](get-lit.md)
1515
{% endcontent-ref %}
1616

17+
{% content-ref url="run-litd.md" %}
18+
[run-litd.md](run-litd.md)
19+
{% endcontent-ref %}
20+
21+
{% content-ref url="integrating-litd.md" %}
22+
[integrating-litd.md](integrating-litd.md)
23+
{% endcontent-ref %}
24+
25+
{% content-ref url="speedrun.md" %}
26+
[speedrun.md](speedrun.md)
27+
{% endcontent-ref %}
28+
1729
{% content-ref url="connect.md" %}
1830
[connect.md](connect.md)
1931
{% endcontent-ref %}
@@ -22,10 +34,18 @@ Through Terminal, you can easily, securely and privately manage your Lightning n
2234
[recommended-channels.md](recommended-channels.md)
2335
{% endcontent-ref %}
2436

37+
{% content-ref url="ranking.md" %}
38+
[ranking.md](ranking.md)
39+
{% endcontent-ref %}
40+
2541
{% content-ref url="health-checks.md" %}
2642
[health-checks.md](health-checks.md)
2743
{% endcontent-ref %}
2844

45+
{% content-ref url="../../the-lightning-network/liquidity/" %}
46+
[liquidity](../../the-lightning-network/liquidity/)
47+
{% endcontent-ref %}
48+
2949
{% content-ref url="opening-channels.md" %}
3050
[opening-channels.md](opening-channels.md)
3151
{% endcontent-ref %}
@@ -34,10 +54,26 @@ Through Terminal, you can easily, securely and privately manage your Lightning n
3454
[channel-liquidity.md](channel-liquidity.md)
3555
{% endcontent-ref %}
3656

57+
{% content-ref url="autofees.md" %}
58+
[autofees.md](autofees.md)
59+
{% endcontent-ref %}
60+
61+
{% content-ref url="autoopen.md" %}
62+
[autoopen.md](autoopen.md)
63+
{% endcontent-ref %}
64+
65+
{% content-ref url="accounts.md" %}
66+
[accounts.md](accounts.md)
67+
{% endcontent-ref %}
68+
3769
{% content-ref url="loop.md" %}
3870
[loop.md](loop.md)
3971
{% endcontent-ref %}
4072

73+
{% content-ref url="loop-fees.md" %}
74+
[loop-fees.md](loop-fees.md)
75+
{% endcontent-ref %}
76+
4177
{% content-ref url="pool.md" %}
4278
[pool.md](pool.md)
4379
{% endcontent-ref %}
@@ -54,6 +90,18 @@ Through Terminal, you can easily, securely and privately manage your Lightning n
5490
[lightning-node-connect.md](lightning-node-connect.md)
5591
{% endcontent-ref %}
5692

93+
{% content-ref url="lnc-npm.md" %}
94+
[lnc-npm.md](lnc-npm.md)
95+
{% endcontent-ref %}
96+
5797
{% content-ref url="privacy-and-security.md" %}
5898
[privacy-and-security.md](privacy-and-security.md)
5999
{% endcontent-ref %}
100+
101+
{% content-ref url="privacy.md" %}
102+
[privacy.md](privacy.md)
103+
{% endcontent-ref %}
104+
105+
{% content-ref url="tos.md" %}
106+
[tos.md](tos.md)
107+
{% endcontent-ref %}

‎lightning-network-tools/lightning-terminal/accounts.md

+20-16
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ How to make use of accounts for your existing application:
1919

2020
As litd is used to create and manage accounts, access to a new account can be granted using a [Lightning Node Connect](lightning-node-connect.md) pairing phrase, removing the need for the LND node to be directly accessible from the web.
2121

22+
{% hint style="info" %}
2223
At this point, it is not possible to pay invoices between two accounts using the same LND node.
24+
{% endhint %}
2325

2426
## Features <a href="#docs-internal-guid-4dd1448a-7fff-b044-815c-f042b0885742" id="docs-internal-guid-4dd1448a-7fff-b044-815c-f042b0885742"></a>
2527

@@ -70,22 +72,24 @@ The permissions of the macaroon can be inspected with lncli:
7072

7173
`lncli printmacaroon --macaroon_file /tmp/user.macaroon`
7274

73-
`{`\
74-
&#x20; `"version": 2,`\
75-
&#x20; `"location": "lnd",`\
76-
&#x20; `"root_key_id": "0",`\
77-
&#x20; `"permissions": [`\
78-
&#x20; `"info:read",`\
79-
&#x20; `"invoices:read",`\
80-
&#x20; `"invoices:write",`\
81-
&#x20; `"offchain:read",`\
82-
&#x20; `"offchain:write",`\
83-
&#x20; `"onchain:read"`\
84-
&#x20; `],`\
85-
&#x20; `"caveats": [`\
86-
&#x20; `"lnd-custom account d64dbc31b28edf66"`\
87-
&#x20; `]`\
88-
`}`
75+
```
76+
{
77+
"version": 2,
78+
"location": "lnd",
79+
"root_key_id": "0",
80+
"permissions": [
81+
"info:read",
82+
"invoices:read",
83+
"invoices:write",
84+
"offchain:read",
85+
"offchain:write",
86+
"onchain:read"
87+
],
88+
"caveats": [
89+
"lnd-custom account d64dbc31b28edf66"
90+
]
91+
}
92+
```
8993

9094
## Create an LNC session <a href="#docs-internal-guid-ab4cf5c6-7fff-a5cd-6b10-9e8cca0c543e" id="docs-internal-guid-ab4cf5c6-7fff-a5cd-6b10-9e8cca0c543e"></a>
9195

‎lightning-network-tools/lightning-terminal/autofees.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ To improve privacy around data sharing, channel ids, channel points and node pub
3434

3535
The privacy mapper can be interacted with manually through `litcli` for debugging purposes. `litcli privacy` can convert both strings and uint64 to the pseudo counter part and back.
3636

37-
| Note: Enabling Autofees will set your channels’ [CLTV delta](../../the-lightning-network/multihop-payments/timelocks.md) to 100. |
38-
| -------------------------------------------------------------------------------------------------------------------------------- |
37+
{% hint style="warning" %}
38+
Enabling Autofees will set your channels’ [CLTV delta](../../the-lightning-network/multihop-payments/timelocks.md) to 100.
39+
{% endhint %}
3940

4041
## Configuration <a href="#docs-internal-guid-df361fd3-7fff-7d3f-4ce1-669733ea2856" id="docs-internal-guid-df361fd3-7fff-7d3f-4ce1-669733ea2856"></a>
4142

‎lightning-network-tools/lightning-terminal/get-lit.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ You can point litd at your existing LND, Loop or Pool installation, or you can r
1212

1313
## Install litd <a href="#docs-internal-guid-18156f91-7fff-a79f-e732-17a8c366357e" id="docs-internal-guid-18156f91-7fff-a79f-e732-17a8c366357e"></a>
1414

15+
You can install litd from source or via the provided binary.
1516

16-
17-
You can install litd from source or via the provided binary. If you are running LND as part of a software bundle like Umbrel, litd might already be installed on your node.
17+
{% hint style="info" %}
18+
If you are running LND as part of a software bundle like Umbrel, litd might already be installed on your node.
19+
{% endhint %}
1820

1921
[Continue here: Connect to Terminal](connect.md)
2022

‎lightning-network-tools/lightning-terminal/loop-fees.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ A Loop Out allows you to trade your off-chain balance for on-chain bitcoin. Ther
1919

2020
Loop will give us an estimate over the fees we are expected to pay before we confirm our swap. These fees depend on transaction size and current demand for on-chain payments and fall into three categories:
2121

22-
**LSAT**: When you perform your first Loop your node will purchase an [LSAT](../../the-lightning-network/l402/). This LSAT does not expire and costs 1 satoshi.
22+
**L402**: When you perform your first Loop your node will purchase an [L402](../../the-lightning-network/l402/). This L402 does not expire and costs 1 satoshi.
2323

2424
**Estimated on-chain fee**: This is the fee you are expected to pay in miners fees to claim your bitcoin from the [HTLC address](../../the-lightning-network/multihop-payments/understanding-submarine-swaps.md#3.-claim-bitcoin-from-the-smart-contract) into your personal wallet. This fee is calculated based on current on-chain fee conditions and may be higher if by the time the Loop Out concludes the mempool is significantly more congested. Larger transaction sizes do not increase this fee, but faster desired confirmation times do.
2525

@@ -29,7 +29,7 @@ Loop will give us an estimate over the fees we are expected to pay before we con
2929

3030
In the below example we expect to pay a fee of 1,312 satoshis to swap 300,000 satoshis to our on-chain wallet.
3131

32-
![Inspect your estimated fees](../../.gitbook/assets/review\_loop\_out.png)
32+
![Inspect your estimated fees](../../.gitbook/assets/review_loop_out.png)
3333

3434
### Actual fees <a href="#docs-internal-guid-95da1b08-7fff-ddac-9e0c-bec46c57b9fb" id="docs-internal-guid-95da1b08-7fff-ddac-9e0c-bec46c57b9fb"></a>
3535

@@ -43,7 +43,7 @@ After we have performed our swap, we can calculate the total fees we paid in the
4343

4444
**Loop fee**: We can calculate the fee paid to Loop by subtracting our desired Loop Out amount from the total we sent to Loop. In the below case we paid 500 sat in fees to Loop
4545

46-
![Actual fees can be inspected under History](../../.gitbook/assets/actual\_loop\_out.png)
46+
![Actual fees can be inspected under History](../../.gitbook/assets/actual_loop_out.png)
4747

4848
## Loop In <a href="#docs-internal-guid-0991dd2d-7fff-96e4-f1c3-74577b32a6e2" id="docs-internal-guid-0991dd2d-7fff-96e4-f1c3-74577b32a6e2"></a>
4949

@@ -57,7 +57,7 @@ Similar to the above, we will receive an estimate of our fees before we confirm
5757

5858
**Loop service fee**: This is the fee that Loop will take from our swap. It includes the on-chain fees to sweep the HTLC and the off-chain fees for Loop’s payment to you.
5959

60-
![Inspect your estimated fees](../../.gitbook/assets/review\_loop\_in.png)
60+
![Inspect your estimated fees](../../.gitbook/assets/review_loop_in.png)
6161

6262
### Actual fees <a href="#docs-internal-guid-a21ba5c6-7fff-809c-80f1-f996ac790234" id="docs-internal-guid-a21ba5c6-7fff-809c-80f1-f996ac790234"></a>
6363

@@ -69,4 +69,4 @@ After our swap is complete, we can inspect the total fees we paid.
6969

7070
**Loop service fee**: We can calculate this fee by subtracting the satoshis we received in our off-chain payment from the swap amount. In our example we paid 1,456 sats in fees. This fee includes the off-chain fees paid by Loop to deliver our payment to our node, the miners fee paid by Loop to sweep the HTLC and the Loop fee.
7171

72-
![actual fees can be inspected uner History](../../.gitbook/assets/actual\_loop\_in.png)
72+
![actual fees can be inspected uner History](../../.gitbook/assets/actual_loop_in.png)

‎lightning-network-tools/lightning-terminal/privacy-and-security.md

+2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ Use a reputable and robust browser that ideally updates itself regularly. Be car
3434

3535
Be vigilant of phishing attacks directing you to sites attempting to steal your pairing phrase before you have connected yourself. Ideally, bookmark the page in your browser and only navigate to it using the bookmark bar.
3636

37+
{% hint style="warning" %}
3738
Choose a strong and unique password for Terminal, for example one created using your password manager.
39+
{% endhint %}
3840

3941
## Other applications
4042

0 commit comments

Comments
 (0)