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 IPCSocketPath(ctx *cli.Context) (ipcpath string)
- func ImportChain(chain *core.BlockChain, fn string) error
- func MakeAccountManager(ctx *cli.Context) *accounts.Manager
- func MakeAddress(accman *accounts.Manager, account string) (a common.Address, err error)
- func MakeBootstrapNodes(ctx *cli.Context) []*discover.Node
- func MakeChain(ctx *cli.Context) (chain *core.BlockChain, chainDb ethdb.Database)
- func MakeEtherbase(accman *accounts.Manager, ctx *cli.Context) common.Address
- func MakeGenesisBlock(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 MakeSystemNode(name, version string, extra []byte, ctx *cli.Context) *node.Node
- func MustMakeDataDir(ctx *cli.Context) string
- func NewApp(version, usage string) *cli.App
- func NewInProcRPCClient(stack *node.Node) *inProcClient
- func NewRemoteRPCClient(ctx *cli.Context) (rpc.Client, error)
- func NewRemoteRPCClientFromString(endpoint string) (rpc.Client, error)
- func PromptConfirm(prompt string) (bool, error)
- func PromptPassword(prompt string, warnTerm bool) (string, error)
- func SetupLogger(ctx *cli.Context)
- func SetupNetwork(ctx *cli.Context)
- func SetupVM(ctx *cli.Context)
- func StartIPC(stack *node.Node, ctx *cli.Context) error
- func StartNode(stack *node.Node)
- func StartPProf(ctx *cli.Context)
- func StartRPC(stack *node.Node, ctx *cli.Context) error
- func StartWS(stack *node.Node, ctx *cli.Context) error
- type DirectoryFlag
- type DirectoryString
- type Jeth
- func (self *Jeth) NewAccount(call otto.FunctionCall) (response otto.Value)
- func (self *Jeth) Send(call otto.FunctionCall) (response otto.Value)
- func (self *Jeth) Sleep(call otto.FunctionCall) (response otto.Value)
- func (self *Jeth) SleepBlocks(call otto.FunctionCall) (response otto.Value)
- func (self *Jeth) UnlockAccount(call otto.FunctionCall) (response otto.Value)
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()}, } 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", } GenesisFileFlag = cli.StringFlag{ Name: "genesis", Usage: "Insert/overwrite the genesis block (JSON format)", } 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: 0, } 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", } // 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)", } 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(50), 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: "", } // vm flags VMDebugFlag = cli.BoolFlag{ Name: "vmdebug", Usage: "Virtual Machine debug output", } 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 VerbosityFlag = cli.IntFlag{ Name: "verbosity", Usage: "Logging verbosity: 0-6 (0=silent, 1=error, 2=warn, 3=info, 4=core, 5=debug, 6=debug detail)", Value: int(logger.InfoLevel), } LogFileFlag = cli.StringFlag{ Name: "logfile", Usage: "Log output file within the data dir (default = no log file generated)", Value: "", } LogVModuleFlag = cli.GenericFlag{ Name: "vmodule", Usage: "Per-module verbosity: comma-separated list of <module>=<level>, where <module> is file literal or a glog pattern", Value: glog.GetVModule(), } BacktraceAtFlag = cli.GenericFlag{ Name: "backtrace", Usage: "Request a stack trace at a specific logging statement (e.g. \"block.go:271\")", Value: glog.GetTraceLocation(), } PProfEanbledFlag = cli.BoolFlag{ Name: "pprof", Usage: "Enable the profiling server on localhost", } PProfPortFlag = cli.IntFlag{ Name: "pprofport", Usage: "Profile server listening port", Value: 6060, } MetricsEnabledFlag = cli.BoolFlag{ Name: metrics.MetricsEnabledFlag, Usage: "Enable metrics collection and reporting", } // 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: "127.0.0.1", } RPCPortFlag = cli.IntFlag{ Name: "rpcport", Usage: "HTTP-RPC server listening port", Value: 8545, } RPCCORSDomainFlag = cli.StringFlag{ Name: "rpccorsdomain", Usage: "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.DefaultHttpRpcApis, } 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", Value: DirectoryString{common.DefaultIpcPath()}, } WSEnabledFlag = cli.BoolFlag{ Name: "ws", Usage: "Enable the WS-RPC server", } WSListenAddrFlag = cli.StringFlag{ Name: "wsaddr", Usage: "WS-RPC server listening interface", Value: "127.0.0.1", } WSPortFlag = cli.IntFlag{ Name: "wsport", Usage: "WS-RPC server listening port", Value: 8546, } WSApiFlag = cli.StringFlag{ Name: "wsapi", Usage: "API's offered over the WS-RPC interface", Value: rpc.DefaultHttpRpcApis, } WSAllowedDomainsFlag = cli.StringFlag{ Name: "wsdomains", Usage: "Domains from which to accept websockets requests", Value: "", } ExecFlag = cli.StringFlag{ Name: "exec", Usage: "Execute JavaScript statement (only in combination with console/attach)", } // 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: "JavaSript 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(50), 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 ¶
func ExportChain ¶
func ExportChain(blockchain *core.BlockChain, fn string) error
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 FormatTransactionData ¶
func IPCSocketPath ¶
func ImportChain ¶
func ImportChain(chain *core.BlockChain, fn string) error
func MakeAccountManager ¶
MakeAccountManager creates an account manager from set command line flags.
func MakeAddress ¶
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 ¶
MakeBootstrapNodes creates a list of bootstrap nodes from the command line flags, reverting to pre-configured ones if none have been specified.
func MakeEtherbase ¶
MakeEtherbase retrieves the etherbase either from the directly specified command line flags or from the keystore if CLI indexed.
func MakeGenesisBlock ¶
MakeGenesisBlock loads up a genesis block from an input file specified in the command line, or returns the empty string if none set.
func MakeListenAddress ¶
MakeListenAddress creates a TCP listening address string from set command line flags.
func MakeMinerExtra ¶
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 ¶
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 ¶
MakeNodeName creates a node name from a base set and the command line flags.
func MakePasswordList ¶
MakePasswordList loads up a list of password from a file specified by the command line flags.
func MakeSystemNode ¶
MakeSystemNode sets up a local node, configures the services to launch and assembles the P2P protocol stack.
func MustMakeDataDir ¶
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 NewInProcRPCClient ¶
NewInProcRPCClient will start a new RPC server for the given node and returns a client to interact with it.
func NewRemoteRPCClient ¶
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 ¶
NewRemoteRPCClientFromString returns a RPC client which connects to the given endpoint. It must start with either `ipc:` or `rpc:` (HTTP).
func PromptConfirm ¶
func SetupLogger ¶
SetupLogger configures glog from the logging-related command line flags.
func SetupNetwork ¶
SetupNetwork configures the system for either the main net or some test network.
func StartPProf ¶
Types ¶
type DirectoryFlag ¶
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 ¶
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 ¶
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 Jeth ¶
type Jeth struct {
// contains filtered or unexported fields
}
func (*Jeth) NewAccount ¶
func (self *Jeth) NewAccount(call otto.FunctionCall) (response otto.Value)
NewAccount asks the user for the password and than executes the jeth.newAccount callback in the jsre
func (*Jeth) Sleep ¶
func (self *Jeth) Sleep(call otto.FunctionCall) (response otto.Value)
Sleep will halt the console for arg[0] seconds.
func (*Jeth) SleepBlocks ¶
func (self *Jeth) SleepBlocks(call otto.FunctionCall) (response otto.Value)
SleepBlocks will wait for a specified number of new blocks or max for a given of seconds. sleepBlocks(nBlocks[, maxSleep]).
func (*Jeth) UnlockAccount ¶
func (self *Jeth) UnlockAccount(call otto.FunctionCall) (response otto.Value)
UnlockAccount asks the user for the password and than executes the jeth.UnlockAccount callback in the jsre