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

66 lines
2.0 KiB
Markdown
Raw Permalink 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
--------
lightningd/opening_control: allow single-arg fundchannel_complete with PSBT Requiring the user to calculate the txid of the PSBT is a horrible, bad, no-good idea. Doesn't deprecate yet, so I can test that this path works while multifundchannel still uses it. Fixes: #4416 (at least for future users!) Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `fundchannel_complete` takes a psbt parameter.
2021-03-15 04:27:56 +00:00
**fundchannel\_complete** *id* *psbt*
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
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
lightningd/opening_control: allow single-arg fundchannel_complete with PSBT Requiring the user to calculate the txid of the PSBT is a horrible, bad, no-good idea. Doesn't deprecate yet, so I can test that this path works while multifundchannel still uses it. Fixes: #4416 (at least for future users!) Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `fundchannel_complete` takes a psbt parameter.
2021-03-15 04:27:56 +00:00
*psbt* is the transaction to use for funding (does not need to be
signed but must be otherwise complete).
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
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
------------
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:33:09 +01:00
fromschema.py: escape underscores in descriptions
2022-11-11 02:03:13 +00:00
- **channel\_id** (hex): The channel\_id of the resulting channel (always 64 characters)
doc: always escape underscores in property names If there's only a single underscore, lowdown ignores it, but if there are multiple (see min_final_cltv_expiry) it decides we're trying to highlight part of the word. Reported-by: @wtogami Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:45:06 +01:00
- **commitments\_secured** (boolean): Indication that channel is safe to use (always *true*)
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 11:07:59 +01:00
doc/schemas: disableoffer, disconnect, feerates, fetchinvoice, fundchannel, fundchannel_cancel, fundchannel_complete, fundchannel_start, fundpsbt, getinfo, getlog, getroute. We also add a test for getlog, since it was never called by the testsuite. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-05-26 08:35:01 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc/manpages: replace asciidoc by markdown
2019-08-10 00:54:18 +01:00
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.
lightningd/opening_control: allow single-arg fundchannel_complete with PSBT Requiring the user to calculate the txid of the PSBT is a horrible, bad, no-good idea. Doesn't deprecate yet, so I can test that this path works while multifundchannel still uses it. Fixes: #4416 (at least for future users!) Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: JSON-RPC: `fundchannel_complete` takes a psbt parameter.
2021-03-15 04:27:56 +00:00
- 309: PSBT does not have a unique, correct output to fund the channel.
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),
df: add openchannel_abort command Allows us to clean up an in-progress open that we won't be completing Changelog-Added: EXPERIMENTAL JSON-RPC: Permit user-initiated aborting of in-progress opens. Only valid for not-yet-committed opens and RBF-attempts
2021-03-09 21:14:08 +00:00
lightning-openchannel\_signed(7), lightning-openchannel\_bump(7),
lightning-openchannel\_abort(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
tools/fromschema.py: don't try to handle more complex cases. We only handle top-level objects with an array of objects: make sure it is one before we call the routines. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2023-01-30 06:24:16 +00:00
[comment]: # ( SHA256STAMP:d264eb570b8e743cf6fbd29d78586224cf565c013d1f7682a01db53858b13467)