thierry61 / node-summary Goto Github PK

This is a Next.js project bootstrapped with create-next-app.

The Web App displays summary information about a Bitcoin Core node. It exclusively uses the bitcoin RPC API to get this information.

The app has one web page (/) and one main API entry point (/api/summary). The web page is automatically refreshed every 5 secondes. The refresh rate can be changed with REVALIDATE parameter in .env file. To not burden the bitcoin RPC, the API is cached and REVALIDATE parameter is also the API cache duration. There is also a health check API entry point (/api/health) that returns either 200 OK or 503 Service Unavailable.

As there is no interactivity, the web page is still operational when javascript is disabled, including automatic refresh which is managed by http-equiv="refresh" meta tag.

The information is divided in a set of cards spread on a grid. The grid uses Tailwind breakpoint prefixes and grid template columns so that the layout is responsive to the dynamic screen size and orientation.

Note: Any mention of 192.168.110.121 throughout the document should be replaced by your own address of deployment.

Adapt .env file at the root:

• set REVALIDATE to the desired refresh rate value (in seconds)
• set BITCOIND_HOST to your bitcoin RPC host (including the scheme)
• set BITCOIND_PORT to your bitcoin RPC port
• use one of 3 authentication methods:
  • define BITCOIND_COOKIE_PATH to point to your bitcoin node .cookie file (when server is run directly on the same machine as the node)
  • set BITCOIND_USERNAME and BITCOIND_PASSWORD environment variables
  • don't set any of BITCOIND_COOKIE_PATH, BITCOIND_USERNAME and BITCOIND_PASSWORD environment variables for an unauthenticated server (like https://bitcoin-mainnet-archive.allthatnode.com:443 for example)

Install the dependencies:

npm install

Run the development server:

npm run dev

Open http://localhost:3003 with your browser to see the result. To display formatted json API result run curl localhost:3003/api/summary | jq -r '.'

If configuration is different from development, then create a .env.production.local file to adapt environment variables. If this file contains secrets don't publish it to GitHub (default NextJS generated configuration exclude it in .gitignore file). Example of such a file:

# New environment variables
BITCOIND_USERNAME="<redacted>"
BITCOIND_PASSWORD="<redacted>"
# Erase BITCOIND_COOKIE_PATH defined in .env file
BITCOIND_COOKIE_PATH=
# Overwrite BITCOIND_HOST defined in .env file
BITCOIND_HOST="http://192.168.110.121"

Build the web app with:

npm run build

Redefine -H option in start command of package.json to correspond to NextJS app exposed address. This address can be different from bitcoind host.

Allow 3003 port in your firewall. For UFW the command is sudo ufw allow from 192.168.110.0/24 to any port 3003 proto tcp (this is my VPN cidr)

Run the server with:

npm run start

Note that in both development and deployment cases the port used is the same (3003) but it's OK to run them in parallel on the same machine because they are defined on different interfaces (respectively, localhost and 192.168.110.121).

Stop any interactive npm run start session.

Create /etc/systemd/system/node-summary.service file with following content (replace working directory, npm path, user, group by your own):

[Unit]
Description=BTC RPC Summary
After=bitcoind.service

[Service]
WorkingDirectory=/home/ubuntu0/Documents/node-summary/
# We need both setting the path (for node) and prefixing executed program (for npm)
ExecStart=bash -c "PATH=/home/ubuntu0/.nvm/versions/node/v20.11.0/bin:$PATH /home/ubuntu0/.nvm/versions/node/v20.11.0/bin/npm start"
User=ubuntu0
Group=ubuntu0
Type=simple
KillMode=control-group
TimeoutSec=60
Restart=always
RestartSec=60

[Install]
WantedBy=multi-user.target

Launch web app with:

sudo systemctl enable node-summary
sudo systemctl start node-summary

Access from browser by navigating to http://192.168.110.121:3003 or call API with curl http://192.168.110.121:3003/api/summary | jq -r '.'

Get the logs with: journalctl -S <hh:mm> -u node-summary -o cat -f

{
  "feerates": {
    "1": 86.783,
    "6": 79.047,
    "36": 53.385,
    "144": 36.146
  },
  "uptime_days": 10.97,
  "diff_epoch": 406,
  "halving_epoch": 4,
  "blocks": 816785,
  "headers": 816785,
  "size_on_disk": 597110617728,
  "totalbytesrecv": 12748361747,
  "totalbytessent": 1143800738038,
  "peers": {
    "total": 124,
    "ipv4": {
      "in": 71,
      "out": 1
    },
    "ipv6": {
      "in": 18,
      "out": 1
    },
    "onion": {
      "in": 24,
      "out": 8
    },
    "not_publicly_routable": {
      "in": 1,
      "out": 0
    }
  },
  "sub_versions": [
    [ "/Satoshi:25.0.0/", 31 ],
    [ "/Satoshi:24.0.1/", 22 ],
    [ "/Satoshi:25.1.0/", 16 ],
    [ "/btcwire:0.5.0/Satoshi:25.0.0/", 8 ],
    [ "/Satoshi:23.0.0/", 6 ],
    [ "/dsn.tm.kit.edu/bitcoin:0.9.99/", 5 ],
    [ "/Satoshi:25.99.0/", 5 ],
    [ "/Satoshi:22.0.0/", 4 ],
    [ "/bitnodes.io:0.3/", 2 ],
    [ "/bitnodes.earn.com:0.1/", 2 ],
    [ "", 2 ],
    [ "/bitcoinj:0.16.1/", 2 ],
    [ "/electrs:0.10.0/", 1 ],
    [ "/seeder:0.0001/", 1 ],
    [ "/Satoshi:26.99.0/", 1 ],
    [ "/Satoshi:0.14.0/", 1 ],
    [ "/Satoshi:0.16.1/", 1 ],
    [ "/Satoshi:0.21.0/", 1 ],
    [ "/Satoshi:25.0.0(RoninDojo 2.1.0)/", 1 ],
    [ "/Satoshi:0.16.0/", 1 ],
    [ "/Satoshi:23.0.0(RoninDojo 2.0.0)/", 1 ],
    [ "/Satoshi:24.1.0/", 1 ],
    [ "/Satoshi:0.21.1/", 1 ],
    [ "/Satoshi:0.19.0.1/", 1 ],
    [ "/Satoshi:0.17.0/", 1 ],
    [ "/bitcoinj:0.15.1/", 1 ],
    [ "/Satoshi:0.18.0/", 1 ],
    [ "/bitcoinj:0.14.5/Bitcoin Wallet:5.35/", 1 ],
    [ "/Satoshi:0.15.0/Knots:20170914/", 1 ],
    [ "/bitcoinj:0.14.4/Bitcoin Wallet:5.30/", 1 ],
    [ "/BitCoinJ:0.11.2/MultiBit:0.5.19/", 1 ]
  ],
  "template": {
    "fees": 0.99696513,
    "ntx": 2772
  },
  "mempool": {
    "fees": 14.51493784,
    "ntx": 103584,
    "ntx_per_second": 4.506
  },
  "ntx": 919454034,
  "ntx_per_second": 5.222,
  "server_time": 1699999628580,
  "time_since_last_bloc": 963,
  "prev_diff_adj_percent": 3.546,
  "next_retarget": {
    "blocks": 1711,
    "days": 12.49,
    "estimated_diff_adj_percent": -4.882
  },
  "next_halving": {
    "blocks": 23215,
    "retargets": 11,
    "days": 161.2
  },
  "revalidate": "5"
}