Skip to content

Commit

Permalink
docs: move 'sign_psbt' docs to correct section and correct reply title
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieDriver committed Mar 26, 2024
1 parent 0a2ae86 commit 1546604
Showing 1 changed file with 40 additions and 40 deletions.
80 changes: 40 additions & 40 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1425,6 +1425,46 @@ get_signature reply (sign_tx)
* 'result' will be the bytes for the signature for the corresponding input, in DER format with the sighash appended.
* 'result' will be empty, if no signature was required for this input.

.. _sign_psbt_request:

sign_psbt request
-----------------

Request to append signatures to a passed psbt, using RFC6979.

.. code-block:: cbor
{
"id": "6979",
"method": "sign_psbt",
"params": {
"network": "mainnet",
"psbt": <psbt bytes>
}
}
* Any inputs requiring signatures from this wallet (as identified by fingerprint) are generated and appended to the passed psbt.

.. _sign_psbt_reply:

sign_psbt reply
---------------

* NOTE: The reply is not sent until the user has explicitly confirmed signing on the hw.

.. code-block:: cbor
{
"id": "6979",
"seqnum": 1
"seqlen": 4
"result": <psbt bytes>
}
* NOTE: 'seqnum' and 'seqlen' indicate if the data is complete. If 'seqlen' is greater than 1, the caller will have to send 'get_extended_data' messages to fetch the complete data. See get_extended_data_request_.
* 'result' is the input psbt updated with any generated signatures.
* NOTE: if 'get_extended_data' calls are needed, the bytes payload of the messages must be concatenated to yield the complete psbt.


Blockstream Liquid specific
===========================
Expand Down Expand Up @@ -1901,46 +1941,6 @@ get_signature reply (sign_liquid_tx)
* 'result' will be the bytes for the signature for the corresponding input, in DER format with the sighash appended.
* 'result' will be empty, if no signature was required for this input.

.. _sign_psbt_request:

sign_psbt request
-----------------

Request to append signatures to a passed psbt, using RFC6979.

.. code-block:: cbor
{
"id": "6979",
"method": "sign_psbt",
"params": {
"network": "mainnet",
"psbt": <psbt bytes>
}
}
* Any inputs requiring signatures from this wallet (as identified by fingerprint) are generated and appended to the passed psbt.

.. _sign_psbt_reply:

sign_psbt
---------

* NOTE: The reply is not sent until the user has explicitly confirmed signing on the hw.

.. code-block:: cbor
{
"id": "6979",
"seqnum": 1
"seqlen": 4
"result": <psbt bytes>
}
* NOTE: 'seqnum' and 'seqlen' indicate if the data is complete. If 'seqlen' is greater than 1, the caller will have to send 'get_extended_data' messages to fetch the complete data. See get_extended_data_request_.
* 'result' is the input psbt updated with any generated signatures.
* NOTE: if 'get_extended_data' calls are needed, the bytes payload of the messages must be concatenated to yield the complete psbt.

Indices and tables
==================

Expand Down

0 comments on commit 1546604

Please sign in to comment.