wallet: document importdescriptors error object fields #34867

pull satsfy wants to merge 1 commits into bitcoin:master from satsfy:document-importdescriptors-error changing 1 files +2 −1
  1. satsfy commented at 4:19 pm on March 19, 2026: none

    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.

    No behavior change. This only updates RPC help metadata.

  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

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

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK nervana21
    Concept ACK willcl-ark

    If your review is incorrectly listed, please copy-paste <!–meta-tag:bot-skip–> into the comment that the bot should ignore.

  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:

     0core/worktrees/pr-34867 on  pr-34867 [$?] via △ v4.1.2 via 🐍 v3.13.12 via ❄️  impure (nix-shell-env)
     1❯ bitcoin-cli -regtest help importdescriptors
     2importdescriptors requests
     3<snip>
     4Result:
     5[                              (json array) Response is an array with the same size as the input that has the execution result
     6  {                            (json object)
     7    "success" : true|false,    (boolean)
     8    "warnings" : [             (json array, optional)
     9      "str",                   (string)
    10      ...
    11    ],
    12    "error" : {                (json object, optional)
    13      ...                      JSONRPC error
    14    }
    15  },
    16  ...
    17]
    

    branch:

     0core/worktrees/pr-34867 on  pr-34867 [$?] via △ v4.1.2 via 🐍 v3.13.12 via ❄️  impure (nix-shell-env)
     1❯ ./build/bin/bitcoin-cli -regtest help importdescriptors
     2importdescriptors requests
     3<snip>
     4Result:
     5[                              (json array) Response is an array with the same size as the input that has the execution result
     6  {                            (json object)
     7    "success" : true|false,    (boolean)
     8    "warnings" : [             (json array, optional)
     9      "str",                   (string)
    10      ...
    11    ],
    12    "error" : {                (json object, optional)
    13      "code" : n,              (numeric) JSONRPC error code
    14      "message" : "str"        (string) JSONRPC error message
    15    }
    16  },
    17  ...
    18]
    
  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

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-03-24 03:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me