Skip to content

Commit

Permalink
Introduce profiles for hybridRelay, hybridArchival, and hybridClient.
Browse files Browse the repository at this point in the history
  • Loading branch information
gmalouf committed Jul 10, 2024
1 parent b3c7bca commit a20c91e
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 8 deletions.
72 changes: 64 additions & 8 deletions cmd/algocfg/profileCommand.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ var (
},
}

relay = configUpdater{
description: "Relay consensus messages across the network and support catchup.",
wsRelay = configUpdater{
description: "Relay consensus messages across the ws network and support recent catchup.",
updateFunc: func(cfg config.Local) config.Local {
cfg.MaxBlockHistoryLookback = 22000 // Enough to support 2 catchpoints with some wiggle room for nodes to catch up from the older one
cfg.CatchpointFileHistoryLength = 3
Expand All @@ -80,7 +80,7 @@ var (
}

archival = configUpdater{
description: "Store the full chain history and support catchup.",
description: "Store the full chain history and support full catchup.",
updateFunc: func(cfg config.Local) config.Local {
cfg.Archival = true
cfg.EnableLedgerService = true
Expand All @@ -91,13 +91,69 @@ var (
},
}

hybridRelay = configUpdater{
description: "Relay consensus messages across both ws and p2p networks, also support recent catchup.",
updateFunc: func(cfg config.Local) config.Local {
// WS relay config defaults
cfg.MaxBlockHistoryLookback = 22000 // Enough to support 2 catchpoints with some wiggle room for nodes to catch up from the older one
cfg.CatchpointFileHistoryLength = 3
cfg.CatchpointTracking = 2
cfg.EnableLedgerService = true
cfg.EnableBlockService = true
cfg.NetAddress = ":4160"
// This should be set to the public address of the node if public access is desired
cfg.PublicAddress = "PLEASE_SET_ME"

// P2P config defaults
cfg.EnableP2PHybridMode = true
cfg.P2PNetAddress = ":4190"
cfg.EnableDHTProviders = true
return cfg
},
}

hybridArchival = configUpdater{
description: "Store the full chain history, support full catchup, P2P enabled, discoverable via DHT.",
updateFunc: func(cfg config.Local) config.Local {
cfg.Archival = true
cfg.EnableLedgerService = true
cfg.EnableBlockService = true
cfg.NetAddress = ":4160"
cfg.EnableGossipService = false
// This should be set to the public address of the node if public access is desired
cfg.PublicAddress = "PLEASE_SET_ME"

// P2P config defaults
cfg.EnableP2PHybridMode = true
cfg.P2PNetAddress = ":4190"
cfg.EnableDHTProviders = true
return cfg
},
}

hybridClient = configUpdater{
description: "Participate in consensus or simply ensure chain health by validating blocks and supporting P2P traffic propagation.",
updateFunc: func(cfg config.Local) config.Local {

// P2P config defaults
cfg.EnableP2PHybridMode = true
cfg.P2PNetAddress = ":4190"
cfg.EnableDHTProviders = true

return cfg
},
}

// profileNames are the supported pre-configurations of config values
profileNames = map[string]configUpdater{
"participation": participation,
"conduit": conduit,
"relay": relay,
"archival": archival,
"development": development,
"participation": participation,
"conduit": conduit,
"wsRelay": wsRelay,
"archival": archival,
"development": development,
"hybridRelay": hybridRelay,
"hybridArchival": hybridArchival,
"hybridClient": hybridClient,
}

forceUpdate bool
Expand Down
61 changes: 61 additions & 0 deletions cmd/algocfg/profileCommand_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,65 @@ func Test_getConfigForArg(t *testing.T) {
require.Equal(t, ":4160", cfg.NetAddress)
require.False(t, cfg.EnableGossipService)
})

t.Run("valid config test hybrid relay", func(t *testing.T) {
t.Parallel()
cfg, err := getConfigForArg("hybridRelay")
require.NoError(t, err)

require.False(t, cfg.Archival)
require.Equal(t, uint64(22000), cfg.MaxBlockHistoryLookback)
require.Equal(t, 3, cfg.CatchpointFileHistoryLength)
require.Equal(t, int64(2), cfg.CatchpointTracking)
require.True(t, cfg.EnableLedgerService)
require.True(t, cfg.EnableBlockService)
require.Equal(t, ":4160", cfg.NetAddress)
require.True(t, cfg.EnableGossipService)
require.Equal(t, "PLEASE_SET_ME", cfg.PublicAddress)

require.True(t, cfg.EnableP2PHybridMode)
require.Equal(t, ":4190", cfg.P2PNetAddress)
require.True(t, cfg.EnableDHTProviders)
})

t.Run("valid config test hybrid archival", func(t *testing.T) {
t.Parallel()
cfg, err := getConfigForArg("hybridArchival")
require.NoError(t, err)

require.True(t, cfg.Archival)
require.Equal(t, uint64(0), cfg.MaxBlockHistoryLookback)
require.Equal(t, 365, cfg.CatchpointFileHistoryLength)
require.Equal(t, int64(0), cfg.CatchpointTracking)
require.True(t, cfg.EnableLedgerService)
require.True(t, cfg.EnableBlockService)
require.Equal(t, ":4160", cfg.NetAddress)
require.False(t, cfg.EnableGossipService)
require.Equal(t, "PLEASE_SET_ME", cfg.PublicAddress)

require.True(t, cfg.EnableP2PHybridMode)
require.Equal(t, ":4190", cfg.P2PNetAddress)
require.True(t, cfg.EnableDHTProviders)
})

t.Run("valid config test hybrid client", func(t *testing.T) {
t.Parallel()
cfg, err := getConfigForArg("hybridClient")
require.NoError(t, err)

require.False(t, cfg.Archival)
require.Equal(t, uint64(0), cfg.MaxBlockHistoryLookback)
require.Equal(t, 365, cfg.CatchpointFileHistoryLength)
require.Equal(t, int64(0), cfg.CatchpointTracking)
require.False(t, cfg.EnableLedgerService)
require.False(t, cfg.EnableBlockService)
require.Empty(t, cfg.NetAddress)
// True because it is the default value, net address is blank so has no effect in practice
require.True(t, cfg.EnableGossipService)
require.Equal(t, "", cfg.PublicAddress)

require.True(t, cfg.EnableP2PHybridMode)
require.Equal(t, ":4190", cfg.P2PNetAddress)
require.True(t, cfg.EnableDHTProviders)
})
}

0 comments on commit a20c91e

Please sign in to comment.