utils

package
v0.0.0-...-516970c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2019 License: LGPL-3.0 Imports: 42 Imported by: 0

Documentation

Overview

Package utils contains internal helper functions for go-pttai commands.

Index

Constants

View Source 
const (
	MaxUploadSize = 10000000 // 10MB
)

Variables

View Source 
var (
	// General settings
	DataDirFlag = DirectoryFlag{
		Name:  "datadir",
		Usage: "Data directory for the databases and keystore",
		Value: DirectoryString{node.DefaultDataDir()},
	}
	KeyStoreDirFlag = DirectoryFlag{
		Name:  "keystore",
		Usage: "Directory for the keystore (default = inside the datadir)",
	}
	TestP2PFlag = cli.BoolFlag{
		Name:  "testp2p",
		Usage: "Test p2p-network: pre-configured PTT.ai test p2p-network",
	}
	IPFSP2PFlag = cli.BoolFlag{
		Name:  "ipfsp2p",
		Usage: "IPFS network: pre-configured PTT.ai ipfs p2p-network",
	}
	DevP2PFlag = cli.BoolFlag{
		Name:  "devp2p",
		Usage: "Dev p2p-network: pre-configured PTT.ai dev p2p-network",
	}

	TestWebrtcFlag = cli.BoolFlag{
		Name:  "testwebrtc",
		Usage: "Test webrtc: pre-configured PTT.ai test webrtc",
	}

	E2EFlag = cli.BoolFlag{
		Name:  "e2e",
		Usage: "e2e environment",
	}

	PrivateAsPublicFlag = cli.BoolFlag{
		Name:  "private-as-public",
		Usage: "Private api as public api",
	}

	OffsetSecondFlag = cli.Int64Flag{
		Name:  "offset-second",
		Usage: "offset second",
	}

	IdentityFlag = cli.StringFlag{
		Name:  "username",
		Usage: "Custom user name",
	}

	LogFilenameFlag = cli.StringFlag{
		Name:  "log",
		Usage: "log filename",
	}

	// My settings
	MyDataDirFlag = DirectoryFlag{
		Name:  "mydatadir",
		Usage: "Data directory for my info",
		Value: DirectoryString{me.DefaultConfig.DataDir},
	}
	MyKeyFileFlag = cli.StringFlag{
		Name:  "mykey",
		Usage: "my key file",
	}
	MyKeyHexFlag = cli.StringFlag{
		Name:  "mykeyhex",
		Usage: "my key as hex (for testing)",
	}

	MyPostfixFlag = cli.StringFlag{
		Name:  "mypostfix",
		Usage: "my postfix (20 bytes)",
	}

	ServerFlag = cli.BoolFlag{
		Name:  "server",
		Usage: "set as server mode",
	}

	// service settings
	ServiceExpireOplogSecondsFlag = cli.IntFlag{
		Name:  "serviceexpireoplog",
		Usage: "expire oplog seconds",
	}

	// Content settings
	ContentDataDirFlag = DirectoryFlag{
		Name:  "contentdatadir",
		Usage: "Data directory for content",
		Value: DirectoryString{content.DefaultConfig.DataDir},
	}

	ContentKeystoreDirFlag = DirectoryFlag{
		Name:  "contentkeystoredir",
		Usage: "Keystore directory for content",
		Value: DirectoryString{content.DefaultConfig.KeystoreDir},
	}

	// Friend settings
	FriendMaxSyncRandomSecondsFlag = cli.IntFlag{
		Name:  "friendmaxsync",
		Usage: "max sync random seconds",
	}

	FriendMinSyncRandomSecondsFlag = cli.IntFlag{
		Name:  "friendminsync",
		Usage: "min sync random seconds",
	}

	// Performance tuning settings
	CacheFlag = cli.IntFlag{
		Name:  "cache",
		Usage: "Megabytes of memory allocated to internal caching",
		Value: 1024,
	}
	CacheDatabaseFlag = cli.IntFlag{
		Name:  "cache.database",
		Usage: "Percentage of cache memory allowance to use for database io",
		Value: 75,
	}
	CacheGCFlag = cli.IntFlag{
		Name:  "cache.gc",
		Usage: "Percentage of cache memory allowance to use for trie pruning",
		Value: 25,
	}

	// Logging and debug settings
	PttStatsURLFlag = cli.StringFlag{
		Name:  "pttstats",
		Usage: "Reporting URL of a pttstats service (nodename:secret@host:port)",
	}
	MetricsEnabledFlag = cli.BoolFlag{
		Name:  "metrics",
		Usage: "Enable metrics collection and reporting",
	}
	MetricsEnableInfluxDBFlag = cli.BoolFlag{
		Name:  "metrics.influxdb",
		Usage: "Enable metrics export/push to an external InfluxDB database",
	}
	MetricsInfluxDBEndpointFlag = cli.StringFlag{
		Name:  "metrics.influxdb.endpoint",
		Usage: "InfluxDB API endpoint to report metrics to",
		Value: "http://localhost:8086",
	}
	MetricsInfluxDBDatabaseFlag = cli.StringFlag{
		Name:  "metrics.influxdb.database",
		Usage: "InfluxDB database name to push reported metrics to",
		Value: "gptt",
	}
	MetricsInfluxDBUsernameFlag = cli.StringFlag{
		Name:  "metrics.influxdb.username",
		Usage: "Username to authorize access to the database",
		Value: "test",
	}
	MetricsInfluxDBPasswordFlag = cli.StringFlag{
		Name:  "metrics.influxdb.password",
		Usage: "Password to authorize access to the database",
		Value: "test",
	}
	// The `host` tag is part of every measurement sent to InfluxDB. Queries on tags are faster in InfluxDB.
	// It is used so that we can group all nodes and average a measurement across all of them, but also so
	// that we can select a specific node and inspect its measurements.
	// https://docs.influxdata.com/influxdb/v1.4/concepts/key_concepts/#tag-key
	MetricsInfluxDBHostTagFlag = cli.StringFlag{
		Name:  "metrics.influxdb.host.tag",
		Usage: "InfluxDB `host` tag attached to all measurements",
		Value: "localhost",
	}

	// HTTP server
	HTTPAddrFlag = cli.StringFlag{
		Name:  "httpaddr",
		Usage: "HTTP server listening addr",
	}
	HTTPDirFlag = cli.StringFlag{
		Name:  "httpdir",
		Usage: "HTTP server serving file-dir",
	}
	ExternHTTPAddrFlag = cli.StringFlag{
		Name:  "exthttpaddr",
		Usage: "External HTTP server listening addr",
	}

	// RPC settings
	RPCEnabledFlag = cli.BoolTFlag{
		Name:  "rpc",
		Usage: "Enable the HTTP-RPC server",
	}
	RPCListenAddrFlag = cli.StringFlag{
		Name:  "rpcaddr",
		Usage: "HTTP-RPC server listening interface",
		Value: node.DefaultHTTPHost,
	}
	RPCPortFlag = cli.IntFlag{
		Name:  "rpcport",
		Usage: "HTTP-RPC server listening port",
		Value: node.DefaultHTTPPort,
	}
	ExternRPCAddrFlag = cli.StringFlag{
		Name:  "extrpcaddr",
		Usage: "External HTTP-RPC server listening addr",
	}
	RPCCORSDomainFlag = cli.StringFlag{
		Name:  "rpccorsdomain",
		Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)",
		Value: "",
	}
	RPCVirtualHostsFlag = cli.StringFlag{
		Name:  "rpcvhosts",
		Usage: "Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts '*' wildcard.",
		Value: strings.Join(node.DefaultConfig.HTTPVirtualHosts, ","),
	}
	RPCApiFlag = cli.StringFlag{
		Name:  "rpcapi",
		Usage: "API's offered over the HTTP-RPC interface",
		Value: "",
	}
	IPCDisabledFlag = cli.BoolFlag{
		Name:  "ipcdisable",
		Usage: "Disable the IPC-RPC server",
	}
	IPCPathFlag = DirectoryFlag{
		Name:  "ipcpath",
		Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)",
	}
	WSEnabledFlag = cli.BoolFlag{
		Name:  "ws",
		Usage: "Enable the WS-RPC server",
	}
	WSListenAddrFlag = cli.StringFlag{
		Name:  "wsaddr",
		Usage: "WS-RPC server listening interface",
		Value: node.DefaultWSHost,
	}
	WSPortFlag = cli.IntFlag{
		Name:  "wsport",
		Usage: "WS-RPC server listening port",
		Value: node.DefaultWSPort,
	}
	WSApiFlag = cli.StringFlag{
		Name:  "wsapi",
		Usage: "API's offered over the WS-RPC interface",
		Value: "",
	}
	WSAllowedOriginsFlag = cli.StringFlag{
		Name:  "wsorigins",
		Usage: "Origins from which to accept websockets requests",
		Value: "",
	}
	ExecFlag = cli.StringFlag{
		Name:  "exec",
		Usage: "Execute JavaScript statement",
	}
	PreloadJSFlag = cli.StringFlag{
		Name:  "preload",
		Usage: "Comma separated list of JavaScript files to preload into the console",
	}

	// Network Settings
	MaxPeersFlag = cli.IntFlag{
		Name:  "maxpeers",
		Usage: "Maximum number of network peers (network disabled if set to 0)",
		Value: 25,
	}
	MaxPendingPeersFlag = cli.IntFlag{
		Name:  "maxpendpeers",
		Usage: "Maximum number of pending connection attempts (defaults used if set to 0)",
		Value: 0,
	}
	ListenPortFlag = cli.IntFlag{
		Name:  "port",
		Usage: "Network listening port",
		Value: 29487,
	}
	BootnodesFlag = cli.StringFlag{
		Name:  "bootnodes",
		Usage: "Comma separated enode URLs for P2P discovery bootstrap (set v4+v5 instead for light servers)",
		Value: "",
	}
	BootnodesV4Flag = cli.StringFlag{
		Name:  "bootnodesv4",
		Usage: "Comma separated enode URLs for P2P v4 discovery bootstrap (light server, full nodes)",
		Value: "",
	}
	BootnodesV5Flag = cli.StringFlag{
		Name:  "bootnodesv5",
		Usage: "Comma separated enode URLs for P2P v5 discovery bootstrap (light server, light nodes)",
		Value: "",
	}
	P2PListenPortFlag = cli.IntFlag{
		Name:  "p2pport",
		Usage: "Network listening port",
		Value: 9487,
	}
	WebrtcSignalServerFlag = cli.StringFlag{
		Name:  "webrtcsignalserver",
		Usage: "webrtc signal server",
		Value: "",
	}
	NodeKeyFileFlag = cli.StringFlag{
		Name:  "nodekey",
		Usage: "P2P node key file",
	}
	NodeKeyHexFlag = cli.StringFlag{
		Name:  "nodekeyhex",
		Usage: "P2P node key as hex (for testing)",
	}
	NATFlag = cli.StringFlag{
		Name:  "nat",
		Usage: "NAT port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
		Value: "any",
	}
	NoDiscoverFlag = cli.BoolFlag{
		Name:  "nodiscover",
		Usage: "Disables the peer discovery mechanism (manual peer addition)",
	}
	DiscoveryV5Flag = cli.BoolFlag{
		Name:  "v5disc",
		Usage: "Enables the experimental RLPx V5 (Topic Discovery) mechanism",
	}
	NetrestrictFlag = cli.StringFlag{
		Name:  "netrestrict",
		Usage: "Restricts network communication to the given IP networks (CIDR masks)",
	}
)
View Source 
var (
	CommandHelpTemplate = `` /* 477-byte string literal not displayed */

)
View Source 
var (
	DefaultConfig = Config{
		HTTPAddr: "localhost:9774",
		HTTPDir:  "static/",
	}
)

default config

View Source 
var (
	ErrInvalidPath = errors.New("invalid path")
)

Functions

func Fatalf 

func Fatalf(format string, args ...interface{})

Fatalf formats a message to standard error and exits the program. The message is also printed to standard output if standard error is redirected to a different file.

func GlobalBig 

func GlobalBig(ctx *cli.Context, name string) *big.Int

GlobalBig returns the value of a BigFlag from the global flag set.

func MakeDataDir 

func MakeDataDir(ctx *cli.Context) string

MakeDataDir retrieves the currently requested data directory, terminating if none (or the empty string) is specified. If the node is starting a testnet, the a subdirectory of the specified datadir will be used.

func MigrateFlags 

func MigrateFlags(action func(ctx *cli.Context) error) func(*cli.Context) error

MigrateFlags sets the global flag from a local flag when it's set. This is a temporary function used for migrating old command/flags to the new format.

e.g. geth account new --keystore /tmp/mykeystore --lightkdf

is equivalent after calling this method with:

geth --keystore /tmp/mykeystore --lightkdf account new

This allows the use of the existing configuration functionality. When all flags are migrated this function can be removed and the existing configuration functionality must be changed that is uses local flags

func NewApp 

func NewApp(gitCommit, version, usage string) *cli.App

NewApp creates an app with sane defaults.

func OpenBrowser 

func OpenBrowser(url string) bool

func SetAccountConfig 

func SetAccountConfig(ctx *cli.Context, cfg *account.Config, cfgNode *node.Config)

SetContentConfig applies node-related command line flags to the config.

func SetContentConfig 

func SetContentConfig(ctx *cli.Context, cfg *content.Config, cfgNode *node.Config)

SetContentConfig applies node-related command line flags to the config.

func SetFriendConfig 

func SetFriendConfig(ctx *cli.Context, cfg *friend.Config, cfgNode *node.Config)

SetContentConfig applies node-related command line flags to the config.

func SetLogging 

func SetLogging(ctx *cli.Context)

func SetMeConfig 

func SetMeConfig(ctx *cli.Context, cfg *me.Config, cfgNode *node.Config)

SetMyConfig applies node-related command line flags to the config.

func SetNodeConfig 

func SetNodeConfig(ctx *cli.Context, cfg *node.Config)

SetNodeConfig applies node-related command line flags to the config.

func SetPttConfig 

func SetPttConfig(ctx *cli.Context, cfg *pkgservice.Config, cfgNode *node.Config, gitCommit string, version string)

SetPttConfig applies ptt-related command line flags to the config.

func SetUtilsConfig 

func SetUtilsConfig(ctx *cli.Context, cfg *Config)

SetContentConfig applies node-related command line flags to the config.

func SetupMetrics 

func SetupMetrics(ctx *cli.Context)

Types

type BigFlag 

type BigFlag struct {
	Name  string
	Value *big.Int
	Usage string
}

BigFlag is a command line flag that accepts 256 bit big integers in decimal or hexadecimal syntax.

func (BigFlag) Apply 

func (f BigFlag) Apply(set *flag.FlagSet)

func (BigFlag) GetName 

func (f BigFlag) GetName() string

func (BigFlag) String 

func (f BigFlag) String() string

type Config 

type Config struct {
	HTTPDir        string
	HTTPAddr       string
	ExternHTTPAddr string
}

type DirectoryFlag 

type DirectoryFlag struct {
	Name  string
	Value DirectoryString
	Usage string
}

Custom cli.Flag type which expand the received string to an absolute path. e.g. ~/.ethereum -> /home/username/.ethereum

func (DirectoryFlag) Apply 

func (self DirectoryFlag) Apply(set *flag.FlagSet)

called by cli library, grabs variable from environment (if in env) and adds variable to flag set for parsing.

func (DirectoryFlag) GetName 

func (self DirectoryFlag) GetName() string

func (*DirectoryFlag) Set 

func (self *DirectoryFlag) Set(value string)

func (DirectoryFlag) String 

func (self DirectoryFlag) String() string

type DirectoryString 

type DirectoryString struct {
	Value string
}

Custom type which is registered in the flags library which cli uses for argument parsing. This allows us to expand Value to an absolute path when the argument is parsed

func (*DirectoryString) Set 

func (self *DirectoryString) Set(value string) error

func (*DirectoryString) String 

func (self *DirectoryString) String() string

type TextMarshaler 

type TextMarshaler interface {
	encoding.TextMarshaler
	encoding.TextUnmarshaler
}

func GlobalTextMarshaler 

func GlobalTextMarshaler(ctx *cli.Context, name string) TextMarshaler

GlobalTextMarshaler returns the value of a TextMarshalerFlag from the global flag set.

type TextMarshalerFlag 

type TextMarshalerFlag struct {
	Name  string
	Value TextMarshaler
	Usage string
}

TextMarshalerFlag wraps a TextMarshaler value.

func (TextMarshalerFlag) Apply 

func (f TextMarshalerFlag) Apply(set *flag.FlagSet)

func (TextMarshalerFlag) GetName 

func (f TextMarshalerFlag) GetName() string

func (TextMarshalerFlag) String 

func (f TextMarshalerFlag) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.