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

87 lines
2.9 KiB
Groff
Raw Normal View History

doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.TH "LIGHTNING-FUNDCHANNEL_START" "7" "" "" "lightning-fundchannel_start"
.SH NAME
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: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH SYNOPSIS
funding: enable push_msat it's that time of year (merry xmas!) enables the ability to push_msat on fundchannel Changelog-Added: RPC: `fundchannel` and `fundchannel_start` can now accept an optional parameter, `push_msat`, which will gift that amount of satoshis to the peer at channel open.
2019-12-21 05:53:12 +00:00
\fBfundchannel_start\fR \fIid\fR \fIamount\fR [\fIfeerate\fR \fIannounce\fR \fIclose_to\fR \fIpush_msat\fR]
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH DESCRIPTION
\fBfundchannel_start\fR is a lower level RPC command\. It allows a user to
initiate channel establishment with a connected peer\.
\fIid\fR 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
\fIamount\fR is the satoshi value that the channel will be funded at\. This
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
value MUST be accurate, otherwise the negotiated commitment transactions
will not encompass the correct channel value\.
\fIfeerate\fR is an optional field\. Sets the feerate for subsequent
doc: feerate is not obvious, refer to fundchannel documentation: It has a whole *two paragraphs* on it: *feerate* is an optional feerate used for the opening transaction and as initial feerate for commitment and HTLC transactions. It can be one of the strings *urgent* (aim for next block), *normal* (next 4 blocks or so) or *slow* (next 100 blocks or so) to use lightningd’s internal estimates: *normal* is the default. Otherwise, *feerate* is a number, with an optional suffix: *perkw* means the number is interpreted as satoshi-per-kilosipa (weight), and *perkb* means it is interpreted bitcoind-style as satoshi-per-kilobyte. Omitting the suffix is equivalent to *perkb*. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-12-04 01:33:19 +00:00
commitment transactions: see \fBfundchannel\fR\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
doc: fix wording for fundchannel_complete
2019-08-21 09:55:49 +01:00
\fIannounce\fR whether or not to announce this channel\.
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
funding: add RPC arg to specify a 'close_to' address Takes advantage of upfront-shutdown-script to permit users to specify the close-to address for a channel at open, by adding a `close_to` field to `fundchannel_start`. Note that this only is in effect if `fundchannel_start` returns with `close_to` set -- otherwise, peer doesn't support `option_upfront_shutdown_script`.
2019-10-15 02:08:33 +01:00
\fIclose_to\fR is a Bitcoin address to which the channel funds should be sent to
on close\. Only valid if both peers have negotiated \fBoption_upfront_shutdown_script\fR\.
Returns \fBclose_to\fR set to closing script iff is negotiated\.
funding: enable push_msat it's that time of year (merry xmas!) enables the ability to push_msat on fundchannel Changelog-Added: RPC: `fundchannel` and `fundchannel_start` can now accept an optional parameter, `push_msat`, which will gift that amount of satoshis to the peer at channel open.
2019-12-21 05:53:12 +00:00
\fIpush_msat\fR is the amount of millisatoshis to push to the channel peer at
open\. Note that this is a gift to the peer -- these satoshis are
added to the initial balance of the peer at channel start and are largely
unrecoverable once pushed\.
funding: add RPC arg to specify a 'close_to' address Takes advantage of upfront-shutdown-script to permit users to specify the close-to address for a channel at open, by adding a `close_to` field to `fundchannel_start`. Note that this only is in effect if `fundchannel_start` returns with `close_to` set -- otherwise, peer doesn't support `option_upfront_shutdown_script`.
2019-10-15 02:08:33 +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
channel establishment has been successfully completed by running
\fBfundchannel_complete\fR, as the commitment transactions for this channel
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
are not secured until the complete command succeeds\. Broadcasting
doc: fix wording for fundchannel_complete
2019-08-21 09:55:49 +01:00
transaction before that can lead to unrecoverable loss of funds\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH 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 \fIfunding_address\fR and the \fIscriptpubkey\fR for the channel funding output\.
funding: add RPC arg to specify a 'close_to' address Takes advantage of upfront-shutdown-script to permit users to specify the close-to address for a channel at open, by adding a `close_to` field to `fundchannel_start`. Note that this only is in effect if `fundchannel_start` returns with `close_to` set -- otherwise, peer doesn't support `option_upfront_shutdown_script`.
2019-10-15 02:08:33 +01:00
If a \fBclose_to\fR address was provided, will close to this address iff the \fBclose_to\fR address is
returned in the response\. Otherwise, the peer does not support \fBoption_upfront_shutdownscript\fR\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +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 \fBcode\fR and \fBmessage\fR properties,
with \fBcode\fR being one of the following:
.RS
.IP \[bu]
-32602: If the given parameters are wrong\.
.IP \[bu]
-1: Catchall nonspecific error\.
.IP \[bu]
300: The amount exceeded the maximum configured funding amount\.
.IP \[bu]
301: The provided \fBpush_msat\fR is greater than the provided \fBamount\fR\.
.IP \[bu]
304: Still syncing with bitcoin network
.IP \[bu]
305: Peer is not connected\.
.IP \[bu]
306: Unknown peer id\.
.RE
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH AUTHOR
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
Lisa Neigut \fI<niftynei@gmail.com\fR> is mainly responsible\.
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
.SH SEE ALSO
\fBlightning-connect\fR(7), \fBlightning-fundchannel\fR(7),
lightning-fundchannel_\fBcomplete\fR(7), lightning-fundchannel_\fBcancel\fR(7)
.SH RESOURCES
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
Main web site: \fIhttps://github.com/ElementsProject/lightning\fR
doc/manpages: regenerate manpages using markdown templates
2019-08-10 01:12:44 +01:00
doc, wiregen: use SHA256 stamps instead of git versions. This should be more robust in future: we SHA256 all of the deps. For wiregen we prefix with EXPERIMENTAL_FEATURES, since it can effect them. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2020-08-31 02:13:23 +01:00
\" SHA256STAMP:8921d89eeebc02d2350608096a8dd0b4108c17f795f1369cdb43bd74d7fb4630