lawallet Environment

Quickly setup a lawallet environment with the latest deployed images for each module.

Included lawallet modules:

• api-gateway
• card
• ledger
• monitor
• urlx

Development

Development environments can be easily set up, including the aforementioned lawallet modules, alongside:

• nostream
• LNBits
• NGINX SSL Proxy
• Polar Network

Requirements

• openssl: required for public / private key generation (you may install it with apt install openssl)
• mkcert: required for local certificate trusting (see: mkcert's homepage)
• docker: required to launch the individual containers (you may install it with apt install docker-compose) --- REQUIRES docker compose VERSION 2.20.0 OR NEWER
• polar: a local lightning network development environment (you may download the AppImage file from the Polar Homepage)

In order to check these, you may run:

$ openssl version
...
$ mkcert -install
...
$ docker compose version
...

Running mkcert -install will incidentally install mkcert's root CA so that you may use it right away.

Quick Start

Simply:

1. Launch the Polar network:
   1. run the Polar AppImage file,
   2. click on Import Network,
   3. select the ./polar/testing.polar.zip file, and
   4. click on the Start button to launch the network proper.
2. (optionally) Customize the .env.example.dev environment file if you so desire (you really don't need to),
3. Run ./dev and follow on-screen instructions.

Why are you asking for my sudo password?

The ./dev script will try to reversibly add entries to /etc/hosts, in order for this process to be non-invasive, we need to be able to run mount --bind ... and umount -f ..., and this can only be done via sudo.

The script will only ask once, and keep the credentials fresh in the background.

The ./dev script will generate all required public / private NOSTR keys, and the nostream secret to use, all other parameters are preconfigured to work correctly with the composed setup.

It will then start the docker instances and show the ongoing logs. When you're done testing, you may stop all the instances with Ctrl+C, and docker will stop all the containers for you, and the script will undo the hosts mappings.

Production

Production environments are easily set up as well, but will spin up a reduced number of containers (since we do not wish to use the Polar Network, nor the SSL proxy, nor the local LNBits instance).

You're likely to want to change the following environment variables in .env.example.prod:

• SERVER_AES_KEY_HEX
• CARD_WRITER_PUBKEY
• FEDERATION_ID

Even if just for prod / dev separations purposes.

Next, you'll need to access your LNBits instance and log into your desired support wallet, and complete the following environmental variables' values:

• LNBITS_ADMIN_KEY
• LNBITS_INVOICE_READ_KEY
• LNBITS_ENDPOINT

Now, you'll need to set up an LNURLp payment link and webhook, to do so:

1. Instal and activate the LNURLp extension (see the LNURLp Homepage)
2. set up a payment link with whatever limits you feel comfortable with, and set up a Webhook URL pointed to https://{LAWALLET_BASE_URL}/invoice/settlement.
3. follow the generated link and extract the cb value, note this value down and complete the LNURLP_URI environmental variable with it.

Finally, the following environmental variables will only be regenerated if empty:

• NOSTREAM_SECRET
• LEDGER_PRIVATE_KEY / LEDGER_PUBLIC_KEY
• URLX_PRIVATE_KEY / URLX_PUBLIC_KEY
• CARD_PRIVATE_KEY / CARD_PUBLIC_KEY

Finally, simply run ./prod to start the production environment.