@@ -9,17 +9,17 @@ import (
99 "errors"
1010 "fmt"
1111 "io"
12- "io/fs"
1312 "os"
1413 "path/filepath"
1514 "strconv"
1615 "strings"
1716 "time"
1817
18+ "github.com/google/uuid"
19+
1920 "github.com/ava-labs/avalanchego/config"
2021 "github.com/ava-labs/avalanchego/genesis"
2122 "github.com/ava-labs/avalanchego/ids"
22- "github.com/ava-labs/avalanchego/utils/constants"
2323 "github.com/ava-labs/avalanchego/utils/crypto/secp256k1"
2424 "github.com/ava-labs/avalanchego/utils/perms"
2525 "github.com/ava-labs/avalanchego/utils/set"
@@ -40,6 +40,9 @@ const (
4040 // increase the time for a network's nodes to be seen as healthy.
4141 networkHealthCheckInterval = 200 * time .Millisecond
4242
43+ // All temporary networks will use this arbitrary network ID by default.
44+ defaultNetworkID = 88888
45+
4346 // eth address: 0x8db97C7cEcE249c2b98bDC0226Cc4C2A57BF52FC
4447 HardHatKeyStr = "56289e99c94b6912bfc12adc093c9b51124f0dc54ac7a766b2bc5ccf558d8027"
4548)
@@ -61,6 +64,16 @@ func init() {
6164
6265// Collects the configuration for running a temporary avalanchego network
6366type Network struct {
67+ // Uniquely identifies the temporary network for metrics
68+ // collection. Distinct from avalanchego's concept of network ID
69+ // since the utility of special network ID values (e.g. to trigger
70+ // specific fork behavior in a given network) precludes requiring
71+ // unique network ID values across all temporary networks.
72+ UUID string
73+
74+ // A string identifying the entity that started or maintains this network.
75+ Owner string
76+
6477 // Path where network configuration and data is stored
6578 Dir string
6679
@@ -150,6 +163,11 @@ func (n *Network) EnsureDefaultConfig(w io.Writer, avalancheGoPath string, plugi
150163 return err
151164 }
152165
166+ // A UUID supports centralized metrics collection
167+ if len (n .UUID ) == 0 {
168+ n .UUID = uuid .NewString ()
169+ }
170+
153171 // Ensure default flags
154172 if n .DefaultFlags == nil {
155173 n .DefaultFlags = FlagsMap {}
@@ -206,8 +224,9 @@ func (n *Network) EnsureDefaultConfig(w io.Writer, avalancheGoPath string, plugi
206224 return nil
207225}
208226
209- // Creates the network on disk, choosing its network id and generating its genesis in the process.
227+ // Creates the network on disk, generating its genesis and configuring its nodes in the process.
210228func (n * Network ) Create (rootDir string ) error {
229+ // Ensure creation of the root dir
211230 if len (rootDir ) == 0 {
212231 // Use the default root dir
213232 var err error
@@ -216,48 +235,34 @@ func (n *Network) Create(rootDir string) error {
216235 return err
217236 }
218237 }
219-
220- // Ensure creation of the root dir
221238 if err := os .MkdirAll (rootDir , perms .ReadWriteExecute ); err != nil {
222239 return fmt .Errorf ("failed to create root network dir: %w" , err )
223240 }
224241
225- // Determine the network path and ID
226- var (
227- networkDir string
228- networkID uint32
229- )
230- if n .Genesis != nil && n .Genesis .NetworkID > 0 {
231- // Use the network ID defined in the provided genesis
232- networkID = n .Genesis .NetworkID
242+ // A time-based name ensures consistent directory ordering
243+ dirName := time .Now ().Format ("20060102-150405.999999" )
244+ if len (n .Owner ) > 0 {
245+ // Include the owner to differentiate networks created at similar times
246+ dirName = fmt .Sprintf ("%s-%s" , dirName , n .Owner )
233247 }
234- if networkID > 0 {
235- // Use a directory with a random suffix
236- var err error
237- networkDir , err = os .MkdirTemp (rootDir , fmt .Sprintf ("%d." , n .Genesis .NetworkID ))
238- if err != nil {
239- return fmt .Errorf ("failed to create network dir: %w" , err )
240- }
241- } else {
242- // Find the next available network ID based on the contents of the root dir
243- var err error
244- networkID , networkDir , err = findNextNetworkID (rootDir )
245- if err != nil {
246- return err
247- }
248+
249+ // Ensure creation of the network dir
250+ networkDir := filepath .Join (rootDir , dirName )
251+ if err := os .MkdirAll (networkDir , perms .ReadWriteExecute ); err != nil {
252+ return fmt .Errorf ("failed to create network dir: %w" , err )
248253 }
249254 canonicalDir , err := toCanonicalDir (networkDir )
250255 if err != nil {
251256 return err
252257 }
253258 n .Dir = canonicalDir
254259
260+ // Ensure the existence of the plugin directory or nodes won't be able to start.
255261 pluginDir , err := n .DefaultFlags .GetStringVal (config .PluginDirKey )
256262 if err != nil {
257263 return err
258264 }
259265 if len (pluginDir ) > 0 {
260- // Ensure the existence of the plugin directory or nodes won't be able to start.
261266 if err := os .MkdirAll (pluginDir , perms .ReadWriteExecute ); err != nil {
262267 return fmt .Errorf ("failed to create plugin dir: %w" , err )
263268 }
@@ -275,7 +280,7 @@ func (n *Network) Create(rootDir string) error {
275280 }
276281 keysToFund = append (keysToFund , n .PreFundedKeys ... )
277282
278- genesis , err := NewTestGenesis (networkID , n .Nodes , keysToFund )
283+ genesis , err := NewTestGenesis (defaultNetworkID , n .Nodes , keysToFund )
279284 if err != nil {
280285 return err
281286 }
@@ -296,7 +301,7 @@ func (n *Network) Create(rootDir string) error {
296301
297302// Starts all nodes in the network
298303func (n * Network ) Start (ctx context.Context , w io.Writer ) error {
299- if _ , err := fmt .Fprintf (w , "Starting network %d @ %s\n " , n .Genesis . NetworkID , n .Dir ); err != nil {
304+ if _ , err := fmt .Fprintf (w , "Starting network %s (UUID: %s) \n " , n .Dir , n .UUID ); err != nil {
300305 return err
301306 }
302307
@@ -313,7 +318,7 @@ func (n *Network) Start(ctx context.Context, w io.Writer) error {
313318 if err := n .WaitForHealthy (ctx , w ); err != nil {
314319 return err
315320 }
316- if _ , err := fmt .Fprintf (w , "\n Started network %d @ %s\n " , n .Genesis . NetworkID , n .Dir ); err != nil {
321+ if _ , err := fmt .Fprintf (w , "\n Started network %s (UUID: %s) \n " , n .Dir , n .UUID ); err != nil {
317322 return err
318323 }
319324
@@ -676,33 +681,3 @@ func getDefaultRootDir() (string, error) {
676681 }
677682 return filepath .Join (homeDir , ".tmpnet" , "networks" ), nil
678683}
679-
680- // Finds the next available network ID by attempting to create a
681- // directory numbered from 1000 until creation succeeds. Returns the
682- // network id and the full path of the created directory.
683- func findNextNetworkID (rootDir string ) (uint32 , string , error ) {
684- var (
685- networkID uint32 = 1000
686- dirPath string
687- )
688- for {
689- _ , reserved := constants .NetworkIDToNetworkName [networkID ]
690- if reserved {
691- networkID ++
692- continue
693- }
694-
695- dirPath = filepath .Join (rootDir , strconv .FormatUint (uint64 (networkID ), 10 ))
696- err := os .Mkdir (dirPath , perms .ReadWriteExecute )
697- if err == nil {
698- return networkID , dirPath , nil
699- }
700-
701- if ! errors .Is (err , fs .ErrExist ) {
702- return 0 , "" , fmt .Errorf ("failed to create network directory: %w" , err )
703- }
704-
705- // Directory already exists, keep iterating
706- networkID ++
707- }
708- }
0 commit comments