refactor: interfaces, make 'createTransaction' less error-prone #807

furszy · 2024-03-22T12:55:51Z

Bundle all function's outputs inside the util::Result returned object.

Removals:

The input-output 'change_pos' ref arg from createTransaction, which has been a source of bugs in the past.
The 'fee' ref arg from createTransaction, which is currently only set when the transaction creation process succeeds.
The currently unreachable AmountWithFeeExceedsBalance error (more info about its re-introduction at wallet: re-activate "AmountWithFeeExceedsBalance" error bitcoin/bitcoin#25269).

Additionally, this PR moves the CreatedTransactionResult struct into its own file. This change is made to avoid further expanding the GUI dependencies on wallet.h. Structurally, the GUI should only access the model/interfaces and never the wallet directly.

DrahtBot · 2024-03-22T12:55:54Z

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

Reviews

See the guideline for information on the review process.

Type	Reviewers
Concept ACK	ryanofsky, hebasto, vasild
Stale ACK	pablomartin4btc

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#bitcoin/bitcoin/26732 ([WIP] wallet: tx creation, don't select outputs from txes that are being replaced by furszy)
#bitcoin/bitcoin/25722 (refactor: Use util::Result class for wallet loading by ryanofsky)

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.

DrahtBot · 2024-03-22T13:09:39Z

🚧 At least one of the CI tasks failed. Make sure to run all tests locally, according to the
documentation.

Possibly this is due to a silent merge conflict (the changes in this pull request being
incompatible with the current code in the target branch). If so, make sure to rebase on the latest
commit of the target branch.

Leave a comment here, if you need help tracking down a confusing failure.

_{Debug: https://github.com/bitcoin-core/gui/runs/22979285609}

pablomartin4btc

tACK dfbd145

This PR solves the error described in #805, even #806 fixes other 2 related errors.

wallet/interfaces.cpp:289:57: runtime error: implicit conversion from type 'int' of value -1 (32-bit, signed) to type 'unsigned int' changed the value to 4294967295 (32-bit, unsigned)

I agree with the reasoning behind the removal of some arguments and the unreachable exception.

Out of curiosity, could you please add some refs on "The input-output 'change_pos' ref arg from createTransaction, which has been a source of bugs in the past.", if possible?

Are there other components/ functions that you think could be moved into the new util_spend.h file (perhaps as a follow-up)?

furszy

Out of curiosity, could you please add some refs on "The input-output 'change_pos' ref arg from createTransaction, which has been a source of bugs in the past.", if possible?

Sure, bitcoin/bitcoin#29065.

Are there other components/ functions that you think could be moved into the new util_spend.h file (perhaps as a follow-up)?

Not off the top of my head. Matter of continue breaking the GUI classes dependency on wallet.h.

src/interfaces/wallet.h

pablomartin4btc

cr ACK dfbd145

furszy

Rebased after #806 merge.

hebasto · 2024-05-12T13:58:47Z

While introducing a new wallet/util_spend.h header, it seems reasonable to address all related IWYU warnings, no?

hebasto · 2024-05-12T13:59:11Z

cc @achow101 @ryanofsky

src/wallet/util_spend.h

furszy

updated per feedback. Thanks @ryanofsky!

DrahtBot · 2024-05-16T21:22:56Z

🚧 At least one of the CI tasks failed. Make sure to run all tests locally, according to the
documentation.

Possibly this is due to a silent merge conflict (the changes in this pull request being
incompatible with the current code in the target branch). If so, make sure to rebase on the latest
commit of the target branch.

Leave a comment here, if you need help tracking down a confusing failure.

_{Debug: https://github.com/bitcoin-core/gui/runs/25073685372}

pablomartin4btc

re-ACK 4d941b5

Changes from my last review: CreatedTransactionResult struct moved as suggested by @ryanofsky explaining reasoning behind the convention. I like the idea of keeping the namespace, not only for consistency but for clarity and making the code more readable. I think it would be good to document this somewhere, perhaps in the developer notes to begin with (?).

nit: on 2nd. commit (95aaaa4), you forgot to remove the change from the makefile as it's not longer needed.

furszy · 2024-05-17T01:40:54Z

nit: on 2nd. commit (95aaaa4), you forgot to remove the change from the makefile as it's not longer needed.

Removed. Thanks.

furszy · 2024-05-17T14:00:36Z

CI failure is unrelated.

ryanofsky

Concept ACK edc3f9a, but this has some changes I like and other changes I don't think are good. Left a more detailed comment below.

ryanofsky · 2024-05-17T18:16:59Z

src/qt/walletmodel.cpp

-        {
-            if(!fSubtractFeeFromAmount && (total + nFeeRequired) > nBalance)
-            {
-                return SendCoinsReturn(AmountWithFeeExceedsBalance);


In commit "gui: remove unreachable AmountWithFeeExceedsBalance error" (355199c)

This is a nice catch noticing that this code doesn't work. But I think the fact that it doesn't work is a pretty unfortunate problem, and the current PR will make fixing it harder.

It seems like bitcoin/bitcoin#20640 unintentionally introduced a bug where the more accurate error message "The total exceeds your balance when the %1 transaction fee is included" can never trigger, and instead only less informative "Insufficient funds" or "The amount exceeds your balance" errors will be shown.

It looks like there are few ways this could be fixed:

An easy way to fix it would be to restore the CAmount& fee output parameter removed by #20640 so it is always returned and this code can work the way it was originally intended.

A slightly more complicated but cleaner fix would be to use CreatedTransactionResult as a return type instead of util::Result<CreatedTransactionResult> and add a bilingual_str error field to CreatedTransactionResult so fee information and an error string can be returned together.

Another alternative fix could be to build on bitcoin/bitcoin#25665 and keep using util::Result, but return the fee in the new util::Result failure field.

And the best but probably most complicated fix would be to remove error message code from the GUI and instead generate detailed error messages in wallet code. This would require bigger changes in the GUI code and might require changing the interface to provide the wallet with more information about transactions.

Against that background, I think this PR (as of edc3f9a) makes some nice cleanups, but I don't like the current changes because I think they make all of the fixes above except maybe the last one harder to implement.

So I don't think I would ACK this PR currently, I'd happily ACK it if it either (1) fixed the problem, maybe using one of the easier fixes suggested above, or (2) did not fix the problem, but at least did not make it harder to fix in the future. This could be implemented by keeping most of the changes in the PR, but not deleting this GUI code in this commit and not deleting the CAmount& fee output parameter from the wallet interface after this commit.

ryanofsky · 2024-05-17T18:37:53Z

I just noticed bitcoin/bitcoin#25269, which I hadn't seen when I posted my comment above. It looks like that PR was closed for inactivity but it does look like a good approach that solves the issue I didn't like in my comment. (Though maybe that PR is still a slight regression because it doesn't include the amount of the fee in the error message.) I wonder if you'd consider reopening that PR and maybe including the changes in this PR there, or basing this PR on that one?

Or if you no longer think that PR is worth pursuing, I think you could separate the cleanups here from the issue that PR was trying to address by leaving the CAmount& fee output parameter and GUI code intact here, but still doing the other cleanups.

…error This was previously implemented at the GUI level but has been broken since #20640

Since #20640, the 'createTransaction' does no longer retrieve the fee if the process fails due to insufficient funds. But, since #25269, 'createTransaction' retrieves an error message indicating that the total transaction amount exceeds the wallet available balance when fees are included. So this enum is no longer needed.

So it can be used by external modules without requiring wallet.h dependency.

Bundle all function's outputs inside the util::Result returned object. Reasons for the refactoring: - The 'change_pos' ref argument has been a source of bugs in the past. - The 'fee' ref argument is currently only set when the transaction creation process succeeds.

furszy

Thanks for the review ryanofsky!

I just noticed bitcoin/bitcoin#25269, which I hadn't seen when I posted my comment above. It looks like that PR was closed for inactivity but it does look like a good approach that solves the issue I didn't like in my comment. (Though maybe that PR is still a slight regression because it doesn't include the amount of the fee in the error message.) I wonder if you'd consider reopening that PR and maybe including the changes in this PR there, or basing this PR on that one?

Yeah sure, I closed it for lack of movement after 6 months.
I just reopen it, reworking part of it, and rebased this one on top. I think it make sense to re-introduce the functionality there and cleanup the GUI code here.

hebasto · 2024-07-15T15:35:09Z

Concept ACK.

Additionally, this PR moves the CreatedTransactionResult struct into its own file.

This part of the PR description seems no longer relevant.

Thanks for the review ryanofsky!

I just noticed bitcoin/bitcoin#25269, which I hadn't seen when I posted my comment above. It looks like that PR was closed for inactivity but it does look like a good approach that solves the issue I didn't like in my comment. (Though maybe that PR is still a slight regression because it doesn't include the amount of the fee in the error message.) I wonder if you'd consider reopening that PR and maybe including the changes in this PR there, or basing this PR on that one?

Yeah sure, I closed it for lack of movement after 6 months. I just reopen it, reworking part of it, and rebased this one on top. I think it make sense to re-introduce the functionality there and cleanup the GUI code here.

I agree on focusing this PR on the code cleanup only.

furszy · 2024-07-15T19:25:04Z

Drafted until bitcoin/bitcoin#25269 gets merged. This is a continuation of that work.

vasild · 2024-07-22T12:53:31Z

Concept ACK

furszy mentioned this pull request Mar 22, 2024

implicit-integer-sign-change wallet/interfaces.cpp:289:57 #805

Closed

1 task

furszy force-pushed the 2024_gui_clean_createTransaction branch from a44999c to dfbd145 Compare March 22, 2024 13:09

DrahtBot added the CI failed label Mar 22, 2024

DrahtBot mentioned this pull request Mar 22, 2024

refactor: Misc int sign change fixes #806

Merged

DrahtBot removed the CI failed label Mar 22, 2024

DrahtBot mentioned this pull request Mar 22, 2024

refactor: Use util::Result class for wallet loading bitcoin/bitcoin#25722

Draft

pablomartin4btc reviewed Apr 2, 2024

View reviewed changes

furszy commented Apr 2, 2024

View reviewed changes

pablomartin4btc reviewed Apr 2, 2024

View reviewed changes

src/interfaces/wallet.h Outdated Show resolved Hide resolved

pablomartin4btc approved these changes Apr 2, 2024

View reviewed changes

DrahtBot added the Needs rebase label Apr 18, 2024

furszy force-pushed the 2024_gui_clean_createTransaction branch from dfbd145 to 7fb81d2 Compare April 18, 2024 11:47

furszy commented Apr 18, 2024

View reviewed changes

DrahtBot removed the Needs rebase label Apr 18, 2024

ryanofsky reviewed May 13, 2024

View reviewed changes

src/wallet/util_spend.h Outdated Show resolved Hide resolved

furszy force-pushed the 2024_gui_clean_createTransaction branch from 7fb81d2 to 4d941b5 Compare May 16, 2024 21:00

furszy commented May 16, 2024

View reviewed changes

DrahtBot added the CI failed label May 16, 2024

pablomartin4btc reviewed May 16, 2024

View reviewed changes

furszy force-pushed the 2024_gui_clean_createTransaction branch from 4d941b5 to edc3f9a Compare May 17, 2024 01:40

ryanofsky reviewed May 17, 2024

View reviewed changes

wallet: introduce "tx amount exceeds balance when fees are included" …

900e5ed

…error This was previously implemented at the GUI level but has been broken since #20640

furszy added 3 commits May 22, 2024 11:12

refactor: move CreatedTransactionResult to types.h

9cd8462

So it can be used by external modules without requiring wallet.h dependency.

furszy force-pushed the 2024_gui_clean_createTransaction branch from edc3f9a to 0b92ee2 Compare May 22, 2024 14:13

furszy commented May 22, 2024

View reviewed changes

DrahtBot mentioned this pull request May 24, 2024

[WIP] wallet: tx creation, don't select outputs from txes that are being replaced bitcoin/bitcoin#26732

Draft

furszy marked this pull request as draft July 15, 2024 19:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: interfaces, make 'createTransaction' less error-prone #807

refactor: interfaces, make 'createTransaction' less error-prone #807

furszy commented Mar 22, 2024

DrahtBot commented Mar 22, 2024 •

edited

Loading

DrahtBot commented Mar 22, 2024

pablomartin4btc left a comment

furszy left a comment

pablomartin4btc left a comment

furszy left a comment

hebasto commented May 12, 2024

hebasto commented May 12, 2024

furszy left a comment

DrahtBot commented May 16, 2024

pablomartin4btc left a comment

furszy commented May 17, 2024

furszy commented May 17, 2024

ryanofsky left a comment

ryanofsky May 17, 2024 •

edited

Loading

ryanofsky commented May 17, 2024 •

edited

Loading

furszy left a comment

hebasto commented Jul 15, 2024

furszy commented Jul 15, 2024

vasild commented Jul 22, 2024

refactor: interfaces, make 'createTransaction' less error-prone #807

Are you sure you want to change the base?

refactor: interfaces, make 'createTransaction' less error-prone #807

Conversation

furszy commented Mar 22, 2024

DrahtBot commented Mar 22, 2024 • edited Loading

Reviews

Conflicts

DrahtBot commented Mar 22, 2024

pablomartin4btc left a comment

Choose a reason for hiding this comment

furszy left a comment

Choose a reason for hiding this comment

pablomartin4btc left a comment

Choose a reason for hiding this comment

furszy left a comment

Choose a reason for hiding this comment

hebasto commented May 12, 2024

hebasto commented May 12, 2024

furszy left a comment

Choose a reason for hiding this comment

DrahtBot commented May 16, 2024

pablomartin4btc left a comment

Choose a reason for hiding this comment

furszy commented May 17, 2024

furszy commented May 17, 2024

ryanofsky left a comment

Choose a reason for hiding this comment

ryanofsky May 17, 2024 • edited Loading

Choose a reason for hiding this comment

ryanofsky commented May 17, 2024 • edited Loading

furszy left a comment

Choose a reason for hiding this comment

hebasto commented Jul 15, 2024

furszy commented Jul 15, 2024

vasild commented Jul 22, 2024

DrahtBot commented Mar 22, 2024 •

edited

Loading

ryanofsky May 17, 2024 •

edited

Loading

ryanofsky commented May 17, 2024 •

edited

Loading