sataddress 0.1.0

Rust implementation of Lightning Address Federated Server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

<div id="top"></div>

<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![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]


<br />
<div align="center">
  <a href="https://github.com/bernii/sataddress-rs">
    <img src="https://raw.githubusercontent.com/bernii/sataddress-rs/7a09f16a116f1211d1e961bc7e78a1add88f6a4e/assets/inv_banner.png" alt="SatAddress RS logo" width="80">
  </a>

<h2 align="center">Lightning address federated server implementation in Rust</h3>
  <p align="center">
    <a href="https://satspay.to"><strong>Live Version</strong></a> | 
    <a href="https://docs.rs/sataddress/latest/sataddress/index.html"><strong>Documentation</strong></a>
    <br />
    <br />
    <a href="https://crates.io/crates/sataddress">Crates.io</a>
    ·
    <a href="https://github.com/bernii/sataddress-rs/issues">Report a Bug</a>
    ·
    <a href="https://github.com/bernii/sataddress-rs/issues">Feature Request</a>
  </p>
</div>


## About The Project

This is a [rust](https://www.rust-lang.org/) implementation of Federated [Lightning Address](https://lightningaddress.com/) 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.

## Getting Started

First, check out the *latest deployed version* at [satspay.to](https://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
PIN_SECRET=my-secret-phrase
SITE_NAME=SATADDRESS
SITE_SUB_NAME=.rs
```

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](https://github.com/casey/just) which will also automatically load your `.env` file. 
```bash
$ just run
```

## Roadmap

- [ ] improve tests
- [ ] add REST API functionality for data manipulation
- [ ] better error generation & handling
- [ ] customizable image, memo, max/min invoice sats
- [ ] implementation for more backends/nodes (contributions welcome!)

See the [open issues](https://github.com/bernii/sataddress-rs/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](https://twitter.com/bkobos) - bkobos+nospam!@gmail.com

Project Link: [https://github.com/bernii/sataddress-rs](https://github.com/bernii/sataddress-rs)

## Acknowledgments

* [sataddress](https://github.com/nbd-wtf/satdress) original federated lightning address server implementation which this implementation is based on
* [go-lnurl](https://github.com/fiatjaf/go-lnurl) which was helpful for learning about LN URL structures
* [Lightning Address](https://github.com/andrerfneves/lightning-address) documentation and explanations
* [BTC lightning logo](https://github.com/shocknet/bitcoin-lightning-logo) for creating an open source vector btc logo


<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/bernii/sataddress-rs.svg?style=for-the-badge
[contributors-url]: https://github.com/bernii/sataddress-rs/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/bernii/sataddress-rs.svg?style=for-the-badge
[forks-url]: https://github.com/bernii/sataddress-rs/network/members
[stars-shield]: https://img.shields.io/github/stars/bernii/sataddress-rs.svg?style=for-the-badge
[stars-url]: https://github.com/bernii/sataddress-rs/stargazers
[issues-shield]: https://img.shields.io/github/issues/bernii/sataddress-rs.svg?style=for-the-badge
[issues-url]: https://github.com/bernii/sataddress-rs/issues
[license-shield]: https://img.shields.io/github/license/bernii/sataddress-rs.svg?style=for-the-badge
[license-url]: https://github.com/bernii/sataddress-rs/blob/main/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/bernii
[product-screenshot]: images/screenshot.png
[build-status]: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fbernii%2Fsataddress-rs%2Fbadge%3Fref%3Dmain&style=for-the-badge
[build-status-url]: https://actions-badge.atrox.dev/bernii/sataddress-rs/goto?ref=main