Skip to content

Latest commit

 

History

History
514 lines (305 loc) · 21.3 KB

README.md

File metadata and controls

514 lines (305 loc) · 21.3 KB
Raw

Alby Hub Logo


Alby Hub - Your Own Center for Internet Money

Alby Hub allows you to control your Lightning node or wallet from any other application that supports NWC. Connect apps like Damus or Amethyst to your node. There are many more available on https://nwc.dev/.

The application can run in two modes:

  • Desktop (Wails app): Mac (arm64), Windows (amd64), Linux (amd64)
  • HTTP (Web app): Docker, Linux (amd64), Mac (arm64)

Ideally the app runs 24/7 (on a node, VPS or always-online desktop/laptop machine) so it can be connected to a lightning address and receive online payments.

Run on Alby Cloud

Visit albyhub.com to learn more and get started and get Alby Hub running in minutes.

Self Hosted

Go to the Deploy it yourself section below.

Supported Backends

By default Alby Hub uses the embedded LDK based lightning node. Optionally it can be configured to use an external node:

  • LND
  • Phoenixd
  • Cashu
  • want more? please open an issue.

Development

Required Software

  • Go
  • Node
  • NPM
  • Yarn

Environment setup

$ cp .env.example .env
# edit the config for your needs (Read further down for all the available env options)
$ vim .env

Server (HTTP mode)

  1. Create a Lightning Polar setup with two LND nodes and uncomment the Polar LND section in your .env file.

  2. Compile the frontend or run touch frontend/dist/tmp to ensure there are embeddable files available.

  3. go run cmd/http/main.go

React Frontend (HTTP mode)

Go to /frontend

  1. yarn install
  2. yarn dev

Wails (Backend + Frontend)

Make sure to have wails installed and all platform-specific dependencies installed (see wails doctor)

$ wails dev -tags "wails"

If you get a blank screen, try running in your normal terminal (outside of vscode, and make sure HTTP frontend is not running)

Wails Production build

$ wails build -tags "wails"

Build and run locally (HTTP mode)

$ mkdir tmp
$ go build -o main cmd/http/main.go
$ cp main tmp
$ cp .env tmp
$ cd tmp
$ ./main

Run dockerfile locally (HTTP mode)

$ docker build . -t nwc-local --progress=plain
$ docker run -v $(pwd)/.data/docker:/data -e WORK_DIR='/data' -p 8080:8080 nwc-local

Testing

$ go test ./...

Test matching regular expression

$ go test ./... -run TestHandleGetInfoEvent

Profiling

The application supports both the Go pprof library and the DataDog profiler.

Go pprof

To enable Go pprof, set the GO_PROFILER_ADDR environment variable to the address you want the profiler to be available on (e.g. localhost:6060).

Now, you should be able to access the pprof web interface at http://localhost:6060/debug/pprof.

You can use the go tool pprof command to collect and inspect the profiling data. For example, to profile the application for 30 seconds and then open the pprof web UI, run:

go tool pprof -http=localhost:8081 -seconds=30 http://localhost:6060/debug/pprof/profile

For more information on the Go pprof library, see the official documentation.

DataDog profiler

To enable the DataDog profiler, set the DD_PROFILER_ENABLED environment variable to true.

Make sure to specify the required DataDog configuration environment variables as well.

For more information refer to:

Versioning

$ go run -ldflags="-X 'github.com/getAlby/hub/version.Tag=v0.6.0'" cmd/http/main.go

Windows

Breez SDK requires gcc to build the Breez bindings. Run choco install mingw and copy the breez SDK bindings file into the root of this directory (from your go installation directory) as per the Breez SDK instructions. ALSO copy the bindings file into the output directory alongside the .exe in order to run it.

Optional configuration parameters

The following configuration options can be set as environment variables or in a .env file

  • RELAY: default: "wss://relay.getalby.com/v1"
  • JWT_SECRET: a randomly generated secret string. (only needed in http mode)
  • DATABASE_URI: a sqlite filename. Default: $XDG_DATA_HOME/albyhub/nwc.db
  • PORT: the port on which the app should listen on (default: 8080)
  • WORK_DIR: directory to store NWC data files. Default: $XDG_DATA_HOME/albyhub
  • LOG_LEVEL: log level for the application. Higher is more verbose. Default: 4 (info)
  • AUTO_UNLOCK_PASSWORD: provide unlock password to auto-unlock Alby Hub on startup (e.g. after a machine restart). Unlock password still be required to access the interface.

Node-specific backend parameters

  • ENABLE_ADVANCED_SETUP: set to false to force a specific backend type (combined with backend parameters below)

LND Backend parameters

Currently only LND can be configured via env. Other node types must be configured via the UI.

To configure via env, the following parameters must be provided:

  • LN_BACKEND_TYPE: LND
  • LND_ADDRESS: the LND gRPC address, eg. localhost:10009 (used with the LND backend)
  • LND_CERT_FILE: the location where LND's tls.cert file can be found (used with the LND backend)
  • LND_MACAROON_FILE: the location where LND's admin.macaroon file can be found (used with the LND backend)

LDK Backend parameters

  • LDK_ESPLORA_SERVER: By default the optimized Alby esplora is used. You can configure your own esplora server (note: the public blockstream one is slow and can cause onchain syncing and issues with opening channels)

LDK Network Configuration

Mutinynet
  • MEMPOOL_API=https://mutinynet.com/api
  • LDK_NETWORK=signet
  • LDK_ESPLORA_SERVER=https://mutinynet.com/api
  • LDK_GOSSIP_SOURCE=https://rgs.mutinynet.com/snapshot
Testnet (Not recommended - try Mutinynet)
  • MEMPOOL_API=https://mempool.space/testnet/api
  • LDK_NETWORK=testnet
  • LDK_ESPLORA_SERVER=https://mempool.space/testnet/api
  • LDK_GOSSIP_SOURCE=https://rapidsync.lightningdevkit.org/testnet/snapshot

Phoenixd

See Phoenixd

Alby OAuth

Create an OAuth client at the Alby Developer Portal and set your ALBY_OAUTH_CLIENT_ID and ALBY_OAUTH_CLIENT_SECRET in your .env. If not running locally, you'll also need to change your BASE_URL.

If running the React app locally, OAuth redirects will not work locally if running the react app you will need to manually change the port to 5173. Login in Wails mode is not yet supported

Getting Started with Mutinynet

Follow the steps to integrate Mutinynet with your NWC Next setup:

  1. Configure your environment with the Mutinynet LDK parameters

  2. Proceed as described in the Development section to run the frontend and backend

  3. Navigate to channels/outgoing, copy your On-Chain Address, then visit the Mutinynet Faucet to deposit sats. Ensure the transaction confirms on mempool.space

  4. Your On-chain balance will update under /channels

Opening a channel from Mutinynet

  1. To create a channel, use the Mutinynet Faucet by entering your desired Channel Capacity and Amount to Push

  2. Locate your Node ID. In the Wallet click on the status on the top right "online". This shows the node ID or look in the NWC Next logs. Then input this in the Connection String field on the faucet page to request a Lightning Channel

{"level":"info","msg":"Connected to LDK node","nodeId":"<your node ID>","time":"<timestamp>"}
  1. After the transaction confirms, the new channel will appear in the Channels section

Opening a Channel in NWC Next

  1. From the Channels interface (/channels), select "Open a Channel" and opt for "Custom Channel."

  2. Enter the pubkey of the Faucet Lightning Node (omit host and port details) available on the Mutinynet Faucet page.

  3. Specify a channel capacity greater than 25,000 sats, confirm the action, and return to the Channels page to view your newly established channel.

Application deeplink options

/apps/new deeplink options

Clients can use a deeplink to allow the user to add a new connection. Depending on the client this URL has different query options:

NWC created secret

The default option is that the NWC app creates a secret and the user uses the nostr wallet connect URL string to enable the client application.

Query parameter options
  • name: the name of the client app

Example:

/apps/new?name=myapp

Client created secret

If the client creates the secret the client only needs to share the public key of that secret for authorization. The user authorized that pubkey and no sensitivate data needs to be shared.

Query parameter options for /new
  • name: the name of the client app
  • pubkey: the public key of the client's secret for the user to authorize
  • return_to: (optional) if a return_to URL is provided the user will be redirected to that URL after authorization. The lud16, relay and pubkey query parameters will be added to the URL.
  • expires_at (optional) connection cannot be used after this date. Unix timestamp in seconds.
  • max_amount (optional) maximum amount in sats that can be sent per renewal period
  • budget_renewal (optional) reset the budget at the end of the given budget renewal. Can be never (default), daily, weekly, monthly, yearly
  • request_methods (optional) url encoded, space separated list of request types that you need permission for: pay_invoice (default), get_balance (see NIP47). For example: ..&request_methods=pay_invoice%20get_balance
  • notification_types (optional) url encoded, space separated list of notification types that you need permission for: For example: ..&notification_types=payment_received%20payment_sent
  • isolated (optional) makes an isolated app connection with its own balance and only access to its own transaction list. e.g. &isolated=true. If using this option, you should not pass any custom request methods or notification types, nor set a budget or expiry.

Example:

/apps/new?name=myapp&pubkey=47c5a21...&return_to=https://example.com

Web-flow: client created secret

Web clients can open a new prompt popup to load the authorization page. Once the user has authorized the app connection a nwc:success message is sent to the opening page (using postMessage) to indicate that the connection is authorized. See the initNWC() function in the alby-js-sdk

Example:

import { webln } from "alby-js-sdk";
const nwc = new webln.NWC();
// initNWC opens a prompt with /apps/new?c=myapp&pubkey=xxxx
// the promise resolves once the user has authorized the connection (when the `nwc:success` message is received) and the popup is closed automatically
// the promise rejects if the user cancels by closing the prompt popup
await nwc.initNWC({ name: "myapp" });

Help

If you need help contact support@getalby.com or reach out on Nostr: npub1getal6ykt05fsz5nqu4uld09nfj3y3qxmv8crys4aeut53unfvlqr80nfm You can also visit the chat of our Community on Telegram.

⚡️Donations

Want to support the work on Alby?

Support the Alby team ⚡️hello@getalby.com You can also contribute to our bounty program: ⚡️bounties@getalby.com

NIP-47 Supported Methods

✅ NIP-47 info event

❌ expiration tag in requests

LND

✅ get_info

✅ get_balance

✅ pay_invoice

  • ⚠️ amount not supported (for amountless invoices)
  • ⚠️ PAYMENT_FAILED error code not supported

✅ pay_keysend

  • ⚠️ PAYMENT_FAILED error code not supported

✅ make_invoice

✅ lookup_invoice

  • ⚠️ NOT_FOUND error code not supported

✅ list_transactions

  • ⚠️ from and until in request not supported
  • ⚠️ failed payments will not be returned

✅ multi_pay_invoice

  • ⚠️ amount not supported (for amountless invoices)
  • ⚠️ PAYMENT_FAILED error code not supported

✅ multi_pay_keysend

  • ⚠️ PAYMENT_FAILED error code not supported

Breez

(Supported methods coming soon)

Node Distributions

Run NWC on your own node!

NOTE: the below links are for the original version of NWC

Deploy it yourself

Requirements

The application has no runtime dependencies. (simple Go executable).

As data storage SQLite is used.

For the default backend which runs a node internally we recommend 1+GB of disk space and 2GB of RAM (or 512GB Ram + 2GB swap can also be used). For connecting to an external node, Alby Hub uses very little RAM (256mb is enough).

From the release

Quick start (x86 Linux Server)

Go to the Quick start script which you can run as a service.

Quick start (Arm64 Linux Server or Raspberry PI 4/5)

Go to the Quick start script which you can run as a service.

Quick start (Raspberry PI Zero)

Go to the Quick start script which you can run as a service.

Quick start (Desktop)

View the release binaries

Manual (x86 Linux Server)

Download and run the executable.

Have a look at the configuration options

wget https://getalby.com/install/hub/server-linux-x86_64.tar.bz2
tar -xvjf server-linux-x86_64.tar.bz2

# run Alby Hub and done!
./bin/albyhub

Fly.io

Make sure to have the fly command line tools installed 

wget https://getalby.com/install/hub/fly.toml
fly launch
fly apps open

Or manually:

  • update app = 'nwc' on line 6 to a unique name in fly.toml e.g. app = 'nwc-john-doe-1234'
  • run fly launch
    • press 'y' to copy configuration to the new app and then hit enter
    • press 'n' to tweak the settings and then hit enter
    • wait for the deployment to succeed, it should give you a URL like https://nwc-john-doe-1234.fly.dev

Update Fly App

  • run fly deploy

View logs

Main application logs

  • fly logs

LDK logs:

  • fly machine exec "tail -100 data/ldk/logs/ldk_node_latest.log"

Docker

From Alby's Container Registry

Tested on Linux only

docker run -v ~/.local/share/albyhub:/data -e WORK_DIR='/data' -p 8080:8080 --pull always ghcr.io/getalby/hub:latest

Build the image locally

docker run -v ~/.local/share/albyhub:/data -e WORK_DIR='/data' -p 8080:8080 $(docker build -q .)

Docker Compose

In this repository. Or manually download the docker-compose.yml file and then run:

docker compose up

From source

  • install go (e.g. using snap)
  • install build-essential
  • install yarn
  • run (cd frontend && yarn install
  • run (cd frontend && yarn build:http)
  • run go run cmd/http/main.go

Render.com

Deploy to Render

Alby Hub Architecture

NWC Wallet Service

At a high level Alby Hub is an NWC wallet service which allows users to use their single wallet seamlessly within a multitude of apps(clients). Any client that supports NWC and has a valid connection secret can communicate with the wallet service to execute commands on the underlying wallet (internally called LNClient).

LNClient

The LNClient interface abstracts the differences between wallet implementations and allows users to run Alby Hub with their preferred wallet, such as LDK, LND, Phoenixd, Cashu, Breez, Greenlight.

Transactions Service

Alby Hub maintains its own database of transactions to enable features like self-payments for isolated app connections (subaccounts), additional metadata (that apps can provide when creating invoices or making keysend payments), and to associate transactions with apps, providing additional context to users about how their wallet is being used across apps.

The transactions service sits between the LNClient and two possible entry points: the NIP-47 handlers, and our internal API which is used by the Alby Hub frontend.

Event Publisher

Internally Alby Hub uses a basic implementation of the pubsub messaging pattern which allows different parts of the system to fire or consume events. For example, the LNClients can fire events when they asynchronously receive or send a payment, which is consumed by the transaction service to update our internal transaction database, and then fire its own events which can be consumed by the NIP-47 notifier to publish notification events to subscribing apps, and also by the Alby OAuth service to send events to the Alby Account (to enable features such as encrypted static channel backups, email notifications of payments, and more).

Published Events

- `nwc_started` - when Alby Hub process starts
- `nwc_stopped` - when Alby Hub process gracefully exits
- `nwc_node_started` - when Alby Hub successfully starts or connects to the configured LNClient.
- `nwc_node_start_failed` - The LNClient failed to sync or could not be connected to (e.g. network error, or incorrect configuration for an external node)
- `nwc_node_stopped` the LNClient was gracefully stopped
- `nwc_node_stop_failed` - failed to request the node to stop. Ideally this never happens.
- `nwc_node_sync_failed` - the node failed to sync onchain, wallet or fee estimates.
- `nwc_unlocked` - when user enters correct password (HTTP only)
- `nwc_channel_ready` - a new channel is opened, active and ready to use
- `nwc_channel_closed` - a channel was closed (could be co-operatively or a force closure)
- `nwc_backup_channels` - send a list of channels that can be used as a SCB.
- `nwc_outgoing_liquidity_required` - when user tries to pay an invoice more than their current outgoing liquidity across active channels
- `nwc_incoming_liquidity_required` - when user tries to creates an invoice more than their current incoming liquidity across active channels
- `nwc_permission_denied` - a NIP-47 request was denied - either due to the app connection not having permission for a certain command, or the app does not have insufficient balance or budget to make the payment.
- `nwc_payment_failed` - failed to make a lightning payment
- `nwc_payment_sent` - successfully made a lightning payment
- `nwc_payment_received` - received a lightning payment
- `nwc_lnclient_*` - underlying LNClient events, consumed only by the transactions service.

NIP-47 Handlers

Alby Hub subscribes to a standard Nostr relay and listens for whitelisted events from known pubkeys and handles these requests in a similar way as a standard HTTP API controller, and either doing requests to the underling LNClient, or to the transactions service in the case of payments and invoices.

Frontend

The Alby Hub frontend is a standard React app that can run in one of two modes: as an HTTP server, or desktop app, built by Wails. To abstract away, both the HTTP service and Wails handlers pass requests through to the API, where the business logic is located, for direct requests from user interactions.

Authentication

Alby Hub uses simple JWT auth in HTTP mode, which also allows the HTTP API to be exposed to external apps, which can use Alby Hub's API to have access to extra functionality currently not covered by the NIP-47 spec, however there are downsides - this API is not a public spec, and only works over HTTP. Therefore, apps are recommended to use NIP-47 where possible.

Encryption

Sensitive data such as the seed phrase are saved AES-encrypted by the user's unlock password, and only decrypted in-memory in order to run the lightning node. This data is not logged and is only transferred over encrypted channels, and always requires the user's unlock password to access.

All requests to the wallet service are made with one of the following ways:

  • NIP-47 - requests encrypted by NIP-04 using randomly-generated keypairs (one per app connection) and sent via websocket through the configured relay.
  • HTTP - requests encrypted by JWT and ideally HTTPS (except self-hosted, which can be protected by firewall)
  • Desktop mode - requests are made internally through the Wails router, without any kind of network traffic.

Alby Hub Origin

Alby Hub is a self-sovereign, self-custodial, single-user NWC-first rewrite of the original Nostr Wallet Connect app which was originally created to support V4V by enabling seamless zaps in nostr clients such as Amethyst and Damus. From there the NIP-47 protocol was grown until it is possible to create many micro apps that connect to your hub, with full control over what each app can do.