mirobit / bitcoin-node-manager

:bar_chart: Lightweight dashboard and control system for bitcoin nodes

Bitcoin Node Manager

Bitcoin Node Manager (BNM) is a lightweight dashboard and control system for your Bitcoin node.

Check out ElextrumX Dashboard if you run an Electrumx Server.

Features

• Extensive dashboard with general information about the node, connected peers and the blockchain
• Create rules to manage your peers
  • Ban, disconnect or log peers that waste resources, are slow or run alternative clients (e.g. BCash)
  • Set global events that trigger the execution of rules, run rules manually or set up a cron job
• Overview of all connected peers including country, ISP, client, traffic usage, supported services...
  • Ban or disconnect peers
  • Manage a list of web hoster to detect if peer is hosted or private
• Manage banned peers
  • Unban specific peers
  • Export/Import your ban list
  • Generate iptables rules (reject banned peers at OS level)
• Last received blocks information
• Last received forks (orphaned blocks / alternative chains) information
• Memory pool statitics
• Wallet overview (no functionality, information only)

Requirements

• Bitcoin Core 0.19.0.1+
• Web Server (Apache, Nginx, PHP Server)
• PHP 7.3.0+
  • curl extension
• Docker (Alternative to Web Server and PHP)

Installation

1. Clone the repository.
2. Make sure bitcoind (-daemon) is running. If you use bitcoin-qt set server=1 in the bitcoin.conf file.
3. Copy src/Config.sample.php and remove .sample. Open src/Config.php and enter your Bitcoin Core RPC credentials and set the BNM password.

Manual setup

4. Make sure the BNM folder is in your web servers folder (e.g. /var/www/html/). If the server is publicly accessible, I recommend renaming the BNM folder to something unique. Although BNM is password protected and access can be limited to a specific IP, there can be security flaws and bugs.
5. Check that the server (e.g. www-data) has access (read and write) to the data folder (git will change the ownership by default).
6. Open the URL to the folder in your browser and login with the password chosen in src/Config.php.

Docker

The BNM folder is mounted as volume in Docker. This way you can edit src/Config.php and update BNM (git pull) at any time without connecting to the container.

4. Change the RPC IP in src/Config.php to the docker network interface IP.
5. Run either docker-compose up -d or docker run -d -p 8000:80 --name bnm -v ${PWD}:/var/www/html php:7.4-apache in the BNM folder.
6. Add the following to your bitcoin.conf:

rpcbind=127.0.0.1 
rpcbind=172.17.0.1 
rpcallowip=0.0.0.0/0

7. BNM should now be accessible under http://server-ip:8000.

Security

• All pages and control functionality are only accessible for logged-in users. The only exception is if you use the Rules cron job functionality. But a password based token is required and the functionality is only able to apply rules.
• Access to BNM is by default limited to localhost. This can be expanded to a specific IP or disabled. If disabled, make sure to protect the BNM folder (.htaccess or rename it to something unique that an attacker will not guess). An attacker could "guess" your password, since there is no build-in brute force protection.
• The data folder contains your rules, rule logs and geo information about your peers. Make sure to protect (e.g. chmod -R 700 data) peer information if your web server is publicly accessible. The previously mentioned IP protection doesn't work here. If you use Apache you are fine, since the folder is protected with .htaccess (make sure AllowOverride All is set in your Apache config file).

Roadmap

• Improve project structure
• Improve OOP
• Improve error handling
• Import rules functionality
• More help icons
• Display expanded peer/block info (popup)

bitcoin-node-manager's Issues

Tor address section does not display Tor address.

Running v1.1.0, the new build that supports Tor v2 and v3 by displaying addresses on mouse-over. When I mouse-over the Tor address it incorrectly displays 127.0.0.1:9050 instead of the appropriate .onion address. If I run bitcoin-cli getnetworkinfo on the nodes the appropriate .onion address does appear in the 'localaddresses' section.

Onion node ip addresses don't display

"Unknown" displays instead.

I have patched my copy of /src/Utility.php, first line of function checkIpPort($ip){ thus:

/bitcoin-node-manager/src$ diff Utility.php.orig Utility.php
127c127
< 	if(preg_match("/^\[{0,1}[0-9a-z:\.]{7,39}\]{0,1}:[0-9]{1,5}$/", $ip)) {
---
> 	if(strpos($ip, ".onion") or preg_match("/^\[{0,1}[0-9a-z:\.]{7,39}\]{0,1}:[0-9]{1,5}$/", $ip)) {

Can't log in

In src/Config.php I made the value of PASSWORD empty (two quotation marks). But I can't log in: the login page just refreshes. I tried changing PASSWORD to something non-empty but no joy. (This feels like the annoying "it doesn't work" kind of issue report, but I don't know what details might help.)

version 1.3.0 shows wrong version in web interface

Recently upgraded to v1.3.0. Clicking 'About' in the web interface shows version 1.2.0.

Bitcoin Node Manager reports negative fees after halvening

The pic says everything I can. Noticed it first on v0.3.0, updated to v0.5.0, confirmed.
My Bitcoin Core node runs version 0.18.0 with Network, Bloom, Witness and Network Limited.

<Feature Request> Show ban reason

bitcoin-cli listbanned returns a ban_reason value. It would be helpful if this was displayed in Bitcoin Node Manager's Ban List page under 'reason'. In my Reason list all I see is 'Core' which isn't helpful from a diagnostics standpoint.

Node info doesn't show IPv4 connectivity

Currently running my node with onlynet=ipv4 and listenonion=1, so with active connections over TOR and clearnet, just not IPv6. The interface doesn't recognize the fact that IPv4 is active, it only notices the TOR.

Where does the script pull the IP and onion addresses from? Does it read the bind=x.x.x.x or externalip=x.x.x.x addresses in bitcoin.conf?

Demo not coming up

The demo url is a 404

Whitelisting error after upgrading to

After upgrading my node to 0.21.0 this error has appeared:

I think it's something to do with this:

The getpeerinfo RPC no longer returns the whitelisted field by default. This field will be fully removed in the next major release. It can be accessed with the configuration option -deprecatedrpc=getpeerinfo_whitelisted. However, it is recommended to instead use the permissions field to understand if specific privileges have been granted to the peer. (#19770)
https://bitcoincore.org/en/releases/0.21.0/

I tried starting my node with with -deprecatedrpc=getpeerinfo_whitelisted and also putting that in my config file but it made no difference.

Ban list reason error

After updating my node to Satoshi:0.20.1 I am now getting an error at the top of the page.

Notice: Undefined index: ban_reason in /var/www/bitcoin/bnm/src/Content.php on line 72

The ban list for rules I have setup myself now shows the reason for my bans as "unknown"

If I clear out the ban list, the warning at the top of the screen goes away.

I think this may be related to the recent update and the changes regarding misbehavnig peers.

https://bitcoin.org/en/release/v0.20.1#changes-regarding-misbehaving-peers

There is no method to list discouraged addresses. They are not returned by the listbanned RPC. That RPC also no longer reports the ban_reason field, as "manually added" is the only remaining option.

Incorrect use of getrawtransaction() on function createBlocksContent().

Blocks tab fails because function getrawtransaction() is missing a third argument "blockhash". Without this argument it just looks in the mempool for the txid not in the block.

Changing the line 116 on Content.php should fix the issue:
$coinbaseTx = $bitcoind->getrawtransaction($block["tx"][0], 1); to
$coinbaseTx = $bitcoind->getrawtransaction($block["tx"][0], 1, $block["hash"]);

Thank you for your work!

Peer traffic information

Could we have a way of seeing both uploaded and downloaded traffic for each individual peer on the peers page? Currently all we see is one traffic figure per peer. Something as simple as separate traffic in and traffic out columns would be great.

Errors in wallet section.

Hi,

I'm getting an error in the wallet section. Not sure if this is something to do with my setup. The chances are it is!

I have never used the wallet in my node and don't intend to. Just would just be nice not to get the error:

Notice: Undefined index: utxo in /var/www/bitcoin/bnm/views/wallet.phtml on line 76
Warning: Invalid argument supplied for foreach() in /var/www/bitcoin/bnm/views/wallet.phtml on line 76

When I set up my node I included wallet support. I have not looked into this issue very much. I was hoping that it's something obvious that you've seen before.

I set up the node first on a PC using Bitcoin Core (64bit), downloaded the blockchain and then swapped the disk over to a Raspberry Pi, where it's running now.

My setup is:
Raspberry Pi 3+
Raspberry Pi OS (Debian 10)
Apache 2.4.38
PHP 7.3
Bitcoin Core 0.20.0 (Snap Store)
Bitcoin Node Manager v0.6.0

The node is running with txindex=1 in the config file.

Thanks
Mark

Rules idea

Due to upload bandwidth constraints my connection can sometimes be sucked dry by my Bitcoin node.

To stop this I have set up some rules to limit each nodes traffic at 500 Mb per day. This works well but I do not want to limit any of the research nodes, with the binocular icon, or my separate Windows node.

I'd like a way of letting individual peers bypass the rules, or a way of adding an exception so that selected peers are never restricted.

IP address: Unknown

Bitcoin Node Manager shows the IP address of my node as unknown.

It seems to only show an IP address when I manually set it in Bitcoin Core using -externalip.

The node is set up on a Raspberry Pi 3 Model B+ using the packaged Snap version with port forwarding configured at the router.

I think it would be nice to show the external IP address in BNM instead of reporting it as unknown.

Here is a useful API https://www.ipify.org that can be used to grab the external IP address.

Undefined index error.

This bug has been going on for a while but I have never had to forsite to take a screenshot of it until tonight.

I'm only interested in the top three lines. The bottom line has already been logged as #22.

If I do a refresh the errors go away and don't come back for a while. I only ever see them when I open the site up after being away from it for for a while.

The last time I looked at my node was about a day ago.

I do also get similar errors appearing if a peer with an unknown country IP address connects to my node but it soon catches up and the error vanishes.

I know it's something to do with the IP country code lookup. Any ideas?

IPv4 is displayed incorrectly when multiple addresses are available

The expected behavior is to pick the IPv4 with the highest score value returned by getnetworkinfo.

It seems BNM currently simply picks random (or maybe the last) IPv4 on the list.

Fatal error: Uncaught Exception: Unable to connect in /var/www/html/bnm/src/jsonRPCClient.php:144

I installed this on mu Odroid C1 with Ubuntu 18.04.4 LTS (GNU/Linux 3.10.107-13 armv7l)

So far it seems to work but when i click on "blocks" the following error comes:
Fatal error: Uncaught Exception: Unable to connect in /var/www/html/bnm/src/jsonRPCClient.php:144 Stack trace: #0 /var/www/html/bnm/src/Content.php(149): App\jsonRPCClient->__call('getrawtransacti...', Array) #1 /var/www/html/bnm/index.php(342): App\createBlocksContent() #2 {main} thrown in /var/www/html/bnm/src/jsonRPCClient.php on line 144

please help

And some informational lines (IPv4) don't work

Feature request: Peers: indicate incoming or outgoing connection

In my copy of Peer.php I have a new line after the initial assignment to $this->id

/bitcoin-node-manager/src$ diff Peer.php.orig Peer.php
44a45
>     $this->id = $peer["inbound"] ? '«' . $this->id : $this->id . '»';

Fatal error

Just installed it on ubuntu (rasp4) and gives me this error

Fatal error: Uncaught Error: Call to undefined function App\curl_init() in /var/www/html/bitcoin-node-manager/src/jsonRPCClient.php:79 Stack trace: #0 /var/www/html/bitcoin-node-manager/src/Utility.php(461): App\jsonRPCClient->__call() #1 /var/www/html/bitcoin-node-manager/src/Content.php(6): App\getPeerData() #2 /var/www/html/bitcoin-node-manager/index.php(89): App\createMainContent() #3 {main} thrown in /var/www/html/bitcoin-node-manager/src/jsonRPCClient.php on line 79

no rights issue because i did 777 on all files

Feature request: LTC support

Hi, Do you have any plans about make BNM litecoin compatible? Will be great to have this wonderfuls screens for LTC nodes too.

tor address does not update

In the Main -> Node sub panel the tor information does not seem to update correctly. I changed the onion_private_key on my bitcoin core node, restarted bitcoind, then restarted apache. BNM displays the old .onion address, not the current one shown in bitcoind's debug.log. Neither restarting apache2 nor shutting it down and starting again resolve the issue.

Call to undefined function App\curl_init() in /var/www/html/bnmbtclnd/src/Utility.php:627

When I set const PEERS_GEO = TRUE; apache returns the following error:

Fatal error: Uncaught Error: Call to undefined function App\curl_init() in /var/www/html/bnmbtclnd/src/Utility.php:627 Stack trace: #0 /var/www/html/bnmbtclnd/src/Utility.php(503): App\getIpData(Array) #1 /var/www/html/bnmbtclnd/src/Utility.php(429): App\createPeersGeo(Array) #2 /var/www/html/bnmbtclnd/src/Content.php(9): App\getPeerData() #3 /var/www/html/bnmbtclnd/index.php(74): App\createMainContent() #4 {main} thrown in /var/www/html/bnmbtclnd/src/Utility.php on line 627

Add option to disable password

In some scenarios like localhost setup or onion client auth the password becomes pointless and also hinders infrastructure tests automation.

It would be cool to add option to disable password authentication.

TIA!

Ban List Cron Job no longer working after upgrade

Just realised that the ban list cron job is no longer working. I can manually run the rules and that works fine. It's just the cron jobs no longer work.

Here's the error I get when I enter the cron job into the browser manually:

Fatal error: Uncaught ArgumentCountError: Too few arguments to function App\jsonRPCClient::__construct(), 1 passed in /var/www/bitcoin/bnm/index.php on line 31 and at least 2 expected in /var/www/bitcoin/bnm/src/jsonRPCClient.php:39 Stack trace: #0 /var/www/bitcoin/bnm/index.php(31): App\jsonRPCClient->__construct('http://bitcoin:...') #1 {main} thrown in /var/www/bitcoin/bnm/src/jsonRPCClient.php on line 39

If I go back to the old version of BNM it work fine except I get the whitelist error but the job runs successfully and the appropriate nodes are blocked.

Any ideas?

Some errors after server maintenance

After updating my server with all the latest security patches and updates, and after performing a few reboots, I checked my Bitcoin Node Manager and I'm now getting the following errors on the main page of BNM.

Notice: Undefined index: softforks in /.../src/Node.php on line 144

Warning: Invalid argument supplied for foreach() in /.../src/Utility.php on line 253

I have tried updating to the latest version of the code but that made no difference.

I also reverted back to a snapshot taken before the updates (but not before the reboots) and I still get the same issues, so this is probably to do with the rebooting of the server, rather than anything else. I also rebooted my Bitcoin node at a similar time, in case it matters. I've got two separate servers.

I'm running BNM on:

Debian Linux 10
Linux 4.19.0-20-amd64 on x86_64
PHP Version 7.3.31-1~deb10u1

Any ideas?

Bitcoin Block Explorer service on the Memory Pool page no longer works

When interrogating entries on the Memory Pool page, Bitcoin Block Explorer no longer works.

Bitcoin Core not reachable

Hi and thank you for this solution!

I got things set up and I am using the docker image on Ubuntu 20.04

Bitcoin Core not reachable: Failed to connect to 127.0.0.1 port 8332: Connection refused

With my bitcoind running (bitcoin core 0.20.1) I am getting above error message.

Here is my bitcoin.conf file
rpcuser=*****
rpcpassword=******
rpcport=8332
server=1
txindex=1

Is there something missing from my bitcoin.conf file to allow for this solution to connect to bitcoin core? Is there another logfile I can look at to determine whats going on?

Thank you in advance.

Geo tracing errors after node restart

I restarted my node today and noticed these errors:

A short while later I did a refresh and got this:

As soon as the geo tracing picked up the first IP address the errors went away.

I had just updated BNM to the very latest version so not sure if that had anything to do with this. I seem to remember seeing this before but did not mention it as it went away within minutes.

Error loading the dashboard

After the initial run and after some time that the peer list changes, the dashboard is not accessible. Error recieving is:

Fatal error: Uncaught Error: Call to undefined function App\curl_init() in /home/testbed/Downloads/bmn/src/Utility.php:662 Stack trace: #0 /home/testbed/Downloads/bmn/src/Utility.php(540): App\getIpData() #1 /home/testbed/Downloads/bmn/src/Utility.php(461): App\createPeersGeo() #2 /home/testbed/Downloads/bmn/src/Content.php(6): App\getPeerData() #3 /home/testbed/Downloads/bmn/index.php(78): App\createMainContent() #4 {main} thrown in /home/testbed/Downloads/bmn/src/Utility.php on line 662

After taking a closer look at the code, I pressume it has to do with the ip geolocation data. Is there any way to disable the geolocation service and only recieve the IP addresses of peers? I don't mind removing the chart and the map on the main screen just to see if it will work that way. Any other suggestions would be appreciated.

Services not being reported correctly.

Hi,

I've got a small issue with Bitcoin Node Manager and wondered if you would be able to help?

In the node information panel on the main screen, my node's services are reporting as unknown:

Yet when I issue the command bitcoin-cli getnetworkinfo my node reports this:

Bitnodes.io is also reporting my node's services correctly:

My set up is:
Raspberry Pi 3+
Raspberry Pi OS (Debian 10)
Apache 2.4.38
PHP 7.3
Bitcoin Core 0.20.0 (Snap Store)
Bitcoin Node Manager v0.6.0

My node is running in a standard home setup behind an ADSL router with port forwarding. The external IP address has been added to bitcoin.conf using externalip=

Any ideas?

Add support for SOCKS5 proxy to allow connecting to onionized RPC

Security conscious users may want to run BNM on a separate, remote machine so that Bitcoin Node is not endangered by the PHP stack and app.

One way to do it is to expose Bitcoin RPC as onion with client authentication.

The good news is this almost works with BNM already.

The only thing missing is:

        CURLOPT_PROXYTYPE      => CURLPROXY_SOCKS5_HOSTNAME,
        CURLOPT_PROXY          => '127.0.0.1:9050'

...in jsonRPCClient.php, obviously subject to user config setting.

Rules broken after update to v1.0.0

After I updated to the latest version I got this error when manually running my rules from the Run Rules button:

Got both old and new versions running in different folders. The the old version's rules are still working fine.

Cleared down my ban list and tried again but still the same.

Bitcoin Block Explorer service on the Forks page no longer works

Thanks for fixing issue #23

I was looking at the Forks page tonight and came across the same issue.

On this page there is only one option which does not work.

It would be nice to give this page the same amount of options as the other pages.

Thanks

Peer filtering from main page

Would it be possible to link the main page to a filtered subset of connected peers when clicking the appropriate peer type or country?

For example, when clicking on any item in the top peer clients panel, say Core 0.20.0 peers for example, I'd like it to open up the Peers page and list all the Core 0.20.0 peers that are connected to my node. Same goes for the global peer distribution section. If I clicked on Germany for example, I'd like to see a list of all my German peers.

Menu options missing on mobile devices.

Hi,

Any chance of updating the mobile device support so menus are included?

This is how it looks on my Android phone:

Would be great if the sidebar could be included as a drop down menu. At the moment there is no menu at all.

I get the same issues when I switch to the browser's desktop site option:

The screenshots are from Bromite but I get the same issue in Chrome. The phone is running Android 8.1.0.

Thanks Mark

Feature Request: what networks are using a proxy

I love the dashboard, great work Mirobi!

It would be helpful to know what networks are using a proxy (usually this would be a tor proxy). with the getnetworkinfo call the daemon returns "networks" > "proxy". "proxy" is empty if it's accessible directly, the field has an address if a proxy is in use.

happy coding

Add NODE_COMPACT_FILTERS service flag support

For the connected Bitcoin node and for the peers it would be cool to support the new NODE_COMPACT_FILTERS service flag.

This regards "Services" paragraph and column.

PS Keep up the great work! I find BNM valuable tool.

Node info panel doesn't display Tor v3 address

bitcoind v0.21.0 now supports Tor v3 addresses exclusively. After upgrading my daemon BNM no longer displays the server's Tor address in the Node info panel. Perhaps just an issue with the RegEx that extracts it from the RPC call?

v0.5.0 fopen http error

Upgraded to v0.5.0. BNM displays all node status properly, but shows this error at the top. It seems to indicate BNM cannot connect to the node on localhost, but confusingly BNM is displaying appropriate node info. Not sure what is going on.

Peers: sense of chevron symbol inverted; page opens with data hidden

When the Peers page is first opened the clickable chevron symbol points up, but the data is not displayed below the header. After the chevron is clicked, the data rolls down -- is displayed -- and the chevron points down. After the down chevron is clicked, the data rolls up-- is hidden -- and the chevron again points up.

"Undefined index" ....

When loading BNM the first time or refreshing after a long time of no viewing I often get 3-6 of the following errors. Waiting 30 seconds or so and refreshing makes them all go away.

It seems like the page loads before the RPC portion gets all its data. These only rarely if ever appeared in v0.4.0. Is there some timeout value that changed from 0.4-0.5, or maybe some race condition?

Total balance is allways 0

node manager crashes while syncing

Hello,

I am giving a try to bitcoin-node-manager to manage my new full node.
Actually I am still syncing the node and the manager crashes.

Is it possible to catch the error and to the keep the dashboard up while syncing or am I doing something wrong?

Thank you!

`
Warning: fopen(http://[email protected]:8332/): failed to open stream: HTTP request failed! in /home/nexus/bitcoin-node-manager/src/jsonRPCClient.php on line 136

Notice: Undefined variable: content in /home/nexus/bitcoin-node-manager/index.php on line 82
`

Error upon login

Uncaught Error: Call to undefined function App\getServices() in /var/www/html/BNM/src/Peer.php

I get this error on login. I tried turning off geo lookup in config, but still get the error.

Any help would be appreciated. The full error is below

Fatal error: Uncaught Error: Call to undefined function App\getServices() in /var/www/html/BNM/src/Peer.php:51 Stack trace: #0 /var/www/html/BNM/src/Utility.php(551): App\Peer->__construct() #1 /var/www/html/BNM/src/Utility.php(464): App\createPeersGeo() #2 /var/www/html/BNM/src/Content.php(6): App\getPeerData() #3 /var/www/html/BNM/index.php(89): App\createMainContent() #4 {main} thrown in /var/www/html/BNM/src/Peer.php on line 51

v0.5.0 divide by zero error when no banned nodes

Running v0.5.0 on a node that currently has zero banned nodes and I get the following error at the top of the page:

Wrong blocknumber in header of index.php?p=blocks

The block number displayed in the header is wrong on this page (it is correct on other pages). It consistently displays the block number of the first block in the 25-block range displayed, instead of the last block. See attached image.

Info panel formatting issues

I've mentioned this before as part of other issues but thought it might be best to raise it independently of them, now that they have all been resolved.

The issue is with the way the info panel information boxes are formatted. The individual info boxes are not the same size so if the page is resized they do not line up evenly.

The reason they do not line up is that the info boxes are not all the same height.

In the example below some are 97 pixels high and others are 95 pixels high.

95

97

97

95

95

95

I think this has something to do with the addition of the second font used for the GB text.

If this could be fixed I think the info boxes would line up evenly making the page look so much better on a smaller screen.

<Feature Request> show country and node type in Banlist

It would be interesting to have a column in the ban list showing country of each banned IP. It would be something a person could see if nodes in a certain country were misbehaving more frequently than others. Not a necessary feature, but interesting nonetheless

would it be possible to list client type in the banlist too? This would help visualize if bans were going to specific client or version

Feature Request: I2P

With I2P now officially integrated in bitcoind, it would be cool to show that status and address in the Main server summary.