feat(trading-proto-upgrade): sql storage wip + protocol enhancement by artemii235 · Pull Request #1980 · GLEECBTC/komodo-defi-framework

artemii235 · 2023-10-02T04:50:46Z

#1895

What's done:

Removed access by index feat(trading-proto-upgrade): UTXO PoC + State machine refactor #1927 (comment)
Changed OP_CHECKMULTISIG to <pubkey0> OP_CHECKSIGVERIFY <pubkey1> OP_CHECKSIG chore(release): v1.0.7-beta #1936 (comment)
Implemented storing upgraded swaps data to SQLite DB (still WIP)
Implemented protocol enhancement for UTXO coins by adding one more funding tx for taker, which can be reclaimed immediately if maker back-outs.
Done some refactoring, added CoinAssocTypes trait representing coin associated types. It makes implementation more generic, helps to avoid repeated transactions and other data deserialization in swaps operations, etc.

Notes

Implementation still covers only success swap case.

…script path.

…ration-3

…ration-3 # Conflicts: # mm2src/coins/eth/web3_transport/http_transport.rs

shamardy

Thank you for the PR! First review iteration!

mm2src/coins/lp_coins.rs

mm2src/coins/utxo.rs

shamardy · 2023-10-03T21:01:52Z

mm2src/coins/utxo/utxo_common.rs

+    let expected_fee = coin
+        .get_htlc_spend_fee(DEFAULT_SWAP_TX_SPEND_SIZE, &FeeApproxStage::WithoutApprox)
+        .await?;
+
+    let actual_fee = funding_amount - payment_amount;
+
+    let fee_div = expected_fee as f64 / actual_fee as f64;
+
+    if !(0.9..=1.1).contains(&fee_div) {
+        return MmError::err(ValidateTakerFundingSpendPreimageError::UnexpectedPreimageFee(format!(
+            "Too large difference between expected {} and actual {} fees",
+            expected_fee, actual_fee
+        )));
+    }


To avoid such issues with validation, I propose that the funding spending fee should be predetermined by the taker and added to the total_amount here https://github.com/KomodoPlatform/komodo-defi-framework/blob/122464c08cf6c73a693518470e035ca146ab8081/mm2src/coins/utxo/utxo_common.rs#L4816 The taker can then validate whether the fee is greater than or equal to the fee they initially decided upon.

It's a question of who should pay the funding spending fee actually, right now the maker pays for it. If the taker sets the fee beforehand, and the fee subsequently rises when the maker is signing the funding spending transaction, the maker could pay the additional amount to ensure that the transaction is processed. However, I think it's better for the maker to just use the exact fee the taker decided to avoid the taker lowballing them. The maker should never sign a transaction with a fee below what the taker decided though, they should use what the taker decided if the fee has decreased since the taker decided upon it.

P.S. you can work on this on next sprints, I think we need to take more time to think about the best way to handle this.

It's a question of who should pay the funding spending fee actually, right now the maker pays for it.

Yeah, it's a tricky part of funding tx approach 🙂 I added it to the issue checklist and will add to the next sprint discussion points.

…ration-3 # Conflicts: # mm2src/mm2_main/tests/docker_tests/swap_watcher_tests.rs

shamardy

Next review iteration! Only 2 comments!
Will do one last review iteration after this where I check the maker_swap_v2 and taker_swap_v2 code one more time :)

shamardy · 2023-10-04T19:33:47Z

mm2src/mm2_main/src/lp_swap.rs


 /// Returns the status of swap performed on `my` node
+#[cfg(not(target_arch = "wasm32"))]
+pub async fn my_swap_status(ctx: MmArc, req: Json) -> Result<Response<Vec<u8>>, String> {


Maybe it's time to implement my_swap_status v2 using "mmrpc": "2.0" similar to withdraw and other methods.

Yeah, I'm thinking about this too, good point to discuss in the next sprint 🙂

mm2src/mm2_main/src/lp_swap/maker_swap_v2.rs

shamardy

Great work as always!
I realised that we are not settled yet on swap payments confirmation requirements so I will do the whole check of swaps code once we settle on them and they are implemented.

shamardy · 2023-10-05T20:41:56Z

mm2src/mm2_main/src/lp_swap/taker_swap_v2.rs

@@ -483,76 +865,125 @@ impl<MakerCoin: MmCoin, TakerCoin: MmCoin + SwapOpsV2> State for TakerPaymentSen

        if let Err(e) = state_machine.maker_coin.wait_for_confirmations(input).compat().await {


I think taker will have to wait for confirmation of maker payment before spending the funding transaction. Concurrent confirmations of both taker and maker payments were only viable before introducing immediate refund path for taker. I think you are aware of this but didn't get to change it yet :)
P.S. This is just a reminder for next sprints where confirmations need to be rechecked and probably changed, ref. next comment.

I assumed that we can still keep concurrent confirmations, though it should be carefully reviewed with regard to possible maker payment cancellation/replacement with another tx. Added to the checklist and will add to the next sprint discussion points.

shamardy · 2023-10-05T20:47:35Z

mm2src/mm2_main/src/lp_swap/maker_swap_v2.rs

+
        let input = ConfirmPaymentInput {
-            payment_tx: self.taker_payment.tx_hex.0.clone(),
+            payment_tx: self.taker_funding.tx_hex(),


Next state is TakerPaymentConfirmed, shouldn't this be the taker_payment not taker_funding. We will also require a confirmation for the taker_funding in a previous step/state. This is also a comment for next sprints.

Yeah, it should be taker payment, fixed.

…ration-3

shamardy · 2023-10-27T14:07:58Z

@artemii235 please merge with latest dev and then merge this PR to dev :)

…ration-3 # Conflicts: # mm2src/coins/test_coin.rs # mm2src/coins/utxo/utxo_common.rs # mm2src/coins/utxo/utxo_standard.rs # mm2src/mm2_main/src/lp_ordermatch.rs # mm2src/mm2_main/src/lp_swap.rs

laruh

I have a question.
Why did you decide to use same struct names for stored negotiation data in maker and taker swaps?
I think its preferable to use different names like StoredTaker/MakerNegotiationData, especially when both structs are public. Or may be I didnt get your idea.

laruh · 2023-10-30T05:46:06Z

mm2src/mm2_main/src/lp_swap/maker_swap_v2.rs


+/// Negotiation data representation to be stored in DB.
+#[derive(Debug, Deserialize, Serialize)]
+pub struct StoredNegotiationData {


These structs have fields with different semantics/names. Possibly, they will differ even more in the future.

Yeah, I mean, if you import structs in other place, it will be comfortable to use them with different names. I dont tell that they are the same objects, of course not :)

I dont insist, just was curious and wanted to note it for the future.

it will be comfortable to use them with different names

I agree, but I had to make them and Maker/TakerSwapEvent public since they are used in the public interface here:
https://github.com/KomodoPlatform/komodo-defi-framework/blob/9de1ea29ffca580910fa4ea7bf16194c3577f5c2/mm2src/mm2_main/src/lp_swap/maker_swap_v2.rs#L127

I will look for a way to remove pub in next iterations, added to the issue checklist, thanks!

laruh · 2023-10-30T05:46:13Z

mm2src/mm2_main/src/lp_swap/taker_swap_v2.rs


+/// Negotiation data representation to be stored in DB.
+#[derive(Debug, Deserialize, Serialize)]
+pub struct StoredNegotiationData {


laruh

Great work! LGTM!

ps: thanks for doc coms :)

artemii235 and others added 25 commits September 22, 2023 13:33

Removing access by index.

0713b5f

Removing access by index.

e638c5b

WIP. SQLite storage for swaps.

72e25a4

WIP. SQLite storage for swaps.

530725f

WIP. SQLite storage.

3377afe

WIP. SQLite storage for upgraded swaps.

1c9442b

WIP. Additional validation.

ca53aa2

WIP. Additional validation and refactoring.

3c1cf64

WIP. Additional validation and refactoring.

c49d424

WIP. Refactor a bit.

137988c

WIP. Refactor.

d8a9608

WIP. Protocol enhancement.

596fc22

WIP. Protocol enhancement.

c4a8c68

WIP. Protocol enhancement.

fffab29

WIP. Protocol enhancement.

6c6c86f

WIP. Demo of maker trying to use taker preimage signature for refund …

01670f7

…script path.

WIP. Protocol enhancement.

b7c327a

WIP. Protocol enhancement.

c6805d3

WIP. Protocol enhancement.

b3cc12f

WIP. Made successful swap after enhancement.

89f6185

WIP. Added validate_taker_funding.

eee4470

WIP. Started addition of validate_taker_funding_spend_preimage.

5bdb141

WIP. Implementing validate_taker_funding_spend_preimage.

987c50d

WIP. Finish validate_taker_funding_spend_preimage for UTXO coins.

122464c

Merge remote-tracking branch 'origin/dev' into swap-proto-upgrade-ite…

eb0aa7d

…ration-3

artemii235 added the in progress label Oct 2, 2023

artemii235 added 2 commits October 2, 2023 18:17

Temporary disable upgraded swaps under WASM.

92990cb

Merge remote-tracking branch 'origin/dev' into swap-proto-upgrade-ite…

909456e

…ration-3 # Conflicts: # mm2src/coins/eth/web3_transport/http_transport.rs

shamardy requested review from dimxy and shamardy October 2, 2023 11:51

artemii235 added under review and removed in progress labels Oct 2, 2023

shamardy reviewed Oct 3, 2023

View reviewed changes

Artem Vitae added 3 commits October 4, 2023 10:02

Merge remote-tracking branch 'origin/dev' into swap-proto-upgrade-ite…

47f4160

…ration-3 # Conflicts: # mm2src/mm2_main/tests/docker_tests/swap_watcher_tests.rs

Fix imports after merging with dev.

c18a597

Review fixes.

c3c527c

artemii235 mentioned this pull request Oct 2, 2023

Trading protocol upgrade v2. #1895

Open

29 tasks

shamardy reviewed Oct 4, 2023

View reviewed changes

Review fixes: use named_params macro.

7697d24

shamardy previously approved these changes Oct 5, 2023

View reviewed changes

Wait for taker payment conf instead of funding.

f197ffb

artemii235 dismissed shamardy’s stale review via f197ffb October 6, 2023 02:57

shamardy previously approved these changes Oct 9, 2023

View reviewed changes

shamardy added sec-review labels Oct 9, 2023

shamardy requested review from Alrighttt, DeckerSU and ca333 October 9, 2023 12:10

Merge remote-tracking branch 'origin/dev' into swap-proto-upgrade-ite…

e26203f

…ration-3

artemii235 added 2 commits October 30, 2023 11:15

Merge remote-tracking branch 'origin/dev' into swap-proto-upgrade-ite…

628e568

…ration-3 # Conflicts: # mm2src/coins/test_coin.rs # mm2src/coins/utxo/utxo_common.rs # mm2src/coins/utxo/utxo_standard.rs # mm2src/mm2_main/src/lp_ordermatch.rs # mm2src/mm2_main/src/lp_swap.rs

Fixes after syncing with dev.

9de1ea2

artemii235 dismissed shamardy’s stale review via 9de1ea2 October 30, 2023 04:30

laruh reviewed Oct 30, 2023

View reviewed changes

laruh approved these changes Oct 30, 2023

View reviewed changes

artemii235 merged commit 8d0a583 into dev Oct 30, 2023

artemii235 deleted the swap-proto-upgrade-iteration-3 branch October 30, 2023 06:31

shamardy mentioned this pull request Dec 15, 2023

chore(release): v2.0.0-beta #1968

Merged

		@@ -483,76 +865,125 @@ impl<MakerCoin: MmCoin, TakerCoin: MmCoin + SwapOpsV2> State for TakerPaymentSen

		if let Err(e) = state_machine.maker_coin.wait_for_confirmations(input).compat().await {

Conversation

artemii235 commented Oct 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shamardy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shamardy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shamardy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shamardy Oct 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shamardy commented Oct 27, 2023

Uh oh!

laruh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

laruh left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

artemii235 commented Oct 2, 2023 •

edited

Loading

shamardy Oct 5, 2023 •

edited

Loading