wallet, rpc: update listdescriptors response format #21063

S3RK · 2021-02-02T08:36:46Z

Update listdescriptors response format according to RPC interface guidelines.

This is a follow up for #20226

Before:

Result:
[                               (json array) Response is an array of descriptor objects
  {                             (json object)
    "desc" : "str",             (string) Descriptor string representation
    "timestamp" : n,            (numeric) The creation time of the descriptor
    "active" : true|false,      (boolean) Activeness flag
    "internal" : true|false,    (boolean, optional) Whether this is internal or external descriptor; defined only for active descriptors
    "range" : [                 (json array, optional) Defined only for ranged descriptors
      n,                        (numeric) Range start inclusive
      n                         (numeric) Range end inclusive
    ],
    "next" : n                  (numeric, optional) The next index to generate addresses from; defined only for ranged descriptors
  },
  ...
]

After:

Result:
{                                 (json object)
  "wallet_name" : "str",          (string) Name of wallet this operation was performed on
  "descriptors" : [               (json array) Array of descriptor objects
    {                             (json object)
      "desc" : "str",             (string) Descriptor string representation
      "timestamp" : n,            (numeric) The creation time of the descriptor
      "active" : true|false,      (boolean) Activeness flag
      "internal" : true|false,    (boolean, optional) Whether this is internal or external descriptor; defined only for active descriptors
      "range" : [                 (json array, optional) Defined only for ranged descriptors
        n,                        (numeric) Range start inclusive
        n                         (numeric) Range end inclusive
      ],
      "next" : n                  (numeric, optional) The next index to generate addresses from; defined only for ranged descriptors
    },
    ...
  ]
}

meshcollider

utACK 6c6803c

src/wallet/rpcdump.cpp

S3RK · 2021-02-09T07:45:36Z

Fixed typo

jonatack · 2021-02-10T10:38:42Z

Tested ACK 94fe31e

achow101 · 2021-02-20T18:21:23Z

Code Review ACK 94fe31e

luke-jr · 2021-02-24T01:25:48Z

I'm not sure it makes sense to return the wallet_name here... And the "prefer an Object result" advice (I assume this is trying to satisfy) doesn't seem like it should be applicable to list* methods.

Don't really care to argue against it if others disagree tho.

Concept ~0

DrahtBot · 2021-03-02T12:15:36Z

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

Conflicts

Reviewers, this pull request conflicts with the following ones:

wallet, rpc: add an option to list private descriptors #21500 (wallet, rpc: add an option to list private descriptors by S3RK)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

meshcollider

This requires rebase after a69c3b3 (#21277) due to changes in wallet_listdescriptors.py

meshcollider

utACK 2e5f7de

fanquake · 2021-04-01T09:03:44Z

Concept ACK. @achow101 @jonatack want to take another look here?

achow101 · 2021-04-01T16:59:39Z

re-ACK 2e5f7de

jonatack

re-ACK 2e5f7de

new help

listdescriptors

List descriptors imported into a descriptor-enabled wallet.
Result:
{                                 (json object)
  "wallet_name" : "str",          (string) Name of wallet this operation was performed on
  "descriptors" : [               (json array) Array of descriptor objects
    {                             (json object)
      "desc" : "str",             (string) Descriptor string representation
      "timestamp" : n,            (numeric) The creation time of the descriptor
      "active" : true|false,      (boolean) Activeness flag
      "internal" : true|false,    (boolean, optional) Whether this is an internal or external descriptor; defined only for active descriptors
      "range" : [                 (json array, optional) Defined only for ranged descriptors
        n,                        (numeric) Range start inclusive
        n                         (numeric) Range end inclusive
      ],
      "next" : n                  (numeric, optional) The next index to generate addresses from; defined only for ranged descriptors
    },
    ...
  ]
}

2e5f7de wallet, rpc: update listdescriptors response format (Ivan Metlushko) Pull request description: Update `listdescriptors` response format according to [RPC interface guidelines](https://github.com/bitcoin/bitcoin/blob/master/doc/developer-notes.md#rpc-interface-guidelines). This is a follow up for bitcoin#20226 **Before:** ``` Result: [ (json array) Response is an array of descriptor objects { (json object) "desc" : "str", (string) Descriptor string representation "timestamp" : n, (numeric) The creation time of the descriptor "active" : true|false, (boolean) Activeness flag "internal" : true|false, (boolean, optional) Whether this is internal or external descriptor; defined only for active descriptors "range" : [ (json array, optional) Defined only for ranged descriptors n, (numeric) Range start inclusive n (numeric) Range end inclusive ], "next" : n (numeric, optional) The next index to generate addresses from; defined only for ranged descriptors }, ... ] ``` **After:** ``` Result: { (json object) "wallet_name" : "str", (string) Name of wallet this operation was performed on "descriptors" : [ (json array) Array of descriptor objects { (json object) "desc" : "str", (string) Descriptor string representation "timestamp" : n, (numeric) The creation time of the descriptor "active" : true|false, (boolean) Activeness flag "internal" : true|false, (boolean, optional) Whether this is internal or external descriptor; defined only for active descriptors "range" : [ (json array, optional) Defined only for ranged descriptors n, (numeric) Range start inclusive n (numeric) Range end inclusive ], "next" : n (numeric, optional) The next index to generate addresses from; defined only for ranged descriptors }, ... ] } ``` ACKs for top commit: achow101: re-ACK 2e5f7de meshcollider: utACK 2e5f7de jonatack: re-ACK 2e5f7de Tree-SHA512: 49bf73e46e2a61003ce594a4bfc506eb9592ccb799c2909c43a1a527490a4b4009f78dc09f3d47b4e945d3d7bb3cd2632cf48c5ace5feed5066158cc010dddc1

S3RK mentioned this pull request Feb 2, 2021

wallet, rpc: add listdescriptors command #20226

Merged

fanquake added the Wallet label Feb 2, 2021

S3RK mentioned this pull request Feb 2, 2021

Add release notes for listdescriptors RPC #21049

Merged

meshcollider reviewed Feb 2, 2021

View reviewed changes

jonatack reviewed Feb 2, 2021

View reviewed changes

src/wallet/rpcdump.cpp Show resolved Hide resolved

S3RK force-pushed the listdescriptors_format branch from 6c6803c to 94fe31e Compare February 9, 2021 07:44

fanquake requested a review from meshcollider February 21, 2021 02:33

DrahtBot mentioned this pull request Mar 2, 2021

rpc: replace wallet raw pointers with references (#18592 rebased) #21331

Merged

meshcollider reviewed Mar 8, 2021

View reviewed changes

wallet, rpc: update listdescriptors response format

2e5f7de

S3RK force-pushed the listdescriptors_format branch from 94fe31e to 2e5f7de Compare March 9, 2021 08:04

meshcollider reviewed Mar 11, 2021

View reviewed changes

S3RK mentioned this pull request Mar 22, 2021

wallet, rpc: add an option to list private descriptors #21500

Merged

jonatack reviewed Apr 1, 2021

View reviewed changes

fanquake merged commit 7aa0d8a into bitcoin:master Apr 2, 2021

bitcoin locked as resolved and limited conversation to collaborators Aug 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

wallet, rpc: update listdescriptors response format #21063

wallet, rpc: update listdescriptors response format #21063

Uh oh!

S3RK commented Feb 2, 2021 •

edited

Loading

Uh oh!

meshcollider left a comment •

edited

Loading

Uh oh!

Uh oh!

S3RK commented Feb 9, 2021

Uh oh!

jonatack commented Feb 10, 2021

Uh oh!

achow101 commented Feb 20, 2021

Uh oh!

luke-jr commented Feb 24, 2021

Uh oh!

DrahtBot commented Mar 2, 2021 •

edited

Loading

Uh oh!

meshcollider left a comment •

edited

Loading

Uh oh!

meshcollider left a comment

Uh oh!

fanquake commented Apr 1, 2021

Uh oh!

achow101 commented Apr 1, 2021

Uh oh!

jonatack left a comment

Uh oh!

Uh oh!

wallet, rpc: update listdescriptors response format #21063

wallet, rpc: update listdescriptors response format #21063

Uh oh!

Conversation

S3RK commented Feb 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

meshcollider left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

S3RK commented Feb 9, 2021

Uh oh!

jonatack commented Feb 10, 2021

Uh oh!

achow101 commented Feb 20, 2021

Uh oh!

luke-jr commented Feb 24, 2021

Uh oh!

DrahtBot commented Mar 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Conflicts

Uh oh!

meshcollider left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

meshcollider left a comment

Choose a reason for hiding this comment

Uh oh!

fanquake commented Apr 1, 2021

Uh oh!

achow101 commented Apr 1, 2021

Uh oh!

jonatack left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

S3RK commented Feb 2, 2021 •

edited

Loading

meshcollider left a comment •

edited

Loading

DrahtBot commented Mar 2, 2021 •

edited

Loading

meshcollider left a comment •

edited

Loading