Swarm config refactoring #12117

lxfind · 2023-05-20T17:07:11Z

This PR does a series of refactoring on how we construct node config and swarm configs to make it cleaner:

Renames utils.rs in sui-config/ to local_ip_utils.rs, and moved all the IP and port management port into it. Now it contains a manager to generate new IPs and new ports for simtest; for non-simtest it always use localhost and new available port.
Previously we start fullnode inside TestCluster, which runs on the client node in simtest. This created a lot of tech debt. This PR moves all fullnode creation into Swarm. Now we can start arbitrary number of fullnodes in a Swarm. When starting TestCluster, it uses Swarm to launch a fullnode, and keep a copy of the fullnode handle locally for rpc access.
Also added the ability to start more fullnodes after a test cluster started running, inside swarm. This means we could also run those fullnodes in a container, managed by the swarm.
Heavy use of the builder pattern: added ValidatorGenesisConfigBuilder to build a ValidatorGenesisConfig; added ValidatorConfigBuilder and FullnodeConfigBuilder to build their node configs.
Removed a number of unused fields in ConfigBuilder and SwarmBuilder.

This this PR, we should be able to start removing all the code that spawns individual nodes instead of inside a container.

vercel · 2023-05-20T17:07:19Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
offline-signer-helper	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 25, 2023 3:37am

4 Ignored Deployments

Name	Status	Updated (UTC)
explorer	⬜️ Ignored (Inspect)	May 25, 2023 3:37am
explorer-storybook	⬜️ Ignored (Inspect)	May 25, 2023 3:37am
sui-wallet-kit	⬜️ Ignored (Inspect)	May 25, 2023 3:37am
wallet-adapter	⬜️ Ignored (Inspect)	May 25, 2023 3:37am

lxfind · 2023-05-22T23:47:11Z

crates/mysten-network/src/multiaddr.rs

+    // Converts a /ip{4,6}/-/tcp/-[/-] Multiaddr to SocketAddr.
+    // Useful when an external library only accepts SocketAddr, e.g. to start a local server.
+    // See `client::endpoint_from_multiaddr()` for converting to Endpoint for clients.
+    pub fn to_socket_addr(&self) -> Result<SocketAddr> {


Non-functional-change

lxfind · 2023-05-22T23:47:41Z

crates/sui-benchmark/tests/simtest.rs

+    /// Get a list of nodes that we don't want to kill in the crash recovery tests.
+    /// This includes the client node which is the node that is running the test, as well as
+    /// rpc fullnode which are needed to run the benchmark.
+    fn get_keep_alive_nodes(cluster: &TestCluster) -> HashSet<sui_simulator::task::NodeId> {


This is added such that crash recovery tests don't kill the rpc fullnode

lxfind · 2023-05-22T23:48:16Z

crates/sui-config/src/local_ip_utils.rs

@@ -0,0 +1,140 @@
+// Copyright (c) Mysten Labs, Inc.


This is a rename of utils.rs, but also with consolidated ip management for both simtest and non-simtest

lxfind · 2023-05-22T23:49:03Z

crates/sui-swarm-config/src/network_config_builder.rs

    genesis_config: Option<GenesisConfig>,
    reference_gas_price: Option<u64>,
    additional_objects: Vec<Object>,
-    with_swarm: bool,


A lot of fields are deleted since they are never needed

crates/sui-swarm-config/src/node_config_builder.rs

healthydeve · 2023-05-24T16:41:43Z

crates/sui-swarm-config/src/node_config_builder.rs

+fn get_key_path(key_pair: &AuthorityKeyPair) -> String {
+    let public_key: AuthorityPublicKeyBytes = key_pair.public().into();
+    let mut key_path = Hex::encode(public_key);
+    key_path.truncate(12);


Nit: make this 12 a constant? or comment what it is?

I copied this from old code. It's just to name the directory name of the validator using validator's public key, but make it shorter

bmwill · 2023-05-23T15:28:11Z

crates/mysten-network/src/multiaddr.rs

+            SocketAddr::V4(v4) => format!("/ip4/{}/udp/{}", v4.ip(), v4.port()),
+            SocketAddr::V6(v6) => format!("/ip6/{}/udp/{}", v6.ip(), v6.port()),


Is this intended to only be used for udp addresses and not tcp ones?

This is out-of-dated code, removed.

mystenmark

some small comments - LGTM otherwise

mystenmark · 2023-05-24T17:55:48Z

crates/sui-swarm/src/memory/swarm.rs

+
+    pub async fn spawn_new_fullnode(&mut self, config: NodeConfig) -> SuiNodeHandle {
+        let name = config.protocol_public_key();
+        let node = Node::new(config);


it would be great if we could add something to the name of the fullnode nodes so that they can be distinguished from validators in the logs

crates/sui/tests/full_node_tests.rs

vercel bot deployed to Preview – offline-signer-helper May 20, 2023 17:07 View deployment

lxfind force-pushed the swarm-start-fullnode-in-container branch from 121f989 to 0a8bef8 Compare May 21, 2023 15:58

vercel bot deployed to Preview – offline-signer-helper May 21, 2023 15:58 View deployment

lxfind force-pushed the swarm-start-fullnode-in-container branch from 0a8bef8 to ca1566a Compare May 22, 2023 05:27

vercel bot deployed to Preview – offline-signer-helper May 22, 2023 05:27 View deployment

lxfind force-pushed the swarm-start-fullnode-in-container branch from ca1566a to 46da9c8 Compare May 22, 2023 23:31

lxfind marked this pull request as ready for review May 22, 2023 23:31

vercel bot deployed to Preview – offline-signer-helper May 22, 2023 23:31 View deployment

lxfind force-pushed the swarm-start-fullnode-in-container branch from 46da9c8 to ec63ea3 Compare May 22, 2023 23:44

vercel bot deployed to Preview – offline-signer-helper May 22, 2023 23:46 View deployment

lxfind commented May 22, 2023

View reviewed changes

lxfind requested review from mystenmark, asonnino, aschran, bmwill and emmazzz May 22, 2023 23:55

lxfind changed the title ~~Consolidate IP management in tests and config builders~~ Swarm config refactoring May 22, 2023

lxfind force-pushed the swarm-start-fullnode-in-container branch from ec63ea3 to d4438e5 Compare May 23, 2023 00:08

lxfind requested a review from healthydeve May 23, 2023 00:08

vercel bot deployed to Preview – offline-signer-helper May 23, 2023 00:08 View deployment

lxfind force-pushed the swarm-start-fullnode-in-container branch from d4438e5 to 88f37e5 Compare May 23, 2023 02:00

vercel bot deployed to Preview – offline-signer-helper May 23, 2023 02:01 View deployment

lxfind force-pushed the swarm-start-fullnode-in-container branch from 88f37e5 to 68e6b67 Compare May 23, 2023 15:02

vercel bot deployed to Preview – offline-signer-helper May 23, 2023 15:03 View deployment

lxfind force-pushed the swarm-start-fullnode-in-container branch from 68e6b67 to 1f9e8fa Compare May 23, 2023 20:01

vercel bot deployed to Preview – offline-signer-helper May 23, 2023 20:02 View deployment

healthydeve reviewed May 24, 2023

View reviewed changes

crates/sui-swarm-config/src/node_config_builder.rs Outdated Show resolved Hide resolved

healthydeve reviewed May 24, 2023

View reviewed changes

bmwill approved these changes May 24, 2023

View reviewed changes

mystenmark approved these changes May 24, 2023

View reviewed changes

lxfind force-pushed the swarm-start-fullnode-in-container branch from 1f9e8fa to 25b48bd Compare May 25, 2023 02:13

lxfind enabled auto-merge (squash) May 25, 2023 02:13

vercel bot deployed to Preview – offline-signer-helper May 25, 2023 02:13 View deployment

Consolidate IP and node/config management in tests

8169ced

lxfind force-pushed the swarm-start-fullnode-in-container branch from 25b48bd to 8169ced Compare May 25, 2023 03:37

vercel bot deployed to Preview – offline-signer-helper May 25, 2023 03:37 View deployment

lxfind merged commit cd6bbe0 into main May 25, 2023

lxfind deleted the swarm-start-fullnode-in-container branch May 25, 2023 04:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swarm config refactoring #12117

Swarm config refactoring #12117

lxfind commented May 20, 2023 •

edited

Loading

vercel bot commented May 20, 2023 •

edited

Loading

lxfind May 22, 2023

lxfind May 22, 2023

lxfind May 22, 2023

lxfind May 22, 2023

healthydeve May 24, 2023

lxfind May 25, 2023

bmwill May 23, 2023

lxfind May 25, 2023

mystenmark left a comment

mystenmark May 24, 2023

		SocketAddr::V4(v4) => format!("/ip4/{}/udp/{}", v4.ip(), v4.port()),
		SocketAddr::V6(v6) => format!("/ip6/{}/udp/{}", v6.ip(), v6.port()),

Swarm config refactoring #12117

Swarm config refactoring #12117

Conversation

lxfind commented May 20, 2023 • edited Loading

vercel bot commented May 20, 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

Choose a reason for hiding this comment

mystenmark left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lxfind commented May 20, 2023 •

edited

Loading

vercel bot commented May 20, 2023 •

edited

Loading