Skip to content

Commit 86e0a33

Browse files
author
MarcoFalke
committed
Merge #14653: rpcwallet: Add missing transaction categories to rpc helptexts
f3f6dde Test coinbase category in wallet rpcs (andrewtoth) e982f0b Add all category options to wallet rpc help (andrewtoth) Pull request description: The current helptext for `listtransactions`, `listsinceblock` and `gettransaction` only list two of the five possible options for `category`. This incorrectly implies that these are the only two options, and can cause problems if the other three options aren't accounted for. Also, some of the documentation is incorrect when specifying which options are returned for which categories. This PR updates the helptext for these RPCs and adds a functional regression test for the cases when the other three categories are returned. Tree-SHA512: 67dd7ff6269a3b0f17f5d1a61b0ae1fb1f3778f05e1c440bfbb9b3a005c9c6d740abcace20f3d597cf2bd6779c494448690f13fab0bd2340f206213bc7890b51
2 parents cb52cee + f3f6dde commit 86e0a33

File tree

3 files changed

+87
-12
lines changed

3 files changed

+87
-12
lines changed

‎src/wallet/rpcwallet.cpp

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1397,9 +1397,14 @@ UniValue listtransactions(const JSONRPCRequest& request)
13971397
"[\n"
13981398
" {\n"
13991399
" \"address\":\"address\", (string) The bitcoin address of the transaction.\n"
1400-
" \"category\":\"send|receive\", (string) The transaction category.\n"
1400+
" \"category\": (string) The transaction category.\n"
1401+
" \"send\" Transactions sent.\n"
1402+
" \"receive\" Non-coinbase transactions received.\n"
1403+
" \"generate\" Coinbase transactions received with more than 100 confirmations.\n"
1404+
" \"immature\" Coinbase transactions received with 100 or fewer confirmations.\n"
1405+
" \"orphan\" Orphaned coinbase transactions received.\n"
14011406
" \"amount\": x.xxx, (numeric) The amount in " + CURRENCY_UNIT + ". This is negative for the 'send' category, and is positive\n"
1402-
" for the 'receive' category,\n"
1407+
" for all other categories\n"
14031408
" \"label\": \"label\", (string) A comment for the address/transaction, if any\n"
14041409
" \"vout\": n, (numeric) the vout value\n"
14051410
" \"fee\": x.xxx, (numeric) The amount of the fee in " + CURRENCY_UNIT + ". This is negative and only available for the \n"
@@ -1526,20 +1531,25 @@ static UniValue listsinceblock(const JSONRPCRequest& request)
15261531
"\nResult:\n"
15271532
"{\n"
15281533
" \"transactions\": [\n"
1529-
" \"address\":\"address\", (string) The bitcoin address of the transaction. Not present for move transactions (category = move).\n"
1530-
" \"category\":\"send|receive\", (string) The transaction category. 'send' has negative amounts, 'receive' has positive amounts.\n"
1531-
" \"amount\": x.xxx, (numeric) The amount in " + CURRENCY_UNIT + ". This is negative for the 'send' category, and for the 'move' category for moves \n"
1532-
" outbound. It is positive for the 'receive' category, and for the 'move' category for inbound funds.\n"
1534+
" \"address\":\"address\", (string) The bitcoin address of the transaction.\n"
1535+
" \"category\": (string) The transaction category.\n"
1536+
" \"send\" Transactions sent.\n"
1537+
" \"receive\" Non-coinbase transactions received.\n"
1538+
" \"generate\" Coinbase transactions received with more than 100 confirmations.\n"
1539+
" \"immature\" Coinbase transactions received with 100 or fewer confirmations.\n"
1540+
" \"orphan\" Orphaned coinbase transactions received.\n"
1541+
" \"amount\": x.xxx, (numeric) The amount in " + CURRENCY_UNIT + ". This is negative for the 'send' category, and is positive\n"
1542+
" for all other categories\n"
15331543
" \"vout\" : n, (numeric) the vout value\n"
15341544
" \"fee\": x.xxx, (numeric) The amount of the fee in " + CURRENCY_UNIT + ". This is negative and only available for the 'send' category of transactions.\n"
1535-
" \"confirmations\": n, (numeric) The number of confirmations for the transaction. Available for 'send' and 'receive' category of transactions.\n"
1545+
" \"confirmations\": n, (numeric) The number of confirmations for the transaction.\n"
15361546
" When it's < 0, it means the transaction conflicted that many blocks ago.\n"
1537-
" \"blockhash\": \"hashvalue\", (string) The block hash containing the transaction. Available for 'send' and 'receive' category of transactions.\n"
1538-
" \"blockindex\": n, (numeric) The index of the transaction in the block that includes it. Available for 'send' and 'receive' category of transactions.\n"
1547+
" \"blockhash\": \"hashvalue\", (string) The block hash containing the transaction.\n"
1548+
" \"blockindex\": n, (numeric) The index of the transaction in the block that includes it.\n"
15391549
" \"blocktime\": xxx, (numeric) The block time in seconds since epoch (1 Jan 1970 GMT).\n"
1540-
" \"txid\": \"transactionid\", (string) The transaction id. Available for 'send' and 'receive' category of transactions.\n"
1550+
" \"txid\": \"transactionid\", (string) The transaction id.\n"
15411551
" \"time\": xxx, (numeric) The transaction time in seconds since epoch (Jan 1 1970 GMT).\n"
1542-
" \"timereceived\": xxx, (numeric) The time received in seconds since epoch (Jan 1 1970 GMT). Available for 'send' and 'receive' category of transactions.\n"
1552+
" \"timereceived\": xxx, (numeric) The time received in seconds since epoch (Jan 1 1970 GMT).\n"
15431553
" \"bip125-replaceable\": \"yes|no|unknown\", (string) Whether this transaction could be replaced due to BIP125 (replace-by-fee);\n"
15441554
" may be unknown for unconfirmed transactions not in the mempool\n"
15451555
" \"abandoned\": xxx, (bool) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions.\n"
@@ -1677,7 +1687,12 @@ static UniValue gettransaction(const JSONRPCRequest& request)
16771687
" \"details\" : [\n"
16781688
" {\n"
16791689
" \"address\" : \"address\", (string) The bitcoin address involved in the transaction\n"
1680-
" \"category\" : \"send|receive\", (string) The category, either 'send' or 'receive'\n"
1690+
" \"category\" : (string) The transaction category.\n"
1691+
" \"send\" Transactions sent.\n"
1692+
" \"receive\" Non-coinbase transactions received.\n"
1693+
" \"generate\" Coinbase transactions received with more than 100 confirmations.\n"
1694+
" \"immature\" Coinbase transactions received with 100 or fewer confirmations.\n"
1695+
" \"orphan\" Orphaned coinbase transactions received.\n"
16811696
" \"amount\" : x.xxx, (numeric) The amount in " + CURRENCY_UNIT + "\n"
16821697
" \"label\" : \"label\", (string) A comment for the address/transaction, if any\n"
16831698
" \"vout\" : n, (numeric) the vout value\n"

‎test/functional/test_runner.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,7 @@
176176
'rpc_getblockstats.py',
177177
'p2p_fingerprint.py',
178178
'feature_uacomment.py',
179+
'wallet_coinbase_category.py',
179180
'feature_filelock.py',
180181
'p2p_unrequested_blocks.py',
181182
'feature_includeconf.py',

‎test/functional/wallet_coinbase_category.py

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
#!/usr/bin/env python3
2+
# Copyright (c) 2014-2018 The Bitcoin Core developers
3+
# Distributed under the MIT software license, see the accompanying
4+
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5+
"""Test coinbase transactions return the correct categories.
6+
7+
Tests listtransactions, listsinceblock, and gettransaction.
8+
"""
9+
10+
from test_framework.test_framework import BitcoinTestFramework
11+
from test_framework.util import (
12+
assert_array_result
13+
)
14+
15+
class CoinbaseCategoryTest(BitcoinTestFramework):
16+
def set_test_params(self):
17+
self.num_nodes = 1
18+
19+
def skip_test_if_missing_module(self):
20+
self.skip_if_no_wallet()
21+
22+
def assert_category(self, category, address, txid, skip):
23+
assert_array_result(self.nodes[0].listtransactions(skip=skip),
24+
{"address": address},
25+
{"category": category})
26+
assert_array_result(self.nodes[0].listsinceblock()["transactions"],
27+
{"address": address},
28+
{"category": category})
29+
assert_array_result(self.nodes[0].gettransaction(txid)["details"],
30+
{"address": address},
31+
{"category": category})
32+
33+
def run_test(self):
34+
# Generate one block to an address
35+
address = self.nodes[0].getnewaddress()
36+
self.nodes[0].generatetoaddress(1, address)
37+
hash = self.nodes[0].getbestblockhash()
38+
txid = self.nodes[0].getblock(hash)["tx"][0]
39+
40+
# Coinbase transaction is immature after 1 confirmation
41+
self.assert_category("immature", address, txid, 0)
42+
43+
# Mine another 99 blocks on top
44+
self.nodes[0].generate(99)
45+
# Coinbase transaction is still immature after 100 confirmations
46+
self.assert_category("immature", address, txid, 99)
47+
48+
# Mine one more block
49+
self.nodes[0].generate(1)
50+
# Coinbase transaction is now matured, so category is "generate"
51+
self.assert_category("generate", address, txid, 100)
52+
53+
# Orphan block that paid to address
54+
self.nodes[0].invalidateblock(hash)
55+
# Coinbase transaction is now orphaned
56+
self.assert_category("orphan", address, txid, 100)
57+
58+
if __name__ == '__main__':
59+
CoinbaseCategoryTest().main()

0 commit comments

Comments
 (0)