Skip to content

Commit e5ec688

Browse files
ShahanaFarooquirustyrussell
authored andcommitted
doc: Fix links to avoid 404 error
1 parent adbe634 commit e5ec688

File tree

8 files changed

+29
-41
lines changed

8 files changed

+29
-41
lines changed

doc/beginners-guide/beginners-guide.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,23 @@ You can start `lightningd` with the following command:
3535
lightningd --network=bitcoin --log-level=debug
3636
```
3737

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.
3939

4040
## Using The JSON-RPC Interface
4141

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).
4343

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.
4545

4646
Useful commands:
4747

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.
53-
- [lightning-pay](ref:lightning-pay): pay someone else's invoice.
54-
- [lightning-plugin](ref:lightning-plugin): commands to control extensions.
48+
- [newaddr](ref:newaddr): get a bitcoin address to deposit funds into your lightning node.
49+
- [listfunds](ref:listfunds): see where your funds are.
50+
- [connect](ref:connect): connect to another lightning node.
51+
- [fundchannel](ref:fundchannel): create a channel to another connected node.
52+
- [invoice](ref:invoice): create an invoice to get paid by another node.
53+
- [pay](ref:pay): pay someone else's invoice.
54+
- [plugin](ref:plugin): commands to control extensions.
5555

5656
## Care And Feeding Of Your New Lightning Node
5757

doc/developers-guide/app-development/json-rpc.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,7 @@ updatedAt: "2023-02-21T13:50:10.086Z"
1313

1414
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).
1515

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.
25-
- [lightning-pay](ref:lightning-pay): pay someone else's invoice.
26-
- [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).
2917

3018
## Using Python
3119

doc/developers-guide/plugin-development/a-day-in-the-life-of-a-plugin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ lightningd --plugin=/path/to/plugin1 --plugin=path/to/plugin2
2828

2929
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.
3030

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)).
3232

3333
- `shutdown` (optional): if subscribed to "shutdown" notification, a plugin can exit cleanly when `lightningd` is shutting down or when stopped via `plugin stop`.
3434

@@ -106,7 +106,7 @@ The `subscriptions` array indicates what [Event Notifications](doc:event-notific
106106

107107
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!
108108

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 .
110110

111111
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!).
112112

@@ -251,4 +251,4 @@ The `startup` field allows a plugin to detect if it was started at `lightningd`
251251
### Timeouts
252252

253253
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.

doc/developers-guide/plugin-development/hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ Note: The `rpc_command` hook is chainable. If two or more plugins try to replace
576576

577577
### `custommsg`
578578

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.
580580

581581
The payload for a call follows this format:
582582

doc/getting-started/advanced-setup/bitcoin-core.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The lightning daemon will poll `bitcoind` for new blocks that it hasn't processe
1515

1616
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.
1717

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.
1919

2020
# Connecting to Bitcoin Core remotely
2121

doc/getting-started/getting-started/configuration.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Blank lines and lines beginning with `#` are ignored.
2828

2929
`--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.
3030

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.
3232

3333
## Options
3434

@@ -255,11 +255,11 @@ The [`lightning-listconfigs`](ref:lightning-listconfigs) command will output a v
255255

256256
- **fee-base**=_MILLISATOSHI_
257257

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).
259259

260260
- **fee-per-satoshi**=_MILLIONTHS_
261261

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).
263263

264264
- **min-capacity-sat**=_SATOSHI_
265265

@@ -277,18 +277,18 @@ The [`lightning-listconfigs`](ref:lightning-listconfigs) command will output a v
277277
- **force-feerates**==_VALUES_
278278

279279
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".
281281

282282
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`.
283283

284284
- **htlc-minimum-msat**=_MILLISATOSHI_
285285

286286
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).
288288

289289
- **htlc-maximum-msat**=_MILLISATOSHI_
290290

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).
292292

293293
### Lightning channel and HTLC options
294294

@@ -477,13 +477,13 @@ plugins along with any immediate subdirectories). You can specify additional pat
477477

478478
- **disable-plugin**=_PLUGIN_
479479

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`.
481481

482482
- **important-plugin**=_PLUGIN_
483483

484484
Specify a plugin to run as part of Core Lightning.
485485
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.
487487
This way, you can monitor crashes of important plugins by simply monitoring if Core Lightning terminates.
488488
Built-in plugins, which are installed with lightningd, are automatically considered important.
489489

doc/node-operators-guide/analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ updatedAt: "2023-02-21T13:39:32.669Z"
1010

1111
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.
1212

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.
1414

1515
## Using third-party software
1616

doc/node-operators-guide/faq.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ A better option is to use the [`summary` plugin](https://github.com/lightningd/p
1717

1818
### My channel is in state `STATE`, what does that mean ?
1919

20-
See the [listpeers](ref:lightning-listpeers) command.
20+
See the [listpeers](ref:listpeers) command.
2121

2222
### My payment is failing / all my payments are failing, why ?
2323

2424
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)
2525
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.
2626

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,
2828
instead of the low-level `sendpay` command which only tries the passed in route.
2929

3030
### How can I receive payments ?
@@ -162,7 +162,7 @@ There are 3 types of 'rescans' you can make:
162162
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.
163163
164164
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.
166166
167167
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`:
168168
@@ -179,4 +179,4 @@ If `option_static_remotekey` is enabled you can attempt to recover the funds in
179179
180180
### How do I get the `psbt` for RPC calls that need it?
181181
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

Comments
 (0)