Merge fort-nix/nix-bitcoin#673: Minor improvements

73d6d1e8ca dev: move mempool to `dev-features.sh` (Erik Arvstedt)
d61dc8b8d9 test/README: fix typos (Erik Arvstedt)
c1a7ab7b2f onion-services: fix markdown code formatting (Erik Arvstedt)
4347125344 nix-bitcoin: add example for option `pkgOverlays` (Erik Arvstedt)
7e0d54a19a docs/services: improve lndconnect-wireguard docs (Erik Arvstedt)

Pull request description:

ACKs for top commit:
  jonasnick:
    ACK 73d6d1e8ca

Tree-SHA512: 6a3348711e3f0d314935086eb081c6d98c2e5654740106d2e11954560ae7adce3d29a9435746eafbc3ead47d696ba48c4f492e2ca3f4673ff65a9e24b8cfac3a

dev/dev-features.sh

@@ -288,6 +288,30 @@ c journalctl -u clightning -f
 # This should show log msgs like
 # plugin-trustedcoin returning block 801409, 0000000000000000000482ddc4…, 1483968 bytes
 
+#―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
+# mempool
+run-tests.sh -s mempool-regtest container
+
+c systemctl status mempool
+c systemctl status mysql
+c nodeinfo
+
+# Check backend
+c curl -fsS localhost:8999/api/v1/blocks/1 | jq
+c curl -fsS localhost:8999/api/v1/blocks/tip/height | jq
+c curl -fsS localhost:8999/api/v1/address/1CGG9qVq2P6F7fo6sZExvNq99Jv2GDpaLE | jq
+
+# Check frontend
+c curl -fsS localhost:60845
+c curl -fsS localhost:60845/api/mempool | jq
+c curl -fsS localhost:60845/api/blocks/1 | jq
+c curl -fsS localhost:60845/api/v1/blocks/1 | jq
+c curl -fsS localhost:60845/api/blocks/tip/height | jq
+
+# Open frontend
+# shellcheck disable=SC2154
+runuser -u "$(logname)" -- xdg-open "http://$ip:60845/"
+
 #―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
 # rtl
 # see ./topics/rtl.sh

dev/topics/mempool.sh

@@ -1,22 +0,0 @@
-# Start mempool container
-run-tests.sh -s mempool-regtest container
-
-c systemctl status mempool
-c systemctl status mysql
-c nodeinfo
-
-# Check backend
-c curl -fsS localhost:8999/api/v1/blocks/1 | jq
-c curl -fsS localhost:8999/api/v1/blocks/tip/height | jq
-c curl -fsS localhost:8999/api/v1/address/1CGG9qVq2P6F7fo6sZExvNq99Jv2GDpaLE | jq
-
-# Check frontend
-c curl -fsS localhost:60845
-c curl -fsS localhost:60845/api/mempool | jq
-c curl -fsS localhost:60845/api/blocks/1 | jq
-c curl -fsS localhost:60845/api/v1/blocks/1 | jq
-c curl -fsS localhost:60845/api/blocks/tip/height | jq
-
-# Open frontend
-# shellcheck disable=SC2154
-runuser -u "$(logname)" -- xdg-open "http://$ip:60845/"

docs/services.md

@@ -236,7 +236,7 @@ There are two ways to establish a secure, direct connection:
    ```
 3. Deploy your configuration.
 
-4. If your node is behind an external firewall or NAT, add the following port forwarding
+4. If your node is behind an external firewall or NAT (e.g. a router), add the following port forwarding
    rule to the external device:
    - Port: 51820 (the default value of option `networking.wireguard.interfaces.wg-nb.listenPort`)
    - Protocol: UDP

modules/nix-bitcoin.nix

@@ -20,6 +20,13 @@ with lib;
       pkgOverlays = mkOption {
         internal = true;
         type = with types; functionTo attrs;
+        example = lib.literalExpression ''
+          super: self: {
+            bitcoind = super.bitcoind.overrideAttrs (old: {
+              # dostuff
+            });
+          }
+        '';
       };
 
       lib = mkOption {

modules/onion-services.nix

@@ -18,7 +18,7 @@ let
             default = config.public;
             description = mdDoc ''
               Create an onion service for the given service.
-              The service must define options {option}'address' and {option}'onionPort' (or `port`).
+              The service must define options {option}`address` and {option}`onionPort` (or `port`).
             '';
           };
           public = mkOption {

test/README.md

@@ -1,4 +1,4 @@
-The [`run-tests.sh`](./run-tests.sh) command is most convenient and versatile way to run tests.\
+The [`run-tests.sh`](./run-tests.sh) command is the most convenient and versatile way to run tests.\
 It leave no traces (outside of `/nix/store`) on the host system.
 
 `run-tests.sh` requires Nix >= 2.10.
@@ -30,7 +30,7 @@ Test scenarios are defined in [tests.nix](./tests.nix) and [tests.py](tests.py).
 ```
 #### Debugging
 ```bash
-# Start a shell is inside a test VM. No tests are executed.
+# Start a shell inside a test VM. No tests are executed.
 ./run-tests.sh -s bitcoind vm
 systemctl status bitcoind