wallet: document importdescriptors error object fields #34867

1. 
   satsfy commented at 4:19 PM on March 19, 2026: contributor

   Related to #29912 and the machine-readable OpenRPC generated from RPCHelpMan metadata work discussed in #34683. Split out from #34764 per review feedback that this change is conceptually separate from the broader elision work there.

   The importdescriptors RPC help currently documents the optional error field using an elided JSONRPC error placeholder. This PR replaces that with explicit code and message fields.

   importdescriptors already returns a structured JSON-RPC error object in practice, so this makes the documented result schema match the existing response shape more closely.

   This PR changes importdescriptors help text, and the runtime checks on the returned json to be more strict.

2. wallet: document structured importdescriptors errors

   Replace the elided "JSONRPC error" placeholder in the
   importdescriptors RPC help with explicit "code" and "message"
   fields.
   
   This makes the documented result schema match the structured
   error object returned in practice.

   445143bfc6
3. DrahtBot added the label Wallet on Mar 19, 2026
4. 
   DrahtBot commented at 4:20 PM on March 19, 2026: contributor

   <!--e57a25ab6845829454e8d69fc972939a-->

   The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

   <!--021abf342d371248e50ceaed478a90ca-->

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   ACK	nervana21, maflcko
   Concept ACK	willcl-ark

   If your review is incorrectly listed, please copy-paste <code>&lt;!--meta-tag:bot-skip--&gt;</code> into the comment that the bot should ignore.

   <!--5faf32d7da4f0f540f40219e4f7537a3-->

5. satsfy renamed this:
   wallet: document structured importdescriptors errors
   wallet: document importdescriptors error object fields
   on Mar 19, 2026
6. 
   willcl-ark commented at 8:10 PM on March 20, 2026: member

   Concept ACK.

   Could we approve the CI in here pls?

   master:

   core/worktrees/pr-34867 on  pr-34867 [$?] via △ v4.1.2 via 🐍 v3.13.12 via ❄️  impure (nix-shell-env)
   ❯ bitcoin-cli -regtest help importdescriptors
   importdescriptors requests
   <snip>
   Result:
   [                              (json array) Response is an array with the same size as the input that has the execution result
     {                            (json object)
       "success" : true|false,    (boolean)
       "warnings" : [             (json array, optional)
         "str",                   (string)
         ...
       ],
       "error" : {                (json object, optional)
         ...                      JSONRPC error
       }
     },
     ...
   ]
   

   branch:

   core/worktrees/pr-34867 on  pr-34867 [$?] via △ v4.1.2 via 🐍 v3.13.12 via ❄️  impure (nix-shell-env)
   ❯ ./build/bin/bitcoin-cli -regtest help importdescriptors
   importdescriptors requests
   <snip>
   Result:
   [                              (json array) Response is an array with the same size as the input that has the execution result
     {                            (json object)
       "success" : true|false,    (boolean)
       "warnings" : [             (json array, optional)
         "str",                   (string)
         ...
       ],
       "error" : {                (json object, optional)
         "code" : n,              (numeric) JSONRPC error code
         "message" : "str"        (string) JSONRPC error message
       }
     },
     ...
   ]
   

7. 
   nervana21 commented at 1:52 PM on March 21, 2026: contributor

   tACK 445143bfc6705b33b66c1c4bef0e92cfd38e4102

   Local testing confirms that the downstream effects of the code changes are as expected

8. DrahtBot requested review from willcl-ark on Mar 21, 2026
9. 
   maflcko commented at 4:50 PM on March 24, 2026: member

   Ok, this is trivial to review, the error struct has nothing to do with the json rpc version:

   $ git grep --function-context 'UniValue JSONRPCError(' -- src/rpc/request.cpp
   src/rpc/request.cpp:UniValue JSONRPCError(int code, const std::string& message)
   src/rpc/request.cpp-{
   src/rpc/request.cpp-    UniValue error(UniValue::VOBJ);
   src/rpc/request.cpp-    error.pushKV("code", code);
   src/rpc/request.cpp-    error.pushKV("message", message);
   src/rpc/request.cpp-    return error;
   src/rpc/request.cpp-}
   

   lgtm ACK 445143bfc6705b33b66c1c4bef0e92cfd38e4102

10. 
    maflcko commented at 4:51 PM on March 24, 2026: member

    No behavior change. This only updates RPC help metadata.

    I don't think this is correct. This change has several behavior changes:

    • It changes the help text here.
    • It changes the runtime checks on the returned json to be more strict here.
11. 
    maflcko commented at 9:00 AM on March 30, 2026: member

    rfm with two acks, or does it need more?

12. fanquake merged this on Mar 30, 2026
13. fanquake closed this on Mar 30, 2026

    ---

Contributors

satsfyDrahtBotwillcl-arknervana21maflcko

Review Requested
willcl-ark