docs: add show_bip85_bip39_entropy RPC documentation
What changed, and why it matters
This commit only adds documentation for an existing RPC command called show_bip85_bip39_entropy. It does not change any code, so it cannot introduce or fix a security vulnerability by itself.
No security action needed; treat as routine documentation update.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is a pure documentation change in docs/index.rst, adding 37 lines describing the show_bip85_bip39_entropy request/reply format. No source code is modified, no logic is changed, and no security boundary is altered. The documented RPC involves BIP85 entropy display with ECDH/AES encryption, but the commit itself only records that behavior.
Changed components
docs/index.rstInspect captured patch +37 / −0
diff --git a/docs/index.rst b/docs/index.rst
index 1df8c6f..f7f84f0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2195,6 +2195,43 @@ 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.
+.. _show_bip85_bip39_entropy_request:
+
+show_bip85_bip39_entropy request
+--------------------------------
+
+Request to show bip85-bip39 entropy as a qr code.
+
+.. code-block:: cbor
+
+ {
+ "id": "256",
+ "method": "show_bip85_bip39_entropy",
+ "params": {
+ "num_words": 12,
+ "index": 0,
+ "pubkey": <33 bytes>
+ }
+ }
+
+* 'num_words' the number of words the entropy is required to produce (must be 12 or 24).
+* 'index' the index to use in the bip32 path to calculate the entropy.
+* 'pubkey' the host ephemeral pubkey to use to generate a shared ecdh secret to use as an AES key to encrypt the returned entropy.
+
+.. _show_bip85_bip39_entropy_reply:
+
+show_bip85_bip39_entropy reply
+------------------------------
+
+* NOTE: The reply is not sent until the user has explicitly confirmed on the hw. It is sent once the QR code is displayed, before the user closes the QR screen.
+
+.. code-block:: cbor
+
+ {
+ "id": "256",
+ "result": true
+ }
+
Indices and tables
==================
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.