core-lightning/doc/lightning-signpsbt.7.md
Rusty Russell 6d1897b796 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-05 15:02:17 +02:00

1.8 KiB

lightning-signpsbt -- Command to sign a wallet's inputs on a provided bitcoin transaction (PSBT).

SYNOPSIS

signpsbt psbt [signonly]

DESCRIPTION

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

  • psbt: A string that represents the PSBT value.
  • signonly: An optional array of input numbers to sign.

By default, all known inputs are signed, and others ignored: with signonly, 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.

EXAMPLE JSON REQUEST

{
  "id": 82,
  "method": "signpsbt",
  "params": {
    "psbt": "some_psbt"
  }
}

RETURN VALUE

On success, an object is returned, containing:

  • signed_psbt (string): The fully signed PSBT

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

  • -32602: Error in given parameters, or there aren't wallet's inputs to sign, or we couldn't sign all of signonly, or inputs are not reserved.

EXAMPLE JSON RESPONSE

{
    "psbt": "some_psbt"
}

AUTHOR

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

SEE ALSO

lightning-fundpsbt(7), lightning-sendpsbt(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning comment: # ( SHA256STAMP:d306b6b0c64e9739bf6a3c6751137f23da6300c6cd8abc3fcd7ebfae9caae732)