From d477a8d755d869a7fbfbadf49c87ee292f3bc88a Mon Sep 17 00:00:00 2001 From: Vincenzo Palazzo Date: Sun, 16 Aug 2020 15:06:01 +0200 Subject: [PATCH] added sendpsbt documentation Signed-off-by: Vincenzo Palazzo --- doc/index.rst | 1 + doc/lightning-signpsbt.7.md | 61 +++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 doc/lightning-signpsbt.7.md diff --git a/doc/index.rst b/doc/index.rst index 7ccf5c1cd..5fde3429d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -69,6 +69,7 @@ c-lightning Documentation lightning-sendpsbt lightning-setchannelfee lightning-signmessage + lightning-signpsbt lightning-txdiscard lightning-txprepare lightning-txsend diff --git a/doc/lightning-signpsbt.7.md b/doc/lightning-signpsbt.7.md new file mode 100644 index 000000000..11faa0098 --- /dev/null +++ b/doc/lightning-signpsbt.7.md @@ -0,0 +1,61 @@ +lightning-signpsbt -- Command to sign a wallet's inputs on a provided bitcoin transaction (PSBT). +============================================================ + +SYNOPSIS +-------- + +**signpsbt** \[psbt\] + +DESCRIPTION +----------- + +The **signpsbt** is a low-level RPC command which sign a PSBT. + +- *psbt*: A string that rappresent the hexadecimal of the psbt. + +EXAMPLE JSON REQUEST +------------ +```json +{ + "id": 82, + "method": "signpsbt", + "params": { + "psbt": "some_psbt" + } +} +``` + +RETURN VALUE +------------ + +On success, a object will be return with a string that rappresent the hexadecimal value of psbt. + +- *psbt*: A string that rappresent the hexadecimal dump of the psbt. + +On failure, one of the following error codes may be returned: + +- -32602. Error in given parameters or there isn't wallet inputs to sign. + +EXAMPLE JSON RESPONSE +----- +```json +{ + "psbt": "some_psbt" +} +``` + + +AUTHOR +------ + +Vincenzo Palazzo <> 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: