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

59 lines
1.7 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\_complete -- Command for completing channel establishment
===============================================================================
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
SYNOPSIS
--------
**fundchannel\_complete** *id* *txid* *txout*
DESCRIPTION
-----------
`fundchannel_complete` is a lower level RPC command. It allows a user to
doc: fix wording for fundchannel_complete
2019-08-21 09:55:49 +01:00
complete an initiated channel establishment with a connected peer.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
doc: fix wording for fundchannel_complete
2019-08-21 09:55:49 +01:00
*id* is the node id of the remote peer.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
*txid* is the hex string of the funding transaction id.
*txout* is the integer outpoint of the funding output for this channel.
doc: fix wording for fundchannel_complete
2019-08-21 09:55:49 +01:00
Note that the funding transaction MUST NOT be broadcast until after
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
channel establishment has been successfully completed, as the commitment
transactions for this channel are not secured until this command
doc: fix wording for fundchannel_complete
2019-08-21 09:55:49 +01:00
successfully completes. Broadcasting transaction before can lead to
unrecoverable loss of funds.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
RETURN VALUE
------------
On success, returns a confirmation that *commitments\_secured* and the
derived *channel\_id*.
doc: list the error codes of funding_* commands Changelog-None
2020-01-05 15:40:17 +00:00
On error the returned object will contain `code` and `message` properties,
with `code` being one of the following:
- -32602: If the given parameters are wrong.
- -1: Catchall nonspecific error.
- 305: Peer is not connected.
- 306: Unknown peer id.
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
AUTHOR
------
Lisa Neigut <<niftynei@gmail.com>> is mainly responsible.
SEE ALSO
--------
df-doc: add docs for openchannel_bump, more checks for valid psbt Add docs for openchannel_bump, plus some checks that were missed for verifying the amount is valid.
2021-03-11 04:33:47 +00:00
lightning-connect(7), lightning-fundchannel(7), lightning-multifundchannel(7),
lightning-fundchannel\_start(7), lightning-fundchannel\_cancel(7),
lightning-openchannel\_init(7), lightning-openchannel\_update(7),
lightning-openchannel\_signed(7), lightning-openchannel\_bump(7)
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
doc: force refresh of all manpages. The idea is that you regenerate the man pages in the same commit you alter them: that's how we know whether to try regenerating them or not (git doesn't store timestamps, so it can't really tell). Travis will now check this, so force them all to sync to this commit. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-25 02:33:16 +01:00