Documentation
¶
Overview ¶
Package utils contains internal helper functions for go-ethereum commands.
Index ¶
- Variables
- func ExportAppendChain(blockchain *core.BlockChain, fn string, first uint64, last uint64) error
- func ExportChain(blockchain *core.BlockChain, fn string) error
- func Fatalf(format string, args ...interface{})
- func FormatTransactionData(data string) []byte
- func ImportChain(chain *core.BlockChain, fn string) error
- func MakeAccountManager(ctx *cli.Context) *accounts.Manager
- func MakeAddress(accman *accounts.Manager, account string) (accounts.Account, error)
- func MakeBootstrapNodes(ctx *cli.Context) []*discover.Node
- func MakeChain(ctx *cli.Context) (chain *core.BlockChain, chainDb ethdb.Database)
- func MakeChainDatabase(ctx *cli.Context) ethdb.Database
- func MakeConsolePreloads(ctx *cli.Context) []string
- func MakeDatabaseHandles() int
- func MakeEtherbase(accman *accounts.Manager, ctx *cli.Context) common.Address
- func MakeHTTPRpcHost(ctx *cli.Context) string
- func MakeIPCPath(ctx *cli.Context) string
- func MakeKeyStoreDir(datadir string, ctx *cli.Context) string
- func MakeListenAddress(ctx *cli.Context) string
- func MakeMinerExtra(extra []byte, ctx *cli.Context) []byte
- func MakeNAT(ctx *cli.Context) nat.Interface
- func MakeNodeKey(ctx *cli.Context) *ecdsa.PrivateKey
- func MakeNodeName(client, version string, ctx *cli.Context) string
- func MakePasswordList(ctx *cli.Context) []string
- func MakeRPCModules(input string) []string
- func MakeSystemNode(name, version string, relconf release.Config, extra []byte, ctx *cli.Context) *node.Node
- func MakeWSRpcHost(ctx *cli.Context) string
- func MustMakeChainConfig(ctx *cli.Context) *params.ChainConfig
- func MustMakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *params.ChainConfig
- func MustMakeDataDir(ctx *cli.Context) string
- func NewApp(version, usage string) *cli.App
- func NewRemoteRPCClient(ctx *cli.Context) (rpc.Client, error)
- func NewRemoteRPCClientFromString(endpoint string) (rpc.Client, error)
- func SetupNetwork(ctx *cli.Context)
- func StartNode(stack *node.Node)
- type DirectoryFlag
- type DirectoryString
Constants ¶
This section is empty.
Variables ¶
var ( // General settings DataDirFlag = DirectoryFlag{ Name: "datadir", Usage: "Data directory for the databases and keystore", Value: DirectoryString{common.DefaultDataDir()}, } KeyStoreDirFlag = DirectoryFlag{ Name: "keystore", Usage: "Directory for the keystore (default = inside the datadir)", } NetworkIdFlag = cli.IntFlag{ Name: "networkid", Usage: "Network identifier (integer, 0=Olympic, 1=Frontier, 2=Morden)", Value: eth.NetworkId, } OlympicFlag = cli.BoolFlag{ Name: "olympic", Usage: "Olympic network: pre-configured pre-release test network", } TestNetFlag = cli.BoolFlag{ Name: "testnet", Usage: "Morden network: pre-configured test network with modified starting nonces (replay protection)", } DevModeFlag = cli.BoolFlag{ Name: "dev", Usage: "Developer mode: pre-configured private network with several debugging flags", } IdentityFlag = cli.StringFlag{ Name: "identity", Usage: "Custom node name", } NatspecEnabledFlag = cli.BoolFlag{ Name: "natspec", Usage: "Enable NatSpec confirmation notice", } DocRootFlag = DirectoryFlag{ Name: "docroot", Usage: "Document Root for HTTPClient file scheme", Value: DirectoryString{common.HomeDir()}, } CacheFlag = cli.IntFlag{ Name: "cache", Usage: "Megabytes of memory allocated to internal caching (min 16MB / database forced)", Value: 128, } BlockchainVersionFlag = cli.IntFlag{ Name: "blockchainversion", Usage: "Blockchain version (integer)", Value: core.BlockChainVersion, } FastSyncFlag = cli.BoolFlag{ Name: "fast", Usage: "Enable fast syncing through state downloads", } LightKDFFlag = cli.BoolFlag{ Name: "lightkdf", Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength", } // Fork settings SupportDAOFork = cli.BoolFlag{ Name: "support-dao-fork", Usage: "Updates the chain rules to support the DAO hard-fork", } OpposeDAOFork = cli.BoolFlag{ Name: "oppose-dao-fork", Usage: "Updates the chain rules to oppose the DAO hard-fork", } // Miner settings // TODO: refactor CPU vs GPU mining flags MiningEnabledFlag = cli.BoolFlag{ Name: "mine", Usage: "Enable mining", } MinerThreadsFlag = cli.IntFlag{ Name: "minerthreads", Usage: "Number of CPU threads to use for mining", Value: runtime.NumCPU(), } MiningGPUFlag = cli.StringFlag{ Name: "minergpus", Usage: "List of GPUs to use for mining (e.g. '0,1' will use the first two GPUs found)", } TargetGasLimitFlag = cli.StringFlag{ Name: "targetgaslimit", Usage: "Target gas limit sets the artificial target gas floor for the blocks to mine", Value: params.GenesisGasLimit.String(), } AutoDAGFlag = cli.BoolFlag{ Name: "autodag", Usage: "Enable automatic DAG pregeneration", } EtherbaseFlag = cli.StringFlag{ Name: "etherbase", Usage: "Public address for block mining rewards (default = first account created)", Value: "0", } GasPriceFlag = cli.StringFlag{ Name: "gasprice", Usage: "Minimal gas price to accept for mining a transactions", Value: new(big.Int).Mul(big.NewInt(20), common.Shannon).String(), } ExtraDataFlag = cli.StringFlag{ Name: "extradata", Usage: "Block extra data set by the miner (default = client version)", } // Account settings UnlockedAccountFlag = cli.StringFlag{ Name: "unlock", Usage: "Comma separated list of accounts to unlock", Value: "", } PasswordFileFlag = cli.StringFlag{ Name: "password", Usage: "Password file to use for non-inteactive password input", Value: "", } VMForceJitFlag = cli.BoolFlag{ Name: "forcejit", Usage: "Force the JIT VM to take precedence", } VMJitCacheFlag = cli.IntFlag{ Name: "jitcache", Usage: "Amount of cached JIT VM programs", Value: 64, } VMEnableJitFlag = cli.BoolFlag{ Name: "jitvm", Usage: "Enable the JIT VM", } // logging and debug settings MetricsEnabledFlag = cli.BoolFlag{ Name: metrics.MetricsEnabledFlag, Usage: "Enable metrics collection and reporting", } FakePoWFlag = cli.BoolFlag{ Name: "fakepow", Usage: "Disables proof-of-work verification", } // RPC settings RPCEnabledFlag = cli.BoolFlag{ Name: "rpc", Usage: "Enable the HTTP-RPC server", } RPCListenAddrFlag = cli.StringFlag{ Name: "rpcaddr", Usage: "HTTP-RPC server listening interface", Value: common.DefaultHTTPHost, } RPCPortFlag = cli.IntFlag{ Name: "rpcport", Usage: "HTTP-RPC server listening port", Value: common.DefaultHTTPPort, } RPCCORSDomainFlag = cli.StringFlag{ Name: "rpccorsdomain", Usage: "Comma separated list of domains from which to accept cross origin requests (browser enforced)", Value: "", } RPCApiFlag = cli.StringFlag{ Name: "rpcapi", Usage: "API's offered over the HTTP-RPC interface", Value: rpc.DefaultHTTPApis, } IPCDisabledFlag = cli.BoolFlag{ Name: "ipcdisable", Usage: "Disable the IPC-RPC server", } IPCApiFlag = cli.StringFlag{ Name: "ipcapi", Usage: "API's offered over the IPC-RPC interface", Value: rpc.DefaultIPCApis, } IPCPathFlag = DirectoryFlag{ Name: "ipcpath", Usage: "Filename for IPC socket/pipe within the datadir (explicit paths escape it)", Value: DirectoryString{common.DefaultIPCSocket}, } WSEnabledFlag = cli.BoolFlag{ Name: "ws", Usage: "Enable the WS-RPC server", } WSListenAddrFlag = cli.StringFlag{ Name: "wsaddr", Usage: "WS-RPC server listening interface", Value: common.DefaultWSHost, } WSPortFlag = cli.IntFlag{ Name: "wsport", Usage: "WS-RPC server listening port", Value: common.DefaultWSPort, } WSApiFlag = cli.StringFlag{ Name: "wsapi", Usage: "API's offered over the WS-RPC interface", Value: rpc.DefaultHTTPApis, } WSAllowedOriginsFlag = cli.StringFlag{ Name: "wsorigins", Usage: "Origins from which to accept websockets requests", Value: "", } ExecFlag = cli.StringFlag{ Name: "exec", Usage: "Execute JavaScript statement (only in combination with console/attach)", } 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: 30303, } BootnodesFlag = cli.StringFlag{ Name: "bootnodes", Usage: "Comma separated enode URLs for P2P discovery bootstrap", 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)", } WhisperEnabledFlag = cli.BoolFlag{ Name: "shh", Usage: "Enable Whisper", } // ATM the url is left to the user and deployment to JSpathFlag = cli.StringFlag{ Name: "jspath", Usage: "JavaScript root path for `loadScript` and document root for `admin.httpGet`", Value: ".", } SolcPathFlag = cli.StringFlag{ Name: "solc", Usage: "Solidity compiler command to be used", Value: "solc", } // Gas price oracle settings GpoMinGasPriceFlag = cli.StringFlag{ Name: "gpomin", Usage: "Minimum suggested gas price", Value: new(big.Int).Mul(big.NewInt(20), common.Shannon).String(), } GpoMaxGasPriceFlag = cli.StringFlag{ Name: "gpomax", Usage: "Maximum suggested gas price", Value: new(big.Int).Mul(big.NewInt(500), common.Shannon).String(), } GpoFullBlockRatioFlag = cli.IntFlag{ Name: "gpofull", Usage: "Full block threshold for gas price calculation (%)", Value: 80, } GpobaseStepDownFlag = cli.IntFlag{ Name: "gpobasedown", Usage: "Suggested gas price base step down ratio (1/1000)", Value: 10, } GpobaseStepUpFlag = cli.IntFlag{ Name: "gpobaseup", Usage: "Suggested gas price base step up ratio (1/1000)", Value: 100, } GpobaseCorrectionFactorFlag = cli.IntFlag{ Name: "gpobasecf", Usage: "Suggested gas price base correction factor (%)", Value: 110, } )
var FrontierBootNodes = []*discover.Node{ discover.MustParseNode("enode://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@52.16.188.185:30303"), discover.MustParseNode("enode://de471bccee3d042261d52e9bff31458daecc406142b401d4cd848f677479f73104b9fdeb090af9583d3391b7f10cb2ba9e26865dd5fca4fcdc0fb1e3b723c786@54.94.239.50:30303"), discover.MustParseNode("enode://1118980bf48b0a3640bdba04e0fe78b1add18e1cd99bf22d53daac1fd9972ad650df52176e7c7d89d1114cfef2bc23a2959aa54998a46afcf7d91809f0855082@52.74.57.123:30303"), discover.MustParseNode("enode://979b7fa28feeb35a4741660a16076f1943202cb72b6af70d327f053e248bab9ba81760f39d0701ef1d8f89cc1fbd2cacba0710a12cd5314d5e0c9021aa3637f9@5.1.83.226:30303"), }
FrontierBootNodes are the enode URLs of the P2P bootstrap nodes running on the Frontier network.
var TestNetBootNodes = []*discover.Node{ discover.MustParseNode("enode://e4533109cc9bd7604e4ff6c095f7a1d807e15b38e9bfeb05d3b7c423ba86af0a9e89abbf40bd9dde4250fef114cd09270fa4e224cbeef8b7bf05a51e8260d6b8@94.242.229.4:40404"), discover.MustParseNode("enode://8c336ee6f03e99613ad21274f269479bf4413fb294d697ef15ab897598afb931f56beb8e97af530aee20ce2bcba5776f4a312bc168545de4d43736992c814592@94.242.229.203:30303"), }
TestNetBootNodes are the enode URLs of the P2P bootstrap nodes running on the Morden test network.
Functions ¶
func ExportAppendChain ¶ added in v0.9.30
func ExportChain ¶ added in v0.9.17
func ExportChain(blockchain *core.BlockChain, fn string) error
func Fatalf ¶ added in v0.9.17
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 FormatTransactionData ¶
func ImportChain ¶ added in v0.8.5
func ImportChain(chain *core.BlockChain, fn string) error
func MakeAccountManager ¶ added in v0.9.26
MakeAccountManager creates an account manager from set command line flags.
func MakeAddress ¶ added in v1.4.0
MakeAddress converts an account specified directly as a hex encoded string or a key index in the key store to an internal account representation.
func MakeBootstrapNodes ¶ added in v1.4.0
MakeBootstrapNodes creates a list of bootstrap nodes from the command line flags, reverting to pre-configured ones if none have been specified.
func MakeChain ¶ added in v0.9.26
func MakeChain(ctx *cli.Context) (chain *core.BlockChain, chainDb ethdb.Database)
MakeChain creates a chain manager from set command line flags.
func MakeChainDatabase ¶ added in v1.4.0
MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
func MakeConsolePreloads ¶ added in v1.4.6
func MakeConsolePreloads(ctx *cli.Context) []string
MakeConsolePreloads retrieves the absolute paths for the console JavaScript scripts to preload before starting.
func MakeDatabaseHandles ¶ added in v1.4.0
func MakeDatabaseHandles() int
MakeDatabaseHandles raises out the number of allowed file handles per process for Geth and returns half of the allowance to assign to the database.
func MakeEtherbase ¶ added in v1.4.0
MakeEtherbase retrieves the etherbase either from the directly specified command line flags or from the keystore if CLI indexed.
func MakeHTTPRpcHost ¶ added in v1.4.0
func MakeHTTPRpcHost(ctx *cli.Context) string
MakeHTTPRpcHost creates the HTTP RPC listener interface string from the set command line flags, returning empty if the HTTP endpoint is disabled.
func MakeIPCPath ¶ added in v1.4.0
func MakeIPCPath(ctx *cli.Context) string
MakeIPCPath creates an IPC path configuration from the set command line flags, returning an empty string if IPC was explicitly disabled, or the set path.
func MakeKeyStoreDir ¶ added in v1.4.0
MakeKeyStoreDir resolves the folder to use for storing the account keys from the set command line flags, returning the explicitly requested path, or one inside the data directory otherwise.
func MakeListenAddress ¶ added in v1.4.0
func MakeListenAddress(ctx *cli.Context) string
MakeListenAddress creates a TCP listening address string from set command line flags.
func MakeMinerExtra ¶ added in v1.4.0
MakeMinerExtra resolves extradata for the miner from the set command line flags or returns a default one composed on the client, runtime and OS metadata.
func MakeNodeKey ¶ added in v0.9.26
func MakeNodeKey(ctx *cli.Context) *ecdsa.PrivateKey
MakeNodeKey creates a node key from set command line flags, either loading it from a file or as a specified hex value. If neither flags were provided, this method returns nil and an emphemeral key is to be generated.
func MakeNodeName ¶ added in v1.4.0
MakeNodeName creates a node name from a base set and the command line flags.
func MakePasswordList ¶ added in v1.4.0
func MakePasswordList(ctx *cli.Context) []string
MakePasswordList reads password lines from the file specified by --password.
func MakeRPCModules ¶ added in v1.4.0
MakeRPCModules splits input separated by a comma and trims excessive white space from the substrings.
func MakeSystemNode ¶ added in v1.4.0
func MakeSystemNode(name, version string, relconf release.Config, extra []byte, ctx *cli.Context) *node.Node
MakeSystemNode sets up a local node, configures the services to launch and assembles the P2P protocol stack.
func MakeWSRpcHost ¶ added in v1.4.0
func MakeWSRpcHost(ctx *cli.Context) string
MakeWSRpcHost creates the WebSocket RPC listener interface string from the set command line flags, returning empty if the HTTP endpoint is disabled.
func MustMakeChainConfig ¶ added in v1.4.0
func MustMakeChainConfig(ctx *cli.Context) *params.ChainConfig
MustMakeChainConfig reads the chain configuration from the database in ctx.Datadir.
func MustMakeChainConfigFromDb ¶ added in v1.4.0
func MustMakeChainConfigFromDb(ctx *cli.Context, db ethdb.Database) *params.ChainConfig
MustMakeChainConfigFromDb reads the chain configuration from the given database.
func MustMakeDataDir ¶ added in v1.4.0
func MustMakeDataDir(ctx *cli.Context) string
MustMakeDataDir 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 NewApp ¶ added in v0.9.17
func NewApp(version, usage string) *cli.App
NewApp creates an app with sane defaults.
func NewRemoteRPCClient ¶ added in v1.4.0
NewRemoteRPCClient returns a RPC client which connects to a running geth instance. Depending on the given context this can either be a IPC or a HTTP client.
func NewRemoteRPCClientFromString ¶ added in v1.4.0
NewRemoteRPCClientFromString returns a RPC client which connects to the given endpoint. It must start with either `ipc:` or `rpc:` (HTTP).
func SetupNetwork ¶ added in v1.3.1
func SetupNetwork(ctx *cli.Context)
SetupNetwork configures the system for either the main net or some test network.
Types ¶
type DirectoryFlag ¶ added in v0.9.17
type DirectoryFlag struct { cli.GenericFlag Name string Value DirectoryString Usage string EnvVar string }
Custom cli.Flag type which expand the received string to an absolute path. e.g. ~/.ethereum -> /home/username/.ethereum
func (DirectoryFlag) Apply ¶ added in v0.9.17
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) Set ¶ added in v0.9.17
func (self *DirectoryFlag) Set(value string)
func (DirectoryFlag) String ¶ added in v0.9.17
func (self DirectoryFlag) String() string
type DirectoryString ¶ added in v0.9.17
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 ¶ added in v0.9.17
func (self *DirectoryString) Set(value string) error
func (*DirectoryString) String ¶ added in v0.9.17
func (self *DirectoryString) String() string