islandbitcoin/gateway-startos

Wrapper for Fedimint Lightning Gateway

Lightning Gateways are lightning service providers for Fedimints. Running a lightning gateway lets you connect your lightning node to different Fedimints to earn routing fees for swapping ecash <> lightning.

This Gateway service runs alongside your LND node and connect to multiple Fedimints and provides a UI for managing liquidity across them.

Dependencies

• docker
• docker-buildx
• yq
• deno
• start-sdk
• make

Build enviroment

Prepare your StartOS build enviroment. In this example we are using Ubuntu 20.04.

1. Install docker

curl -fsSL https://get.docker.com -o- | bash
sudo usermod -aG docker "$USER"
exec sudo su -l $USER

2. Set buildx as the default builder

docker buildx install
docker buildx create --use

3. Enable cross-arch emulated builds in docker

docker run --privileged --rm linuxkit/binfmt:v0.8

4. Install yq

Ubuntu:

sudo snap install yq

Debian:

PLATFORM=$(dpkg --print-architecture)
wget -q https://github.com/mikefarah/yq/releases/latest/download/yq_linux_${PLATFORM} && sudo mv yq_linux_${PLATFORM} /usr/local/bin/yq && sudo chmod +x /usr/local/bin/yq

5. Install essential build packages

sudo apt-get install -y build-essential openssl libssl-dev libc6-dev clang libclang-dev ca-certificates

6. Install Rust

curl https://sh.rustup.rs -sSf | sh
# Choose nr 1 (default install)
source $HOME/.cargo/env

7. Install toml

cargo install toml-cli

8. Build and install start-sdk

cd ~/ && git clone https://github.com/Start9Labs/start-os.git
#checkout v0.3.5.1
git checkout 39de098461833e4c56bd3509644ddf7f1a0fc4ca
cd core/
./install-sdk.sh
start-sdk init

Cloning

Clone the project locally. Note the submodule link to the original project(s).

git clone https://github.com/Start9Labs/jam-startos
cd jam-startos
git submodule update --init --recursive

Building

To build the project, run the following commands:

docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
docker buildx create --name multiarch --driver docker-container --use
docker buildx inspect --bootstrap

You should only run the above commands once to create a custom builder. Afterwards you will only need the below command to make the .s9pk file

make

Installing (on StartOS)

Sideload from the web-UI: System > Sideload Service

Sideload from the CLI: SSH into your StartOS device. scp the .s9pk to any directory from your local machine. Run the following command to install the package:

start-cli auth login
#Enter your StartOS server's master password, then run:
start-cli package install /path/to/jam.s9pk

Verify Install

Go to your StartOS Services page, select Jam and start the service.

#Done