vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-fundchannel_start...

54 lines
1.6 KiB
Markdown
Raw Normal View History

docs: Update manpages to be recognized correctly by mrkd mrkd started enforcing the `name -- short description` style of top-level headings somewhere, and was thus failing to build the man-pages. I swapped the title and with the existing short description to make it work again. `mrkd` will automatically infer the section from the filename so no need to put it in the title as well. In addition I removed the "last updated" lines at the bottom since they are out of date at best, and misleading at the worst. If we want to keep them, I'd suggest generating them from the commit that last touched them.
2019-08-31 13:30:56 +01:00
lightning-fundchannel\_start -- Command for initiating channel establishment for a lightning channel
====================================================================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
doc: Use `amount` as the parameter name for `fundchannel`
2019-09-19 08:51:07 +01:00
**fundchannel\_start** *id* *amount* \[*feerate* *announce*\]
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
DESCRIPTION
-----------
`fundchannel_start` is a lower level RPC command. It allows a user to
initiate channel establishment with a connected peer.
*id* is the node id of the remote peer.
doc: Use `amount` as the parameter name for `fundchannel`
2019-09-19 08:51:07 +01:00
*amount* is the satoshi value that the channel will be funded at. This
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
value MUST be accurate, otherwise the negotiated commitment transactions
will not encompass the correct channel value.
*feerate* is an optional field. Sets the feerate for subsequent
commitment transactions.
doc: fix wording for fundchannel_complete
2019-08-21 09:55:49 +01:00
*announce* whether or not to announce this channel.
Note that the funding transaction MUST NOT be broadcast until after
channel establishment has been successfully completed by running
`fundchannel_complete`, as the commitment transactions for this channel
are not secured until the complete command succeeds. Broadcasting
transaction before that can lead to unrecoverable loss of funds.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
RETURN VALUE
------------
rpc: have fundchannel_start also return scriptpubkey Easier to pass it back than dig it out of the address, since we have it. Needed for extracting fundchannel
2019-08-28 04:33:55 +01:00
On success, returns the *funding\_address* and the *scriptpubkey* for the channel funding output.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
On failure, returns an error.
AUTHOR
------
Lisa Neigut <<niftynei@gmail.com>> is mainly responsible.
SEE ALSO
--------
lightning-connect(7), lightning-fundchannel(7),
lightning-fundchannel\_complete(7), lightning-fundchannel\_cancel(7)
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>