2017-10-20 19:27:55 +02:00
|
|
|
#!/usr/bin/env python3
|
|
|
|
# Copyright (c) 2016 The Bitcoin Core developers
|
|
|
|
# Distributed under the MIT software license, see the accompanying
|
|
|
|
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
"""Test label RPCs.
|
|
|
|
|
|
|
|
RPCs tested are:
|
|
|
|
- getlabeladdress
|
2018-04-24 14:27:55 +02:00
|
|
|
- getaddressesbyaccount/getaddressesbylabel
|
2017-10-20 19:27:55 +02:00
|
|
|
- listaddressgroupings
|
|
|
|
- setlabel
|
|
|
|
- sendfrom (with account arguments)
|
|
|
|
- move (with account arguments)
|
2018-04-24 14:27:55 +02:00
|
|
|
|
|
|
|
Run the test twice - once using the accounts API and once using the labels API.
|
|
|
|
The accounts API test can be removed in V0.18.
|
2017-10-20 19:27:55 +02:00
|
|
|
"""
|
2016-03-21 16:55:02 +01:00
|
|
|
from collections import defaultdict
|
2017-10-20 19:27:55 +02:00
|
|
|
|
|
|
|
from test_framework.test_framework import BitcoinTestFramework
|
2018-04-24 14:27:55 +02:00
|
|
|
from test_framework.util import assert_equal, assert_raises_rpc_error
|
2017-10-20 19:27:55 +02:00
|
|
|
|
|
|
|
class WalletLabelsTest(BitcoinTestFramework):
|
|
|
|
def set_test_params(self):
|
|
|
|
self.setup_clean_chain = True
|
2018-04-24 14:27:55 +02:00
|
|
|
self.num_nodes = 2
|
|
|
|
self.extra_args = [['-deprecatedrpc=accounts', "-paytxfee=0.0001"], ["-paytxfee=0.0001"]]
|
2017-10-20 19:27:55 +02:00
|
|
|
|
|
|
|
def run_test(self):
|
2018-04-24 14:27:55 +02:00
|
|
|
"""Run the test twice - once using the accounts API and once using the labels API."""
|
|
|
|
self.log.info("Test accounts API")
|
|
|
|
self.nodes[0].setnetworkactive(False)
|
|
|
|
self._run_subtest(True, self.nodes[0])
|
|
|
|
self.log.info("Test labels API")
|
|
|
|
self._run_subtest(False, self.nodes[1])
|
|
|
|
|
|
|
|
def _run_subtest(self, accounts_api, node):
|
2017-10-20 19:27:55 +02:00
|
|
|
# Check that there's no UTXO on any of the nodes
|
|
|
|
assert_equal(len(node.listunspent()), 0)
|
|
|
|
|
|
|
|
# Note each time we call generate, all generated coins go into
|
|
|
|
# the same address, so we call twice to get two addresses w/500 each
|
|
|
|
node.generate(1)
|
|
|
|
node.generate(101)
|
|
|
|
assert_equal(node.getbalance(), 1000)
|
|
|
|
|
|
|
|
# there should be 2 address groups
|
|
|
|
# each with 1 address with a balance of 500 Dash
|
|
|
|
address_groups = node.listaddressgroupings()
|
|
|
|
assert_equal(len(address_groups), 2)
|
|
|
|
# the addresses aren't linked now, but will be after we send to the
|
|
|
|
# common address
|
|
|
|
linked_addresses = set()
|
|
|
|
for address_group in address_groups:
|
|
|
|
assert_equal(len(address_group), 1)
|
|
|
|
assert_equal(len(address_group[0]), 2)
|
|
|
|
assert_equal(address_group[0][1], 500)
|
|
|
|
linked_addresses.add(address_group[0][0])
|
|
|
|
|
|
|
|
# send 500 from each address to a third address not in this wallet
|
|
|
|
# There's some fee that will come back to us when the miner reward
|
|
|
|
# matures.
|
|
|
|
common_address = "yd5KMREs3GLMe6mTJYr3YrH1juwNwrFCfB"
|
|
|
|
txid = node.sendmany(
|
|
|
|
fromaccount="",
|
|
|
|
amounts={common_address: 1000},
|
|
|
|
minconf=1,
|
|
|
|
addlocked=False,
|
|
|
|
comment="",
|
|
|
|
subtractfeefrom=[common_address],
|
|
|
|
)
|
|
|
|
tx_details = node.gettransaction(txid)
|
|
|
|
fee = -tx_details['details'][0]['fee']
|
|
|
|
# there should be 1 address group, with the previously
|
|
|
|
# unlinked addresses now linked (they both have 0 balance)
|
|
|
|
address_groups = node.listaddressgroupings()
|
|
|
|
assert_equal(len(address_groups), 1)
|
|
|
|
assert_equal(len(address_groups[0]), 2)
|
|
|
|
assert_equal(set([a[0] for a in address_groups[0]]), linked_addresses)
|
|
|
|
assert_equal([a[1] for a in address_groups[0]], [0, 0])
|
|
|
|
|
|
|
|
node.generate(1)
|
|
|
|
|
|
|
|
# we want to reset so that the "" label has what's expected.
|
|
|
|
# otherwise we're off by exactly the fee amount as that's mined
|
|
|
|
# and matures in the next 100 blocks
|
|
|
|
node.sendfrom("", common_address, fee)
|
|
|
|
amount_to_send = 1.0
|
|
|
|
|
|
|
|
# Create labels and make sure subsequent label API calls
|
|
|
|
# recognize the label/address associations.
|
2018-04-24 14:27:55 +02:00
|
|
|
labels = [Label(name, accounts_api) for name in ("a", "b", "c", "d", "e")]
|
2017-10-20 19:27:55 +02:00
|
|
|
for label in labels:
|
2016-03-21 16:55:02 +01:00
|
|
|
label.add_receive_address(node.getlabeladdress(label=label.name, force=True))
|
2017-10-20 19:27:55 +02:00
|
|
|
label.verify(node)
|
|
|
|
|
2016-03-21 16:55:02 +01:00
|
|
|
# Check all labels are returned by listlabels.
|
|
|
|
assert_equal(node.listlabels(), [label.name for label in labels])
|
|
|
|
|
2017-10-20 19:27:55 +02:00
|
|
|
# Send a transaction to each label, and make sure this forces
|
|
|
|
# getlabeladdress to generate a new receiving address.
|
|
|
|
for label in labels:
|
|
|
|
node.sendtoaddress(label.receive_address, amount_to_send)
|
|
|
|
label.add_receive_address(node.getlabeladdress(label.name))
|
|
|
|
label.verify(node)
|
|
|
|
|
|
|
|
# Check the amounts received.
|
|
|
|
node.generate(1)
|
|
|
|
for label in labels:
|
|
|
|
assert_equal(
|
|
|
|
node.getreceivedbyaddress(label.addresses[0]), amount_to_send)
|
|
|
|
assert_equal(node.getreceivedbylabel(label.name), amount_to_send)
|
|
|
|
|
|
|
|
# Check that sendfrom label reduces listaccounts balances.
|
|
|
|
for i, label in enumerate(labels):
|
2018-04-24 14:27:55 +02:00
|
|
|
to_label = labels[(i + 1) % len(labels)]
|
2017-10-20 19:27:55 +02:00
|
|
|
node.sendfrom(label.name, to_label.receive_address, amount_to_send)
|
|
|
|
node.generate(1)
|
|
|
|
for label in labels:
|
|
|
|
label.add_receive_address(node.getlabeladdress(label.name))
|
|
|
|
label.verify(node)
|
|
|
|
assert_equal(node.getreceivedbylabel(label.name), 2)
|
2018-04-24 14:27:55 +02:00
|
|
|
if accounts_api:
|
|
|
|
node.move(label.name, "", node.getbalance(label.name))
|
2017-10-20 19:27:55 +02:00
|
|
|
label.verify(node)
|
|
|
|
node.generate(101)
|
|
|
|
expected_account_balances = {"": 52000}
|
|
|
|
for label in labels:
|
|
|
|
expected_account_balances[label.name] = 0
|
2018-04-24 14:27:55 +02:00
|
|
|
if accounts_api:
|
|
|
|
assert_equal(node.listaccounts(), expected_account_balances)
|
|
|
|
assert_equal(node.getbalance(""), 52000)
|
2017-10-20 19:27:55 +02:00
|
|
|
|
|
|
|
# Check that setlabel can assign a label to a new unused address.
|
|
|
|
for label in labels:
|
2016-03-21 16:55:02 +01:00
|
|
|
address = node.getlabeladdress(label="", force=True)
|
2017-10-20 19:27:55 +02:00
|
|
|
node.setlabel(address, label.name)
|
|
|
|
label.add_address(address)
|
|
|
|
label.verify(node)
|
2018-04-24 14:27:55 +02:00
|
|
|
if accounts_api:
|
|
|
|
assert(address not in node.getaddressesbyaccount(""))
|
|
|
|
else:
|
|
|
|
assert_raises_rpc_error(-11, "No addresses with label", node.getaddressesbylabel, "")
|
2017-10-20 19:27:55 +02:00
|
|
|
|
|
|
|
# Check that addmultisigaddress can assign labels.
|
|
|
|
for label in labels:
|
|
|
|
addresses = []
|
|
|
|
for x in range(10):
|
|
|
|
addresses.append(node.getnewaddress())
|
|
|
|
multisig_address = node.addmultisigaddress(5, addresses, label.name)['address']
|
|
|
|
label.add_address(multisig_address)
|
2016-03-21 16:55:02 +01:00
|
|
|
label.purpose[multisig_address] = "send"
|
2017-10-20 19:27:55 +02:00
|
|
|
label.verify(node)
|
|
|
|
node.sendfrom("", multisig_address, 50)
|
|
|
|
node.generate(101)
|
2018-04-24 14:27:55 +02:00
|
|
|
if accounts_api:
|
|
|
|
for label in labels:
|
|
|
|
assert_equal(node.getbalance(label.name), 50)
|
2017-10-20 19:27:55 +02:00
|
|
|
|
|
|
|
# Check that setlabel can change the label of an address from a
|
|
|
|
# different label.
|
|
|
|
change_label(node, labels[0].addresses[0], labels[0], labels[1])
|
|
|
|
|
|
|
|
# Check that setlabel can change the label of an address which
|
|
|
|
# is the receiving address of a different label.
|
|
|
|
change_label(node, labels[0].receive_address, labels[0], labels[1])
|
|
|
|
|
|
|
|
# Check that setlabel can set the label of an address already
|
|
|
|
# in the label. This is a no-op.
|
|
|
|
change_label(node, labels[2].addresses[0], labels[2], labels[2])
|
|
|
|
|
|
|
|
# Check that setlabel can set the label of an address which is
|
2016-03-21 16:55:02 +01:00
|
|
|
# already the receiving address of the label. This is a no-op.
|
2017-10-20 19:27:55 +02:00
|
|
|
change_label(node, labels[2].receive_address, labels[2], labels[2])
|
|
|
|
|
|
|
|
class Label:
|
2018-04-24 14:27:55 +02:00
|
|
|
def __init__(self, name, accounts_api):
|
2017-10-20 19:27:55 +02:00
|
|
|
# Label name
|
|
|
|
self.name = name
|
2018-04-24 14:27:55 +02:00
|
|
|
self.accounts_api = accounts_api
|
2017-10-20 19:27:55 +02:00
|
|
|
# Current receiving address associated with this label.
|
|
|
|
self.receive_address = None
|
|
|
|
# List of all addresses assigned with this label
|
|
|
|
self.addresses = []
|
2016-03-21 16:55:02 +01:00
|
|
|
# Map of address to address purpose
|
|
|
|
self.purpose = defaultdict(lambda: "receive")
|
2017-10-20 19:27:55 +02:00
|
|
|
|
|
|
|
def add_address(self, address):
|
|
|
|
assert_equal(address not in self.addresses, True)
|
|
|
|
self.addresses.append(address)
|
|
|
|
|
|
|
|
def add_receive_address(self, address):
|
|
|
|
self.add_address(address)
|
|
|
|
self.receive_address = address
|
|
|
|
|
|
|
|
def verify(self, node):
|
|
|
|
if self.receive_address is not None:
|
|
|
|
assert self.receive_address in self.addresses
|
|
|
|
assert_equal(node.getlabeladdress(self.name), self.receive_address)
|
|
|
|
|
|
|
|
for address in self.addresses:
|
2016-03-21 16:55:02 +01:00
|
|
|
assert_equal(
|
|
|
|
node.getaddressinfo(address)['labels'][0],
|
|
|
|
{"name": self.name,
|
|
|
|
"purpose": self.purpose[address]})
|
2018-04-24 14:27:55 +02:00
|
|
|
if self.accounts_api:
|
|
|
|
assert_equal(node.getaccount(address), self.name)
|
|
|
|
else:
|
|
|
|
assert_equal(node.getaddressinfo(address)['label'], self.name)
|
2017-10-20 19:27:55 +02:00
|
|
|
|
2016-03-21 16:55:02 +01:00
|
|
|
assert_equal(
|
|
|
|
node.getaddressesbylabel(self.name),
|
|
|
|
{address: {"purpose": self.purpose[address]} for address in self.addresses})
|
2018-04-24 14:27:55 +02:00
|
|
|
if self.accounts_api:
|
|
|
|
assert_equal(set(node.getaddressesbyaccount(self.name)), set(self.addresses))
|
2017-10-20 19:27:55 +02:00
|
|
|
|
|
|
|
|
|
|
|
def change_label(node, address, old_label, new_label):
|
|
|
|
assert_equal(address in old_label.addresses, True)
|
|
|
|
node.setlabel(address, new_label.name)
|
|
|
|
|
|
|
|
old_label.addresses.remove(address)
|
|
|
|
new_label.add_address(address)
|
|
|
|
|
|
|
|
# Calling setlabel on an address which was previously the receiving
|
|
|
|
# address of a different label should reset the receiving address of
|
|
|
|
# the old label, causing getlabeladdress to return a brand new
|
|
|
|
# address.
|
2016-03-21 16:55:02 +01:00
|
|
|
if old_label.name != new_label.name and address == old_label.receive_address:
|
2017-10-20 19:27:55 +02:00
|
|
|
new_address = node.getlabeladdress(old_label.name)
|
|
|
|
assert_equal(new_address not in old_label.addresses, True)
|
|
|
|
assert_equal(new_address not in new_label.addresses, True)
|
|
|
|
old_label.add_receive_address(new_address)
|
|
|
|
|
|
|
|
old_label.verify(node)
|
|
|
|
new_label.verify(node)
|
|
|
|
|
|
|
|
|
|
|
|
if __name__ == '__main__':
|
|
|
|
WalletLabelsTest().main()
|