mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-12-28 01:24:42 +01:00
Code Issues Projects Releases Wiki Activity
008a59b004
core-lightning/doc/lightning-openchannel_signed.7.md

70 lines
2.1 KiB
Markdown
Raw Normal View History

df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
lightning-openchannel\_signed -- Command to conclude a channel open
===================================================================
SYNOPSIS
--------
df-open: use channel_id for openchannel_update and openchannel_signed Be as specific as possible is a good rule for things, I think
2020-09-17 22:28:46 +02:00
**openchannel_signed** *channel_id* *signed_psbt*
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
DESCRIPTION
-----------
`openchannel_signed` is a low level RPC command which concludes a channel
open with the specified peer. It uses the v2 openchannel protocol, which
allows for interactive transaction construction.
This command should be called after `openchannel_update` returns
*commitments_secured* `true`.
This command will broadcast the finalized funding transaction,
if we receive valid signatures from the peer.
df-open: use channel_id for openchannel_update and openchannel_signed Be as specific as possible is a good rule for things, I think
2020-09-17 22:28:46 +02:00
*channel_id* is the id of the channel.
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
*signed_psbt* is the PSBT returned from `openchannel_update` (where
*commitments_secured* was true) with partial signatures or finalized
witness stacks included for every input that we contributed to the
PSBT.
RETURN VALUE
------------
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
- **channel_id** (hex): the channel id of the channel (always 64 characters)
- **tx** (hex): the funding transaction
- **txid** (txid): The txid of the **tx**
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 12:07:59 +02:00
doc: schemas for everything else. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
2021-06-16 03:10:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02: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.
- 303: Funding transaction broadcast failed.
df-doc: update error codes, make sure they're correct
2021-03-11 05:32:48 +01:00
- 305: Peer is not connected.
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
- 309: PSBT missing required fields.
df-open: use channel_id for openchannel_update and openchannel_signed Be as specific as possible is a good rule for things, I think
2020-09-17 22:28:46 +02:00
- 311: Unknown channel id.
df-doc: update error codes, make sure they're correct
2021-03-11 05:32:48 +01:00
- 312: Channel in an invalid state
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
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 05:33:47 +01:00
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 22:14:08 +01:00
lightning-openchannel\_abort(7), lightning-openchannel\_bump(7),
lightning-fundchannel\_start(7), lightning-fundchannel\_complete(7),
lightning-fundchannel(7), lightning-fundpsbt(7),
lightning-utxopsbt(7), lightning-multifundchannel(7)
df-open: commands to update a PSBT or submit a signed PSBT `openchannel_signed` and `openchannel_update` which allow a user to continue a openchannel or kick off the completion of a openchannel. `openchannel_update` should be called until it returns with `commitments_secured`.
2020-09-10 21:43:40 +02:00
AUTHOR
------
@niftynei <<niftynei@gmail.com>> is mainly responsible.
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
make-schema: don't include tools/fromschema.py in SHASUMS We were including the entire list of prerequisites when generating a shastamp, which for schemas includes the `tools/fromschema.py` doc. This meant all of our shasums were updating anytime this tool file changed. Instead, we just include the first prerequisite. See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables
2022-07-13 17:45:39 +02:00
[comment]: # ( SHA256STAMP:304d819b092e1d9ce7b4cd8ef08ecdd7952b454fed59e908ab1af02b50e9a0b0)
Reference in New Issue Copy Permalink