mempool/production
wiz d17a78715a
Merge pull request #1347 from mempool/wiz/add-mysql-to-install-script
Add mariadb-server and mysql db creation to install script
2022-03-12 13:16:40 +00:00
..
freebsd Add new production installation script and related files 2022-03-08 20:46:58 +01:00
nginx Fix nginx configuration for liquid assets APIs 2022-02-07 03:34:16 +04:00
bitcoin.conf Add signet and liquidtestnet to install script 2022-03-09 20:59:12 +01:00
bitcoin.crontab Add new production installation script and related files 2022-03-08 20:46:58 +01:00
electrs-start-liquid Add new production installation script and related files 2022-03-08 20:46:58 +01:00
electrs-start-liquidtestnet Add new production installation script and related files 2022-03-08 20:46:58 +01:00
electrs-start-mainnet Add new production installation script and related files 2022-03-08 20:46:58 +01:00
electrs-start-signet Add new production installation script and related files 2022-03-08 20:46:58 +01:00
electrs-start-testnet Add new production installation script and related files 2022-03-08 20:46:58 +01:00
elements.conf Add new production installation script and related files 2022-03-08 20:46:58 +01:00
elements.crontab Add new production installation script and related files 2022-03-08 20:46:58 +01:00
install Merge pull request #1347 from mempool/wiz/add-mysql-to-install-script 2022-03-12 13:16:40 +00:00
mempool-build-all Create symlinks for mempool scripts in installation script 2022-03-12 12:41:33 +00:00
mempool-config.bisq.json Remove old install script, merge remaining stuff into upgrade script 2022-03-12 11:52:19 +00:00
mempool-config.liquid.json Remove old install script, merge remaining stuff into upgrade script 2022-03-12 11:52:19 +00:00
mempool-config.liquidtestnet.json Remove old install script, merge remaining stuff into upgrade script 2022-03-12 11:52:19 +00:00
mempool-config.mainnet.json Remove old install script, merge remaining stuff into upgrade script 2022-03-12 11:52:19 +00:00
mempool-config.signet.json Remove old install script, merge remaining stuff into upgrade script 2022-03-12 11:52:19 +00:00
mempool-config.testnet.json Remove old install script, merge remaining stuff into upgrade script 2022-03-12 11:52:19 +00:00
mempool-frontend-config.bisq.json Add production frontend configurations 2022-03-12 10:34:17 +00:00
mempool-frontend-config.liquid.json Add production frontend configurations 2022-03-12 10:34:17 +00:00
mempool-frontend-config.mainnet.json Remove INDEXING_BLOCKS_AMOUNT from mainnet frontend configuration 2022-03-12 10:39:28 +00:00
mempool-kill-all Fix upgrade script not restarting node due to new command line args 2020-09-18 18:08:59 +09:00
mempool-logger Fix typo/bug in mempool-logger script 2021-08-21 15:39:15 +09:00
mempool-restart-all Update syslog.conf and upgrade/restart scripts for new keybase channels 2021-09-02 19:30:54 +09:00
mempool-start-all Add support for liquidtestnet in production backend and nginx 2021-12-28 15:20:11 +09:00
mempool-update-assets Add support for liquidtestnet in production backend and nginx 2021-12-28 15:20:11 +09:00
newsyslog-mempool-backend.conf Add newsyslog.conf for nginx log rotation - delete logs after 90 days 2021-09-11 08:40:58 +09:00
newsyslog-mempool-nginx.conf Fix newsyslog.conf owner and pidfile location 2022-01-14 19:21:42 +09:00
nginx-cache-warmer Cleanup empty block in api response - Update cache warmer 2022-03-08 20:46:19 +01:00
README.md Merge branch 'master' into simon/removing-sql-import-references 2022-01-05 13:51:58 +04:00
sitemap-update Update misc files used for mempool.space production website 2020-05-25 18:42:00 +09:00
sysctl.conf Add production FreeBSD tuning parameters to increase network buffers 2021-04-16 00:12:29 +09:00
syslog.conf Update syslog.conf and upgrade/restart scripts for new keybase channels 2021-09-02 19:30:54 +09:00
test-nginx Improve nginx caching and use redirects for i18n 2022-01-12 23:12:49 +09:00
torrc Add production/torrc file to git repo 2022-01-10 18:37:54 +09:00

mempool enterprise production instance

These instructions are for setting up a serious production mempool website for Bitcoin mainnet, testnet, signet, Liquid mainnet and testnet, and Bisq. For home users, you should use one-click installation methods instead, and for advanced manual deployments of mainnet only see the top-level installation instructions.

Server Hardware

Mempool V2 is powered by blockstream/electrs, which is a beast. I recommend a beefy server:

  • 20C CPU (more is better)
  • 64G RAM (more is better)
  • 4TB SSD (NVMe is better)

HDD vs SSD vs NVMe

If you don't have a fast SSD or NVMe backed disk, that's fine. What you do is, go online and buy some fast new NVMe drives and wait for them to arrive. After you install them, throw away your old HDDs and then proceed with the rest of this guide.

FreeBSD 13

The mempool.space site is powered by FreeBSD with ZFS root and ARC cache for maximum performance. Linux probably works fine too, but why settle?

Filesystem

For maximum performance, I use 2x 2TB NVMe SSDs in a RAID 0 using ZFS with lots of RAM for the ARC L2 cache.

% zpool list -v
NAME        SIZE  ALLOC   FREE  CKPOINT  EXPANDSZ   FRAG    CAP  DEDUP    HEALTH  ALTROOT
nvm        3.62T  1.25T  2.38T        -         -     2%    34%  1.00x    ONLINE  -
  nvd0p3   1.81T   629G  1.20T        -         -     2%  33.9%      -  ONLINE
  nvd1p3   1.81T   646G  1.18T        -         -     2%  34.8%      -  ONLINE

For maximum flexibility of configuration, I recommend partitions separately for each data folder:

Filesystem                             Size    Used   Avail Capacity  Mounted on
nvm/bisq                             766G    1.1G    765G     0%    /bisq
nvm/bitcoin                          766G    648M    765G     0%    /bitcoin
nvm/bitcoin/blocks                   1.1T    375G    765G    33%    /bitcoin/blocks
nvm/bitcoin/chainstate               770G    4.5G    765G     1%    /bitcoin/chainstate
nvm/bitcoin/electrs                  772G    7.3G    765G     1%    /bitcoin/electrs
nvm/bitcoin/indexes                  799G     34G    765G     4%    /bitcoin/indexes
nvm/bitcoin/testnet3                 765G    5.0M    765G     0%    /bitcoin/testnet3
nvm/bitcoin/testnet3/blocks          786G     21G    765G     3%    /bitcoin/testnet3/blocks
nvm/bitcoin/testnet3/chainstate      766G    1.1G    765G     0%    /bitcoin/testnet3/chainstate
nvm/bitcoin/testnet3/indexes         768G    2.9G    765G     0%    /bitcoin/testnet3/indexes
nvm/electrs                          765G    128K    765G     0%    /electrs
nvm/electrs/liquid                   765G    104K    765G     0%    /electrs/liquid
nvm/electrs/liquid/cache             765G    7.8M    765G     0%    /electrs/liquid/newindex/cache
nvm/electrs/liquid/history           766G    886M    765G     0%    /electrs/liquid/newindex/history
nvm/electrs/liquid/txstore           775G     10G    765G     1%    /electrs/liquid/newindex/txstore
nvm/electrs/liquidtestnet            765G    112K    765G     0%    /electrs/liquidtestnet
nvm/electrs/liquidtestnet/cache      765G     96K    765G     0%    /electrs/liquidtestnet/newindex/cache
nvm/electrs/liquidtestnet/history    765G     96K    765G     0%    /electrs/liquidtestnet/newindex/history
nvm/electrs/liquidtestnet/txstore    765G     96K    765G     0%    /electrs/liquidtestnet/newindex/txstore
nvm/electrs/mainnet                  765G    112K    765G     0%    /electrs/mainnet
nvm/electrs/mainnet/cache            765G    4.4M    765G     0%    /electrs/mainnet/newindex/cache
nvm/electrs/mainnet/history          1.0T    300G    765G    28%    /electrs/mainnet/newindex/history
nvm/electrs/mainnet/txstore          1.3T    530G    765G    41%    /electrs/mainnet/newindex/txstore
nvm/electrs/signet                   766G    522M    765G     0%    /electrs/signet
nvm/electrs/testnet                  765G    104K    765G     0%    /electrs/testnet
nvm/electrs/testnet/cache            765G    1.6M    765G     0%    /electrs/testnet/newindex/cache
nvm/electrs/testnet/history          784G     19G    765G     2%    /electrs/testnet/newindex/history
nvm/electrs/testnet/txstore          803G     38G    765G     5%    /electrs/testnet/newindex/txstore
nvm/elements                         766G    927M    765G     0%    /elements
nvm/elements/electrs                 766G    716M    765G     0%    /elements/electrs
nvm/elements/liquidv1                777G     11G    765G     1%    /elements/liquidv1
nvm/mempool                          789G     24G    765G     3%    /mempool
nvm/mysql                            766G    648M    765G     0%    /mysql
tmpfs                                1.0G    1.3M    1.0G     0%    /var/cache/nginx
tmpfs                                3.0G    1.9G    1.1G    63%    /bisq/statsnode-data/btc_mainnet/db/json

Build Dependencies

You'll probably need these:

pkg install -y zsh sudo git screen curl wget neovim rsync nginx openssl openssh-portable py38-pip py38-certbot-nginx boost-libs autoconf automake gmake gcc libevent libtool pkgconf mariadb105-server mariadb105-client

NodeJS / npm

I recommend to build nodejs / npm from source using nvm:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | zsh
source $HOME/.zshrc
nvm install v16.10.0
nvm alias default node

Rust

I recommend to build rust from latest source:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Tor

Install tor, add Bitcoin to _tor group:

pkg install -y tor
pw user mod bitcoin -G _tor

Then configure /usr/local/etc/tor/torrc as follows:

RunAsDaemon 1
SOCKSPort 9050
ControlPort 9051
Log notice syslog

CookieAuthentication 1
CookieAuthFileGroupReadable 1
CookieAuthFile /var/db/tor/control_auth_cookie
DataDirectory /var/db/tor
DataDirectoryGroupReadable 1

HiddenServiceDir /var/db/tor/mempool
HiddenServicePort 80 127.0.0.1:81
HiddenServiceVersion 3

HiddenServiceDir /var/db/tor/bisq
HiddenServicePort 80 127.0.0.1:82
HiddenServiceVersion 3

HiddenServiceDir /var/db/tor/liquid
HiddenServicePort 80 127.0.0.1:83
HiddenServiceVersion 3

Bitcoin

Build Bitcoin Core from source. Alternatively, install the OS packages:

pkg install -y bitcoin-daemon bitcoin-utils

Configure your bitcoin.conf like this:

datadir=/bitcoin
server=1
txindex=1
listen=1
discover=1
par=16
dbcache=4096
maxmempool=1337
mempoolexpiry=999999
maxconnections=42
onion=127.0.0.1:9050
rpcallowip=127.0.0.1
rpcuser=foo
rpcpassword=bar

[main]
bind=127.0.0.1:8333
rpcbind=127.0.0.1:8332
whitelist=bloomfilter@127.0.0.1

[test]
daemon=1
bind=127.0.0.1:18333
rpcbind=127.0.0.1:18332

[signet]
daemon=1
bind=127.0.0.1:38333
rpcbind=127.0.0.1:38332

Elements

Build Elements Core from source:

./autogen.sh
MAKE=gmake CC=cc CXX=c++ CPPFLAGS=-I/usr/local/include \
./configure --with-gui=no --disable-wallet
gmake -j19
gmake install

Configure your elements.conf like this:

server=1
daemon=1
listen=1
rpcuser=foo
rpcpassword=bar
mainchainrpchost=127.0.0.1
mainchainrpcuser=foo
mainchainrpcpassword=bar
txindex=1

[liquidv1]
validatepegin=1
mainchainrpcport=8332

[liquidtestnet]
validatepegin=0
anyonecanspendaremine=0
initialfreecoins=2100000000000000
con_dyna_deploy_start=0
con_max_block_sig_size=150
checkblockindex=0
fallbackfee=0.00000100
con_has_parent_chain=0
parentgenesisblockhash=NULL
pubkeyprefix=36
scriptprefix=19
blindedprefix=23
bech32_hrp=tex
blech32_hrp=tlq
pchmessagestart=410edd62
dynamic_epoch_length=1000
signblockscript=51210217e403ddb181872c32a0cd468c710040b2f53d8cac69f18dad07985ee37e9a7151ae
evbparams=dynafed:0:::
addnode=liquid-testnet.blockstream.com:18892
addnode=liquidtestnet.com:18891
addnode=liquid.network:18444

Start elementsd and wait for it to sync the Liquid blockchain.

Electrs

Install Electrs from source:

git clone https://github.com/Blockstream/electrs
cd electrs
git checkout new-index

You'll need one instance per network. Build and run them one at a time:

./electrs-start-mainnet
./electrs-start-testnet
./electrs-start-signet
./electrs-start-liquid
./electrs-start-liquidtestnet

MariaDB

Import historical mempool fee database snapshot:

mysql -u root
create database mempool;
grant all on mempool.* to 'mempool'@'localhost' identified by 'mempool';
create database mempool_testnet;
grant all on mempool_testnet.* to 'mempool_testnet'@'localhost' identified by 'mempool_testnet';
create database mempool_signet;
grant all on mempool_signet.* to 'mempool_signet'@'localhost' identified by 'mempool_signet';
create database mempool_liquid;
grant all on mempool_liquid.* to 'mempool_liquid'@'localhost' identified by 'mempool_liquid';
create database mempool_liquidtestnet;
grant all on mempool_liquidtestnet.* to 'mempool_liquidtestnet'@'localhost' identified by 'mempool_liquidtestnet';

Bisq

Build bisq-statsnode normally and run using options like this:

./bisq-statsnode --dumpBlockchainData=true --dumpStatistics=true

If bisq is happy, it should dump JSON files for Bisq Markets and BSQ data into /bisq that the mempool backend will use.

Mempool

After all 3 electrs instances are fully indexed, install your 3 mempool nodes:

./mempool-install-all
./mempool-upgrade-all

Finally, start your 3 mempool backends:

./mempool-start-all

Nginx

Get SSL certificate using certbot:

certbot --nginx -d mempool.ninja

Make a symlink from /usr/local/etc/nginx/mempool to /mempool/mempool, and copy the nginx.conf and edit as necessary. You probably only need to edit the top-level nginx.conf file.

cd /usr/local/etc/nginx
ln -s /mempool/mempool
cp /mempool/mempool/nginx.conf .
vi nginx.conf

Restart nginx

service nginx restart

Done

Your site should look like https://mempool.space/