Skip to content

Commit dd88855

Browse files
Leo Weesegitbook-bot
authored andcommitted
GitBook: [#173] add videos!
1 parent 8f8c646 commit dd88855

File tree

4 files changed

+52
-33
lines changed

4 files changed

+52
-33
lines changed

lapps/guides/polar-lapps/README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,18 @@ description: >-
77

88
# Use Polar to Build Your First LAPP
99

10-
{% page-ref page="local-cluster-setup-with-polar.md" %}
11-
12-
{% page-ref page="run-the-completed-app.md" %}
13-
14-
{% page-ref page="run-the-app-without-lnd.md" %}
10+
{% content-ref url="local-cluster-setup-with-polar.md" %}
11+
[local-cluster-setup-with-polar.md](local-cluster-setup-with-polar.md)
12+
{% endcontent-ref %}
1513

14+
{% content-ref url="run-the-completed-app.md" %}
15+
[run-the-completed-app.md](run-the-completed-app.md)
16+
{% endcontent-ref %}
1617

18+
{% content-ref url="run-the-app-without-lnd.md" %}
19+
[run-the-app-without-lnd.md](run-the-app-without-lnd.md)
20+
{% endcontent-ref %}
1721

22+
{% embed url="https://www.youtube.com/watch?v=6P0DZ74DmFA" %}
23+
Video: Build Bitcoin into Your App: Getting Started with the Lightning Network
24+
{% endembed %}

lightning-network-tools/lnd/amp.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@ For a shard of size two this can be simplified as follows, with k being the prei
3030

3131
The information necessary for the recipient node to generate the correct preimages and reveal them to claim their payments is passed on in encrypted form as part of the Onion TLV (Type Length Value). This removes the need for additional interaction between the payer and the payee beyond transmitting a node public key or an invoice.
3232

33-
## Get your node ready for AMPs <a href="docs-internal-guid-0aff8c2e-7fff-3644-f0f2-cf0efff90d43" id="docs-internal-guid-0aff8c2e-7fff-3644-f0f2-cf0efff90d43"></a>
33+
{% embed url="https://www.youtube.com/watch?v=PNSPXRflCSc" %}
34+
Video: Get AMPed: Making Atomic Multi-Path Payments
35+
{% endembed %}
36+
37+
## Get your node ready for AMPs <a href="#docs-internal-guid-0aff8c2e-7fff-3644-f0f2-cf0efff90d43" id="docs-internal-guid-0aff8c2e-7fff-3644-f0f2-cf0efff90d43"></a>
3438

3539
To be able to make and send Atomic Multi-path Payments, you will need to upgrade your node to [LND 0.13 or above](https://github.com/lightningnetwork/lnd/releases).
3640

lightning-network-tools/lnd/run-lnd.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@ description: >-
88

99
The Lightning Network Daemon (LND) is a complete implementation of a Lightning Network node. That means that LND is able to perform all actions necessary to participate and interact with all aspects of the Lightning Network and its nodes. It fully complies with all Lightning Network specifications (BOLTs) [as described here](https://github.com/lightningnetwork/lightning-rfc/blob/master/00-introduction.md). As these specifications are currently rapidly evolving, so is LND.
1010

11-
## Part 1: Installation <a href="docs-internal-guid-ff85e2ff-7fff-ef9c-0f05-8da12a86ea43" id="docs-internal-guid-ff85e2ff-7fff-ef9c-0f05-8da12a86ea43"></a>
11+
## Part 1: Installation <a href="#docs-internal-guid-ff85e2ff-7fff-ef9c-0f05-8da12a86ea43" id="docs-internal-guid-ff85e2ff-7fff-ef9c-0f05-8da12a86ea43"></a>
1212

1313
There are multiple methods for getting LND running on your machine. Your choice will depend on your requirements, the purpose of the installation, your technical expertise, your hardware, security needs and comfort with various tools.
1414

1515
Your requirements and dependencies will vary between installation types, as will the effort to maintain them.
1616

17+
{% embed url="https://www.youtube.com/watch?v=rf-GvVYuWa8" %}
18+
Video: RUN LND: Building a Node from Scratch
19+
{% endembed %}
20+
1721
### System requirements
1822

1923
LND generally has low system requirements and performs well on small single-board devices with 2 GiB and a CPU with over 1 GHz quad core, such as a Raspberry Pi. Generally the system requirements for Bitcoind are higher than those for LND. A 64-bit architecture is strongly recommended, as a large (>2GB) `channel.db`on 32-bit systems can lead to a system halt. Due to the frequent read and write operations LND should **not** be run from an SD card, but ideally a high-performing SSD.
@@ -44,15 +48,15 @@ You can use the file manager or command line, but may have to create this direct
4448

4549
Congratulations, you have successfully installed LND using the binary release. [Jump to: Configuring LND](run-lnd.md#docs-internal-guid-f1be3c4d-7fff-b4f7-e6cd-ce2c32ba2d86)
4650

47-
### Installing Lightning via Docker <a href="docs-internal-guid-fe99d99a-7fff-2f7a-022e-4fab339d71f9" id="docs-internal-guid-fe99d99a-7fff-2f7a-022e-4fab339d71f9"></a>
51+
### Installing Lightning via Docker <a href="#docs-internal-guid-fe99d99a-7fff-2f7a-022e-4fab339d71f9" id="docs-internal-guid-fe99d99a-7fff-2f7a-022e-4fab339d71f9"></a>
4852

4953
For those familiar with Docker, or those interested in easily running a variety of software alongside each other, the Docker installation is a convenient and quick way to get started with lightning.
5054

5155
To install LND via Docker you will need `docker`, `make` and `bash` on your system. You can install lnd with the following commands:
5256

53-
`git clone https://github.com/lightningnetwork/lnd `\
54-
`cd lnd `\
55-
`git checkout <latest-release> `\
57+
`git clone https://github.com/lightningnetwork/lnd` \
58+
`cd lnd` \
59+
`git checkout <latest-release>` \
5660
`make docker-release tag=<latest-release>`
5761

5862
You are now able to find the binaries in the directory lnd\<latest-release> for your use. Congratulations, [jump to: Configuring LND](run-lnd.md#docs-internal-guid-f1be3c4d-7fff-b4f7-e6cd-ce2c32ba2d86)
@@ -65,7 +69,7 @@ Installing LND from source is recommended when using it in development or on tes
6569
You can find the latest version of Golang [on its official website](https://golang.org/dl/). Make sure to verify the checksum before you install Go.
6670

6771
You can now install go with the command:\
68-
`tar -C /usr/local -xzf go[version].linux-[platform].tar.gz `\
72+
`tar -C /usr/local -xzf go[version].linux-[platform].tar.gz` \
6973
`export PATH=$PATH:/usr/local/go/bin`
7074

7175
**Installing Go on MacOS**\
@@ -74,19 +78,19 @@ To install, simply run the command:\
7478

7579
**Set your Go path**\
7680
To ensure that the command go refers to the correct path, you will need to set your Go path:\
77-
`export GOPATH=~/gocode `\
81+
`export GOPATH=~/gocode` \
7882
`export PATH=$PATH:$GOPATH/bin`
7983

8084
**Installing LND**\
8185
We can now install LND. We can run the following command from our home directory:\
82-
`git clone https://github.com/lightningnetwork/lnd `\
83-
`cd lnd `\
84-
`git checkout [version] `\
86+
`git clone https://github.com/lightningnetwork/lnd` \
87+
`cd lnd` \
88+
`git checkout [version]` \
8589
`make install tags="autopilotrpc chainrpc invoicesrpc routerrpc signrpc walletrpc watchtowerrpc wtclientrpc"`
8690

8791
LND is now installed from source.
8892

89-
## Part 2: Configuring LND <a href="docs-internal-guid-f1be3c4d-7fff-b4f7-e6cd-ce2c32ba2d86" id="docs-internal-guid-f1be3c4d-7fff-b4f7-e6cd-ce2c32ba2d86"></a>
93+
## Part 2: Configuring LND <a href="#docs-internal-guid-f1be3c4d-7fff-b4f7-e6cd-ce2c32ba2d86" id="docs-internal-guid-f1be3c4d-7fff-b4f7-e6cd-ce2c32ba2d86"></a>
9094

9195
### Bitcoin
9296

@@ -147,7 +151,7 @@ When starting lnd with neutrino, you will need to set the following flags:`--bit
147151

148152
To make your node available as a routing node, you will need to listen to incoming connections. In your [lnd.conf configuration file](https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf), include the following lines:
149153

150-
`listen=0.0.0.0:9735 `\
154+
`listen=0.0.0.0:9735` \
151155
`listen=[::1]:9736`
152156

153157
This will allow your node to listen on all IPv4 (port 9735) and IPv6 (port 9736) interfaces.
@@ -162,15 +166,15 @@ Be aware of any firewall that might be enabled on your system, for example by us
162166

163167
Using a firewall is a great idea, although the ports defined above need to remain accessible:
164168

165-
`sudo ufw status `\
166-
`sudo ufw allow OpenSSH `\
169+
`sudo ufw status` \
170+
`sudo ufw allow OpenSSH` \
167171
`sudo ufw allow 9735`
168172

169173
#### Other available configurations
170174

171175
There are plenty of options to configure lnd. Have a look at the [sample lnd.conf file here](https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf) and read our article on the optimal configuration for your node.
172176

173-
## Part 3: Running LND <a href="docs-internal-guid-9df27c7d-7fff-522a-838a-a42710fe3e75" id="docs-internal-guid-9df27c7d-7fff-522a-838a-a42710fe3e75"></a>
177+
## Part 3: Running LND <a href="#docs-internal-guid-9df27c7d-7fff-522a-838a-a42710fe3e75" id="docs-internal-guid-9df27c7d-7fff-522a-838a-a42710fe3e75"></a>
174178

175179
Now that we have LND installed and configured with its Bitcoin backend we may start it for the first time.
176180

@@ -245,8 +249,8 @@ If you are running LND in a docker container, you can upgrade this container as
245249

246250
First navigate to the local copy of the lnd github repository, for example with `cd lnd`. Then execute the following commands:
247251

248-
`git pull `\
249-
`git checkout <latest-release> `\
252+
`git pull` \
253+
`git checkout <latest-release>` \
250254
`make docker-release tag=<latest-release>`
251255

252256
You can now start lnd again, unlock the wallet and verify you are using the correct version with `lncli version`.

the-lightning-network/liquidity/manage-liquidity.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: >-
66

77
# Managing Liquidity on the Lightning Network
88

9-
## On-chain Bitcoin <a href="docs-internal-guid-f32642c8-7fff-bda4-5003-3937885e00bc" id="docs-internal-guid-f32642c8-7fff-bda4-5003-3937885e00bc"></a>
9+
## On-chain Bitcoin <a href="#docs-internal-guid-f32642c8-7fff-bda4-5003-3937885e00bc" id="docs-internal-guid-f32642c8-7fff-bda4-5003-3937885e00bc"></a>
1010

1111
The liquidity of on-chain bitcoin is predictable. Bitcoin exists in the form of UTXOs, which are unspent outputs from a previous transaction. To spend bitcoin, you need to receive or mine them first, but generally, they can be moved by the owner at any time.
1212

@@ -15,7 +15,7 @@ On-chain bitcoin require multiple confirmations by the Bitcoin network to be con
1515
Your Lightning node is able to receive and send on-chain bitcoin.
1616

1717
* `lncli newaddress` Generate a new Bitcoin address
18-
* `lncli walletbalance `Check your balance.
18+
* `lncli walletbalance` Check your balance.
1919
* `lncli sendcoins` Send Bitcoin from this wallet
2020

2121
This command follows the format `lncli sendcoins [command options] addr amt`
@@ -65,7 +65,7 @@ Useful tips:
6565
Example usage:
6666

6767
* `lncli openchannel 021c97a90a411ff2b10dc2a8e32de2f29d2fa49d41bfbb52bd416e460db0747d0d 1000000`
68-
* `lncli openchannel --sat_per_byte 21 --local-amt 800000 --close_address bc1qsltz4tt23k0825q76ylj5mt0gwenlm8wr7umkl 021c97a90a411ff2b10dc2a8e32de2f29d2fa49d41bfbb52bd416e460db0747d0d `
68+
* `lncli openchannel --sat_per_byte 21 --local-amt 800000 --close_address bc1qsltz4tt23k0825q76ylj5mt0gwenlm8wr7umkl 021c97a90a411ff2b10dc2a8e32de2f29d2fa49d41bfbb52bd416e460db0747d0d`&#x20;
6969

7070
To see if your channel is pending confirmation, you can use the command `lncli pendingchannels`.
7171

@@ -91,13 +91,13 @@ You are able to charge fees for routing payments. You can use the command `lncli
9191

9292
By default, your fee policy may look something like this:
9393

94-
&#x20; ` {`\
95-
` "chan_id": "739918549049147393",`\
96-
` "channel_point": "3ebdb34f1fc1948b5b49d127b52b19d24549779661af03a691cf934aa3b86e3f:1",`\
97-
` "base_fee_msat": "1000",`\
98-
` "fee_per_mil": "1",`\
99-
` "fee_rate": 0.000001`\
100-
` }`
94+
&#x20; `{`\
95+
&#x20; `"chan_id": "739918549049147393",`\
96+
&#x20; `"channel_point": "3ebdb34f1fc1948b5b49d127b52b19d24549779661af03a691cf934aa3b86e3f:1",`\
97+
&#x20; `"base_fee_msat": "1000",`\
98+
&#x20; `"fee_per_mil": "1",`\
99+
&#x20; `"fee_rate": 0.000001`\
100+
&#x20; `}`
101101

102102
This means to route payments through this channel, your node will charge 1,000 milli-satoshi (1 satoshi), plus 1 milli-satoshi per million milli-satoshi (`fee_rate` times one million equals fee\_per\_mil). So when routing a payment of 10,000 satoshi, you will earn 1.01 satoshi in fees. This fee policy is applied to all outgoing payments, meaning you will only earn the fee as it is passed on. The fee policy on the incoming channel is decided by that peer. As a rule of thumb, you decide on the fee policy of your capital.
103103

@@ -206,3 +206,7 @@ Private channels may also bind your capital. Typically, they are created by paym
206206
Example usage:
207207

208208
`lncli closechannel --funding_txid 83b5a55b21255915dbc0d005230b2c026a004c839edaa716247b96b66490c66a --output_index 1 --sat_per_byte 20 --delivery_addr bc1q6tcemsjadwgt938gkrmcqyvt79wxla42js8r4l`
209+
210+
{% embed url="https://www.youtube.com/watch?v=LRZy-VtCPe4" %}
211+
`Video:` Lightning 101: Node Profitability feat PLEBNET
212+
{% endembed %}

0 commit comments

Comments
 (0)