You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 lines
1.3 KiB
42 lines
1.3 KiB
5 years ago
|
# Relay
|
||
|
|
|
||
|
|
**Relay** is a Node.js wrapper around [LND](https://github.com/lightningnetwork/lnd), handling connectivity and storage for [**Sphinx**](https://github.com/stakwork/sphinx). Communication between Relay nodes takes place entirely on the Lightning Network, so is decentralized, untraceable, and encrypted. Message content is also end-to-end encrypted using client public keys, on the **Sphinx** app itself.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Relay stores:
|
||
|
|
- Aliases
|
||
|
|
- Messages
|
||
|
|
- Recurring payment configurations
|
||
|
|
- Invites (so you can add your friends)
|
||
|
|
- Media Keys: keys for decrypting media files, asymetrically encrypted for each contact in a chat
|
||
|
|
|
||
|
|
# run your own sphinx node
|
||
|
|
|
||
|
|
You can run your own Sphinx node in order to have full ownership over your communication!
|
||
|
|
|
||
|
|
### download
|
||
|
|
|
||
|
|
`git clone https://github.com/stakwork/sphinx-node`
|
||
|
|
|
||
|
|
`cd sphinx-node`
|
||
|
|
|
||
|
|
`npm install`
|
||
|
|
|
||
|
|
### dependencies
|
||
|
|
|
||
|
|
sqlite3: `apt-get install sqlite3`
|
||
|
|
|
||
|
|
### configure
|
||
|
|
|
||
|
|
Edit the "production" section of config/app.json:
|
||
|
|
- Change `macaroon_location` to the location of your LND admin macaroon
|
||
|
|
- Change `tls_location` to the location of your LND cert
|
||
|
|
|
||
|
|
### run
|
||
|
|
|
||
|
|
`npm run prod`
|
||
|
|
|
||
|
|
# Roadmap
|
||
|
|
|
||
|
|
- linking recurring payments to files, to enable use cases such as subscribing to podcasts with BTC!
|