refactor(params): Moving params to p2p

celestiaorg · Oct 18, 2022 · d7b8d37 · d7b8d37
1 parent d239616
commit d7b8d37
Show file tree

Hide file tree

Showing 31 changed files with 161 additions and 171 deletions.
diff --git a/cmd/cel-key/node_types.go b/cmd/cel-key/node_types.go
@@ -8,9 +8,9 @@ import (
  "github.com/spf13/cobra"
  flag "github.com/spf13/pflag"
 
- "github.com/celestiaorg/celestia-node/params"
-
  sdkflags "github.com/cosmos/cosmos-sdk/client/flags"
+
+ "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 )
 
 var (
@@ -20,7 +20,7 @@ var (
 
 func DirectoryFlags() *flag.FlagSet {
  flags := &flag.FlagSet{}
- defaultNetwork := string(params.DefaultNetwork())
+ defaultNetwork := string(p2p.DefaultNetwork)
 
  flags.String(
  nodeDirKey,

diff --git a/cmd/celestia/bridge.go b/cmd/celestia/bridge.go
@@ -3,13 +3,12 @@ package main
 import (
  "github.com/spf13/cobra"
 
+ cmdnode "github.com/celestiaorg/celestia-node/cmd"
  "github.com/celestiaorg/celestia-node/nodebuilder/core"
+ "github.com/celestiaorg/celestia-node/nodebuilder/node"
  "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
  "github.com/celestiaorg/celestia-node/nodebuilder/rpc"
  "github.com/celestiaorg/celestia-node/nodebuilder/state"
-
- cmdnode "github.com/celestiaorg/celestia-node/cmd"
- "github.com/celestiaorg/celestia-node/nodebuilder/node"
 )
 
 // NOTE: We should always ensure that the added Flags below are parsed somewhere, like in the PersistentPreRun func on
@@ -48,6 +47,12 @@ var bridgeCmd = &cobra.Command{
 
  ctx = cmdnode.WithNodeType(ctx, node.Bridge)
 
+ parsedNetwork, err := p2p.ParseNetwork(cmd)
+ if err != nil {
+ return err
+ }
+ ctx = cmdnode.WithNetwork(ctx, parsedNetwork)
+
  ctx, err = cmdnode.ParseNodeFlags(ctx, cmd)
  if err != nil {
  return err

diff --git a/cmd/celestia/full.go b/cmd/celestia/full.go
@@ -4,14 +4,13 @@ package main
 import (
  "github.com/spf13/cobra"
 
+ cmdnode "github.com/celestiaorg/celestia-node/cmd"
  "github.com/celestiaorg/celestia-node/nodebuilder/core"
  "github.com/celestiaorg/celestia-node/nodebuilder/header"
+ "github.com/celestiaorg/celestia-node/nodebuilder/node"
  "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
  "github.com/celestiaorg/celestia-node/nodebuilder/rpc"
  "github.com/celestiaorg/celestia-node/nodebuilder/state"
-
- cmdnode "github.com/celestiaorg/celestia-node/cmd"
- "github.com/celestiaorg/celestia-node/nodebuilder/node"
 )
 
 // NOTE: We should always ensure that the added Flags below are parsed somewhere, like in the PersistentPreRun func on
@@ -56,6 +55,12 @@ var fullCmd = &cobra.Command{
 
  ctx = cmdnode.WithNodeType(ctx, node.Full)
 
+ parsedNetwork, err := p2p.ParseNetwork(cmd)
+ if err != nil {
+ return err
+ }
+ ctx = cmdnode.WithNetwork(ctx, parsedNetwork)
+
  ctx, err = cmdnode.ParseNodeFlags(ctx, cmd)
  if err != nil {
  return err

diff --git a/cmd/celestia/light.go b/cmd/celestia/light.go
@@ -4,14 +4,13 @@ package main
 import (
  "github.com/spf13/cobra"
 
+ cmdnode "github.com/celestiaorg/celestia-node/cmd"
  "github.com/celestiaorg/celestia-node/nodebuilder/core"
  "github.com/celestiaorg/celestia-node/nodebuilder/header"
+ "github.com/celestiaorg/celestia-node/nodebuilder/node"
  "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
  "github.com/celestiaorg/celestia-node/nodebuilder/rpc"
  "github.com/celestiaorg/celestia-node/nodebuilder/state"
-
- cmdnode "github.com/celestiaorg/celestia-node/cmd"
- "github.com/celestiaorg/celestia-node/nodebuilder/node"
 )
 
 // NOTE: We should always ensure that the added Flags below are parsed somewhere, like in the PersistentPreRun func on
@@ -56,6 +55,12 @@ var lightCmd = &cobra.Command{
 
  ctx = cmdnode.WithNodeType(ctx, node.Light)
 
+ parsedNetwork, err := p2p.ParseNetwork(cmd)
+ if err != nil {
+ return err
+ }
+ ctx = cmdnode.WithNetwork(ctx, parsedNetwork)
+
  // loads existing config into the environment
  ctx, err = cmdnode.ParseNodeFlags(ctx, cmd)
  if err != nil {

diff --git a/cmd/env.go b/cmd/env.go
@@ -8,6 +8,7 @@ import (
 
  "github.com/celestiaorg/celestia-node/nodebuilder"
  "github.com/celestiaorg/celestia-node/nodebuilder/node"
+ "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 )
 
 var log = logging.Logger("cmd")
@@ -17,6 +18,11 @@ func NodeType(ctx context.Context) node.Type {
  return ctx.Value(nodeTypeKey{}).(node.Type)
 }
 
+// Network reads the node type from the context.
+func Network(ctx context.Context) p2p.Network {
+ return ctx.Value(networkKey{}).(p2p.Network)
+}
+
 // StorePath reads the store path from the context.
 func StorePath(ctx context.Context) string {
  return ctx.Value(storePathKey{}).(string)
@@ -37,6 +43,11 @@ func WithNodeType(ctx context.Context, tp node.Type) context.Context {
  return context.WithValue(ctx, nodeTypeKey{}, tp)
 }
 
+// WithNetwork sets the network in the given context.
+func WithNetwork(ctx context.Context, network p2p.Network) context.Context {
+ return context.WithValue(ctx, networkKey{}, network)
+}
+
 // WithStorePath sets Store Path in the given context.
 func WithStorePath(ctx context.Context, storePath string) context.Context {
  return context.WithValue(ctx, storePathKey{}, storePath)
@@ -67,4 +78,5 @@ type (
  configKey struct{}
  storePathKey struct{}
  nodeTypeKey struct{}
+ networkKey struct{}
 )
diff --git a/cmd/flags_node.go b/cmd/flags_node.go
@@ -11,13 +11,11 @@ import (
  flag "github.com/spf13/pflag"
 
  "github.com/celestiaorg/celestia-node/nodebuilder"
- "github.com/celestiaorg/celestia-node/params"
 )
 
 var (
- nodeStoreFlag = "node.store"
- nodeConfigFlag = "node.config"
- nodeNetworkFlag = "node.network"
+ nodeStoreFlag = "node.store"
+ nodeConfigFlag = "node.config"
 )
 
 // NodeFlags gives a set of hardcoded Node package flags.
@@ -34,31 +32,17 @@ func NodeFlags() *flag.FlagSet {
  "",
  "Path to a customized node config TOML file",
  )
- flags.String(
- nodeNetworkFlag,
- "",
- "The name of the network to connect to, e.g. "+params.ListProvidedNetworks(),
- )
 
  return flags
 }
 
 // ParseNodeFlags parses Node flags from the given cmd and applies values to Env.
 func ParseNodeFlags(ctx context.Context, cmd *cobra.Command) (context.Context, error) {
- network := cmd.Flag(nodeNetworkFlag).Value.String()
- if network != "" {
- err := params.SetDefaultNetwork(params.Network(network))
- if err != nil {
- return ctx, err
- }
- } else {
- network = string(params.DefaultNetwork())
- }
-
+ network := Network(ctx)
  store := cmd.Flag(nodeStoreFlag).Value.String()
  if store == "" {
  tp := NodeType(ctx)
- store = fmt.Sprintf("~/.celestia-%s-%s", strings.ToLower(tp.String()), strings.ToLower(network))
+ store = fmt.Sprintf("~/.celestia-%s-%s", strings.ToLower(tp.String()), strings.ToLower(string(network)))
  }
  ctx = WithStorePath(ctx, store)
 

diff --git a/cmd/start.go b/cmd/start.go
@@ -29,7 +29,7 @@ Options passed on start override configuration options only on start and are not
  // override config with all modifiers passed on start
  cfg := NodeConfig(ctx)
 
- nd, err := nodebuilder.NewWithConfig(NodeType(ctx), store, &cfg, NodeOptions(ctx)...)
+ nd, err := nodebuilder.NewWithConfig(NodeType(ctx), Network(ctx), store, &cfg, NodeOptions(ctx)...)
  if err != nil {
  return err
  }

diff --git a/das/daser_test.go b/das/daser_test.go
@@ -139,7 +139,7 @@ func TestDASer_stopsAfter_BEFP(t *testing.T) {
  // 15 headers from the past and 15 future headers
  mockGet, sub, _ := createDASerSubcomponents(t, bServ, 15, 15)
 
- // create fraud share and break one header
+ // create fraud service and break one header
  f := fraud.NewProofService(ps, net.Hosts()[0], mockGet.GetByHeight, ds, false)
  require.NoError(t, f.Start(ctx))
  mockGet.headers[1] = header.CreateFraudExtHeader(t, mockGet.headers[1], bServ)

diff --git a/fraud/service.go b/fraud/service.go
@@ -13,18 +13,17 @@ import (
  "github.com/libp2p/go-libp2p-core/peer"
  "github.com/libp2p/go-libp2p-core/protocol"
  pubsub "github.com/libp2p/go-libp2p-pubsub"
-
- "github.com/celestiaorg/celestia-node/params"
-
  "go.opentelemetry.io/otel/attribute"
  "go.opentelemetry.io/otel/codes"
  "go.opentelemetry.io/otel/trace"
+
+ "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 )
 
 // fraudRequests is the amount of external requests that will be tried to get fraud proofs from other peers.
 const fraudRequests = 5
 
-var fraudProtocolID = protocol.ID(fmt.Sprintf("/fraud/v0.0.1/%s", params.DefaultNetwork()))
+var fraudProtocolID = protocol.ID(fmt.Sprintf("/fraud/v0.0.1/%s", p2p.DefaultNetwork))
 
 // ProofService is responsible for validating and propagating Fraud Proofs.
 // It implements the Service interface.

diff --git a/header/p2p/exchange.go b/header/p2p/exchange.go
@@ -18,7 +18,7 @@ import (
 
  "github.com/celestiaorg/celestia-node/header"
  p2p_pb "github.com/celestiaorg/celestia-node/header/p2p/pb"
- "github.com/celestiaorg/celestia-node/params"
+ "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 )
 
 var log = logging.Logger("header/p2p")
@@ -38,7 +38,7 @@ const (
 // gossipsub topic.
 const PubSubTopic = "header-sub"
 
-var exchangeProtocolID = protocol.ID(fmt.Sprintf("/header-ex/v0.0.3/%s", params.DefaultNetwork()))
+var exchangeProtocolID = protocol.ID(fmt.Sprintf("/header-ex/v0.0.3/%s", p2p.DefaultNetwork))
 
 // Exchange enables sending outbound ExtendedHeaderRequests to the network as well as
 // handling inbound ExtendedHeaderRequests from the network.

diff --git a/nodebuilder/header/config.go b/nodebuilder/header/config.go
@@ -7,7 +7,7 @@ import (
  "github.com/multiformats/go-multiaddr"
  tmbytes "github.com/tendermint/tendermint/libs/bytes"
 
- "github.com/celestiaorg/celestia-node/params"
+ "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 )
 
 // Config contains configuration parameters for header retrieval and management.
@@ -28,7 +28,7 @@ func DefaultConfig() Config {
  }
 }
 
-func (cfg *Config) trustedPeers(bpeers params.Bootstrappers) (infos []peer.AddrInfo, err error) {
+func (cfg *Config) trustedPeers(bpeers p2p.Bootstrappers) (infos []peer.AddrInfo, err error) {
  if len(cfg.TrustedPeers) == 0 {
  log.Infof("No trusted peers in config, initializing with default bootstrappers as trusted peers")
  return bpeers, nil
@@ -49,9 +49,9 @@ func (cfg *Config) trustedPeers(bpeers params.Bootstrappers) (infos []peer.AddrI
  return
 }
 
-func (cfg *Config) trustedHash(net params.Network) (tmbytes.HexBytes, error) {
+func (cfg *Config) trustedHash(net p2p.Network) (tmbytes.HexBytes, error) {
  if cfg.TrustedHash == "" {
- gen, err := params.GenesisFor(net)
+ gen, err := p2p.GenesisFor(net)
  if err != nil {
  return nil, err
  }

diff --git a/nodebuilder/header/header.go b/nodebuilder/header/header.go
@@ -13,12 +13,12 @@ import (
  "github.com/celestiaorg/celestia-node/header/p2p"
  "github.com/celestiaorg/celestia-node/header/store"
  "github.com/celestiaorg/celestia-node/header/sync"
- "github.com/celestiaorg/celestia-node/params"
+ modp2p "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 )
 
 // newP2PExchange constructs new Exchange for headers.
-func newP2PExchange(cfg Config) func(params.Bootstrappers, host.Host) (header.Exchange, error) {
- return func(bpeers params.Bootstrappers, host host.Host) (header.Exchange, error) {
+func newP2PExchange(cfg Config) func(modp2p.Bootstrappers, host.Host) (header.Exchange, error) {
+ return func(bpeers modp2p.Bootstrappers, host host.Host) (header.Exchange, error) {
  peers, err := cfg.trustedPeers(bpeers)
  if err != nil {
  return nil, err
@@ -45,7 +45,7 @@ type initStore header.Store
 func newInitStore(
  lc fx.Lifecycle,
  cfg Config,
- net params.Network,
+ net modp2p.Network,
  s header.Store,
  ex header.Exchange,
 ) (initStore, error) {

diff --git a/nodebuilder/header/module.go b/nodebuilder/header/module.go
@@ -13,7 +13,7 @@ import (
  "github.com/celestiaorg/celestia-node/header/sync"
  fraudServ "github.com/celestiaorg/celestia-node/nodebuilder/fraud"
  "github.com/celestiaorg/celestia-node/nodebuilder/node"
- "github.com/celestiaorg/celestia-node/params"
+ modp2p "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 )
 
 var log = logging.Logger("header-module")
@@ -25,7 +25,7 @@ func ConstructModule(tp node.Type, cfg *Config) fx.Option {
  baseComponents := fx.Options(
  fx.Supply(*cfg),
  fx.Error(cfgErr),
- fx.Supply(params.BlockTime),
+ fx.Supply(modp2p.BlockTime),
  fx.Provide(NewHeaderService),
  fx.Provide(fx.Annotate(
  store.NewStore,

diff --git a/nodebuilder/init.go b/nodebuilder/init.go
@@ -8,7 +8,7 @@ import (
  "github.com/celestiaorg/celestia-node/libs/fslock"
  "github.com/celestiaorg/celestia-node/libs/utils"
  "github.com/celestiaorg/celestia-node/nodebuilder/node"
- "github.com/celestiaorg/celestia-node/params"
+ "github.com/celestiaorg/celestia-node/nodebuilder/p2p"
 )
 
 // Init initializes the Node FileSystem Store for the given Node Type 'tp' in the directory under 'path'.
@@ -104,7 +104,7 @@ func initDir(path string) error {
  if utils.Exists(path) {
  // if the dir already exists and `CELESTIA_CUSTOM` env var is set,
  // fail out to prevent store corruption
- if _, ok := os.LookupEnv(params.EnvCustomNetwork); ok {
+ if _, ok := os.LookupEnv(p2p.EnvCustomNetwork); ok {
  return fmt.Errorf("cannot run a custom network over an already-existing node store")
  }
  return nil

diff --git a/nodebuilder/module.go b/nodebuilder/module.go
@@ -15,13 +15,13 @@ import (
  "github.com/celestiaorg/celestia-node/nodebuilder/rpc"
  "github.com/celestiaorg/celestia-node/nodebuilder/share"
  "github.com/celestiaorg/celestia-node/nodebuilder/state"
- "github.com/celestiaorg/celestia-node/params"
 )
 
-func ConstructModule(tp node.Type, cfg *Config, store Store) fx.Option {
+func ConstructModule(tp node.Type, network p2p.Network, cfg *Config, store Store) fx.Option {
  baseComponents := fx.Options(
- fx.Provide(params.DefaultNetwork),
- fx.Provide(params.BootstrappersFor),
+ fx.Supply(tp),
+ fx.Supply(network),
+ fx.Provide(p2p.BootstrappersFor),
  fx.Provide(func(lc fx.Lifecycle) context.Context {
  return fxutil.WithLifecycle(context.Background(), lc)
  }),
@@ -42,7 +42,6 @@ func ConstructModule(tp node.Type, cfg *Config, store Store) fx.Option {
 
  return fx.Module(
  "node",
- fx.Supply(tp),
  baseComponents,
  )
 }