Retropex/bitcoin
1
0
Fork 0
mirror of https://github.com/Retropex/bitcoin.git synced 2025-08-06 06:54:49 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge #21063: wallet, rpc: update listdescriptors response format

Browse Source 
2e5f7def22 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 #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 2e5f7def22
  meshcollider:
    utACK 2e5f7def22
  jonatack:
    re-ACK 2e5f7def22

Tree-SHA512: 49bf73e46e2a61003ce594a4bfc506eb9592ccb799c2909c43a1a527490a4b4009f78dc09f3d47b4e945d3d7bb3cd2632cf48c5ace5feed5066158cc010dddc1
This commit is contained in:
fanquake 2021-04-02 12:31:17 +08:00
commit 7aa0d8adf8
No known key found for this signature in database
GPG Key ID: 2EEB9F5CC09526C1
2 changed files with 37 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/wallet/rpcdump.cpp
View File

@ -1737,22 +1737,23 @@ RPCHelpMan listdescriptors()
"listdescriptors", "listdescriptors",
"\nList descriptors imported into a descriptor-enabled wallet.", "\nList descriptors imported into a descriptor-enabled wallet.",
{}, {},
RPCResult{ RPCResult{RPCResult::Type::OBJ, "", "", {
RPCResult::Type::ARR, "", "Response is an array of descriptor objects", {RPCResult::Type::STR, "wallet_name", "Name of wallet this operation was performed on"},
{RPCResult::Type::ARR, "descriptors", "Array of descriptor objects",
{ {
{RPCResult::Type::OBJ, "", "", { {RPCResult::Type::OBJ, "", "", {
{RPCResult::Type::STR, "desc", "Descriptor string representation"}, {RPCResult::Type::STR, "desc", "Descriptor string representation"},
{RPCResult::Type::NUM, "timestamp", "The creation time of the descriptor"}, {RPCResult::Type::NUM, "timestamp", "The creation time of the descriptor"},
{RPCResult::Type::BOOL, "active", "Activeness flag"}, {RPCResult::Type::BOOL, "active", "Activeness flag"},
{RPCResult::Type::BOOL, "internal", true, "Whether this is internal or external descriptor; defined only for active descriptors"}, {RPCResult::Type::BOOL, "internal", true, "Whether this is an internal or external descriptor; defined only for active descriptors"},
{RPCResult::Type::ARR_FIXED, "range", true, "Defined only for ranged descriptors", { {RPCResult::Type::ARR_FIXED, "range", true, "Defined only for ranged descriptors", {
{RPCResult::Type::NUM, "", "Range start inclusive"}, {RPCResult::Type::NUM, "", "Range start inclusive"},
{RPCResult::Type::NUM, "", "Range end inclusive"}, {RPCResult::Type::NUM, "", "Range end inclusive"},
}}, }},
{RPCResult::Type::NUM, "next", true, "The next index to generate addresses from; defined only for ranged descriptors"}, {RPCResult::Type::NUM, "next", true, "The next index to generate addresses from; defined only for ranged descriptors"},
}}, }},
} }}
}, }},
RPCExamples{ RPCExamples{
HelpExampleCli("listdescriptors", "") + HelpExampleRpc("listdescriptors", "") HelpExampleCli("listdescriptors", "") + HelpExampleRpc("listdescriptors", "")
}, },
@ -1769,7 +1770,7 @@ RPCHelpMan listdescriptors()
LOCK(wallet->cs_wallet); LOCK(wallet->cs_wallet);
UniValue response(UniValue::VARR); UniValue descriptors(UniValue::VARR);
const auto active_spk_mans = wallet->GetActiveScriptPubKeyMans(); const auto active_spk_mans = wallet->GetActiveScriptPubKeyMans();
for (const auto& spk_man : wallet->GetAllScriptPubKeyMans()) { for (const auto& spk_man : wallet->GetAllScriptPubKeyMans()) {
const auto desc_spk_man = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man); const auto desc_spk_man = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man);
@ -1798,9 +1799,13 @@ RPCHelpMan listdescriptors()
spk.pushKV("range", range); spk.pushKV("range", range);
spk.pushKV("next", wallet_descriptor.next_index); spk.pushKV("next", wallet_descriptor.next_index);
} }
response.push_back(spk); descriptors.push_back(spk);
} }
UniValue response(UniValue::VOBJ);
response.pushKV("wallet_name", wallet->GetName());
response.pushKV("descriptors", descriptors);
return response; return response;
}, },
}; };

39
test/functional/wallet_listdescriptors.py
View File

@ -36,15 +36,16 @@ class ListDescriptorsTest(BitcoinTestFramework):
self.log.info('Test the command for empty descriptors wallet.') self.log.info('Test the command for empty descriptors wallet.')
node.createwallet(wallet_name='w2', blank=True, descriptors=True) node.createwallet(wallet_name='w2', blank=True, descriptors=True)
assert_equal(0, len(node.get_wallet_rpc('w2').listdescriptors())) assert_equal(0, len(node.get_wallet_rpc('w2').listdescriptors()['descriptors']))
self.log.info('Test the command for a default descriptors wallet.') self.log.info('Test the command for a default descriptors wallet.')
node.createwallet(wallet_name='w3', descriptors=True) node.createwallet(wallet_name='w3', descriptors=True)
result = node.get_wallet_rpc('w3').listdescriptors() result = node.get_wallet_rpc('w3').listdescriptors()
assert_equal(6, len(result)) assert_equal("w3", result['wallet_name'])
assert_equal(6, len([d for d in result if d['active']])) assert_equal(6, len(result['descriptors']))
assert_equal(3, len([d for d in result if d['internal']])) assert_equal(6, len([d for d in result['descriptors'] if d['active']]))
for item in result: assert_equal(3, len([d for d in result['descriptors'] if d['internal']]))
for item in result['descriptors']:
assert item['desc'] != '' assert item['desc'] != ''
assert item['next'] == 0 assert item['next'] == 0
assert item['range'] == [0, 0] assert item['range'] == [0, 0]
@ -59,12 +60,17 @@ class ListDescriptorsTest(BitcoinTestFramework):
'desc': descsum_create('wpkh(' + xprv + hardened_path + '/0/*)'), 'desc': descsum_create('wpkh(' + xprv + hardened_path + '/0/*)'),
'timestamp': 1296688602, 'timestamp': 1296688602,
}]) }])
expected = {'desc': descsum_create('wpkh([80002067' + hardened_path + ']' + xpub_acc + '/0/*)'), expected = {
'timestamp': 1296688602, 'wallet_name': 'w2',
'active': False, 'descriptors': [
'range': [0, 0], {'desc': descsum_create('wpkh([80002067' + hardened_path + ']' + xpub_acc + '/0/*)'),
'next': 0} 'timestamp': 1296688602,
assert_equal([expected], wallet.listdescriptors()) 'active': False,
'range': [0, 0],
'next': 0},
],
}
assert_equal(expected, wallet.listdescriptors())
self.log.info('Test non-active non-range combo descriptor') self.log.info('Test non-active non-range combo descriptor')
node.createwallet(wallet_name='w4', blank=True, descriptors=True) node.createwallet(wallet_name='w4', blank=True, descriptors=True)
@ -73,9 +79,14 @@ class ListDescriptorsTest(BitcoinTestFramework):
'desc': descsum_create('combo(' + node.get_deterministic_priv_key().key + ')'), 'desc': descsum_create('combo(' + node.get_deterministic_priv_key().key + ')'),
'timestamp': 1296688602, 'timestamp': 1296688602,
}]) }])
expected = [{'active': False, expected = {
'desc': 'combo(0227d85ba011276cf25b51df6a188b75e604b38770a462b2d0e9fb2fc839ef5d3f)#np574htj', 'wallet_name': 'w4',
'timestamp': 1296688602}] 'descriptors': [
{'active': False,
'desc': 'combo(0227d85ba011276cf25b51df6a188b75e604b38770a462b2d0e9fb2fc839ef5d3f)#np574htj',
'timestamp': 1296688602},
]
}
assert_equal(expected, wallet.listdescriptors()) assert_equal(expected, wallet.listdescriptors())