faucet-package

This repo helps you set up a minimal deployment of the mobilecoind-dev-faucet.

Quick start

Start by getting a cloud machine somewhere.

I used Amazon Lightsail with 2 GB RAM, 1 vCPUs, 60 GB SSD.

I configured a machine with OS-only and selected Ubuntu 22.04.

Then, get a prompt in the container. You will need to install supervisord and nginx.

sudo apt-get update && sudo apt-get install supervisor nginx-core jq

You will need to further fix-up the default nginx install.

sudo systemctl stop nginx
sudo systemctl disable nginx
sudo update-rc.d -f nginx disable
sudo rm /etc/nginx/sites-enabled/default

You can use wget to fetch the pre-created package and install it with tar. (Below we have a one-liner using jq that finds and fetches the latest release.)

sudo su
cd /
curl -s https://api.github.com/repos/cbeck88/faucet-package/releases/latest | jq -r .assets[0].browser_download_url | wget -i -
tar -xzvf package.tar.gz

The package will include an example account key which holds the funds of the faucet. This key is installed as /var/lib/faucet/account_key_example.json. You should copy this file to account_key.json, and modify the mnemonic, replacing it with a secret mnemonic that you control.

Please back up your mnemonic using a password manager.

Then, run supervisorctl. You can use reload to start the services.

To monitor the services using supervisorctl, you can use the commands status and tail -f mobilecoind or tail -f faucet to look at logs. You can also stop and start the services using supervisorctl.

You can also look at the /var/log/mobilecoind.log and /var/log/faucet.log files on disk, outside of supervisorctl.

Ports and Networking

With the packaged configs, nginx listens on port 80 for HTTP, and it proxies POST / and GET /status to the faucet on 9090. It serves other GET requests from the /var/www directory.

• You can modify /etc/supervisord/conf.d/nginx.conf if you want to change how it is launched.

I recommend that you

1. Click on the networking tab and configure a static ip.
2. Ensure that port 80 HTTP is exposed.

If you have a static ip, you can set up an A record in DNS if you like.

Testing that it is working

You can try to ask the dev-faucet for its status:

curl http://123.456.789.000/status

You should get back a json blob. This will include the faucet's public address if you want to fund it.

You can request payment directly using curl.

curl http://123.456.789.000/ -d '{"b58_address": "5KBMnd8cs5zPsytGgZrjmQ8z9VJYThuh1B39pKzDERTfzm3sVGQxnZPC8JEWP69togpSPRz3e6pBsLzwnMjrXTbDqoRTQ8VF98sQu7LqjL5"}' -X POST

Building the package

To build the package, start by checking out this repo and building the rust part.

git submodule update --recursive
./build_rust.sh

Then you can build the package, which produces package.tar.gz.

./make_package.sh

If you want to make a new release, simply tag whatever changes you made and attach package.tar.gz to the release.