Skip to content

Add nwc, overview and lease info #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions docs/for-users/embedded-node/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Introduction
---

# Overview ZEUS embedded node

### What is ZEUS "embedded node" ?

[Starting with v.0.8.0](https://blog.zeusln.com/new-release-zeus-v0-8-0/) Zeus introduced a new way to run a node directly into your mobile device, without the need to connect to a remote node (at home or a VPS / cloud one).

This embedded node is a full LND node that is using Neutrino protocol to sync the blocks necessary to operate the LND node. This is a very important aspect that new users should pay attention to it. Without a proper sync, your embedded node will not function properly. In the [FAQ page](https://docs.zeusln.app/for-users/embedded-node/faq) we have described all sorts of situations and steps to take, in order to debug and fix possible issues regarding this sync procedure. As a new Zeus user, it is important to know and learn these aspects if you want a smooth experience using your node on your phone.

Besides the embedded node you can also run one or multiple remote nodes or additional lndhub and NWC accounts. Starting with [Zeus v.0.10.0](https://blog.zeusln.com/new-release-zeus-v0-10-0/) you can even run multiple embedded nodes (but NOT at the same time). You can switch between any of these nodes and connections very easily from the top right icon.

insert zeus-node-phone-meme.jpg

### Main features of the Zeus embedded node

1. **Private LND node** - That means this node will NOT do public routing of others payments through your node. The node and the channels are unannounced (private, not visible on the public LN graph). To receive and make payments will be done through your connected LSP peers. REMEMBER: Zeus Embedded Node will NOT do public routing!
2. **Persistent LND service** - user can activate this feature and keep the LND service active continuously as any regular LN node. The app does not have to be open, the persistent service will keep all the communication online. This is a very helpful feature in case you are running Zeus embedded node on a tablet with Zeus PoS, for a small shop. So you will have an "always online" LN node, ready to take payments.
3. **Neutrino block filters** - block sync is done using block filters and the Neutrino protocol (providing no information about our users' on-chain funds). Reminder: for high-latency / slow internet connections this block sync based on neutrino, can sometimes fail. Trying to switch to a near neutrino server could help restore the sync. Without this sync, your LND node cannot start!
4. **Simple Taproot Channels** - When closing these channels, users incur lower fees and are given more privacy as they appear like any other Taproot spend when examining their on-chain footprint.
5. **Integrated LSP** - Olympus is the new LSP node for Zeus. Users can receive sats over LN straight away, without having previously set up LN channels. You will simply have to create a LN invoice and pay from any other LN wallet, with Zeus 0-conf channel service. Read more about Zeus LSP here. The LSP also provides added privacy to our users by providing them with wrapped invoices that conceal their node's public keys from payers.

**NOTE**: LSP = Liquidity Service Provider, [read more here](https://docs.zeusln.app/lsp/intro).

6. **Channels Management** - apart from [easy onboarding on Lightning](https://docs.zeusln.app/for-users/embedded-node/lightning-onboarding) you can open various LN channels with any other LN node you want. But keep in mind - this embedded node is meant to be a "private" node with unannounced channels. You can open channels with funds from your Zeus onchain wallet or with any other LSP by buying [JiT (just-in-time) channels](https://docs.zeusln.app/lsp/services/flow).

**NOTE**: just for a personal mobile node like Zeus embedded is not really necessary to have open too many LN channels. One channel with [Olympus LSP](https://docs.zeusln.app/for-users/embedded-node/lightning-onboarding) plus 2-3 more with other good LSPs will be more than enough. You can see more "vouched" peers for your Zeus node [here](https://docs.zeusln.app/for-users/embedded-node/lightning-onboarding). Size wisely your channels, do not open too small channels, like 50-100k sats, but big enough to cover your regular payments.

7. **Contacts Book** - you can manually save contacts or import from NOSTR, for easily sending payments to your regular destinations.

8. **Full support for LNURL, LN Address send and receive** - now you can setup your own self-custodial LN Address with @zeuspay.com. Reminder: You can also use Zeus for LN-auth on sites where you can login with a LN authentication. It is very handy.

**NOTE**: Zeus also supports [NameDesc bLIP-11](https://github.com/lightning/blips/blob/master/blip-0011.md) which offers the option to add a "receiver name" in your invoices. It is quite handy and useful for shops that are generating invoices and want to add their shop name in the invoice automatically. So the payer will always have a record history of his payments to this particular shop / destination. This feature is OPTIONAL (not enforced) and can be set from "Settings" - "Invoices" - "Receiver name". Once set, will be attached to all your LN invoices you create.

9. **Point of Sale** - Now merchant users can setup their own product items and sell directly from Zeus, with integrated PoS. For the moment, it contains basic features, but in the future, it will include extended features.

10. **LND logs** - the user can read in real time the LND service logs and use them to debug possible issues (mainly for bad connections).

11. **Chantools Sweep** - advanced command used to recover funds from closed channels. [More details here](https://docs.zeusln.app/for-users/embedded-node/backup-and-recovery#chantools-sweepremoteclosed).

12. **Developer Tools** - advanced CLI commands that can be run directly in your embedded node to debug, test, obtain more information from your LND node.

13. **Speed-up transaction** - in case you were opening / closing a channel or doing a simple onchain TX and the mempool fees were spiking up, you have the option to increase the fee for your tx with this easy integrated tool.

14. **Automated Backups** - the LN node channels are automatically backed up on the Olympus server. This automated backup is encrypted with your node wallet seed (without the seed, it is totally useless). The user can also manually export a SCB (static channels backup) for a disaster recovery.

**NOTE**: In the `Backup` section you could also export your Zeus embedded node xpriv/zpriv. What is this useful for? In case you want to restore your Zeus onchain wallet into Sparrow wallet, in case of disaster (your phone was stolen or broken) or you want to extract the xpub keys for use as a watch-only wallet. This is a very useful feature for advanced users.

### Additional guides

If you want to know more about how to run Zeus embedded node and its advanced features, here are some community guides:
- [Getting started with Zeus Mobile Node](https://darth-coin.github.io/wallets/getting-started-zeus-wallet-en.html)
- [Advanced use case for Zeus Mobile Node](https://darth-coin.github.io/wallets/zeus-node-advanced-usage-en.html)
25 changes: 25 additions & 0 deletions docs/for-users/remote-connections/nwc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: NWC - Nostr Wallet Connect
---

# Connecting NWC sub-accounts from a node with ZEUS
Nostr Wallet Connect (NWC) is an open protocol to connect lightning wallets to apps.

NWC describes a way for client apps to access a remote bitcoin lightning wallet through a standardized protocol. Wallets and apps want to implement this to allow users to seamlessly connect their own wallet accounts for native payments in apps. [Read more details about NWC here](https://nwc.dev/).

![nwc-protocol](/img/nwc-protocol.png)

Now you can connect various NWC accounts from your own LN node (Alby Hub, LNbits) or custodial ones like: CoinOS.io, Cashu.me, LNwallet.app, Rizful.com etc

### Connect a NWC account

Keep in mind that NWC accounts will not provide any on-chain bitcoin address, only Lightning use.

1. Obtain from your account provider the NWC connection string. They should provide 2 types of strings: receive-only and send-receive (full access).
2. The string will be in this format: `nostr+walletconnect://ba7299......?relay=wss//relay.domain.com&[email protected]`
3. Open ZEUS app and click to top right icon or `-> Wallets -> click on top right +`
4. Click on `Wallet interface` and select `Nostr Wallet Connect`
5. In the next field `Nostr Wallet Connect URL` paste the NWC string you obtained from your account provider.
6. Put an alias name for your NWC account and optional you can add a nice avatar image.
7. Click on `SAVE WALLET CONFIG` and is all done.
8. You can add multiple NWC accounts and switch between them on-the-fly.
14 changes: 7 additions & 7 deletions docs/for-users/using-zeus/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
---

# Overview
ZEUS is an advanced app designed to give you an easy access to your Bitcoin Lightning Nodes and lndhub accounts.
ZEUS is an advanced app designed to give you easy access to your Bitcoin Lightning Nodes, NWC wallets, and lndhub accounts.

You could configure ZEUS with multiple nodes and accounts, switching between them, instantly without restarting the app.
You can configure ZEUS with multiple nodes and accounts, switching between them instantly without restarting the app.

Managing your home/office LN node from your mobile device, with ZEUS, was never so easy. In this way you could have a full control of your self-custody funds from your own node, in a private and secure way, wherever you are traveling, anytime.
Managing your home/office LN node from your mobile device with ZEUS has never been easier. This way, you can have full control of your self-custody funds from your own node, privately and securely, wherever you are, anytime.

Keep in mind that ZEUS is not just a Bitcoin Lightning wallet in itself, but an advanced app that connects to your node wallets and access the channels so you could manage it directly, remotely.
Keep in mind that ZEUS is not just a Bitcoin Lightning wallet in itself, but an advanced app that connects to your node wallets and accesses the channels so you can manage them directly and remotely.

Also another important aspect is that from your ZEUS you will have full access to all your node funds. So keep it protected with a PIN. For more privacy, when you are using it in public places, you could activate the option to hide balances.
Another important aspect is that from your ZEUS, you will have full access to all your node funds. So, keep it protected with a PIN. For more privacy when using it in public places, you can activate the option to hide balances.

Another option is to use a lndhub account, also from your own node, with LNBank (BTCpay plugin), LNBits or LNDhub accounting. In this way, you could use only a small fraction of funds (that you decide), from your own LN node liquidity. In case your device is lost or stolen, will not put in danger all the node funds (in case you don't activate the security PIN).
Another option is to use an lndhub account, also from your own node, with LNBank (BTCpay plugin), LNBits, or LNDhub accounting. This way, you can use only a small fraction of funds (that you decide) from your own LN node liquidity. If your device is lost or stolen, this will not endanger all the node funds (if you haven't activated the security PIN).

It's up to each user how to use ZEUS, you have many options, depending on each use case.
It's up to each user how to use ZEUS; you have many options, depending on your use case.
110 changes: 59 additions & 51 deletions docs/lsp/channel-differences.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,59 @@
---

---

# Channel differences and limits

Depending on how you get your channel with Olympus, you'll face different policies in terms or channel lifetime and routing fees.

### Channels open with on-chain funds

These are channels that users open to Olympus using on-chain funds that they've deposited in their wallet.

__Channel size__: 150,000 - 1,500,000 sats

__Channel lifetime__: Variable. We reserve the right to close your channel at any point. Channels with large balances pushed to our side, are more likely to be closed.

__Routing fees__:
Fee rate: 5000 ppm
Base fee: 1 sat

*NOTE*: routing fees are only applicable for the first hop out of the Olympus channel, through our node. Subsequent hops have their own routing fees.

### LSP: Just-in-time channels

These are channels that are opened to users instantly, when they create an invoice and don't have enough inbound capacity to accept the payment.

__Channel size__: 100,000 - 5,000,000 sats

__Channel lifetime__: 3 months minimum. We may choose to leave your channel open for a longer duration.

__Routing fees__: Reduced.

### LSP: Purchase in advance channels

These are channels that user can purchase by pressing the `Purchase inbound channel` button in the ZEUS app or through our [LSP web portal](https://channels.zeuslsp.com/).

__Channel size__: 100,000 - 10,000,000 sats

__Channel lifetime__: Minimum is selected by the user at time of purchase, up to 6 months. We may choose to leave your channel open for a longer duration.

__Routing fees__: Reduced.


# Total capacity

At present, users can only have a max total capacity of 10,000,000 sats across all their channels with the Olympus by ZEUS LSP node.


# I'd like to extend the lifetime of my channel. How do I do that?

As of ZEUS v0.10.0, you can extend the lifetime of a channel by going to the single channel view and pressing the `Extend channel lease` button. Learn [more about the service here](/lsp/services/lsps7).
---

---

# Channel differences and limits

Depending on how you get your channel with Olympus, you'll face different policies in terms of channel lifetime and routing fees.

### Channels open with on-chain funds

These are channels that users open to Olympus using on-chain funds they've deposited in their wallet.

__Channel size__: 150,000 - 1,500,000 sats

__Channel lifetime__: Variable. We reserve the right to close your channel at any point. Channels with large balances pushed to our side are more likely to be closed.

__Routing fees__:
Fee rate: 5,000 ppm
Base fee: 1 sat

*NOTE*: Routing fees are only applicable for the first hop out of the Olympus channel through our node. Subsequent hops have their own routing fees.

### LSP: Just-in-time channels

These are channels that are opened to users instantly when they create an invoice and don't have enough inbound capacity to accept the payment.

__Channel size__: 100,000 - 5,000,000 sats

__Channel lifetime__: Minimum 3 months. We may choose to leave your channel open for a longer duration.

__Routing fees__: Reduced.

### LSP: Purchase in advance channels

These are channels that users can purchase by pressing the `Purchase inbound channel` button in the ZEUS app or through our [LSP web portal](https://channels.zeuslsp.com/).

__Channel size__: 100,000 - 10,000,000 sats

__Channel lifetime__: The minimum is selected by the user at the time of purchase, up to 6 months. We may choose to leave your channel open for a longer duration.

__Routing fees__: Reduced.


# Total capacity

Currently, users can only have a maximum total capacity of 10,000,000 sats across all their channels with the Olympus by ZEUS LSP node.


# I'd like to extend the lifetime of my channel. How do I do that?

As of ZEUS v0.10.0, you can extend the lifetime of a channel by going to the single channel view and pressing the `Extend channel lease` button. Learn [more about the service here](/lsp/services/lsps7).

# Can I convert a standard channel into an LSP channel?

Yes, it is possible. If you opened a channel with the Olympus LSP node directly with your on-chain funds and you want to "convert" it into a leased LSP channel, you just have to go to the details of the active channel you want to convert and click on the red button saying `Purchase Channel Lease`, as in the following example.

![zeus-purchase-lease](/img/zeus-purchase-lease.jpg)

You will be asked to pay an LN invoice representing the lease cost, and once done, your channel will henceforth have all the features and advantages of an LSP channel.
6 changes: 4 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ const sidebars = {
},
collapsed: true,
items: [
"for-users/embedded-node/backup-and-recovery",
"for-users/embedded-node/lightning-onboarding",
"for-users/embedded-node/overview",
"for-users/embedded-node/privacy",
"for-users/embedded-node/lightning-onboarding",
"for-users/embedded-node/backup-and-recovery",
"for-users/embedded-node/open-channel-to-embedded-node",
"for-users/embedded-node/trusted-funding",
"for-users/embedded-node/faq",
Expand All @@ -49,6 +50,7 @@ const sidebars = {
"for-users/remote-connections/nodl",
"for-users/remote-connections/btcpay",
"for-users/remote-connections/lndhub",
"for-users/remote-connections/nwc",
],
},
{
Expand Down
Binary file added static/img/nwc-protocol.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/zeus-node-phone-meme.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/zeus-purchase-lease.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.