search

stakwork / sphinx-relay

Node.js wrapper for communication between sphinx client and lightning node.
MIT License
248 stars 71 forks source link

Channel opening docs improvement #637

Open fernando2h opened 1 year ago

fernando2h commented 1 year ago

I found the docs on opening channels on my node to use with the relay on https://github.com/stakwork/sphinx-relay/wiki/Home-node-FAQ a bit confusing. The consequence was that I opened a channel without pushing sats to the other side, which made it impossible for me (with my knowledge) to use sphinx chat with my own relay. I only noticed the need to use Thunderhub to push sats after the channel had already been opened on LND Lightning Node app on Umbrel.

Below my suggestion (in italics) to make the text clearer:

Is your node ready? Your node has to be in sync with the bitcoin blockchain in order to open a channel (this can be in normal or the faster neutrino mode) You have to have some bitcoin (recommend at least .001 or 100,000 satoshis)

Make sure you that you open the channel in a way that you can push sats to our side (remote balance), otherwise you won't be able to receive any sats and messages. We recommend using Thunderhub for that (see below), as LND does not allow for this.

The "push" amount to our routing node should be 2% since 1% is set aside as a channel reserve and is unusable

Now open a channel following the instructions below: You can connect to any node, but for your first channel you can link to one of ours to minimize errors:

gameb_2: 03c8dfbf829eaeb0b6dab099d87fdf7f8faceb0c1b935cd243e8c1fb5af71361cf@3.234.251.85:9735 gameb_1: 023d70f2f76d283c6c4e58109ee3a2816eb9d8feb40b23d62469060a2b2867b77f@54.159.193.149:9735

Marvel-Ib commented 1 year ago

@kevkevinpal can i tackle this issue and help to update the docs

kevkevinpal commented 1 year ago

@kevkevinpal can i tackle this issue and help to update the docs

awesome I created this bounty

https://people-test.sphinx.chat/tickets?owner_id=03bfe6723c06fb2b7546df1e8ca1a17ae5c504615da32c945425ccbe8d3ca6260d&created=1679408715

let me know if you're on sphinx and we can connect there aswell

Marvel-Ib commented 1 year ago

@kevkevinpal
updated

https://github.com/Marvel-Ib/sphinx-relay/wiki/Home-node-FAQ https://github.com/Marvel-Ib/sphinx-relay.wiki.git

this guide was helpful for me as this was my first time contributing to a wiki https://gist.github.com/larrybotha/10650410

I am not on sphinx yet, still trying to figure out the home node setup on since there is no dedicated or lite node available at the moment.

kevkevinpal commented 1 year ago

Go to https://people-test.sphinx.chat/tickets click "Post a Bounty" -> "Scan Code" -> "Connection Code" and scan with sphinx app

Marvel-Ib commented 1 year ago

Thank you. I was able to set it up and sent you a message as well.

I also wanted to confirm if the change I made to the wiki is okay or if any edits still need to be made,

https://github.com/Marvel-Ib/sphinx-relay/wiki/Home-node-FAQ https://github.com/Marvel-Ib/sphinx-relay.wiki.git

I discovered I couldn't make pull requests for wiki, so that's why this is on my page.

This article helped me understand how to go about that. https://gist.github.com/larrybotha/10650410