go-waku/cmd/waku/flags.go

package main

import (
	"time"

	"github.com/urfave/cli/v2"
	"github.com/waku-org/go-waku/waku/cliutils"
)

var (
	TcpPort = &cli.IntFlag{
		Name:        "tcp-port",
		Aliases:     []string{"port", "p"},
		Value:       60000,
		Usage:       "Libp2p TCP listening port (0 for random)",
		Destination: &options.Port,
	}
	Address = &cli.StringFlag{
		Name:        "address",
		Aliases:     []string{"host", "listen-address"},
		Value:       "0.0.0.0",
		Usage:       "Listening address",
		Destination: &options.Address,
	}
	WebsocketSupport = &cli.BoolFlag{
		Name:        "websocket-support",
		Aliases:     []string{"ws"},
		Usage:       "Enable websockets support",
		Destination: &options.Websocket.Enable,
	}
	WebsocketPort = &cli.IntFlag{
		Name:        "websocket-port",
		Aliases:     []string{"ws-port"},
		Value:       60001,
		Usage:       "Libp2p TCP listening port for websocket connection (0 for random)",
		Destination: &options.Websocket.WSPort,
	}
	WebsocketSecurePort = &cli.IntFlag{
		Name:        "websocket-secure-port",
		Aliases:     []string{"wss-port"},
		Value:       6443,
		Usage:       "Libp2p TCP listening port for secure websocket connection (0 for random, binding to 443 requires root access)",
		Destination: &options.Websocket.WSSPort,
	}
	WebsocketAddress = &cli.StringFlag{
		Name:        "websocket-address",
		Aliases:     []string{"ws-address"},
		Value:       "0.0.0.0",
		Usage:       "Listening address for websocket connections",
		Destination: &options.Websocket.Address,
	}
	WebsocketSecureSupport = &cli.BoolFlag{
		Name:        "websocket-secure-support",
		Aliases:     []string{"wss"},
		Usage:       "Enable secure websockets support",
		Destination: &options.Websocket.Secure,
	}
	WebsocketSecureKeyPath = &cli.PathFlag{
		Name:        "websocket-secure-key-path",
		Aliases:     []string{"wss-key"},
		Value:       "/path/to/key.txt",
		Usage:       "Secure websocket key path",
		Destination: &options.Websocket.KeyPath,
	}
	WebsocketSecureCertPath = &cli.PathFlag{
		Name:        "websocket-secure-cert-path",
		Aliases:     []string{"wss-cert"},
		Value:       "/path/to/cert.txt",
		Usage:       "Secure websocket certificate path",
		Destination: &options.Websocket.CertPath,
	}
	Dns4DomainName = &cli.StringFlag{
		Name:        "dns4-domain-name",
		Value:       "",
		Usage:       "The domain name resolving to the node's public IPv4 address",
		Destination: &options.Dns4DomainName,
	}
	NodeKey = &cli.GenericFlag{
		Name:  "nodekey",
		Usage: "P2P node private key as hex. Can also be set with GOWAKU-NODEKEY env variable (default random)",
		Value: &cliutils.PrivateKeyValue{
			Value: &options.NodeKey,
		},
		EnvVars: []string{"GOWAKU-NODEKEY"},
	}
	KeyFile = &cli.PathFlag{
		Name:        "key-file",
		Value:       "./nodekey",
		Usage:       "Path to a file containing the private key for the P2P node",
		Destination: &options.KeyFile,
	}
	KeyPassword = &cli.StringFlag{
		Name:        "key-password",
		Value:       "secret",
		Usage:       "Password used for the private key file",
		Destination: &options.KeyPasswd,
	}
	GenerateKey = &cli.BoolFlag{
		Name:        "generate-key",
		Usage:       "Generate private key file at path specified in --key-file with the password defined by --key-password",
		Destination: &options.GenerateKey,
	}
	Overwrite = &cli.BoolFlag{
		Name:        "overwrite",
		Usage:       "When generating a keyfile, overwrite the nodekey file if it already exists",
		Destination: &options.Overwrite,
	}
	StaticNode = &cli.GenericFlag{
		Name:  "staticnode",
		Usage: "Multiaddr of peer to directly connect with. Option may be repeated",
		Value: &cliutils.MultiaddrSlice{
			Values: &options.StaticNodes,
		},
	}
	KeepAlive = &cli.DurationFlag{
		Name:        "keep-alive",
		Value:       5 * time.Minute,
		Usage:       "Interval of time for pinging peers to keep the connection alive.",
		Destination: &options.KeepAlive,
	}
	PersistPeers = &cli.BoolFlag{
		Name:        "persist-peers",
		Usage:       "Enable peer persistence",
		Destination: &options.PersistPeers,
		Value:       false,
	}
	NAT = &cli.StringFlag{
		Name:        "nat", // This was added so js-waku test don't fail
		Usage:       "TODO: Not implemented yet. Specify method to use for determining public address: any, none ('any' will attempt upnp/pmp)",
		Value:       "any",
		Destination: &options.NAT, // TODO: accept none,any,upnp,extaddr
	}
	AdvertiseAddress = &cli.StringFlag{
		Name:        "advertise-address",
		Usage:       "External address to advertise to other nodes (overrides --address and --ws-address flags)",
		Destination: &options.AdvertiseAddress,
	}
	ShowAddresses = &cli.BoolFlag{
		Name:        "show-addresses",
		Usage:       "Display listening addresses according to current configuration",
		Destination: &options.ShowAddresses,
	}
	LogLevel = &cli.GenericFlag{
		Name:    "log-level",
		Aliases: []string{"l"},
		Value: &cliutils.ChoiceValue{
			Choices: []string{"DEBUG", "INFO", "WARN", "ERROR", "DPANIC", "PANIC", "FATAL"},
			Value:   &options.LogLevel,
		},
		Usage: "Define the logging level,",
	}
	LogEncoding = &cli.GenericFlag{
		Name:  "log-encoding",
		Usage: "Define the encoding used for the logs",
		Value: &cliutils.ChoiceValue{
			Choices: []string{"console", "nocolor", "json"},
			Value:   &options.LogEncoding,
		},
	}
	LogOutput = &cli.StringFlag{
		Name:        "log-output",
		Value:       "stdout",
		Usage:       "specifies where logging output should be written  (stdout, file, file:./filename.log)",
		Destination: &options.LogOutput,
	}
	AgentString = &cli.StringFlag{
		Name:        "agent-string",
		Value:       "go-waku",
		Usage:       "client id to advertise",
		Destination: &options.UserAgent,
	}
	Relay = &cli.BoolFlag{
		Name:        "relay",
		Value:       true,
		Usage:       "Enable relay protocol",
		Destination: &options.Relay.Enable,
	}
	Topics = &cli.StringSliceFlag{
		Name:        "topics",
		Usage:       "List of topics to listen",
		Destination: &options.Relay.Topics,
	}
	RelayPeerExchange = &cli.BoolFlag{
		Name:        "relay-peer-exchange",
		Value:       false,
		Usage:       "Enable GossipSub Peer Exchange",
		Destination: &options.Relay.PeerExchange,
	}
	MinRelayPeersToPublish = &cli.IntFlag{
		Name:        "min-relay-peers-to-publish",
		Value:       1,
		Usage:       "Minimum number of peers to publish to Relay",
		Destination: &options.Relay.MinRelayPeersToPublish,
	}
	StoreNodeFlag = &cli.GenericFlag{
		Name:  "storenode",
		Usage: "Multiaddr of a peer that supports store protocol. Option may be repeated",
		Value: &cliutils.MultiaddrSlice{
			Values: &options.Store.Nodes,
		},
	}
	StoreFlag = &cli.BoolFlag{
		Name:        "store",
		Usage:       "Enable store protocol to persist messages",
		Destination: &options.Store.Enable,
	}
	StoreMessageRetentionTime = &cli.DurationFlag{
		Name:        "store-message-retention-time",
		Value:       time.Hour * 24 * 2,
		Usage:       "maximum number of seconds before a message is removed from the store. Set to 0 to disable it",
		Destination: &options.Store.RetentionTime,
	}
	StoreMessageRetentionCapacity = &cli.IntFlag{
		Name:        "store-message-retention-capacity",
		Value:       0,
		Usage:       "maximum number of messages to store. Set to 0 to disable it",
		Destination: &options.Store.RetentionMaxMessages,
	}
	StoreMessageDBURL = &cli.StringFlag{
		Name:        "store-message-db-url",
		Usage:       "The database connection URL for persistent storage.",
		Value:       "sqlite3://store.db",
		Destination: &options.Store.DatabaseURL,
	}
	StoreResumePeer = &cli.GenericFlag{
		Name:  "store-resume-peer",
		Usage: "Peer multiaddress to resume the message store at boot. Option may be repeated",
		Value: &cliutils.MultiaddrSlice{
			Values: &options.Store.ResumeNodes,
		},
	}
	SwapFlag = &cli.BoolFlag{
		Name:        "swap",
		Usage:       "Enable swap protocol",
		Value:       false,
		Destination: &options.Swap.Enable,
	}
	SwapMode = &cli.IntFlag{
		Name:        "swap-mode",
		Value:       0,
		Usage:       "Swap mode: 0=soft, 1=mock, 2=hard",
		Destination: &options.Swap.Mode,
	}
	SwapPaymentThreshold = &cli.IntFlag{
		Name:        "swap-payment-threshold",
		Value:       100,
		Usage:       "Threshold for payment",
		Destination: &options.Swap.PaymentThreshold,
	}
	SwapDisconnectThreshold = &cli.IntFlag{
		Name:        "swap-disconnect-threshold",
		Value:       -100,
		Usage:       "Threshold for disconnecting",
		Destination: &options.Swap.DisconnectThreshold,
	}
	FilterFlag = &cli.BoolFlag{
		Name:        "filter",
		Usage:       "Enable filter protocol",
		Destination: &options.Filter.Enable,
	}
	LightClient = &cli.BoolFlag{
		Name:        "light-client",
		Usage:       "Don't accept filter subscribers",
		Destination: &options.Filter.DisableFullNode,
	}
	FilterNode = &cli.GenericFlag{
		Name:  "filternode",
		Usage: "Multiaddr of a peer that supports filter protocol. Option may be repeated",
		Value: &cliutils.MultiaddrSlice{
			Values: &options.Filter.Nodes,
		},
	}
	FilterTimeout = &cli.DurationFlag{
		Name:        "filter-timeout",
		Value:       14400 * time.Second,
		Usage:       "Timeout for filter node in seconds",
		Destination: &options.Filter.Timeout,
	}
	LightPush = &cli.BoolFlag{
		Name:        "lightpush",
		Usage:       "Enable lightpush protocol",
		Destination: &options.LightPush.Enable,
	}
	LightPushNode = &cli.GenericFlag{
		Name:  "lightpushnode",
		Usage: "Multiaddr of a peer that supports lightpush protocol. Option may be repeated",
		Value: &cliutils.MultiaddrSlice{
			Values: &options.LightPush.Nodes,
		},
	}
	Discv5Discovery = &cli.BoolFlag{
		Name:        "discv5-discovery",
		Usage:       "Enable discovering nodes via Node Discovery v5",
		Destination: &options.DiscV5.Enable,
	}
	Discv5BootstrapNode = &cli.StringSliceFlag{
		Name:        "discv5-bootstrap-node",
		Usage:       "Text-encoded ENR for bootstrap node. Used when connecting to the network. Option may be repeated",
		Destination: &options.DiscV5.Nodes,
	}
	Discv5UDPPort = &cli.IntFlag{
		Name:        "discv5-udp-port",
		Value:       9000,
		Usage:       "Listening UDP port for Node Discovery v5.",
		Destination: &options.DiscV5.Port,
	}
	Discv5ENRAutoUpdate = &cli.BoolFlag{
		Name:        "discv5-enr-auto-update",
		Usage:       "Discovery can automatically update its ENR with the IP address as seen by other nodes it communicates with.",
		Destination: &options.DiscV5.AutoUpdate,
	}
	PeerExchange = &cli.BoolFlag{
		Name:        "peer-exchange",
		Usage:       "Enable waku peer exchange protocol (responder side)",
		Destination: &options.PeerExchange.Enable,
	}
	PeerExchangeNode = &cli.GenericFlag{
		Name:  "peer-exchange-node",
		Usage: "Peer multiaddr to send peer exchange requests to. (enables peer exchange protocol requester side)",
		Value: &cliutils.MultiaddrValue{
			Value: &options.PeerExchange.Node,
		},
	}
	DNSDiscovery = &cli.BoolFlag{
		Name:        "dns-discovery",
		Usage:       "Enable DNS discovery",
		Destination: &options.DNSDiscovery.Enable,
	}
	DNSDiscoveryUrl = &cli.StringSliceFlag{
		Name:        "dns-discovery-url",
		Usage:       "URL for DNS node list in format 'enrtree://<key>@<fqdn>'",
		Destination: &options.DNSDiscovery.URLs,
	}
	DNSDiscoveryNameServer = &cli.StringFlag{
		Name:        "dns-discovery-name-server",
		Aliases:     []string{"dns-discovery-nameserver"},
		Usage:       "DNS nameserver IP to query (empty to use system's default)",
		Destination: &options.DNSDiscovery.Nameserver,
	}
	MetricsServer = &cli.BoolFlag{
		Name:        "metrics-server",
		Aliases:     []string{"metrics"},
		Usage:       "Enable the metrics server",
		Destination: &options.Metrics.Enable,
	}
	MetricsServerAddress = &cli.StringFlag{
		Name:        "metrics-server-address",
		Aliases:     []string{"metrics-address"},
		Value:       "127.0.0.1",
		Usage:       "Listening address of the metrics server",
		Destination: &options.Metrics.Address,
	}
	MetricsServerPort = &cli.IntFlag{
		Name:        "metrics-server-port",
		Aliases:     []string{"metrics-port"},
		Value:       8008,
		Usage:       "Listening HTTP port of the metrics server",
		Destination: &options.Metrics.Port,
	}
	RPCFlag = &cli.BoolFlag{
		Name:        "rpc",
		Usage:       "Enable the rpc server",
		Destination: &options.RPCServer.Enable,
	}
	RPCPort = &cli.IntFlag{
		Name:        "rpc-port",
		Value:       8545,
		Usage:       "Listening port of the rpc server",
		Destination: &options.RPCServer.Port,
	}
	RPCAddress = &cli.StringFlag{
		Name:        "rpc-address",
		Value:       "127.0.0.1",
		Usage:       "Listening address of the rpc server",
		Destination: &options.RPCServer.Address,
	}
	RPCRelayCacheCapacity = &cli.IntFlag{
		Name:        "rpc-relay-cache-capacity",
		Value:       30,
		Usage:       "Capacity of the Relay REST API message cache",
		Destination: &options.RPCServer.RelayCacheCapacity,
	}
	RPCAdmin = &cli.BoolFlag{
		Name:        "rpc-admin",
		Value:       false,
		Usage:       "Enable access to JSON-RPC Admin API",
		Destination: &options.RPCServer.Admin,
	}
	RPCPrivate = &cli.BoolFlag{
		Name:        "rpc-private",
		Value:       false,
		Usage:       "Enable access to JSON-RPC Private API",
		Destination: &options.RPCServer.Private,
	}
	RESTFlag = &cli.BoolFlag{
		Name:        "rest",
		Usage:       "Enable Waku REST HTTP server",
		Destination: &options.RESTServer.Enable,
	}
	RESTAddress = &cli.StringFlag{
		Name:        "rest-address",
		Value:       "127.0.0.1",
		Usage:       "Listening address of the REST HTTP server",
		Destination: &options.RESTServer.Address,
	}
	RESTPort = &cli.IntFlag{
		Name:        "rest-port",
		Value:       8645,
		Usage:       "Listening port of the REST HTTP server",
		Destination: &options.RESTServer.Port,
	}
	RESTRelayCacheCapacity = &cli.IntFlag{
		Name:        "rest-relay-cache-capacity",
		Value:       30,
		Usage:       "Capacity of the Relay REST API message cache",
		Destination: &options.RESTServer.RelayCacheCapacity,
	}
	RESTAdmin = &cli.BoolFlag{
		Name:        "rest-admin",
		Value:       false,
		Usage:       "Enable access to REST HTTP Admin API",
		Destination: &options.RESTServer.Admin,
	}
	RESTPrivate = &cli.BoolFlag{
		Name:        "rest-private",
		Value:       false,
		Usage:       "Enable access to REST HTTP Private API",
		Destination: &options.RESTServer.Private,
	}
)