[r2r] Ethereum swap watchers #1601

caglaryucekaya · 2023-01-04T21:51:31Z

Extending the watcher spending maker_payment_spend and refunding taker_payment functionalities for Ethereum and ERC-20 tokens. ETH gas fee of watchers are not yet compensated in this PR.

artemii235

Thanks for the PR! First review iteration.

mm2src/coins/eth.rs

mm2src/mm2_main/tests/docker_tests/swap_watcher_tests.rs

onur-ozkan

Solid work!

First review iteration:

onur-ozkan · 2023-01-06T06:53:39Z

mm2src/mm2_main/src/lp_swap/swap_watcher.rs

 use common::executor::{AbortSettings, SpawnAbortable, Timer};
 use common::log::{debug, error, info};
 use common::state_machine::prelude::*;
 use common::{now_ms, DEX_FEE_ADDR_RAW_PUBKEY};
 use futures::compat::Future01CompatExt;
 use mm2_core::mm_ctx::MmArc;
 use mm2_libp2p::{decode_signed, pub_sub_topic, TopicPrefix};
+use rpc::v1::types::Bytes;


In mm2 we call this as BytesJson everywhere. Let's call this one as BytesJson as well to avoid calling single data-type with multiple names.

onur-ozkan · 2023-01-06T07:04:19Z

mm2src/mm2_main/src/lp_swap/swap_watcher.rs

@@ -94,6 +96,7 @@ pub struct TakerSwapWatcherData {
    pub maker_pub: Vec<u8>,
    pub maker_payment_hash: Vec<u8>,
    pub maker_coin_start_block: u64,
+    pub swap_contract_address: Option<Vec<u8>>,


You can use Option<BytesJson> here. Right now we are doing extra mappings for no reason.

onur-ozkan · 2023-01-06T07:10:18Z

mm2src/mm2_main/tests/docker_tests/docker_tests_common.rs

+        "urls": ["http://195.201.0.6:8565"],
+        "swap_contract_address": "0xa09ad3cd7e96586ebd05a2607ee56b56fb2db8fd",


You can use ETH_DEV_NODES and ETH_DEV_SWAP_CONTRACT consts here.

Also eth_conf for eth_coin_from_conf_and_request

onur-ozkan · 2023-01-06T07:11:02Z

mm2src/mm2_main/tests/docker_tests/docker_tests_common.rs

+        "urls": ["http://195.201.0.6:8565"],
+        "swap_contract_address": "0xa09ad3cd7e96586ebd05a2607ee56b56fb2db8fd",


Please consider using eth_jst_conf for eth_coin_from_conf_and_request

onur-ozkan · 2023-01-06T10:32:16Z

mm2src/coins/eth.rs

@@ -1243,55 +1245,348 @@ impl SwapOps for EthCoin {
        MmError::err(ValidateInstructionsErr::UnsupportedCoin(self.ticker().to_string()))
    }

-    fn is_supported_by_watchers(&self) -> bool { false }
+    fn is_supported_by_watchers(&self) -> bool { true }


Q: Will this function have work flow in the future? If not, we don't need to register functions, it's better to have this functionality via coins configurations.

There can be a case when an outdated mm2 alongside a newer coins config where supports_watchers is true.

Good point, I was going to remove it and use the coins config, but it's actually better this way then.

There can be a case when an outdated mm2 alongside a newer coins config where supports_watchers is true.

Don't we use unwrap_or(DEFAULT_VALUE) approach while parsing the config anyway?

I believe all coins should support watchers in the future, so adding if a coin supports watchers to config will be an overkill, since we will add it to all or most coins configs eventually. We can implement a default implementation

fn is_supported_by_watchers(&self) -> bool { false }

in lp_coins.rs and implement it to true for Eth and Utxo only for now.

onur-ozkan · 2023-01-06T10:34:47Z

mm2src/coins/eth.rs

+        let fut = async move {
+            let tx = TransactionEnum::from(signed);
+            Ok(tx)
+        };


Suggested change

let fut = async move {

let tx = TransactionEnum::from(signed);

Ok(tx)

};

let fut = async move { Ok(TransactionEnum::from(signed)) };

onur-ozkan · 2023-01-06T10:35:45Z

mm2src/coins/eth.rs

+        let fut = async move {
+            let tx = TransactionEnum::from(signed);
+            Ok(tx)
+        };


Suggested change

let fut = async move {

let tx = TransactionEnum::from(signed);

Ok(tx)

};

let fut = async move { Ok(TransactionEnum::from(signed)) };

onur-ozkan · 2023-01-06T10:40:20Z

mm2src/coins/eth.rs

+                        .decode_input(&tx_from_rpc.input.0)
+                        .map_to_mm(|e| ValidatePaymentError::TxDeserializationError(e.to_string()))?;
+
+                    if decoded_input[0] != Token::Address(fee_addr) {


Direct access memory addresses might cause problems which are hard to debug. I recommend to use first() function. It will return None rather than panicking the mm2.

onur-ozkan · 2023-01-06T10:50:03Z

mm2src/coins/eth.rs

+                    let decoded = function
+                        .decode_input(&tx_from_rpc.input.0)
+                        .map_to_mm(|err| ValidatePaymentError::TxDeserializationError(err.to_string()))?;
+                    if decoded[0] != Token::FixedBytes(swap_id.clone()) {


onur-ozkan · 2023-01-06T10:50:11Z

mm2src/coins/eth.rs

+                    let decoded = function
+                        .decode_input(&tx_from_rpc.input.0)
+                        .map_to_mm(|err| ValidatePaymentError::TxDeserializationError(err.to_string()))?;
+                    if decoded[0] != Token::FixedBytes(swap_id.clone()) {


…time_locked_payment

…h_time_locked_payment

sergeyboyko0791

Awesome work!
First review iteration

sergeyboyko0791 · 2023-01-06T12:06:21Z

mm2src/coins/eth.rs

@@ -1243,55 +1245,348 @@ impl SwapOps for EthCoin {
        MmError::err(ValidateInstructionsErr::UnsupportedCoin(self.ticker().to_string()))
    }

-    fn is_supported_by_watchers(&self) -> bool { false }
+    fn is_supported_by_watchers(&self) -> bool { true }


There can be a case when an outdated mm2 alongside a newer coins config where supports_watchers is true.

sergeyboyko0791 · 2023-01-06T15:47:29Z

mm2src/coins/eth.rs

    }

-    fn watcher_validate_taker_fee(&self, _input: WatcherValidateTakerFeeInput) -> ValidatePaymentFut<()> {
-        unimplemented!();
+    fn watcher_validate_taker_fee(&self, validate_fee_args: WatcherValidateTakerFeeInput) -> ValidatePaymentFut<()> {


Is it possible to reuse EthCoin::validate_fee?
I believe SwapOps::validate_fee could be refactored to return Box<dyn Future<Item = (), Error = ValidateTakerFeeError> + Send> or probably ValidatePaymentFut

validate_fee takes as parameter a copy of the taker fee, then requests the transaction from the chain using the hash. In the watcher, we don't have a copy of the transaction, we only have the hash. If we use the validate_fee method, we'd have to request the transaction from the chain twice: once before calling the method and once in the method.

I think for the watcher node it should be a problem to request the transaction twice. But on the other hand, it will simplify the code significantly.
Also as another solution, EthCoin::validate_fee method could take an extended EthValidateFeeArgs:

pub fee_tx_hash: &'a [u8], // This is the only difference between `ValidateFeeArgs` and `EthValidateFeeArgs`. pub expected_sender: &'a [u8], pub fee_addr: &'a [u8], pub amount: &'a BigDecimal, pub min_block_number: u64, pub uuid: &'a [u8],

Are you talking about writing another method that takes as parameter EthValidateFeeArgs, which is then called both by EthCoin::validate_fee and EthCoin::watcher_validate_taker_fee?

I also added this to the todo list in the issue

Yes, exactly :)

Are you talking about writing another method that takes as parameter EthValidateFeeArgs, which is then called both by EthCoin::validate_fee and EthCoin::watcher_validate_taker_fee?

mm2src/coins/eth.rs

sergeyboyko0791 · 2023-01-09T11:18:18Z

mm2src/coins/eth.rs

    }

-    fn watcher_validate_taker_payment(&self, _input: WatcherValidatePaymentInput) -> ValidatePaymentFut<()> {
-        unimplemented!();
+    fn watcher_validate_taker_payment(&self, input: WatcherValidatePaymentInput) -> ValidatePaymentFut<()> {


Is it possible to reuse EthCoin::validate_payment? Perhaps, it could look like:

fn watcher_validate_taker_payment(&self, input: WatcherValidatePaymentInput) -> ValidatePaymentFut<()> { self.validate_payment(input.payment_tx, ...).await?; // Here perform some additional checks: }

This one's possible, but there's some differences between the two validations. I added this to the TODO list in the issue, and I'll combine the methods if I can do it without making any important changes to the validate_payment method.

mm2src/coins/eth.rs

sergeyboyko0791 · 2023-01-09T12:58:28Z

mm2src/mm2_main/tests/docker_tests/docker_tests_common.rs

+        "urls": ["http://195.201.0.6:8565"],
+        "swap_contract_address": "0xa09ad3cd7e96586ebd05a2607ee56b56fb2db8fd",


Also eth_conf for eth_coin_from_conf_and_request

sergeyboyko0791 · 2023-01-09T13:00:19Z

mm2src/mm2_main/tests/docker_tests/docker_tests_common.rs

+        "urls": ["http://195.201.0.6:8565"],
+        "swap_contract_address": "0xa09ad3cd7e96586ebd05a2607ee56b56fb2db8fd",


Please consider using eth_jst_conf for eth_coin_from_conf_and_request

mm2src/mm2_main/tests/docker_tests/docker_tests_common.rs

…hereum-swap-watchers

borngraced

Great work! I have just a comment for now.

borngraced · 2023-01-10T20:26:14Z

mm2src/coins/utxo/utxo_common.rs

 ) -> TransactionFut {
-    let transaction: UtxoTx =
-        try_tx_fus!(deserialize(taker_payment_refund_preimage).map_err(|e| TransactionErr::Plain(format!("{:?}", e))));
+    let transaction: UtxoTx = try_tx_fus!(


What do you think about taking T as ref here and cloning once inside the function instead of cloning everywhere the function is used?

ub fn send_taker_payment_refund_preimage<T: UtxoCommonOps + SwapOps>( coin: &T, watcher_refunds_payment_args: SendWatcherRefundsPaymentArgs, ) -> TransactionFut { let coin = coin.clone() .... }

Yes, this is better

…hereum-swap-watchers

sergeyboyko0791

Looks good to me!
I have just a few non-critical suggestions

sergeyboyko0791 · 2023-01-13T12:21:05Z

mm2src/coins/eth.rs

+            if tx_from_rpc.to != Some(expected_swap_contract_address) {
+                if tx_from_rpc.to == fallback_swap_contract {
+                    expected_swap_contract_address = fallback_swap_contract.ok_or_else(|| {
+                        ValidatePaymentError::InternalError("Fallback swap contract address not found".to_string())
+                    })?;
+                } else {
+                    return MmError::err(ValidatePaymentError::WrongPaymentTx(format!(
+                        "Payment tx {:?} was sent to wrong address, expected {:?}",
+                        tx_from_rpc, expected_swap_contract_address,
+                    )));
+                }
+            }


I think it can be simplified a bit. Please consider these changes

if tx_from_rpc.to != self.swap_contract_address && Some(tx_from_rpc.to) != fallback_swap { return MmError::err(ValidatePaymentError::WrongPaymentTx(format!( "Payment tx {tx_from_rpc:?} was sent to wrong address, expected either {:?} or the fallback {fallback_swap_contract:?}", self.swap_contract_address, ))); } let expected_swap_contract = tx_from_rpc.to;

Nice, yes this is better

sergeyboyko0791 · 2023-01-13T12:29:28Z

mm2src/coins/eth.rs

+                    let swap_id_input = get_function_input_data(&decoded, function, 0)
+                        .map_to_mm(ValidatePaymentError::TxDeserializationError)?;


It's not critical. In my opinion, the best way to handle each token step by step is to use Iterator::next.
But only if the tokens are handled one after another.
For example,
https://github.com/KomodoPlatform/atomicDEX-API/blob/2e720274af8173b42a50fa54bbf36517096bbb51/mm2src/coins/qrc20/swap.rs#L681-L696

We have too many decoded index accesses in the eth module, it would take hundreds of lines if we handle them all like this. Also in some cases not all sequential array items are required as you said, and I don't like the idea of using next() to skip unused items. I decided to use a helper function to simplify this as much as possible, and I think it'd be better if we use this and maybe improve it.

If we need more detailed error messages, we could get e.g. the parameter names from the Function input, or we could use a different helper for each contract function (e.g. erc20Payment) and write everything manually. But in general I'd prefer a solution that does all of this once, and not every time we use them. Maybe we can open an issue for this, there's still lots of direct index accesses in the eth module that I didn't fix.

I meant that if you need to parse 1st, 2nd, 3rd, ... tokens, you can use Iterator::next.

The best way to handle each token step by step is to use Iterator::next. But only if the tokens are handled one after another.

In other cases, I like your solution to use get_function_input_data.
Anyway, the way you've chosen definitely can be

sergeyboyko0791 · 2023-01-13T12:38:05Z

mm2src/coins/utxo/utxo_common.rs

    input: SendMakerPaymentSpendPreimageInput,
 ) -> TransactionFut {
+    let coin = coin.clone();


I think it's better to clone the coin just before let fut = async move {}

sergeyboyko0791 · 2023-01-13T12:38:17Z

mm2src/coins/utxo/utxo_common.rs

    maker_payment_tx: &[u8],
    time_lock: u32,
    maker_pub: &[u8],
    secret_hash: &[u8],
    swap_unique_data: &[u8],
 ) -> TransactionFut {
+    let coin = coin.clone();


…hereum-swap-watchers

…yment

artemii235

Great work! Two notes for the next iteration.

mm2src/coins/eth.rs

mm2src/mm2_main/tests/docker_tests/swap_watcher_tests.rs

sergeyboyko0791

Could you please consider two minor changes?

sergeyboyko0791 · 2023-01-16T14:23:32Z

mm2src/coins/eth.rs

-                }
+            if tx_from_rpc.to != Some(expected_swap_contract_address) && tx_from_rpc.to != fallback_swap_contract {
+                return MmError::err(ValidatePaymentError::WrongPaymentTx(format!(
+                                      "Payment tx {tx_from_rpc:?} was sent to wrong address, expected either {expected_swap_contract_address:?} or the fallback {fallback_swap_contract:?}"


I guess you copied my suggestion as it is.
Could you please fix the tabulation?

Yeah I copied your suggestion and made changes on it. Then I falsely assumed that cargo fmt would fix everything.

mm2src/coins/eth.rs

shamardy

LGTM! I have nothing to add :)

artemii235 · 2023-01-16T15:15:05Z

@caglaryucekaya Could you please also fix WASM CI stage?

…hereum-swap-watchers

artemii235

Last note related to the latest changes.

mm2src/mm2_test_helpers/src/for_tests.rs

artemii235

Re-approving.

artemii235 · 2023-01-20T09:34:26Z

@ozkanonur @sergeyboyko0791 Could you complete the review of this PR, please?

@caglaryucekaya If there are more notes, please add them to the next iteration TODO list.

onur-ozkan

I see the missing parts are now in the TODO list. So I can approve this.

Great work!

sergeyboyko0791

LGTM, thanks for the fixes!

caglaryucekaya added 3 commits January 5, 2023 00:45

add ethereum swap watchers

e7066ad

fix formatting and use fixed addresses for tests

14b19ac

ignore unstable tests

fce3361

caglaryucekaya changed the title ~~Ethereum swap watchers~~ [r2r] Ethereum swap watchers Jan 5, 2023

caglaryucekaya requested review from artemii235, borngraced, laruh, onur-ozkan, sergeyboyko0791 and shamardy January 5, 2023 13:45

artemii235 requested changes Jan 5, 2023

View reviewed changes

onur-ozkan requested changes Jan 6, 2023

View reviewed changes

caglaryucekaya changed the title ~~[r2r] Ethereum swap watchers~~ [wip] Ethereum swap watchers Jan 6, 2023

caglaryucekaya added 8 commits January 6, 2023 19:09

get the swap contract address from the payment in watcher_spend_hash_…

d3e455c

…time_locked_payment

get the swap contract address from the payment in watcher_refunds_has…

0e3b0b2

…h_time_locked_payment

use existing my_balance function instead of get_balances

046c44d

use struct for watcher_light_node parameters

8d809ff

use BigDecimal for balance comparisons

4c24979

remove all usages of swap_contract_address from TakerSwapWatcherData

e9ddd6b

use constants for nodes urls and contract addresses

f45ff58

fix small details

bd87d0b

sergeyboyko0791 suggested changes Jan 9, 2023

View reviewed changes

caglaryucekaya added 6 commits January 9, 2023 18:51

use first and get methods instead of indexes

83bb6ab

use helper functions for eth and jst coin configs

fd712d6

fix watcher validate taker payment bugs

7406763

fix watcher test configurations

24255c3

Merge branch 'dev' of github.com:KomodoPlatform/atomicDEX-API into et…

a1e9596

…hereum-swap-watchers

make small changes to the generate_erc20_coin function

d511122

onur-ozkan mentioned this pull request Jan 10, 2023

[r2r] Complete MetaMask #1591

Closed

8 tasks

borngraced reviewed Jan 10, 2023

View reviewed changes

caglaryucekaya changed the title ~~[wip] Ethereum swap watchers~~ [r2r] Ethereum swap watchers Jan 12, 2023

caglaryucekaya added 3 commits January 12, 2023 22:32

Merge branch 'dev' of github.com:KomodoPlatform/atomicDEX-API into et…

0403945

…hereum-swap-watchers

use try_tx_fus! macro instead of match expressions

090aad0

use helper function to get input data from functions

e6e40f4

sergeyboyko0791 previously approved these changes Jan 13, 2023

View reviewed changes

Merge branch 'dev' of github.com:KomodoPlatform/atomicDEX-API into et…

b482fa4

…hereum-swap-watchers

caglaryucekaya dismissed sergeyboyko0791’s stale review via b482fa4 January 13, 2023 18:56

caglaryucekaya added 2 commits January 13, 2023 22:56

simplify the contract address validation in watcher_validate_taker_pa…

a0abcfd

…yment

minor fixes

1f25593

artemii235 previously approved these changes Jan 14, 2023

View reviewed changes

mm2src/coins/eth.rs Outdated Show resolved Hide resolved

mm2src/mm2_main/tests/docker_tests/swap_watcher_tests.rs Outdated Show resolved Hide resolved

caglaryucekaya added 2 commits January 14, 2023 16:45

remove unnecessary clone usages

ce6b229

change my_balance return type to MyBalanceResponse

be23766

caglaryucekaya dismissed artemii235’s stale review via be23766 January 14, 2023 21:13

sergeyboyko0791 suggested changes Jan 16, 2023

View reviewed changes

shamardy previously approved these changes Jan 16, 2023

View reviewed changes

caglaryucekaya added 3 commits January 16, 2023 17:48

add default is_supported_by_watchers implementation

b778f26

fix tabulation

62e33ef

minor fixes

3ca216d

caglaryucekaya dismissed shamardy’s stale review via 3ca216d January 16, 2023 15:08

caglaryucekaya added 2 commits January 16, 2023 18:44

fix a wasm issue

a814f1d

Merge branch 'dev' of github.com:KomodoPlatform/atomicDEX-API into et…

8eebecf

…hereum-swap-watchers

artemii235 requested changes Jan 16, 2023

View reviewed changes

mm2src/mm2_test_helpers/src/for_tests.rs Outdated Show resolved Hide resolved

make my_balance function async

593032c

artemii235 approved these changes Jan 17, 2023

View reviewed changes

onur-ozkan approved these changes Jan 20, 2023

View reviewed changes

sergeyboyko0791 approved these changes Jan 20, 2023

View reviewed changes

sergeyboyko0791 merged commit fed3413 into dev Jan 20, 2023

sergeyboyko0791 deleted the ethereum-swap-watchers branch January 20, 2023 11:32

		"urls": ["http://195.201.0.6:8565"],
		"swap_contract_address": "0xa09ad3cd7e96586ebd05a2607ee56b56fb2db8fd",

		let swap_id_input = get_function_input_data(&decoded, function, 0)
		.map_to_mm(ValidatePaymentError::TxDeserializationError)?;

[r2r] Ethereum swap watchers #1601

[r2r] Ethereum swap watchers #1601

Conversation

caglaryucekaya commented Jan 4, 2023 • edited Loading

artemii235 left a comment

Choose a reason for hiding this comment

onur-ozkan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

caglaryucekaya Jan 9, 2023 • edited Loading

Choose a reason for hiding this comment

onur-ozkan Jan 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergeyboyko0791 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borngraced left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergeyboyko0791 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

artemii235 left a comment

Choose a reason for hiding this comment

sergeyboyko0791 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shamardy left a comment

Choose a reason for hiding this comment

artemii235 commented Jan 16, 2023

artemii235 left a comment

Choose a reason for hiding this comment

artemii235 left a comment

Choose a reason for hiding this comment

artemii235 commented Jan 20, 2023

onur-ozkan left a comment

Choose a reason for hiding this comment

sergeyboyko0791 left a comment

Choose a reason for hiding this comment

caglaryucekaya commented Jan 4, 2023 •

edited

Loading

caglaryucekaya Jan 9, 2023 •

edited

Loading

onur-ozkan Jan 9, 2023 •

edited

Loading