mirrors/Ride-The-Lightning-RTL
1
0
Fork 0
mirror of https://github.com/Ride-The-Lightning/RTL.git synced 2024-11-19 09:50:36 +01:00
Code Issues Projects Releases Wiki Activity

Help updated

Browse Source
This commit is contained in:
saubyk 2020-01-07 19:50:04 -05:00
parent 46044c5510
commit 715b2366f2
No known key found for this signature in database
GPG Key ID: 00C9E2BC2E45666F
2 changed files with 40 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.DS_Store vendored
View File

Binary file not shown.

51
src/app/shared/components/help/help.component.ts
View File

@ -24,26 +24,55 @@ export class HelpComponent implements OnInit {
ngOnInit() { ngOnInit() {
this.helpTopics.push(new HelpTopic('Getting started', 'Funding your node is the first step to get started.\n' + this.helpTopics.push(new HelpTopic('Getting started', 'Funding your node is the first step to get started.\n' +
'On the *On-chain* menu:\n' + 'Go to the *On-chain* page of the app:\n' +
'1. Generate a new address on the *Recieve* tab.\n'+ '1. Generate a new address on the *Recieve* tab.\n'+
'2. Send funds to the address.\n' + '2. Send funds to the address.\n' +
'3. Wait for the balance to be confirmed on-chain before proceeding further.\n' + '3. Wait for the balance to be confirmed on-chain before proceeding further.\n' +
'<a href="http://localhost:3000/rtl/lnd/onchain">On-Chain</a>.')); '<a href="http://localhost:3000/rtl/lnd/onchain">On-Chain page</a>'));
this.helpTopics.push(new HelpTopic('Connect with peers', 'Connecting with network peers is the next step.\n' + this.helpTopics.push(new HelpTopic('Connect with peers', 'Connecting with network peers is the next step.\n' +
'Go the *Peer/Channels* page under the *Lightning* menu :\n' + 'Go to *Peer/Channels* page under the *Lightning* menu :\n' +
'1. Get the peer pubkey and host address in the pubkey@ip:port format.\n' + '1. Get the peer pubkey and host address in the pubkey@ip:port format.\n' +
'2. On the *Peers" enter the peer address and connect.\n' + '2. On the *Peers" enter the peer address and connect.\n' +
'3. Once the peer is connected, you can open channel with the peer.\n'+ '3. Once the peer is connected, you can open channel with the peer.\n'+
'<a href="http://localhost:3000/rtl/lnd/peerschannels">Peers/Channels</a>.')); '4. A variety of actions can be performed on the connected peers page for each peer:\n'+
this.helpTopics.push(new HelpTopic('Opening Channels', 'Opening channel with the peer is the next step.\n' + ' a. View Info - View the peer details.\n' +
'Go the *Peer/Channels* page under the *Lightning* menu:\n' + ' b. Open Channel - Open channel with the peer.\n' +
'1. On the *Channels* section, select the Alias of the connected peer from the drop-down\n' + ' c. Disconnect - Disconnect from the peer.\n' +
'2. Specify the amount to commit to the channel.\n' + '<a href="http://localhost:3000/rtl/lnd/peerschannels">Peers/Channels page</a>'));
this.helpTopics.push(new HelpTopic('Opening Channels', 'Opening channel with a peer is the next step.\n' +
'Go to *Peer/Channels* page under the *Lightning* menu:\n' +
'1. On the *Channels* section, select the alias of the connected peer from the drop-down\n' +
'2. Specify the amount to commit to the channel and click on "Open Channel".\n' +
'3. There are a variety of options available while opening a channel. \n' + '3. There are a variety of options available while opening a channel. \n' +
' a. Private Channel - When this option is selected, the channel is opened privately and not broadcast. \n' + ' a. Private Channel - When this option is selected, a private channel is opened with the peer. \n' +
' b. Priority (advanced option) - Specify either Target confirmation Block or Fee in Sat/Byte. \n' + ' b. Priority (advanced option) - Specify either Target confirmation Block or Fee in Sat/Byte. \n' +
' c. Spend Unconfirmd Output (advanced option) - Allow channels to be opened with unconfirmed UTXOs.\n' + ' c. Spend Unconfirmd Output (advanced option) - Allow channels to be opened with unconfirmed UTXOs.\n' +
'<a href="http://localhost:3000/rtl/lnd/peerschannels">Peers/Channels</a>.')); '4. Track the pending open channels under the "Pending" tab . \n' +
'5. Wait for the channel to be confirmed. Only a confimed channel can be used for payments or routing. \n' +
'6. A variety of actions can be perfomed on the open channels under the "Open" tab, with the "Actions" button:\n' +
' a. View Info - View the channel details.\n' +
' b. View Remote Fee - View the fee policy on the channel of the remote peer.\n' +
' c. Update Fee Policy - Modify the fee policy on the channel.\n' +
' d. Close Channel - Close the channel.\n' +
'7. Balance Score is balancedness metric score for the channel:\n' +
' a. It helps measure how balanced the remote and local balance on a channel is.\n' +
' b. A perfectly balanced channel has a score of one, where a completely lopsided one has a score of zero.\n' +
' c. The formular for calculating the score is "1 - abs((local bal - remote bal)/total bal)".\n' +
'<a href="http://localhost:3000/rtl/lnd/peerschannels">Peers/Channels page</a>'));
this.helpTopics.push(new HelpTopic('Lightning Transactions', 'Transactions can be sent or received on confirmed channels.\n' +
'Go to "Transactions" page under the "Lightning" menu :\n' +
'1. Payments - Payments tab is for making payments via your node\n' +
' a. Input a non-expired lightning invoice (Bolt11 format) in the "Payment request" field and click on "Send Payment" to send.\n' +
' b. Advanced option # 1 - Specify a limit on the routing fee you are willing to pay for the payment.\n' +
' b. Advanced option # 2 - Specify the outgoing channel through which you want the payment to go out.\n' +
'2. Invoices - Invoices tab is for receiving payments on your node.\n' +
' a. Memo - Description you want to provide on the invoice.\n' +
' b. Expiry - The time period, after which the invoice will be invalid.\n' +
' c. Private Routing Hints - Generate an invoice with routing hints for private channels.\n' +
'3. Query Routes - Query Routes tab is for querying a potential path to a node and a routing fee estimate for a payment amount.\n'+
' a. Destination Pubkey - Pubkey of the node, you want to send the payment to.\n' +
' b. Amount - Amount in Sats, which you want to send to the node.\n' +
'<a href="http://localhost:3000/rtl/lnd/transactions">Transactions page</a>'));
} }
} }