[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![Build Status][build-status]][build-status-url] [![MIT License][license-shield]][license-url] [![LinkedIn][linkedin-shield]][linkedin-url]
SatAddress RS logo

Lightning address federated server implementation in Rust

Live Version | Documentation

Crates.io · Report a Bug · Feature Request

About The Project

This is a rust implementation of Federated Lightning Address Server.

Lightning address / alias helps with greatly improving the user experience of using LN payments by using email-like addresses for recieving and sending bitcoin lightning payments.

The federated server allows you to easily handle LN Address requests and add those capabilties to the domains you own.

The project consists of server and cli tool: * Server is responsible for handling requests from LN wallets and serving the alias reservation page and APIs. * CLI tool can be used to interact with the embedded database in order to export/import data or generate usage statistics.

Keysend

Currently sataddress is the only federated server supporting keysend (pubkey) aliasing implementation.

The solution is being achieved by introducing an intermediate lightning node which recieves payments and forwards them automatically to the desination node.

Thanks to the setup above, the user does not have to expose the API (including secrets) of their Lightning Node and is able to recieve payments passively.

Getting Started

First, check out the latest deployed version at satspay.to

The easiest way to run the server is just using the automatically published docker container.

You can configure the container easily by providing enivronment variables either by passing them to docker or by putting them into dot-env file.

```

.env file

DOMAINS=sataddress.rs,another-domain.com PINSECRET=my-secret-phrase SITENAME=SATADDRESS SITESUBNAME=.rs

keysend requires lnbits proxy to work

LNBITSURL=http://127.0.0.1:5001 LNBITSAPIKEY=THEAPIKEY LNBITSADMINID=ADMINIDUNDERWHICHSUBACCOUNTSARE_CREATED ```

Once you have your config figured out, just run the container:

bash $ docker run -v $(pwd)/.env:/opt/sataddress/.env -v $(pwd)/sataddress.db:/opt/sataddress/sataddress.db --name sataddress -it --rm sataddress:latest

As an alternative, if you're familiar with the rust toolset, you can use just which will also automatically load your .env file. bash $ just run

Roadmap

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Bernard Kobos - @bkobos - bkobos+nospam!@gmail.com

Project Link: https://github.com/bernii/sataddress-rs

Acknowledgments