This script installs a Handshake full node (https://github.com/handshake-org/hsd) and all dependencies.
- Ubuntu (20.04 LTS preferred) or Debian
- Static public IP address (for listening full node)
- 2GB RAM
- Enough storage space, the current chain (May 2022) takes already about 24GB - check via
df -h
If you install this on a new deployed system and currently work with user root consider using a different user with root privilegies.
adduser -m -d /home/<Username> <Username>
usermod -aG sudo <Username>
su - <Username>
On a new deployed system this installation takes about 3 minutes before hsd full node is started as service. Duration of a full chain sync depends on your system, most important is fast storage. On performant entry level VPS it takes few hours.
sudo apt update
sudo apt install git
cd
git clone https://github.com/befranz/hshelp
hshelp/install-all-hsd
Per default all blockchain data, config and log files are under ${HOME}/.hsd. You can set an alternative path by adding it as parameter like hshelp/install-all-hsd /some/where/else.
During this first chain sync hsd is still running as a non listening node. After you restart hsd or reboot - which also makes sense since most probably some installed components might require a reboot anyway - the node allows 800 inbound connections. Those could be other full nodes but also SPV nodes like hnsd or Fingertip. Running listening public full nodes are essential for Handshake, you do great support by running one!
The node listens to port 12038 and 44806. Make sure you allowed those ports on incoming traffic.
If you don't use any firewall consider running one like ufw and set the specific ports. (Don't forget to set your ssh port ;-)
Some useful commands - hsd status: systemctl status hsd - hsd restart: sudo systemctl restart hsd
hsd node is accessable via hsd-cli, hsw-cli and API.
Full documentation: https://hsd-dev.org/api-docs/
To check the current outbound and inbound connections call hsd-cli info|jq .pool
If you run the script while hsd is already installed it will try to update to the latest release.
This command generates a link to a report provided by ipinfo.io of all inbound connections of other nodes (Bob Wallet Desktop, Fingertip, basically other full and spv nodes).
hsd-cli rpc getpeerinfo | jq -r '.[]|select(.inbound==true)|.addr|sub(":.*$";"")' | curl -s -XPOST --data-binary @- "ipinfo.io/tools/summarize-ips?cli=1"|jq -r .reportUrl
Every new report mentioned above gets a new URL. This script is made to access newly created reports always with the same URL.
To achieve this the script starts a listener at a specific port (default 50505) after creating a new report. This listener does a http 302 forward to the real report URL.
Even though you can always start this script manually, to create a report periodically (like every hour) add those lines to cron via crontab -e. In case you use cron the first time you need to select an editor, taking nano is most probably your best choice.
CRONCMD=1
@reboot sleep 180s; /root/hshelp/inbound-report
59 * * * * /root/hshelp/inbound-report
CRONCMD=1 is used to identify if the script is started via cron. In this case it's waiting a random time up to 30 seconds before it creates a new report, to avoid that many hosts (who knows ;-) execute the script at the same time.
@reboot... This makes sure 3 minutes after reboot (to give the node some time) a new report is created and the forwarder is started.
59 * ... Every hour at 59 minutes the script is started, makes a new report, kills the running forwarder and starts a new one.
In case a firewall is activated make sure to allow the listening port (default 50505).
After the script is started the first time you're able to access the most recent report via
http://<IP of your node>:50505
ps -ef|grep socat