You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/beginners-guide/beginners-guide.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,23 +35,23 @@ You can start `lightningd` with the following command:
35
35
lightningd --network=bitcoin --log-level=debug
36
36
```
37
37
38
-
This creates a `.lightning/` subdirectory in your home directory: see `man -l doc/lightningd.8` (or [???](???)) for more runtime options.
38
+
This creates a `.lightning/` subdirectory in your home directory: see `man -l doc/lightningd.8` (or [lightningd-config](ref:lightningd-config)) for more runtime options.
39
39
40
40
## Using The JSON-RPC Interface
41
41
42
-
Core Lightning exposes a [JSON-RPC 2.0](https://www.jsonrpc.org/specification) interface over a Unix Domain socket; the [`lightning-cli`](ref:lightning-cli) tool can be used to access it, or there is a [python client library](???).
42
+
Core Lightning exposes a [JSON-RPC 2.0](https://www.jsonrpc.org/specification) interface over a Unix Domain socket; the [`lightning-cli`](ref:lightning-cli) tool can be used to access it, or there is a [python client library](doc:json-rpc#using-python).
43
43
44
-
You can use `[lightning-cli](ref:lightning-cli) help` to print a table of RPC methods; `[lightning-cli](lightning-cli) help <command>` will offer specific information on that command.
44
+
You can use `lightning-cli help` to print a table of RPC methods; `lightning-cli help <command>` will offer specific information on that command.
45
45
46
46
Useful commands:
47
47
48
-
-[lightning-newaddr](ref:lightning-newaddr): get a bitcoin address to deposit funds into your lightning node.
49
-
-[lightning-listfunds](ref:lightning-listfunds): see where your funds are.
50
-
-[lightning-connect](ref:lightning-connect): connect to another lightning node.
51
-
-[lightning-fundchannel](ref:lightning-fundchannel): create a channel to another connected node.
52
-
-[lightning-invoice](ref:lightning-invoice): create an invoice to get paid by another node.
Core Lightning exposes a [JSON-RPC 2.0](https://www.jsonrpc.org/specification) interface over a Unix Domain socket; the [`lightning-cli`](ref:lightning-cli) tool can be used to access it, or there is a [python client library](doc:json-rpc#using-python).
15
15
16
-
You can use `[lightning-cli](ref:lightning-cli) help` to print a table of RPC methods; `[lightning-cli](lightning-cli) help <command>` will offer specific information on that command.
17
-
18
-
Useful commands:
19
-
20
-
-[lightning-newaddr](ref:lightning-newaddr): get a bitcoin address to deposit funds into your lightning node.
21
-
-[lightning-listfunds](ref:lightning-listfunds): see where your funds are.
22
-
-[lightning-connect](ref:lightning-connect): connect to another lightning node.
23
-
-[lightning-fundchannel](ref:lightning-fundchannel): create a channel to another connected node.
24
-
-[lightning-invoice](ref:lightning-invoice): create an invoice to get paid by another node.
-[lightning-plugin](ref:lightning-plugin): commands to control extensions.
27
-
28
-
A complete list of all JSON-RPC commands is available at [API Reference](ref:lightning-addgossip).
16
+
You can use `lightning-cli help` to print a table of RPC methods; `lightning-cli help <command>` will offer specific information on that command. A complete list of all JSON-RPC commands is available at [API Reference](ref:get_list_methods_resource).
Once those two methods were called `lightningd` will start passing through incoming JSON-RPC commands that were registered and the plugin may interact with `lightningd` using the JSON-RPC over Unix-Socket interface.
30
30
31
-
Above is generally valid for plugins that start when `lightningd` starts. For dynamic plugins that start via the [lightning-plugin](ref:lightning-plugin) JSON-RPC command there is some difference, mainly in options passthrough (see note in [Types of Options](doc:a-day-in-the-life-of-a-plugin#types-of-options)).
31
+
Above is generally valid for plugins that start when `lightningd` starts. For dynamic plugins that start via the [lightning-plugin](ref:plugin) JSON-RPC command there is some difference, mainly in options passthrough (see note in [Types of Options](doc:a-day-in-the-life-of-a-plugin#types-of-options)).
32
32
33
33
-`shutdown` (optional): if subscribed to "shutdown" notification, a plugin can exit cleanly when `lightningd` is shutting down or when stopped via `plugin stop`.
34
34
@@ -106,7 +106,7 @@ The `subscriptions` array indicates what [Event Notifications](doc:event-notific
106
106
107
107
The `nonnumericids` indicates that the plugin can handle string JSON request `id` fields: prior to v22.11 lightningd used numbers for these, and the change to strings broke some plugins. If present, this must be `true` (since v23.05). See the [lightningd-rpc](ref:lightningd-rpc) documentation for how to handle JSON `id` fields!
108
108
109
-
The `dynamic` indicates if the plugin can be managed after `lightningd` has been started using the [lightning-plugin](ref:lightning-plugin) JSON-RPC command. Critical plugins that should not be stopped should set it to false. Plugin `options` can be passed to dynamic plugins as argument to the `plugin` command .
109
+
The `dynamic` indicates if the plugin can be managed after `lightningd` has been started using the [lightning-plugin](ref:plugin) JSON-RPC command. Critical plugins that should not be stopped should set it to false. Plugin `options` can be passed to dynamic plugins as argument to the `plugin` command .
110
110
111
111
If you can handle the `check` command on your commands, you should set `cancheck` to `true` and expect `lightningd` to pass through any user-requested `check` commands to you directly (without this, `check` currently always passes, which is not very useful!).
112
112
@@ -251,4 +251,4 @@ The `startup` field allows a plugin to detect if it was started at `lightningd`
251
251
### Timeouts
252
252
253
253
During startup ("startup" is true), the plugin has 60 seconds to return `getmanifest` and another 60 seconds to return `init`, or gets killed.
254
-
When started dynamically via the [lightning-plugin](ref:lightning-plugin) JSON-RPC command, both `getmanifest` and `init` should be completed within 60 seconds.
254
+
When started dynamically via the [lightning-plugin](ref:plugin) JSON-RPC command, both `getmanifest` and `init` should be completed within 60 seconds.
Copy file name to clipboardExpand all lines: doc/developers-guide/plugin-development/hooks.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -576,7 +576,7 @@ Note: The `rpc_command` hook is chainable. If two or more plugins try to replace
576
576
577
577
### `custommsg`
578
578
579
-
The `custommsg` plugin hook is the receiving counterpart to the [`sendcustommsg`](ref:lightning-sendcustommsg) RPC method and allows plugins to handle messages that are not handled internally. The goal of these two components is to allow the implementation of custom protocols or prototypes on top of a Core Lightning node, without having to change the node's implementation itself.
579
+
The `custommsg` plugin hook is the receiving counterpart to the [`sendcustommsg`](ref:sendcustommsg) RPC method and allows plugins to handle messages that are not handled internally. The goal of these two components is to allow the implementation of custom protocols or prototypes on top of a Core Lightning node, without having to change the node's implementation itself.
Copy file name to clipboardExpand all lines: doc/getting-started/advanced-setup/bitcoin-core.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The lightning daemon will poll `bitcoind` for new blocks that it hasn't processe
15
15
16
16
If `bitcoind` prunes a block that Core Lightning has not processed yet, e.g., Core Lightning was not running for a prolonged period, then `bitcoind` will not be able to serve the missing blocks, hence Core Lightning will not be able to synchronize anymore and will be stuck.
17
17
18
-
In order to avoid this situation you should be monitoring the gap between Core Lightning's blockheight using `[lightning-cli](ref:lightning-cli) getinfo` and `bitcoind`'s blockheight using `bitcoin-cli getblockchaininfo`. If the two blockheights drift apart it might be necessary to intervene.
18
+
In order to avoid this situation you should be monitoring the gap between Core Lightning's blockheight using `lightning-cli getinfo` and `bitcoind`'s blockheight using `bitcoin-cli getblockchaininfo`. If the two blockheights drift apart it might be necessary to intervene.
Copy file name to clipboardExpand all lines: doc/getting-started/getting-started/configuration.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ Blank lines and lines beginning with `#` are ignored.
28
28
29
29
`--help` will show you the defaults for many options; they vary with network settings so you can specify `--network` before `--help` to see the defaults for that network.
30
30
31
-
The [`lightning-listconfigs`](ref:lightning-listconfigs) command will output a valid configuration file using the current settings.
31
+
The [`listconfigs`](ref:listconfigs) command will output a valid configuration file using the current settings.
32
32
33
33
## Options
34
34
@@ -255,11 +255,11 @@ The [`lightning-listconfigs`](ref:lightning-listconfigs) command will output a v
255
255
256
256
-**fee-base**=_MILLISATOSHI_
257
257
258
-
Default: 1000. The base fee to charge for every payment which passes through. Note that millisatoshis are a very, very small unit! Changing this value will only affect new channels and not existing ones. If you want to change fees for existing channels, use the RPC call [`lightning-setchannel`](ref:lightning-setchannel).
258
+
Default: 1000. The base fee to charge for every payment which passes through. Note that millisatoshis are a very, very small unit! Changing this value will only affect new channels and not existing ones. If you want to change fees for existing channels, use the RPC call [`setchannel`](ref:setchannel).
259
259
260
260
-**fee-per-satoshi**=_MILLIONTHS_
261
261
262
-
Default: 10 (0.001%). This is the proportional fee to charge for every payment which passes through. As percentages are too coarse, it's in millionths, so 10000 is 1%, 1000 is 0.1%. Changing this value will only affect new channels and not existing ones. If you want to change fees for existing channels, use the RPC call [`lightning-setchannel`](ref:lightning-setchannel).
262
+
Default: 10 (0.001%). This is the proportional fee to charge for every payment which passes through. As percentages are too coarse, it's in millionths, so 10000 is 1%, 1000 is 0.1%. Changing this value will only affect new channels and not existing ones. If you want to change fees for existing channels, use the RPC call [`setchannel`](ref:setchannel).
263
263
264
264
-**min-capacity-sat**=_SATOSHI_
265
265
@@ -277,18 +277,18 @@ The [`lightning-listconfigs`](ref:lightning-listconfigs) command will output a v
277
277
-**force-feerates**==_VALUES_
278
278
279
279
Networks like regtest and testnet have unreliable fee estimates: we usually treat them as the minimum (253 sats/kw) if we can't get them.
280
-
This allows override of one or more of our standard feerates (see [`lightning-feerates`](ref:lightning-feerates)). Up to 5 values, separated by '/' can be provided: if fewer are provided, then the final value is used for the remainder. The values are in per-kw (roughly 1/4 of bitcoind's per-kb values), and the order is "opening", "mutual_close", "unilateral_close", "delayed_to_us", "htlc_resolution", and "penalty".
280
+
This allows override of one or more of our standard feerates (see [`feerates`](ref:feerates)). Up to 5 values, separated by '/' can be provided: if fewer are provided, then the final value is used for the remainder. The values are in per-kw (roughly 1/4 of bitcoind's per-kb values), and the order is "opening", "mutual_close", "unilateral_close", "delayed_to_us", "htlc_resolution", and "penalty".
281
281
282
282
You would usually put this option in the per-chain config file, to avoid setting it on Bitcoin mainnet! e.g. `~rusty/.lightning/regtest/config`.
283
283
284
284
-**htlc-minimum-msat**=_MILLISATOSHI_
285
285
286
286
Default: 0. Sets the minimal allowed HTLC value for newly created channels.
287
-
If you want to change the `htlc_minimum_msat` for existing channels, use the RPC call [`lightning-setchannel`](ref:lightning-setchannel).
287
+
If you want to change the `htlc_minimum_msat` for existing channels, use the RPC call [`setchannel`](ref:setchannel).
288
288
289
289
-**htlc-maximum-msat**=_MILLISATOSHI_
290
290
291
-
Default: unset (no limit). Sets the maximum allowed HTLC value for newly created channels. If you want to change the `htlc_maximum_msat` for existing channels, use the RPC call [`lightning-setchannel`](ref:lightning-setchannel).
291
+
Default: unset (no limit). Sets the maximum allowed HTLC value for newly created channels. If you want to change the `htlc_maximum_msat` for existing channels, use the RPC call [`setchannel`](ref:setchannel).
292
292
293
293
### Lightning channel and HTLC options
294
294
@@ -477,13 +477,13 @@ plugins along with any immediate subdirectories). You can specify additional pat
477
477
478
478
-**disable-plugin**=_PLUGIN_
479
479
480
-
If _PLUGIN_ contains a /, plugins with the same path as _PLUGIN_ will not be loaded at startup. Otherwise, no plugin with that base name will be loaded at startup, whatever directory it is in. This option is useful for disabling a single plugin inside a directory. You can still explicitly load plugins which have been disabled, using [lightning-plugin](ref:lightning-plugin)`start`.
480
+
If _PLUGIN_ contains a /, plugins with the same path as _PLUGIN_ will not be loaded at startup. Otherwise, no plugin with that base name will be loaded at startup, whatever directory it is in. This option is useful for disabling a single plugin inside a directory. You can still explicitly load plugins which have been disabled, using [plugin](ref:plugin)`start`.
481
481
482
482
-**important-plugin**=_PLUGIN_
483
483
484
484
Specify a plugin to run as part of Core Lightning.
485
485
This can be specified multiple times to add multiple plugins.
486
-
Plugins specified via this option are considered so important, that if the plugin stops for any reason (including via [lightning-plugin](ref:lightning-plugin)`stop`), Core Lightning will also stop running.
486
+
Plugins specified via this option are considered so important, that if the plugin stops for any reason (including via [plugin](ref:plugin)`stop`), Core Lightning will also stop running.
487
487
This way, you can monitor crashes of important plugins by simply monitoring if Core Lightning terminates.
488
488
Built-in plugins, which are installed with lightningd, are automatically considered important.
Since version 23.02, Core Lightning ships with a powerful SQL plugin that allows you to query your node and analyse data for channel / liquidity management, accounting and audit.
12
12
13
-
See [lightning-sql](ref:lightning-sql) for a full primer on its usage.
13
+
See [sql](ref:sql) for a full primer on its usage.
Copy file name to clipboardExpand all lines: doc/node-operators-guide/faq.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,14 +17,14 @@ A better option is to use the [`summary` plugin](https://github.com/lightningd/p
17
17
18
18
### My channel is in state `STATE`, what does that mean ?
19
19
20
-
See the [listpeers](ref:lightning-listpeers) command.
20
+
See the [listpeers](ref:listpeers) command.
21
21
22
22
### My payment is failing / all my payments are failing, why ?
23
23
24
24
There are many reasons for a payment failure. The most common one is a [failure](https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages)
25
25
along the route from you to the payee. The best (and most common) solution to a route failure problem is to open more channels, which should increase the available routes to the recipient and lower the probability of a failure.
26
26
27
-
**Hint:** use the [`pay`](ref:lightning-pay) command which is will iterate through trying all possible routes,
27
+
**Hint:** use the [`pay`](ref:pay) command which is will iterate through trying all possible routes,
28
28
instead of the low-level `sendpay` command which only tries the passed in route.
29
29
30
30
### How can I receive payments ?
@@ -162,7 +162,7 @@ There are 3 types of 'rescans' you can make:
162
162
If you lose data (likely corrupted `lightningd.sqlite3`) about a channel **with `option_static_remotekey` enabled**, you can wait for your peer to unilateraly close the channel, then use `tools/hsmtool` with the `guesstoremote` command to attempt to recover your funds from the peer's published unilateral close transaction.
163
163
164
164
If `option_static_remotekey` was not enabled, you're probably out of luck. The keys for your funds in your peer's unilateral close transaction are derived from information you lost. Fortunately, since version `0.7.3` channels are created with `option_static_remotekey` by default if your peer supports it. Which is to say that channels created after block [598000](https://blockstream.info/block/0000000000000000000dd93b8fb5c622b9c903bf6f921ef48e266f0ead7faedb)
165
-
(short channel id starting with > 598000) have a high chance of supporting `option_static_remotekey`. You can verify it using the `features` field from the [`listpeers` command](ref:lightning-listpeers)'s result.
165
+
(short channel id starting with > 598000) have a high chance of supporting `option_static_remotekey`. You can verify it using the `features` field from the [`listpeers` command](ref:listpeers)'s result.
166
166
167
167
Here is an example in Python checking if [one of the `option_static_remotekey` bits](https://github.com/lightning/bolts/blob/master/09-features.md) is set in the negotiated features corresponding to `0x02aaa2`:
168
168
@@ -179,4 +179,4 @@ If `option_static_remotekey` is enabled you can attempt to recover the funds in
179
179
180
180
### How do I get the `psbt` for RPC calls that need it?
181
181
182
-
A `psbt` is created and returned by a call to [`utxopsbt` with `reservedok=true`](ref:lightning-utxopsbt).
182
+
A `psbt` is created and returned by a call to [`utxopsbt` with `reservedok=true`](ref:utxopsbt).
0 commit comments