fix(legacy-swap): taker failed spend maker payment marked as failed #2199

laruh · 2024-08-26T12:11:57Z

related to #2175 (comment)

To fix issue where taker doesnt wait for maker payment spend tx was confirmed we added two new events:

"MakerPaymentSpendConfirmed": successful event, which goes after "MakerPaymentSpent"
Note: MakerPaymentSpent event means that broadcasted tx taker spends maker payment wasnt reverted
"MakerPaymentSpendConfirmFailed": error event, means that taker spend maker payment transaction confirmation was failed.

…ked-successful

…d_taker_expected.json

…sts, iris_nimda_rick_taker_swap.json

…MAKER_PAYMENT

laruh · 2024-08-28T03:39:27Z

Second problem solving approach

If we wouldn't like to do changes in legacy taker swap events/logic and increase backward incompatibility risks, there is an alternative. We can add maker payment spend confirmation right after send_taker_spends_maker_payment in spend_maker_payment taker swap operation.

komodo-defi-framework/mm2src/mm2_main/src/lp_swap/taker_swap.rs

Lines 1787 to 1812 in 5c47ef0

    
           async fn spend_maker_payment(&self) -> Result<(Option<TakerSwapCommand>, Vec<TakerSwapEvent>), String> { 
        
               #[cfg(any(test, feature = "run-docker-tests"))] 
        
               if self.fail_at == Some(FailAt::MakerPaymentSpend) { 
        
                   return Ok((Some(TakerSwapCommand::Finish), vec![ 
        
                       TakerSwapEvent::MakerPaymentSpendFailed("Explicit test failure".into()), 
        
                   ])); 
        
               } else if self.fail_at == Some(FailAt::MakerPaymentSpendPanic) { 
        
                   panic!("Taker panicked unexpectedly at maker payment spend"); 
        
               } 
        
               let other_maker_coin_htlc_pub = self.r().other_maker_coin_htlc_pub; 
        
               let secret = self.r().secret; 
        
               let taker_spends_payment_args = SpendPaymentArgs { 
        
                   other_payment_tx: &self.r().maker_payment.clone().unwrap().tx_hex, 
        
                   time_lock: self.maker_payment_lock.load(Ordering::Relaxed), 
        
                   other_pubkey: &*other_maker_coin_htlc_pub, 
        
                   secret: &secret.0, 
        
                   secret_hash: &self.r().secret_hash.clone().0, 
        
                   swap_contract_address: &self.r().data.maker_coin_swap_contract_address.clone(), 
        
                   swap_unique_data: &self.unique_swap_data(), 
        
                   watcher_reward: self.r().watcher_reward, 
        
               }; 
        
               let maybe_spend_tx = self 
        
                   .maker_coin 
        
                   .send_taker_spends_maker_payment(taker_spends_payment_args) 
        
                   .await;

If confirmation failed, then also return swap finish command and MakerPaymentSpendFailed event

                return Ok((Some(TakerSwapCommand::Finish), vec![
                    TakerSwapEvent::MakerPaymentSpendFailed(ERRL!("{}", err.get_plain_text_format()).into()),
                ]));

MakerPaymentSpendFailed is not actually correct event in the case of failed maker payment spend confirmation, but in this way we dont do changes in Taker commands and events logic.

In comparison, Maker has taker payment spend confirmation events in MakerSwapEvent:

komodo-defi-framework/mm2src/mm2_main/src/lp_swap/maker_swap.rs

Lines 1646 to 1648 in 5c47ef0

    
           TakerPaymentSpendConfirmStarted, 
        
           TakerPaymentSpendConfirmed, 
        
           TakerPaymentSpendConfirmFailed(SwapError),

laruh · 2024-08-30T05:07:50Z

Solved with second approach in this pr #2206

UPD: opened again as we decided to test both approaches #2206 (comment)

one problem with adding confirmation to SpendMakerPayment step is that GUI will not have the tx hash to show to user until tx is confirmed, users like to check tx on chain while it's awaiting confirmations

This pr approach could be preferable

…ked-successful

…d::ConfirmMakerPaymentSpend)

…d => Ok(command),

…and_add_event(ctx, swap, saved).await in taker restart

…pCommand::Finish),

…TS in for_tests.rs

shamardy · 2024-09-06T17:59:14Z

@laruh this is still draft, should I review it? I want to check it so that I can close the other PR if there are no problems with the approach here.

laruh · 2024-09-08T02:07:33Z

@laruh this is still draft, should I review it? I want to check it so that I can close the other PR if there are no problems with the approach here.

Its almost r2r, I just wanted to fix these notes #2206 (review) in other approach and cherry pick commit to this branch, as both branches would have the same review notes. (already fixed this b2446b9, just confirmation number is left)

…ked-successful

mm2src/mm2_main/src/lp_swap/taker_swap.rs

… in is_recoverable function

…R_SWAP

… MakerSavedSwap

…nfirm_taker_payment_spend

dimxy

LGTM

…Swap and MakerSavedSwap" This reverts commit 5ce137f.

shamardy

LGTM but for one nit!

Please open docs issue and add To Test comment to the PR opening comment.

mm2src/mm2_main/src/lp_swap/taker_swap.rs

shamardy · 2024-10-04T08:55:21Z

@cipig you tested this #2206 but we opted for a new event instead and implemented in this PR. Can you please check if the issue is resolved here?

laruh · 2024-10-04T09:53:32Z

Please open docs issue and add To Test comment to the PR opening comment.

KomodoPlatform/komodo-docs-mdx#351

* dev: fix(orders): fix cancel order race condition using time-based cache (#2232) fix(legacy-swap): taker failed spend maker payment marked as failed (#2199) chore(adex-cli): deprecate adex-cli (#2234) feat(new-RPC): connection healthcheck implementation for peers (#2194) fix(proxy-signature): add message lifetime overflows (#2233) feat(CI): handle remote files in a safer way (#2217) chore(doc): update issue address in README (#2227) fix(merge): remove duplicated db_root function (#2229) feat(wallets): add `get_wallet_names` rpc (#2202) chore(tests): don't use `.wait()` and use `block_on` instead (#2220) fix(native-rpc): remove escaped response body (#2219) fix(clippy): fix coins mod clippy warnings in wasm (#2224) feat(core): handling CTRL-C signal with graceful shutdown (#2213) docs(README): fix typos (#2212) remove the non-sense arguments (#2216) fix(db): stop creating the all-zeroes dir on KDF start (#2218)

* dev: fix(cosmos): fix tx broadcasting error (#2238) chore(solana): remove solana implementation (#2239) chore(cli): remove leftover subcommands from help message (#2235) fix(orders): fix cancel order race condition using time-based cache (#2232) fix(legacy-swap): taker failed spend maker payment marked as failed (#2199) chore(adex-cli): deprecate adex-cli (#2234) feat(new-RPC): connection healthcheck implementation for peers (#2194) fix(proxy-signature): add message lifetime overflows (#2233) feat(CI): handle remote files in a safer way (#2217) chore(doc): update issue address in README (#2227) fix(merge): remove duplicated db_root function (#2229) feat(wallets): add `get_wallet_names` rpc (#2202) chore(tests): don't use `.wait()` and use `block_on` instead (#2220) fix(native-rpc): remove escaped response body (#2219) fix(clippy): fix coins mod clippy warnings in wasm (#2224) feat(core): handling CTRL-C signal with graceful shutdown (#2213) docs(README): fix typos (#2212) remove the non-sense arguments (#2216) fix(db): stop creating the all-zeroes dir on KDF start (#2218)

laruh added 6 commits August 23, 2024 20:01

WIP: new fn confirm_maker_payment_spend, Taker command and events

1461212

Merge remote-tracking branch 'origin/dev' into taker-failed-swaps-mar…

31292be

…ked-successful

update events in recreate_taker_swap_taker_expected.json

0ede740

update events in recreate_taker_swap_taker_payment_wait_confirm_faile…

9c6c892

…d_taker_expected.json

update events in for_tests.rs consts, taker_swap.rs mod taker_swap_te…

b716806

…sts, iris_nimda_rick_taker_swap.json

add "MakerPaymentSpendConfirmed" to TAKER_ACTUAL_EVENTS_TAKER_SPENDS_…

5c47ef0

…MAKER_PAYMENT

laruh added the in progress Changes will be made from the author label Aug 26, 2024

laruh mentioned this pull request Aug 29, 2024

fix(legacy-swap): wait for confirmation of taker spend maker payment #2206

Closed

laruh closed this Aug 30, 2024

laruh reopened this Sep 5, 2024

laruh added 12 commits September 5, 2024 14:31

Merge remote-tracking branch 'origin/dev' into taker-failed-swaps-mar…

3117c5f

…ked-successful

provide "MakerPaymentSpendConfirmed" success event in more test jsons

eca0bda

log events

0e9a807

TakerSwapEvent::MakerPaymentSpentByWatcher(_) => Some(TakerSwapComman…

eb16235

…d::ConfirmMakerPaymentSpend)

in taker_restart.rs provide TakerSwapCommand::ConfirmMakerPaymentSpen…

1a1a775

…d => Ok(command),

move TakerSwapEvent::MakerPaymentSpendConfirmFailed in MakerSavedEvent

3af96a5

use TakerSwapCommand::SpendMakerPayment => check_maker_payment_spend_…

1c3c935

…and_add_event(ctx, swap, saved).await in taker restart

return TakerSwapEvent::MakerPaymentSpentByWatcher(_) => Some(TakerSwa…

7829b4b

…pCommand::Finish),

add "MakerPaymentSpendConfirmed" to TAKER_USING_WATCHERS_SUCCESS_EVENTS

075de97

add "MakerPaymentSpendConfirmed" to TAKER_USING_WATCHERS_SUCCESS_EVEN…

cc7c963

…TS in for_tests.rs

remove logs

69ed68e

self.r().data.maker_payment_requires_nota.unwrap_or(false)

b2446b9

laruh marked this pull request as ready for review September 8, 2024 02:07

laruh added 2 commits September 8, 2024 09:23

provide number of confirmations in wait_for_confirmations

2c119be

Merge remote-tracking branch 'origin/dev' into taker-failed-swaps-mar…

b9ba150

…ked-successful

laruh removed the in progress Changes will be made from the author label Sep 8, 2024

laruh force-pushed the taker-failed-swaps-marked-successful branch from 4462a41 to 0073fe8 Compare September 26, 2024 13:49

dimxy reviewed Sep 26, 2024

View reviewed changes

mm2src/mm2_main/src/lp_swap/taker_swap.rs Show resolved Hide resolved

laruh added in progress Changes will be made from the author and removed under review labels Sep 27, 2024

review: for old saved swaps check "TakerSwapEvent::MakerPaymentSpent"…

aed8d4c

… in is_recoverable function

laruh force-pushed the taker-failed-swaps-marked-successful branch from cd75bd0 to aed8d4c Compare September 27, 2024 09:16

laruh added 3 commits September 27, 2024 17:07

review: add "MakerPaymentSpendConfirmed" event in const FINISHED_TAKE…

ed91569

…R_SWAP

review: cover ConfirmMakerPaymentSpend for MakerPaymentSpentByWatcher

0661ee2

review: add SAVED_SWAP_V for new version fields in TakerSavedSwap and…

5ce137f

… MakerSavedSwap

laruh force-pushed the taker-failed-swaps-marked-successful branch from d2fd10f to 5ce137f Compare September 29, 2024 12:20

update confirmation comments in confirm_maker_payment_spend and in co…

f93fcde

…nfirm_taker_payment_spend

laruh added under review and removed in progress Changes will be made from the author labels Sep 29, 2024

dimxy previously approved these changes Oct 3, 2024

View reviewed changes

Revert "review: add SAVED_SWAP_V for new version fields in TakerSaved…

51c58cb

…Swap and MakerSavedSwap" This reverts commit 5ce137f.

laruh dismissed dimxy’s stale review via 51c58cb October 4, 2024 07:27

shamardy previously approved these changes Oct 4, 2024

View reviewed changes

mm2src/mm2_main/src/lp_swap/taker_swap.rs Outdated Show resolved Hide resolved

shamardy requested a review from cipig October 4, 2024 08:54

laruh mentioned this pull request Oct 4, 2024

Cover new events added to fix legacy taker failed swap marked as successful KomodoPlatform/komodo-docs-mdx#351

Open

review: simplify is_recoverable

b33380a

laruh dismissed shamardy’s stale review via b33380a October 4, 2024 10:01

shamardy approved these changes Oct 4, 2024

View reviewed changes

shamardy merged commit 359cb5c into dev Oct 4, 2024
26 checks passed

shamardy deleted the taker-failed-swaps-marked-successful branch October 4, 2024 10:56

smk762 mentioned this pull request Nov 4, 2024

add missing swap events KomodoPlatform/komodo-docs-mdx#368

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(legacy-swap): taker failed spend maker payment marked as failed #2199

fix(legacy-swap): taker failed spend maker payment marked as failed #2199

laruh commented Aug 26, 2024 •

edited

Loading

laruh commented Aug 28, 2024 •

edited

Loading

laruh commented Aug 30, 2024 •

edited

Loading

shamardy commented Sep 6, 2024

laruh commented Sep 8, 2024 •

edited

Loading

dimxy left a comment

shamardy left a comment

shamardy commented Oct 4, 2024

laruh commented Oct 4, 2024

fix(legacy-swap): taker failed spend maker payment marked as failed #2199

fix(legacy-swap): taker failed spend maker payment marked as failed #2199

Conversation

laruh commented Aug 26, 2024 • edited Loading

laruh commented Aug 28, 2024 • edited Loading

laruh commented Aug 30, 2024 • edited Loading

shamardy commented Sep 6, 2024

laruh commented Sep 8, 2024 • edited Loading

dimxy left a comment

Choose a reason for hiding this comment

shamardy left a comment

Choose a reason for hiding this comment

shamardy commented Oct 4, 2024

laruh commented Oct 4, 2024

laruh commented Aug 26, 2024 •

edited

Loading

laruh commented Aug 28, 2024 •

edited

Loading

laruh commented Aug 30, 2024 •

edited

Loading

laruh commented Sep 8, 2024 •

edited

Loading