feat(p2p): ensure time synchronization in the network by onur-ozkan · Pull Request #2255 · GLEECBTC/komodo-defi-framework

onur-ozkan · 2024-10-28T12:37:49Z

Implementation Details

Once a connection is established with a peer, validation check is immediately performed to confirm the peer's clock. If the peer's time exceeds the maximum allowed cap, the connection is terminated. This approach ensures that all peers performing operations in the network are synchronized in terms of time. Current time cap is set to 30 seconds, which can be changed if it doesn't fit the requirements.

Each peer is temporarily added to the RECENTLY_DIALED_PEERS map for 5 minutes before any connection attempt. This prevents repeated connection attempts to peers that are unavailable or out-of-sync, which reduces unnecessary reconnection overheads.

                      +---------------------+
                      |  Connection Attempt |
                      |       On a Peer     |
                      +---------------------+
                                |
                                v
                   +------------------------+
                   |   Is already dialed    |
                   |       recently?        |
                   +------------------------+
                      |                    |
                      Yes                  No
                      |                    |
                      v                    v
        +---------------------+       +-----------------------+
        |   Skip Connection   |       |  Make the Connection  |
        +---------------------+       +-----------------------+
                                             |
                                             v
                            +---------------------------------+
                            |     Check Peer Time Validity    |
                            +---------------------------------+
                                    |              |
                               Time Valid     Time Invalid
                                    |              |
                                    v              v
                                    |       +-------------------------+
                                    |       | Disconnect from Peer    |
                                    |       +-------------------------+
                                    |
                                    |
                                    v
                +------------------------------------+
                |       Validation completed         |
                +------------------------------------+

~~Breaking Changes~~

1. A new request-response payload (GetPeerUtcTimestamp) has been added. This request is sent at each connection attempt, which makes it mandatory for all seed nodes and GUI applications in the network to be updated to this version. Meaning, this version is incompatible with any older version.

~~2. The NetworkInfoRequest has been renamed to PeerInfoRequest. This likely affects the encoded payload of GetMm2Version (not yet verified but highly likely).~~

Resolves #1115 and #1683

~~Blocked by #2256~~

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan · 2024-10-31T12:22:04Z

mm2src/mm2_p2p/src/application/request_response/mod.rs

-    /// TODO: This should be called `PeerInfoRequest` instead. However, renaming it
-    /// will introduce a breaking change in the network and is not worth it. Do this
-    /// renaming when there is already a breaking change in the release.
-    NetworkInfo(network_info::NetworkInfoRequest),


This PR already leads to breaking change. It's perfect time to rename this.

One way to avoid breaking changes is to have a timeout on the request for peer timestamp and allow them to connect if there is no response from the peer. We later remove this when most peers update. Another way is to get the mm2 version and do the timestamp request depending on the version. What do you think?

One way to avoid breaking changes is to have a timeout on the request for peer timestamp and allow them to connect if there is no response from the peer. We later remove this when most peers update.

This sounds like a good plan!

Another way is to get the mm2 version and do the timestamp request depending on the version. What do you think?

I think the first idea was better, but then I need to revert the peer-info renaming part. What about bundling these changes in some branch, and then releasing multiple breaking changes at once (like removing mm2 binaries and some other stuff) ?

What about bundling these changes in some branch, and then releasing multiple breaking changes at once (like removing mm2 binaries and some other stuff) ?

I am fine with this or the first approach.

Signed-off-by: onur-ozkan <work@onurozkan.dev>

… into time-synced-network

Signed-off-by: onur-ozkan <work@onurozkan.dev>

mm2src/mm2_main/src/lp_stats.rs

mariocynicys · 2024-11-14T09:00:59Z

mm2src/mm2_p2p/src/behaviours/atomicdex.rs

+/// Determines if a dial attempt to the remote should be made.
+///
+/// Returns `false` if a dial attempt to the given address has already been made,
+/// in which case the caller must skip the dial attempt.
+fn pre_dial_check(recently_dialed_peers: &mut MutexGuard<TimedMap<StdClock, Multiaddr, ()>>, addr: &Multiaddr) -> bool {


Neither the doc comment nor the func name signify how this function changes the timedmap (only visible from the mutability of the passed map). Let's change this to something like check_and_mark_dialed or something.

Also, no need for the MutexGuard annotation here.

Neither the doc comment nor the func name signify how this function changes the timedmap (only visible from the mutability of the passed map)

"only visible from the mutability of the passed map" that's visible everywhere, both in the function signature and on the caller side!

I struggle to see how check_and_mark_dialed describes the function better than pre_dial_check but whatever, I am okay with it.

Also, no need for the MutexGuard annotation here.

It gives/documents the background context how this map is utilized from caller.

mm2src/mm2_p2p/src/behaviours/atomicdex.rs

Signed-off-by: onur-ozkan <work@onurozkan.dev>

… into time-synced-network

onur-ozkan · 2024-12-10T08:05:10Z

Do we have any blocker for this PR? @shamardy

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan · 2024-12-17T12:21:50Z

Doesn't cause the breakage anymore.

… into time-synced-network

onur-ozkan · 2024-12-23T05:51:46Z

Resolved conflicts

mariocynicys

non-blocking comments inline (just to not block this further).
LGTM

mariocynicys · 2024-12-23T11:02:57Z

mm2src/mm2_p2p/src/behaviours/atomicdex.rs

+                    debug!(
+                        "Peer '{peer}' is within the acceptable time gap ({MAX_TIME_GAP_FOR_CONNECTED_PEER} seconds); time difference is {diff} seconds."
+                    );
+                    response_tx.send(None).await.unwrap();


this send in redundant. what about not sending anything in here, as the other end of the end of the channel doesn't really use the None for anything.

If you don't send anything, it will block the request/process until timeout. The channel plays a request-response style communication here.

please take a second look at this. the response_tx is for the timestamp checker and not a response to some node or something (i didn't really get what u mean).

Ah, thought was awaiting on result of this channel

mariocynicys · 2024-12-23T11:03:05Z

mm2src/mm2_p2p/src/behaviours/atomicdex.rs

+            error!("Unexpected response `{other:?}` from peer `{peer}`");
+            // TODO: Ideally, we should send `Some(peer)` to end the connection,
+            // but we don't want to cause a breaking change yet.
+            response_tx.send(None).await.unwrap();


same for this None

mariocynicys · 2024-12-23T11:05:35Z

mm2src/mm2_p2p/src/behaviours/atomicdex.rs

            }
        }

+        while let Poll::Ready(Some(Some(peer_id))) = timestamp_rx.poll_next_unpin(cx) {


and we can make this channel transmit PeerIDs instead of Option<PeerID>s.

dimxy · 2024-12-23T13:12:03Z

BTW I tried to run tests in the mm2_p2p module with command cargo test -p mm2_p2p but received errors could not find application in the crate root
(however in the previous commit this command ran okay)

onur-ozkan · 2024-12-23T15:59:09Z

BTW I tried to run tests in the mm2_p2p module with command cargo test -p mm2_p2p but received errors could not find application in the crate root (however in the previous commit this command ran okay)

That's weird lol. The crate path can't be resolved when targeting mm2_p2p specifically but it does build when building whole workspace (which we do on CI by default). We can fix that as a follow-up PR.

dimxy · 2024-12-23T16:08:25Z

BTW I tried to run tests in the mm2_p2p module with command cargo test -p mm2_p2p but received errors could not find application in the crate root (however in the previous commit this command ran okay)

That's weird lol. The crate path can't be resolved when targeting mm2_p2p specifically but it does build when building whole workspace (which we do on CI by default). We can fix that as a follow-up PR.

cargo test -p mm2_p2p --features "application" is needed

onur-ozkan · 2024-12-23T16:13:47Z

I am aware, it's fixed in #2302 already

* dev: (35 commits) fix(crypto): allow non bip39 mnemonics storage (GLEECBTC#2312) fix(legacy_swap): check for existing maker/taker payment before timeout (GLEECBTC#2283) feat(tendermint): validators RPC (GLEECBTC#2310) chore(CI): validate Cargo lock file (GLEECBTC#2309) test(P2P): add test for peer time sync validation (GLEECBTC#2304) fix mm2_p2p dev build (GLEECBTC#2311) update Cargo.lock (GLEECBTC#2308) chore(CI): unlock wasm-pack version (GLEECBTC#2307) add `wasm` feature on WASM for timed-map (GLEECBTC#2306) replace broken rpc link (GLEECBTC#2305) chore(eth-websocket): remove some unnecessary wrappers (GLEECBTC#2291) improvement(CI): switch to proper rust caching (GLEECBTC#2303) fix(wasm): add test-ext-api feature to mm2_main and mm2_bin_lib tomls (GLEECBTC#2295) chore(ci): Update docker build for wasm (GLEECBTC#2294) chore(p2p): follow-up nits (GLEECBTC#2302) feat(p2p): ensure time synchronization in the network (GLEECBTC#2255) bump libp2p (GLEECBTC#2296) chore(adex-cli): use "Komodo DeFi Framework" name in adex_cli (GLEECBTC#2290) chore(ctx): replace gstuff constructible with oncelock (GLEECBTC#2267) don't rely on core (GLEECBTC#2289) ...

* add time validation core logic Signed-off-by: onur-ozkan <work@onurozkan.dev> * nit fixes Signed-off-by: onur-ozkan <work@onurozkan.dev> * handle time gap Signed-off-by: onur-ozkan <work@onurozkan.dev> * improve logging Signed-off-by: onur-ozkan <work@onurozkan.dev> * add more trackable processing logs Signed-off-by: onur-ozkan <work@onurozkan.dev> * improve info log and remove debugging leftover Signed-off-by: onur-ozkan <work@onurozkan.dev> * rename `NetworkInfoRequest` to `PeerInfoRequest` Signed-off-by: onur-ozkan <work@onurozkan.dev> * handle recently dialed peers Signed-off-by: onur-ozkan <work@onurozkan.dev> * add useful logs Signed-off-by: onur-ozkan <work@onurozkan.dev> * create function for pre-dial check Signed-off-by: onur-ozkan <work@onurozkan.dev> * set max cap for timestamp channel Signed-off-by: onur-ozkan <work@onurozkan.dev> * remove leftover Signed-off-by: onur-ozkan <work@onurozkan.dev> * use `Multiaddr` as key Signed-off-by: onur-ozkan <work@onurozkan.dev> * fix p2p tests Signed-off-by: onur-ozkan <work@onurozkan.dev> * update logs Signed-off-by: onur-ozkan <work@onurozkan.dev> * rename leftovers Signed-off-by: onur-ozkan <work@onurozkan.dev> * update timing values Signed-off-by: onur-ozkan <work@onurozkan.dev> * minor fixes Signed-off-by: onur-ozkan <work@onurozkan.dev> * update pre dial check calls Signed-off-by: onur-ozkan <work@onurozkan.dev> * apply nit fixes Signed-off-by: onur-ozkan <work@onurozkan.dev> * don't update existing expiries Signed-off-by: onur-ozkan <work@onurozkan.dev> * revert breakage Signed-off-by: onur-ozkan <work@onurozkan.dev> --------- Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan added enhancement labels Oct 28, 2024

onur-ozkan mentioned this pull request Oct 29, 2024

refactor(P2P): types and modules #2256

Merged

onur-ozkan force-pushed the time-synced-network branch from b675759 to afe2212 Compare October 30, 2024 11:37

add time validation core logic

4343c0e

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the time-synced-network branch from afe2212 to 4343c0e Compare October 31, 2024 08:35

onur-ozkan added 2 commits October 31, 2024 14:17

nit fixes

3b69689

Signed-off-by: onur-ozkan <work@onurozkan.dev>

handle time gap

5acfe8d

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the time-synced-network branch from f9dd830 to 5acfe8d Compare October 31, 2024 11:34

improve logging

82ae6d2

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the time-synced-network branch from da8335c to 82ae6d2 Compare October 31, 2024 11:40

onur-ozkan added 2 commits October 31, 2024 14:51

add more trackable processing logs

5771790

Signed-off-by: onur-ozkan <work@onurozkan.dev>

improve info log and remove debugging leftover

f42e706

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan added the breaking-change label Oct 31, 2024

rename NetworkInfoRequest to PeerInfoRequest

b693d8c

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan commented Oct 31, 2024

View reviewed changes

onur-ozkan added 2 commits November 4, 2024 17:09

handle recently dialed peers

92af285

Signed-off-by: onur-ozkan <work@onurozkan.dev>

add useful logs

86eb068

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the time-synced-network branch from 5ba1ac5 to e86a166 Compare November 4, 2024 14:29

create function for pre-dial check

c1a6eaf

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan force-pushed the time-synced-network branch from e86a166 to c1a6eaf Compare November 4, 2024 14:38

onur-ozkan added 5 commits November 4, 2024 17:41

set max cap for timestamp channel

e5c284d

Signed-off-by: onur-ozkan <work@onurozkan.dev>

remove leftover

130af67

Signed-off-by: onur-ozkan <work@onurozkan.dev>

use Multiaddr as key

422626c

Signed-off-by: onur-ozkan <work@onurozkan.dev>

Merge branch 'dev' of github.com:KomodoPlatform/komodo-defi-framework…

3859afc

… into time-synced-network

fix p2p tests

1c7229c

Signed-off-by: onur-ozkan <work@onurozkan.dev>

shamardy added breaking-change: P2P and removed breaking-change labels Nov 4, 2024

onur-ozkan added the under review label Nov 5, 2024

onur-ozkan marked this pull request as ready for review November 5, 2024 05:22

mariocynicys reviewed Nov 14, 2024

View reviewed changes

apply nit fixes

9ad57a7

Signed-off-by: onur-ozkan <work@onurozkan.dev>

shamardy removed the P2 label Nov 15, 2024

shamardy added the 2.4.0-beta label Dec 9, 2024

Merge branch 'dev' of github.com:KomodoPlatform/komodo-defi-framework…

ff1a52e

… into time-synced-network

don't update existing expiries

3b18529

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan added status: pending review feature: P2P and removed enhancement labels Dec 16, 2024

revert breakage

7418211

Signed-off-by: onur-ozkan <work@onurozkan.dev>

onur-ozkan removed the breaking-change: P2P label Dec 17, 2024

Merge branch 'dev' of github.com:KomodoPlatform/komodo-defi-framework…

fd64a72

… into time-synced-network

mariocynicys approved these changes Dec 23, 2024

View reviewed changes

onur-ozkan merged commit 87be260 into dev Dec 23, 2024

onur-ozkan deleted the time-synced-network branch December 23, 2024 12:06

onur-ozkan mentioned this pull request Dec 23, 2024

chore(p2p): follow-up nits #2302

Merged

dimxy mentioned this pull request Dec 25, 2024

test(P2P): add test for peer time sync validation #2304

Merged

shamardy mentioned this pull request Apr 16, 2025

chore(release): v2.4.0-beta #2345

Merged

Conversation

onur-ozkan commented Oct 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

onur-ozkan commented Dec 10, 2024

Uh oh!

onur-ozkan commented Dec 17, 2024

Uh oh!

onur-ozkan commented Dec 23, 2024

Uh oh!

mariocynicys left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

onur-ozkan Dec 23, 2024 • 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!

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!

dimxy commented Dec 23, 2024

Uh oh!

onur-ozkan commented Dec 23, 2024

Uh oh!

dimxy commented Dec 23, 2024

Uh oh!

onur-ozkan commented Dec 23, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

onur-ozkan commented Oct 28, 2024 •

edited

Loading

onur-ozkan Dec 23, 2024 •

edited

Loading