Update README.md
This commit is contained in:
parent
97fbaa5d80
commit
b13a5b58a5
1 changed files with 20 additions and 10 deletions
26
README.md
26
README.md
|
|
@ -10,25 +10,28 @@
|
|||
|
||||
"Pub" is a [Nostr](https://nostr.info)-native account system designed to make running Lightning infrastructure for your friends/family/customers easier than previously thought possible.
|
||||
|
||||
It may come as a surprise that the biggest hurdle to more Uncle Jim nodes hasn't been with Bitcoin/Lightning node management itself, as we've seen liquidity easily automated even in unreliable environments like mobile nodes.
|
||||
Lightning payments open the door to a new internet, but because of UX challenges with sovereignty we've seen a much slower uptake than we should for something so amazing.
|
||||
|
||||
It's the legacy baggage of traditional Client-Server web infrastructure, things like IP4, Reverse Proxies, DNS, Firewalls and SSL certificates, all of which require a personal configuration that is a hurdle for most.
|
||||
It may come as a surprise that the biggest hurdle to more adoption via Family and SMB Lightning nodes hasn't been with Bitcoin/Lightning node management itself, as we've seen that liquidity is easily automated, but rather the legacy baggage of traditional Client-Server web infrastructure. Things like IP4, Reverse Proxies, DNS, Firewalls and SSL certificates, all require a personal configuration that is a hurdle for most.
|
||||
|
||||
Tor as a workaround has proven too slow and unreliable, and a dead-end for clearnet-web usecases. Bxlt12, being a re-implementation of Tor, appears destined for the same fate.
|
||||
Tor as a workaround has proven too slow and unreliable, and a dead-end for clearnet-web usecases. Mobile node are easy but channels for every device is expensive and unscalable, and the UX that suffers from the limitations of the node not being an always-online server.
|
||||
|
||||
Pub solves these challenges with a P2P-like design that is also web-friendly, by implementing a full RPC that is Nostr-native. Being Nostr-native eliminates the complexity of configuring your node like a server by using commodity Nostr relays. These relays, unlike LNURL proxies, are trustless by nature of Nostr's own encryption spec (NIP44).
|
||||
|
||||
Additionally, support for optional services are integrated into Pub for operators seeking backward compatibility with legacy LNURLs and Lightning Addresses.
|
||||
|
||||
By solving the networking and programability hurdles, Pub provides Lightning with a 3rd Layer that enables node-runners and Uncle Jims to more easily bring their personal network into Bitcoin's permissionless economy. In doing so, Pub runners can keep the Lightning Network decentralized, with custodial scaling that is free of fiat rails, large banks, and other forms of high-time-preference shitcoinery.
|
||||
By solving the networking and programability hurdles, Pub provides Lightning with a 3rd Layer that enables node-runners, Busineses, and Uncle Jims to more easily bring their personal network into Bitcoin's permissionless economy. In doing so, Pub runners can keep the Lightning Network decentralized, with custodial scaling that is free of fiat rails, large banks, and other forms of high-time-preference shitcoinery.
|
||||
|
||||
#### Features:
|
||||
|
||||
- Wrapper for [`LND`](https://github.com/lightningnetwork/lnd/releases) that can serve accounts over LNURL and NOSTR
|
||||
- A growing number of [methods](https://github.com/shocknet/Lightning.Pub/blob/master/proto/autogenerated/client.md)
|
||||
- Automated Channels
|
||||
- Receives quotes from multiple LSPs including Zeus, Voltage, and Flashsats
|
||||
- Bootstrap Peering
|
||||
- A pub node may trust another pub node until it can afford a channel
|
||||
- Accounting SubLayers for Application Pools and Users
|
||||
- A fee regime allows applications owners to monetize users, or node operators to host distinctly monetized applications.
|
||||
|
||||

|
||||
|
||||
- Connecting via ShockWallet is as easy as pasting an nprofile
|
||||
|
|
@ -40,8 +43,7 @@ By solving the networking and programability hurdles, Pub provides Lightning wit
|
|||
#### Planned
|
||||
- [ ] A management dashboard is actively being integrated into [ShockWallet](https://github.com/shocknet/wallet2)
|
||||
- [ ] Nostr native "offers" (successor to LNURL-Pay, Lightning Address, Bxlt12)
|
||||
- [ ] Automated Channels
|
||||
- [ ] Bootstrap Peering (Passive "LSP")
|
||||
- [ ] P2P "LSP" coordination for channel batching over Nostr
|
||||
- [ ] Event Notifications
|
||||
- [ ] Swap integration
|
||||
- [ ] High-Availabilty / Clustering
|
||||
|
|
@ -59,6 +61,14 @@ Dashboard Wireframe:
|
|||
> [!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**.
|
||||
|
||||
## One-Line Deployment
|
||||
|
||||
Experimental-ish, it has been tested in Ubuntu/Debian x64 environments but is general enough that it should work on most systems. Mac support is there also, but untested. Please report any issues.
|
||||
|
||||
`sudo wget -qO- https://deploy.lightning.pub | sudo bash`
|
||||
|
||||
Automatic updates are not implemented, but running the script a second time in the future will gracefully upgrade the existing installation.
|
||||
|
||||
## Umbrel Installation
|
||||
|
||||
Coming Soon
|
||||
|
|
@ -67,7 +77,7 @@ Coming Soon
|
|||
|
||||
Coming Soon
|
||||
|
||||
## Docker
|
||||
## Docker (testing)
|
||||
|
||||
`docker pull ghcr.io/shocknet/lightning-pub:latest`
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue