core-lightning/doc/lightning-signpsbt.7

.TH "LIGHTNING-SIGNPSBT" "7" "" "" "lightning-signpsbt"
.SH NAME
lightning-signpsbt - Command to sign a wallet's inputs on a provided bitcoin transaction (PSBT)\.
.SH SYNOPSIS

\fBsignpsbt\fR \fIpsbt\fR [\fIsignonly\fR]

.SH DESCRIPTION

\fBsignpsbt\fR is a low-level RPC command which signs a PSBT as defined by
BIP-174\.

.RS
.IP \[bu]
\fIpsbt\fR: A string that represents the PSBT value\.
.IP \[bu]
\fIsignonly\fR: An optional array of input numbers to sign\.

.RE

By default, all known inputs are signed, and others ignored: with
\fIsignonly\fR, only those inputs are signed, and an error is returned if
one of them cannot be signed\.


Note that the command will fail if there are no inputs to sign, or
if the inputs to be signed were not previously reserved\.

.SH EXAMPLE JSON REQUEST
.nf
.RS
{
  "id": 82,
  "method": "signpsbt",
  "params": {
    "psbt": "some_psbt"
  }
}
.RE

.fi
.SH RETURN VALUE

On success, an object is returned, containing:

.RS
.IP \[bu]
\fBsigned_psbt\fR (string): The fully signed PSBT

.RE

On failure, one of the following error codes may be returned:

.RS
.IP \[bu]
-32602: Error in given parameters, or there aren't wallet's inputs to sign, or we couldn't sign all of \fIsignonly\fR, or inputs are not reserved\.

.RE
.SH EXAMPLE JSON RESPONSE
.nf
.RS
{
    "psbt": "some_psbt"
}
.RE

.fi
.SH AUTHOR

Vincenzo Palazzo \fI<vincenzo.palazzo@protonmail.com\fR> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command\.

.SH SEE ALSO

\fBlightning-fundpsbt\fR(7), \fBlightning-sendpsbt\fR(7)

.SH RESOURCES

Main web site: \fIhttps://github.com/ElementsProject/lightning\fR

\" SHA256STAMP:e6c554936e7bf7c4937db4a1e98e47486540948505bc0b8021a33b2c805cbaf6