feat(utxo): prioritize electrum connections #1966
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
onur-ozkan
changed the title
onur-ozkan
requested changes
Sep 12, 2023
shamardy
reviewed
Sep 15, 2023
mm2src/coins/utxo/rpc_clients.rs
Outdated
| pub struct ElectrumClientImpl { | ||
| weak_self: Mutex<Option<Weak<ElectrumClientImpl>>>, |
There was a problem hiding this comment.
This is a very bad design choice, the struct should never reference it self to not create any unstable behavior.
There was a problem hiding this comment.
There was a problem hiding this comment.
why not just introduce a new struct ? e.g
struct ElectrumClientImplWeak(Mutex<Option<Weak<ElectrumClientImpl>>>)
mm2src/coins/utxo/rpc_clients.rs
Outdated
| struct ConnMng(Arc<ConnMngImpl>); | ||
|
|
||
| impl ConnMng { | ||
| async fn suspend_server(self, address: String) -> Result<(), String> { |
There was a problem hiding this comment.
Since this is a new implementation, please start using specific error types and MmError
mm2src/coins/utxo/rpc_clients.rs
Outdated
Comment on lines
2751
to
2754
| spawner.spawn(async move { | ||
| let state = conn_mng.0.guarded.lock().await; | ||
| state.connecting.store(false, AtomicOrdering::Relaxed); | ||
| }) |
There was a problem hiding this comment.
Can you please elaborate on this more? ConnectingStateCtx will be considered dropped before connecting is set to false if the lock was held by other operation for sometime.
There was a problem hiding this comment.
Certainly should have been more detailed! Thanks for pointing this out! This place is the heart of selective connectivity.
mm2src/coins/utxo/rpc_clients.rs
Outdated
Comment on lines
2732
to
2738
| let address: String = { | ||
| if address.is_some() { | ||
| address.map(|internal| internal.to_string()) | ||
| } else { | ||
| guard.active.as_ref().cloned() | ||
| } | ||
| }?; |
There was a problem hiding this comment.
Suggested change
| let address: String = { | |
| if address.is_some() { | |
| address.map(|internal| internal.to_string()) | |
| } else { | |
| guard.active.as_ref().cloned() | |
| } | |
| }?; | |
| let address = address.map_or_else(|| guard.active.as_ref().cloned(), |internal| Some(internal.to_string()))?; |
added 10 commits
September 21, 2023 12:31
rozhkovdmitrii
force-pushed
the
1520-prioritize-nodes
branch
from
38adc56
to
cfbeea0
Compare
still needs refactoring for the tons of warnings there also selective connection manager is missing
the total time this method might take is at most the timeout decided in the connection settings, which is the time needed to establish the connection and query for the version
the abortable system that created the children abortable systems for the connections were dropped and that resulted in a non functioning connection abortable systems
electrum servers don't like it when the same connection query for the vesion again, they expect us to store the version and never ask about it again
the middle subsystem wasn't used anywhere, thus was dropped and caused all the connection subsystems to get aborted.
…zation and not in tests
the new design doesn't break the coin initilization if the electrum servers fail for whatever reason. Create the coin and make sure that each server fails version check when queried
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a new electrum connection management system that is presented by two defined policies:
multipleandselective. In the future the other types of connections are presumably to be managed in the same way.Setting up conn mng policy
To set up connection management policy the
conn_mng_policyshould be provided in the mm2 configuration file (MM2.json). This setting is also provided by thekomodefi-cli(adex-cli)initcommandExample:
{ "gui": "adex-cli", "netid": 7777, "rpc_password": "#asdfASD2", "passphrase": "please excite exit liquid amused light canal cattle depart execute code leaf", "allow_weak_password": false, "conn_mng_policy": "multiple" }Selective move and electrum activation scheme
Selective mode assumes that the electrum activation method is extended by the
priorityandtimeout_secsettings, which determine in which queue the associated addresses are connected and how long the connection should take, respectively.primarynodes are connected first thensecondaryones. These settings are optional and if are not set the default values are applied.secondarypriority is set by default.Example:
{ "platform": "UTXO", "coin": "DOC", "command": { "coin": "DOC", "method": "electrum", "servers": [ { "url": "electrum1.cipig.net:10020", "priority": "primary", "timeout_sec": 10, "contact": [ { "email": "cipi@komodoplatform.com" }, { "discord": "cipi#4502" } ] }, { "url": "electrum2.cipig.net:10020", "priority": "secondary", "timeout_sec": 20, "contact": [ { "email": "cipi@komodoplatform.com" }, { "discord": "cipi#4502" } ] }, { "url": "electrum3.cipig.net:10020", "priority": "primary", "timeout_sec": 10, "contact": [ { "email": "cipi@komodoplatform.com" }, { "discord": "cipi#4502" } ] }, { "url": "electrum1.cipig.net:20020", ... }For the given activation scheme mm2 has the following addresses queue:
It is important to note that addresses are shuffled before being queued.
If a connection cannot be established with an address or if it is broken for any reason, it is suspended for 30, 60, 120, etc. seconds, after which it is resumed. Resuming assumes that the primary address pushes out the secondary one, if it is currently connected.
Testing
selectiveandmultipleconn mng policyThere are several practices that have been used to test expected behavior. These practices are provided in the examples for your reference:
In the separate frame
elease/adex-cli enable DOC Enabling asset: DOC coin: DOC address: RPFGrvJWjSYN4qYvcXsECW1HoHbvQjowZM balance: 949828.3746221 unspendable_balance: 0 required_confirmations: 1 requires_notarization: No mature_confirmations: 100Using the table of established connection it's always possible to know what address mm2 is connected to check if it's connected to expected ones. It is also possible to break the certain connection to check if that is suspended/resumed.