From 0df31e9c249179dfc4d8989accdd9acae32b6adf Mon Sep 17 00:00:00 2001
From: saubyk <39208279+saubyk@users.noreply.github.com>
Date: Tue, 7 Jan 2020 21:53:25 -0500
Subject: [PATCH] Help updates
---
.../shared/components/help/help.component.ts | 54 +++++++++++--------
1 file changed, 32 insertions(+), 22 deletions(-)
diff --git a/src/app/shared/components/help/help.component.ts b/src/app/shared/components/help/help.component.ts
index 04a76a57..ec74e444 100644
--- a/src/app/shared/components/help/help.component.ts
+++ b/src/app/shared/components/help/help.component.ts
@@ -24,24 +24,25 @@ export class HelpComponent implements OnInit {
ngOnInit() {
this.helpTopics.push(new HelpTopic('Getting started', 'Funding your node is the first step to get started.\n' +
- 'Go to the *On-chain* page of the app:\n' +
- '1. Generate a new address on the *Recieve* tab.\n'+
+ 'Go to the "On-chain" page of the app:\n' +
+ '1. Generate a new address on the "Recieve" tab.\n'+
'2. Send funds to the address.\n' +
'3. Wait for the balance to be confirmed on-chain before proceeding further.\n' +
+ '3. Connecting with network peers and opening channels is next.\n' +
'On-Chain page'));
- this.helpTopics.push(new HelpTopic('Connect with peers', 'Connecting with network peers is the next step.\n' +
- 'Go to *Peer/Channels* page under the *Lightning* menu :\n' +
+ this.helpTopics.push(new HelpTopic('Connect with peers', 'Connect with network peers to open channels with them.\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' +
- '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'+
'4. A variety of actions can be performed on the connected peers page for each peer:\n'+
' a. View Info - View the peer details.\n' +
' b. Open Channel - Open channel with the peer.\n' +
' c. Disconnect - Disconnect from the peer.\n' +
'Peers/Channels page'));
- 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' +
+ this.helpTopics.push(new HelpTopic('Opening Channels', 'Open channels with a connected network peer.\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' +
' a. Private Channel - When this option is selected, a private channel is opened with the peer. \n' +
@@ -49,29 +50,38 @@ export class HelpComponent implements OnInit {
' c. Spend Unconfirmd Output (advanced option) - Allow channels to be opened with unconfirmed UTXOs.\n' +
'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' +
+ 'Peers/Channels page'));
+ this.helpTopics.push(new HelpTopic('Channel Management', 'Channel maintenance and balance score.\n' +
+ 'Go to "Peer/Channels" page under the "Lightning" menu:\n' +
+ '1. 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' +
+ '2. 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' +
'Peers/Channels page'));
- this.helpTopics.push(new HelpTopic('Lightning Transactions', 'Transactions can be sent or received on confirmed channels.\n' +
+ this.helpTopics.push(new HelpTopic('Lightning Transactions - Payments', 'Sending Payments from your node.\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' +
+ 'Payments - Payments tab is for making payments via your node\n' +
+ ' 1. Input a non-expired lightning invoice (Bolt11 format) in the "Payment request" field and click on "Send Payment" to send.\n' +
+ ' 2. Advanced option # 1 - Specify a limit on the routing fee you are willing to pay for the payment.\n' +
+ ' 3. Advanced option # 2 - Specify the outgoing channel through which you want the payment to go out.\n' +
+ 'Transactions page'));
+ this.helpTopics.push(new HelpTopic('Lightning Transactions - Invoices', 'Receiving Payments on your node.\n' +
+ 'Go to "Transactions" page under the "Lightning" menu :\n' +
+ 'Invoices - Invoices tab is for receiving payments on your node.\n' +
+ ' 1. Memo - Description you want to provide on the invoice.\n' +
+ ' 2. Expiry - The time period, after which the invoice will be invalid.\n' +
+ ' 3. Private Routing Hints - Generate an invoice with routing hints for private channels.\n' +
+ 'Transactions page'));
+ this.helpTopics.push(new HelpTopic('Lightning Transactions - Query Route', 'Querying Payment Routes.\n' +
+ 'Go to "Transactions" page under the "Lightning" menu :\n' +
+ 'Query Routes - Query Routes tab is for querying a potential path to a node and a routing fee estimate for a payment amount.\n'+
+ ' 1. Destination Pubkey - Pubkey of the node, you want to send the payment to.\n' +
+ ' 2. Amount - Amount in Sats, which you want to send to the node.\n' +
'Transactions page'));
}