Fix calculation & display of Locked Funds

[ghost]

Fixes #5703, #5574

Scenario:

If for any reason the deposit transaction is rejected by bitcoin nodes, Bisq thinks those funds are locked in a trade. Bisq does not receive any notification about rejected transactions -- once they are broadcast via BitcoinJ they are assumed to be valid even though this may not be the case. This can happen when for example if the user's wallet is out of sync and the deposit transaction is attempting to use already spent funds. The only indication that something is wrong is that the deposit transaction never confirms (and if they look it up on a blockchain explorer the txId will not be found). At this point Bisq will erroneously show the deposit amount in "Locked Funds" on the main screen.

This can be fixed by considering funds to be locked once the deposit transaction is confirmed on the blockchain.

---

Code change:

We change one line in the method isFundsLockedIn() replacing isDepositPublished with isDepositConfirmed.

bisq/core/src/main/java/bisq/core/trade/model/bisq_v1/Trade.java

Line 921 in 851bdcf

public boolean isFundsLockedIn() {

In order to determine the possible impacts of this, here is a usage analysis of the altered method 'isFundsLockedIn'.
It is used in the following 3 locations:

Funds -> Locked Funds Tab:
TradeManager.java +769 method getTradesStreamWithFundsLockedIn
-> LockedView.java +224
-> updates the amounts shown in Funds -> Locked Funds (active trades only)

Main Screen Locked Balance:
TradeManager.java +769 method getTradesStreamWithFundsLockedIn
ClosedTradableManager.java +156 method getTradesStreamWithFundsLockedIn
FailedTradesManager.java +117 method getTradesStreamWithFundsLockedIn
-> Balances.java +123
-> sets the locked balance amount shown at the top right of the main screen

Locked Funds Popup:
ClosedTradableManager.java +156 method getTradesStreamWithFundsLockedIn
FailedTradesManager.java +117 method getTradesStreamWithFundsLockedIn
Each of the above are used in the following two use cases:
-> TradeManager.java +772 method getSetOfFailedOrClosedTradeIdsFromLockedInFunds
-> BisqSetup.java method checkForLockedUpFunds pops up a user directed warning message "you have locked up funds from a failed trade"

[chimp1984]

NACK

This will not fix it as the call checks if the state.ordinal is >= DEPOSIT_PUBLISHED so DEPOSIT_CONFIRMED is included in that as well.

You probably need to check the tx from the wallet to see if its really confirmed/available

   public boolean isDepositPublished() {
        return getTradePhase().ordinal() >= Phase.DEPOSIT_PUBLISHED.ordinal();
    }


 public enum Phase implements TradePhase {
        INIT,
        TAKER_FEE_PUBLISHED,
        DEPOSIT_PUBLISHED,
        DEPOSIT_CONFIRMED,
        FIAT_SENT,
        FIAT_RECEIVED,
        PAYOUT_PUBLISHED,
        WITHDRAWN;

[ripcurlx]

@jmacxx Did you have time already to look at @chimp1984 's remark?

[ghost]

I did test this fix while developing it. I was going to return and re-do the tests before commenting again. They do take a few hours to run and I still have a PR to finish work on before I can get to this.

[ghost]

The easiest consistent way to reproduce the locked up funds issue described in #5703, is by not signing one of the deposit transaction inputs causing it to be rejected by bitcoind. Achieve that in test commenting out TradeWalletService L645-L646.

You end up with a trade that looks ok, but its deposit tx never gets a confirm.

At that point you'll decide to do an SPV resync, reconciling BitcoinJ state with the blockchain. Upon restarting Bisq you'll encounter the following:

• Locked funds amount showing the trade deposit value.
• A popup which says the deposit tx has missing inputs.
• Red failed icons in the pending trades screen.
• Nothing shown in Funds -> Locked funds tab.

Screenshots - click to expand

Moving that trade to Failed Trades shows the dialog which says there are no locked funds, contradicting what is shown in the top right of the screen at Locked Funds display.

I re-did my testing to obtain these screenshots.

---

After the patch is applied, the Locked Funds no longer displays the fake locked amount.

confirmed deposit == locked funds.

[chimp1984]

Ah sorry my earlier comment was wrong. As we use the negation its a difference if the state is published or confirmed for that case.
Could you check what state the trade is in? Probably in pusblished state but not confirmed state...

[ghost]

Yes published, not confirmed.

[chimp1984]

utACK

[chimp1984]

Yes published, not confirmed.

Ok. From my understanding it should be ok then.

[ripcurlx]

utACK - based on #5813 (comment)

[pazza83]

Hi @jmacxx will this fix users with historic locked funds showing? Assuming they will have to do an spv resync?

[ghost]

Yes.