aiolabs/lightning-pub
2
0
Fork 0
Code Issues 9 Pull requests 4 Projects Releases Packages Wiki Activity Actions

docs

Browse source
This commit is contained in:
Justin (shocknet) 2024-04-29 12:07:47 -04:00
parent 1debe0baf4
commit 8e93cdba3e
2 changed files with 89 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -8,11 +8,15 @@
### Don't just run a Lightning Node, run a Lightning Pub.
"Pub" is a `nostr` native account system that makes connecting your node to apps and websites super easy.
"Pub" is a `nostr` native account system, the goal of the project is to make running Lightning infrastructure for your friends/family/customers easier than previously thought possible.
Using Nostr relays as transport for encrypted RPCs, Pub eliminates the complexity of WebServer and SSL configurations.
It may come as a surprise that the biggest hurdle to more Uncle Jim's nodes hasn't been with Bitcoin/Lightning node management itself, that's easily automated as illustrated by bad patterns, like mobile nodes and unreliable Tor connections.
By solving the networking and programability hurdles, Pub enables node-runners and Uncle Jim's to bring their Friends, Family and Customers into Bitcoin's permissionless circular economy. All while keeping the Lightning Network decentralized, and custodial scaling free of fiat shitcoin rails and large banks.
It's the legacy baggage of traditional web infrastructure, things like IP4, reverse proxies, DNS, Firewalls and SSL certificates, all which require a personal configuration that is a hurdle for most.
Pub solves these challenges with a [Nostr](https://nostr.info/)-native RPC. Being Nostr-native eliminates the complexity of legacy server configuration using completely commoditized and trustless Nostr relays. Additionally, some optional services are integrated for backward compatibility with LNURL and Lightning Address.
By solving the networking and programability hurdles, Pub enables node-runners and Uncle Jim's to bring their personal network into Bitcoin's permissionless circular economy. All while keeping the Lightning Network decentralized, and custodial scaling free of fiat rails, large banks, and other forms of high-time preference shitcoinery.
#### Features:
@ -27,32 +31,40 @@ By solving the networking and programability hurdles, Pub enables node-runners a
- [ ] Management Dashboard is being integrated into [ShockWallet](https://github.com/shocknet/wallet2)
- [ ] Nostr native "offers"
- [ ] Channel Automation
- [ ] Bootstarp Peering (Passive "LSP")
- [ ] Bootstrap Peering (Passive "LSP")
- [ ] Subscriptions / Notifications
- [ ] Submarine Swaps
- [ ] High-Availabilty / Clustering
Dashboard:
Dashboard Wireframe:
<img src="https://shockwallet.b-cdn.net/pub_home_ss.png" alt="Pub Dashboard" width="240">
#### ShockWallet and Lightning.Pub are free software. If you would like to see continued development, please show your [support](https://github.com/sponsors/shocknet) :)
> **WARNING:** While this software has been used in production for many months, it is still bleeding edge and security or reliabilty is not guaranteed.
> **WARNING:** While this software has been used in a high-profile production environment for over a year, it should still be considered bleeding edge. Special care has been taken to mitigate the risk of drainage attacks, which is a common risk to all Lightning API's. An integrated Watchdog service will terminate spends if it detects a discrepency between LND and the database, for this reason IT IS NOT RECOMMENDED TO USE PUB ALONGSIDE OTHER ACCOUNT SYSTEMS. While we give the utmost care and attention to security, the internet is an adversarial environment and SECURITY/RELIABILITY ARE NOT GUARANTEED- USE AT YOUR OWN RISK.
## Umbrel Installation
Coming Soon
## Automatic Installation
Coming Soon
## Manual Installation
#### Notes:
* The service defaults to port `8080`
* Use of a reverse proxy is only required if you wish to serve LNURLs
* The service defaults to port `8080`
* Requires [Node.js](https://nodejs.org) >=18.x
#### Steps:
1) Run [LND](https://github.com/lightningnetwork/lnd/releases) - *Example mainnet startup*:
```
./lnd --bitcoin.active --bitcoin.mainnet --bitcoin.node=neutrino --neutrino.connect=neutrino.shock.network --routing.assumechanvalid --accept-keysend --allow-circular-route --feeurl=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json
./lnd --bitcoin.active --bitcoin.mainnet --bitcoin.node=neutrino --neutrino.connect=neutrino.shock.network --accept-keysend --allow-circular-route --feeurl=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json
```
@ -65,18 +77,16 @@ cd Lightning.Pub && npm i
3) `cp env.example .env`
4) Add values to env file
4) Configure values to env file as desired
5) `npm start`
6) Create an Application Pool
A default "wallet" pool will be automatically created and keys generated automatically, if you wish to create something other:
A default "wallet" pool will be automatically created, if you wish to create something other:
```
curl -XPOST -H 'Authorization: Bearer defined_in_constants.ts' -H "Content-type: application/json" -d '{"name":"ExampleApplicationPoolName"}' 'http://localhost:8080/api/admin/app/add'
```
7) Connect with [wallet2](https://github.com/shocknet/wallet2) using the npub response in step 6 or the the wallet application nprofile logged at startup.
7) Connect with [wallet2](https://github.com/shocknet/wallet2) using the wallet nprofile that was logged at startup.