From 5efdbb3312c1ffa882364db6226b02a3633423be Mon Sep 17 00:00:00 2001 From: "Justin (shocknet)" <34176400+capitalistdog@users.noreply.github.com> Date: Sun, 11 Feb 2024 15:12:29 -0500 Subject: [PATCH] Update README.md --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5dbf6c3d..1bbabcb7 100644 --- a/README.md +++ b/README.md @@ -8,36 +8,38 @@ ### Don't just run a Lightning Node, run a Lightning Pub. -`Pub` enables your Lightning node with public API's and accounts over `nostr`, allowing LN nodes to act like a webserver without the complexity of networking and SSL configurations. +"Pub" is a `nostr` native account system that makes connecting your node to apps and websites super easy. -The Permissionless WebApps that use these API's promote a more decentralized Lightning Network, by removing hurdles for self-custodial home nodes to power connections from Friends, Family and Customers. +Using Nostr relays as transport for encrypted RPCs, Pub eliminates the complexity of WebServer and SSL configurations. + +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. #### 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) - Accounting SubLayers for Application Pools and Users - - A fee regime allows applications owners to tax users, or node operators to tax applications. + - A fee regime allows applications owners to monetize users, or node operators to host distinctly monetized applications. ![Accounts](https://github.com/shocknet/Lightning.Pub/raw/master/accounting_layers.png) #### Planned - [ ] Management Dashboard is being integrated into [ShockWallet](https://github.com/shocknet/wallet2) +- [ ] Nostr native "offers" - [ ] Channel Automation +- [ ] Bootstarp Peering (Passive "LSP") - [ ] Subscriptions / Notifications - [ ] Submarine Swaps -- [ ] High-Availabilty +- [ ] High-Availabilty / Clustering Dashboard: Pub Dashboard -#### ShockWallet and most of Lightning.Pub were developed as part of the [Bolt.Fun hackathon](https://bolt.fun/project/shocknet). If you would like to see continued development, please show your support there and help us win :) - -#### See the original NostrHack presentation: https://lightning.video/f0f64fa1fc3744fb6a3880e2bd8f6a254ceb3caee112d9708271f2d6a09a2f00 +#### 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:** This repository is under rapid iteration and security is not guaranteed. Use tagged releases for non-development. +> **WARNING:** While this software has been used in production for many months, it is still bleeding edge and security or reliabilty is not guaranteed. ## Manual Installation @@ -64,16 +66,17 @@ cd Lightning.Pub && npm i 3) `cp env.example .env` 4) Add values to env file - - You can generate a keypair with `node genkey.js` 5) `npm start` -6) Create an Application Pool +6) Create an Application Pool + +A default "wallet" pool will be automatically created and keys generated automatically, 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. +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.