GlcoinCore/elements
1
0
Fork 0
mirror of https://github.com/ElementsProject/elements.git synced 2026-08-13 12:33:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Adapt sendall RPC to work properly in elements.

Browse source 
This fixes errors introduced in the merge of bitcoin/bitcoin#24118 in d5b8d28d07.

Pleaae review this commit carefully.
This commit is contained in:
James Dorfman 2024-05-24 18:30:57 +00:00
parent d5b8d28d07
commit 22ccf93f29
2 changed files with 49 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/wallet/rpc/spend.cpp
View file

@ -1500,7 +1500,7 @@ RPCHelpMan sendall()
throw JSONRPCError(RPC_WALLET_ERROR, "Fee estimation failed. Fallbackfee is disabled. Wait a few blocks or enable -fallbackfee.");
}
CMutableTransaction rawTx{ConstructTransaction(options["inputs"], recipient_key_value_pairs, options["locktime"], rbf)};
CMutableTransaction rawTx{ConstructTransaction(options["inputs"], recipient_key_value_pairs, options["locktime"], rbf, pwallet->chain().getTip(), nullptr, true, true)};
LOCK(pwallet->cs_wallet);
std::vector<COutput> all_the_utxos;
@ -1517,18 +1517,18 @@ RPCHelpMan sendall()
if (!tx || pwallet->IsMine(tx->tx->vout[input.prevout.n]) != (coin_control.fAllowWatchOnly ? ISMINE_ALL : ISMINE_SPENDABLE)) {
throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Input not found. UTXO (%s:%d) is not part of wallet.", input.prevout.hash.ToString(), input.prevout.n));
}
total_input_value += tx->tx->vout[input.prevout.n].nValue;
total_input_value += tx->tx->vout[input.prevout.n].nValue.GetAmount(); // ELEMENTS FIXME: is the unblinded value always available since it's in our wallet?
}
} else {
AvailableCoins(*pwallet, all_the_utxos, &coin_control, /*nMinimumAmount=*/0);
for (const COutput& output : all_the_utxos) {
CHECK_NONFATAL(output.input_bytes > 0);
if (send_max && fee_rate.GetFee(output.input_bytes) > output.txout.nValue) {
if (send_max && fee_rate.GetFee(output.input_bytes) > output.txout.nValue.GetAmount()) { // ELEMENTS FIXME: is the unblinded value always available since it's in our wallet?
continue;
}
CTxIn input(output.outpoint.hash, output.outpoint.n, CScript(), rbf ? MAX_BIP125_RBF_SEQUENCE : CTxIn::SEQUENCE_FINAL);
rawTx.vin.push_back(input);
total_input_value += output.txout.nValue;
total_input_value += output.txout.nValue.GetAmount(); // ELEMENTS FIXME: is the unblinded value always available since it's in our wallet?
}
}
@ -1547,7 +1547,7 @@ RPCHelpMan sendall()
CAmount output_amounts_claimed{0};
for (CTxOut out : rawTx.vout) {
output_amounts_claimed += out.nValue;
output_amounts_claimed += out.nValue.GetAmount(); // ELEMENTS FIXME: is the unblinded value always available since it's in our wallet?
}
if (output_amounts_claimed > total_input_value) {
@ -1569,7 +1569,7 @@ RPCHelpMan sendall()
if (addresses_without_amount.count(addr) > 0) {
out.nValue = per_output_without_amount;
if (!gave_remaining_to_first) {
out.nValue += remainder % addresses_without_amount.size();
out.nValue.SetToAmount(out.nValue.GetAmount() + CAmount(remainder % addresses_without_amount.size())); // ELEMENTS FIXME: is it fine to call GetAmount() here? Is the unblinded value always available since it's in our wallet?
gave_remaining_to_first = true;
}
if (IsDust(out, pwallet->chain().relayDustFee())) {
@ -1584,6 +1584,12 @@ RPCHelpMan sendall()
}
}
// ELEMENTS: add explicit fee output
CTxOut feeOutput;
feeOutput.nValue = fee_from_size;
feeOutput.scriptPubKey = CScript(); // Empty scriptPubKey represents fee
rawTx.vout.push_back(feeOutput);
const bool lock_unspents{options.exists("lock_unspents") ? options["lock_unspents"].get_bool() : false};
if (lock_unspents) {
for (const CTxIn& txin : rawTx.vin) {

58
test/functional/wallet_sendall.py
View file

@ -19,9 +19,9 @@ def cleanup(func):
try:
func(self)
finally:
if 0 < self.wallet.getbalances()["mine"]["trusted"]:
if 0 < self.wallet.getbalances()["mine"]["trusted"]['bitcoin']:
self.wallet.sendall([self.remainder_target])
assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]) # wallet is empty
assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]['bitcoin']) # wallet is empty
return wrapper
class SendallTest(BitcoinTestFramework):
@ -36,17 +36,21 @@ class SendallTest(BitcoinTestFramework):
def assert_balance_swept_completely(self, tx, balance):
output_sum = sum([o["value"] for o in tx["decoded"]["vout"]])
assert_equal(output_sum, balance + tx["fee"])
assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]) # wallet is empty
assert_equal(output_sum, balance + tx["fee"]['bitcoin'])
assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]["bitcoin"]) # wallet is empty
def assert_tx_has_output(self, tx, addr, value=None):
for output in tx["decoded"]["vout"]:
if output["scriptPubKey"]["type"] == 'fee':
# ELEMENTS: explicit fee output
continue
if addr == output["scriptPubKey"]["address"] and value is None or value == output["value"]:
return
raise AssertionError("Output to {} not present or wrong amount".format(addr))
def assert_tx_has_outputs(self, tx, expected_outputs):
assert_equal(len(expected_outputs), len(tx["decoded"]["vout"]))
assert_equal(len(expected_outputs) + 1, len(tx["decoded"]["vout"])) # ELEMENTS: add 1 for explicit fee output
for eo in expected_outputs:
self.assert_tx_has_output(tx, eo["address"], eo["value"])
@ -54,19 +58,25 @@ class SendallTest(BitcoinTestFramework):
for a in amounts:
self.def_wallet.sendtoaddress(self.wallet.getnewaddress(), a)
self.generate(self.nodes[0], 1)
assert_greater_than(self.wallet.getbalances()["mine"]["trusted"], 0)
return self.wallet.getbalances()["mine"]["trusted"]
assert_greater_than(self.wallet.getbalances()["mine"]["trusted"]['bitcoin'], 0)
return self.wallet.getbalances()["mine"]["trusted"]['bitcoin']
# Helper schema for success cases
def test_sendall_success(self, sendall_args, remaining_balance = 0):
sendall_tx_receipt = self.wallet.sendall(sendall_args)
self.generate(self.nodes[0], 1)
# wallet has remaining balance (usually empty)
assert_equal(remaining_balance, self.wallet.getbalances()["mine"]["trusted"])
assert_equal(remaining_balance, self.wallet.getbalances()["mine"]["trusted"]['bitcoin'])
assert_equal(sendall_tx_receipt["complete"], True)
return self.wallet.gettransaction(txid = sendall_tx_receipt["txid"], verbose = True)
def get_fee_from_wallet_tx(self, tx_from_wallet):
for out in tx_from_wallet["vout"]:
if out["scriptPubKey"]["type"] == "fee":
return out["value"]
raise Exception("Unable find fee in tranaction: ", tx_from_wallet)
@cleanup
def gen_and_clean(self):
self.add_utxos([15, 2, 4])
@ -74,7 +84,7 @@ class SendallTest(BitcoinTestFramework):
def test_cleanup(self):
self.log.info("Test that cleanup wrapper empties wallet")
self.gen_and_clean()
assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]) # wallet is empty
assert_equal(0, self.wallet.getbalances()["mine"]["trusted"]['bitcoin']) # wallet is empty
# Actual tests
@cleanup
@ -82,10 +92,12 @@ class SendallTest(BitcoinTestFramework):
self.log.info("Testing basic sendall case without specific amounts")
pre_sendall_balance = self.add_utxos([10,11])
tx_from_wallet = self.test_sendall_success(sendall_args = [self.remainder_target])
fee = self.get_fee_from_wallet_tx(tx_from_wallet["decoded"])
self.assert_tx_has_outputs(tx = tx_from_wallet,
expected_outputs = [
{ "address": self.remainder_target, "value": pre_sendall_balance + tx_from_wallet["fee"] } # fee is neg
# ELEMENT: fee in bitcoin is negative, so add it. fee in element is positive, so subtract it
{ "address": self.remainder_target, "value": pre_sendall_balance - fee }
]
)
self.assert_balance_swept_completely(tx_from_wallet, pre_sendall_balance)
@ -95,8 +107,9 @@ class SendallTest(BitcoinTestFramework):
self.log.info("Testing sendall where two recipients have unspecified amount")
pre_sendall_balance = self.add_utxos([1, 2, 3, 15])
tx_from_wallet = self.test_sendall_success([self.remainder_target, self.split_target])
fee = self.get_fee_from_wallet_tx(tx_from_wallet["decoded"])
half = (pre_sendall_balance + tx_from_wallet["fee"]) / 2
half = (pre_sendall_balance - fee) / 2
self.assert_tx_has_outputs(tx_from_wallet,
expected_outputs = [
{ "address": self.split_target, "value": half },
@ -110,11 +123,12 @@ class SendallTest(BitcoinTestFramework):
self.log.info("Testing sendall in combination with paying specified amount to recipient")
pre_sendall_balance = self.add_utxos([8, 13])
tx_from_wallet = self.test_sendall_success([{self.recipient: 5}, self.remainder_target])
fee = self.get_fee_from_wallet_tx(tx_from_wallet["decoded"])
self.assert_tx_has_outputs(tx_from_wallet,
expected_outputs = [
{ "address": self.recipient, "value": 5 },
{ "address": self.remainder_target, "value": pre_sendall_balance - 5 + tx_from_wallet["fee"] }
{ "address": self.remainder_target, "value": pre_sendall_balance - 5 - fee }
]
)
self.assert_balance_swept_completely(tx_from_wallet, pre_sendall_balance)
@ -150,7 +164,7 @@ class SendallTest(BitcoinTestFramework):
expected_tx = self.wallet.sendall(recipients=[{self.recipient: 5}, self.remainder_target], options={"add_to_wallet": False})
tx = self.wallet.decoderawtransaction(expected_tx['hex'])
fee = 21 - sum([o["value"] for o in tx["vout"]])
fee = self.get_fee_from_wallet_tx(tx)
assert_raises_rpc_error(-6, "Assigned more value to outputs than available funds.", self.wallet.sendall,
[{self.recipient: pre_sendall_balance + 1}, self.remainder_target])
@ -170,10 +184,11 @@ class SendallTest(BitcoinTestFramework):
self.nodes[0].createwallet("dustwallet")
dust_wallet = self.nodes[0].get_wallet_rpc("dustwallet")
self.def_wallet.sendtoaddress(dust_wallet.getnewaddress(), 0.00000400)
self.def_wallet.sendtoaddress(dust_wallet.getnewaddress(), 0.00000300)
# ELEMENTS: remove a 0 from numbers (i.e. multiply by 10), because dust threshold is higher
self.def_wallet.sendtoaddress(dust_wallet.getnewaddress(), 0.0000400)
self.def_wallet.sendtoaddress(dust_wallet.getnewaddress(), 0.0000300)
self.generate(self.nodes[0], 1)
assert_greater_than(dust_wallet.getbalances()["mine"]["trusted"], 0)
assert_greater_than(dust_wallet.getbalances()["mine"]["trusted"]["bitcoin"], 0)
assert_raises_rpc_error(-6, "Total value of UTXO pool too low to pay for transaction."
+ " Try using lower feerate or excluding uneconomic UTXOs with 'send_max' option.",
@ -184,15 +199,16 @@ class SendallTest(BitcoinTestFramework):
@cleanup
def sendall_with_send_max(self):
self.log.info("Check that `send_max` option causes negative value UTXOs to be left behind")
self.add_utxos([0.00000400, 0.00000300, 1])
self.add_utxos([0.0000400, 0.0000300, 1]) # ELEMENTS: remove a 0 from numbers (i.e. multiply by 10), because dust threshold is higher
# sendall with send_max
sendall_tx_receipt = self.wallet.sendall(recipients=[self.remainder_target], fee_rate=300, options={"send_max": True})
tx_from_wallet = self.wallet.gettransaction(txid = sendall_tx_receipt["txid"], verbose = True)
fee = self.get_fee_from_wallet_tx(tx_from_wallet["decoded"])
assert_equal(len(tx_from_wallet["decoded"]["vin"]), 1)
self.assert_tx_has_outputs(tx_from_wallet, [{"address": self.remainder_target, "value": 1 + tx_from_wallet["fee"]}])
assert_equal(self.wallet.getbalances()["mine"]["trusted"], Decimal("0.00000700"))
self.assert_tx_has_outputs(tx_from_wallet, [{"address": self.remainder_target, "value": 1 - fee}])
assert_equal(self.wallet.getbalances()["mine"]["trusted"]["bitcoin"], Decimal("0.0000700"))
self.def_wallet.sendtoaddress(self.wallet.getnewaddress(), 1)
self.generate(self.nodes[0], 1)
@ -206,13 +222,13 @@ class SendallTest(BitcoinTestFramework):
sendall_tx_receipt = self.wallet.sendall(recipients=[self.remainder_target], options={"inputs": [utxo]})
tx_from_wallet = self.wallet.gettransaction(txid = sendall_tx_receipt["txid"], verbose = True)
assert_equal(len(tx_from_wallet["decoded"]["vin"]), 1)
assert_equal(len(tx_from_wallet["decoded"]["vout"]), 1)
assert_equal(len(tx_from_wallet["decoded"]["vout"]), 1 + 1) # ELEMENTS: add 1 for explicit fee output
assert_equal(tx_from_wallet["decoded"]["vin"][0]["txid"], utxo["txid"])
assert_equal(tx_from_wallet["decoded"]["vin"][0]["vout"], utxo["vout"])
self.assert_tx_has_output(tx_from_wallet, self.remainder_target)
self.generate(self.nodes[0], 1)
assert_greater_than(self.wallet.getbalances()["mine"]["trusted"], 0)
assert_greater_than(self.wallet.getbalances()["mine"]["trusted"]["bitcoin"], 0)
@cleanup
def sendall_fails_on_missing_input(self):