Documentation ¶
Overview ¶
Package utils contains internal helper functions for abey commands.
Package utils contains internal helper functions for abey commands.
Package utils contains internal helper functions for abey commands.
Index ¶
- Variables
- func CheckExclusive(ctx *cli.Context, args ...interface{})
- func ExportAppendChain(blockchain *core.BlockChain, fn string, first uint64, last uint64) error
- func ExportAppendSnailChain(blockchain *snailchain.SnailBlockChain, fn string, first uint64, last uint64) error
- func ExportChain(blockchain *core.BlockChain, fn string) error
- func ExportPreimages(db *abeydb.LDBDatabase, fn string) error
- func ExportSnailChain(blockchain *snailchain.SnailBlockChain, fn string) error
- func Fatalf(format string, args ...interface{})
- func GlobalBig(ctx *cli.Context, name string) *big.Int
- func ImportChain(chain *core.BlockChain, fn string) error
- func ImportPreimages(db *abeydb.LDBDatabase, fn string) error
- func ImportSnailChain(chain *snailchain.SnailBlockChain, fn string) error
- func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error)
- func MakeChain(ctx *cli.Context, stack *node.Node) (fchain *core.BlockChain, schain *snailchain.SnailBlockChain, ...)
- func MakeChainDatabase(ctx *cli.Context, stack *node.Node) abeydb.Database
- func MakeConsolePreloads(ctx *cli.Context) []string
- func MakeDataDir(ctx *cli.Context) string
- func MakeGenesis(ctx *cli.Context) *core.Genesis
- func MakePasswordList(ctx *cli.Context) []string
- func MigrateFlags(action func(ctx *cli.Context) error) func(*cli.Context) error
- func NewApp(gitCommit, gitDate, usage string) *cli.App
- func RegisterAbeyService(stack *node.Node, cfg *abey.Config)
- func RegisterAbeystatsService(stack *node.Node, url string)
- func SetAbeychainConfig(ctx *cli.Context, stack *node.Node, cfg *abey.Config)
- func SetNodeConfig(ctx *cli.Context, cfg *node.Config)
- func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config)
- func SetupMetrics(ctx *cli.Context)
- func StartNode(stack *node.Node)
- type BigFlag
- type DirectoryFlag
- type DirectoryString
- type TextMarshaler
- type TextMarshalerFlag
Constants ¶
This section is empty.
Variables ¶
var ( CommandHelpTemplate = `` /* 471-byte string literal not displayed */ OriginCommandHelpTemplate = `` /* 343-byte string literal not displayed */ )
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)", } NoUSBFlag = cli.BoolFlag{ Name: "nousb", Usage: "Disables monitoring for and managing USB hardware wallets", } NetworkIdFlag = cli.Uint64Flag{ Name: "networkid", Usage: "Network identifier", Value: abey.DefaultConfig.NetworkId, } TestnetFlag = cli.BoolFlag{ Name: "testnet", Usage: "Ropsten network: pre-configured proof-of-work test network", } DevnetFlag = cli.BoolFlag{ Name: "devnet", Usage: "dev network: pre-configured proof-of-work develop network", } IdentityFlag = cli.StringFlag{ Name: "identity", Usage: "Custom node name", } DocRootFlag = DirectoryFlag{ Name: "docroot", Usage: "Document Root for HTTPClient file scheme", Value: DirectoryString{homeDir()}, } /*FastSyncFlag = cli.BoolFlag{ Name: "fast", Usage: "Enable fast syncing through state downloads (replaced by --syncmode)", } LightModeFlag = cli.BoolFlag{ Name: "light", Usage: "Enable light client mode (replaced by --syncmode)", }*/ //SingleNodeFlag is single node setting SingleNodeFlag = cli.BoolFlag{ Name: "singlenode", Usage: "sing node model start", } //election setting EnableElectionFlag = cli.BoolFlag{ Name: "election", Usage: "enable election", } //bpft setting BFTIPFlag = cli.StringFlag{ Name: "bftip", Usage: "committee node ip", } BFTPortFlag = cli.Uint64Flag{ Name: "bftport", Usage: "committee node port ", Value: uint64(abey.DefaultConfig.Port), } BFTStandbyPortFlag = cli.Uint64Flag{ Name: "bftport2", Usage: "committee node standby port ", Value: uint64(abey.DefaultConfig.StandbyPort), } BftKeyFileFlag = cli.StringFlag{ Name: "bftkey", Usage: "committee generate bft_privatekey", } BftKeyHexFlag = cli.StringFlag{ Name: "bftkeyhex", Usage: "committee generate bft_privatekey as hex (for testing)", } SyncModeFlag = TextMarshalerFlag{ Name: "syncmode", Usage: `Blockchain sync mode ("full", or "snapshot")`, Value: &defaultSyncMode, } GCModeFlag = cli.StringFlag{ Name: "gcmode", Usage: `Blockchain garbage collection mode ("full", "archive")`, Value: "full", } StateGCFlag = cli.BoolFlag{ Name: "stategc", Usage: "Delete block body and receipt", } LightServFlag = cli.IntFlag{ Name: "lightserv", Usage: "Maximum percentage of time allowed for serving LES requests (0-90)", Value: 0, } LightPeersFlag = cli.IntFlag{ Name: "lightpeers", Usage: "Maximum number of LES client peers", Value: abey.DefaultConfig.LightPeers, } LightKDFFlag = cli.BoolFlag{ Name: "lightkdf", Usage: "Reduce key-derivation RAM & CPU usage at some expense of KDF strength", } // Transaction pool settings TxPoolNoLocalsFlag = cli.BoolFlag{ Name: "txpool.nolocals", Usage: "Disables price exemptions for locally submitted transactions", } TxPoolJournalFlag = cli.StringFlag{ Name: "txpool.journal", Usage: "Disk journal for local transaction to survive node restarts", Value: core.DefaultTxPoolConfig.Journal, } TxPoolRejournalFlag = cli.DurationFlag{ Name: "txpool.rejournal", Usage: "Time interval to regenerate the local transaction journal", Value: core.DefaultTxPoolConfig.Rejournal, } TxPoolPriceLimitFlag = cli.Uint64Flag{ Name: "txpool.pricelimit", Usage: "Minimum gas price limit to enforce for acceptance into the pool", Value: abey.DefaultConfig.TxPool.PriceLimit, } TxPoolPriceBumpFlag = cli.Uint64Flag{ Name: "txpool.pricebump", Usage: "Price bump percentage to replace an already existing transaction", Value: abey.DefaultConfig.TxPool.PriceBump, } TxPoolAccountSlotsFlag = cli.Uint64Flag{ Name: "txpool.accountslots", Usage: "Minimum number of executable transaction slots guaranteed per account", Value: abey.DefaultConfig.TxPool.AccountSlots, } TxPoolGlobalSlotsFlag = cli.Uint64Flag{ Name: "txpool.globalslots", Usage: "Maximum number of executable transaction slots for all accounts", Value: abey.DefaultConfig.TxPool.GlobalSlots, } TxPoolAccountQueueFlag = cli.Uint64Flag{ Name: "txpool.accountqueue", Usage: "Maximum number of non-executable transaction slots permitted per account", Value: abey.DefaultConfig.TxPool.AccountQueue, } TxPoolGlobalQueueFlag = cli.Uint64Flag{ Name: "txpool.globalqueue", Usage: "Maximum number of non-executable transaction slots for all accounts", Value: abey.DefaultConfig.TxPool.GlobalQueue, } TxPoolLifetimeFlag = cli.DurationFlag{ Name: "txpool.lifetime", Usage: "Maximum amount of time non-executable transaction are queued", Value: abey.DefaultConfig.TxPool.Lifetime, } //fruit pool settings SnailPoolJournalFlag = cli.StringFlag{ Name: "fruitpool.journal", Usage: "Disk journal for local fruit to survive node restarts", Value: snailchain.DefaultSnailPoolConfig.Journal, } SnailPoolRejournalFlag = cli.DurationFlag{ Name: "fruitpool.rejournal", Usage: "Time interval to regenerate the local fruit journal", Value: snailchain.DefaultSnailPoolConfig.Rejournal, } SnailPoolFruitCountFlag = cli.Uint64Flag{ Name: "fruitpool.count", Usage: "Maximum amount of fruits in fruitPending", Value: snailchain.DefaultSnailPoolConfig.FruitCount, } // 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, } TrieCacheGenFlag = cli.IntFlag{ Name: "trie-cache-gens", Usage: "Number of trie node generations to keep in memory", Value: int(state.MaxTrieCacheGen), } // Miner settings MiningEnabledFlag = cli.BoolFlag{ Name: "mine", Usage: "Enable mining", } MiningRemoteEnableFlag = cli.BoolFlag{ Name: "remote", Usage: "Enable remote mining", } MineFruitFlag = cli.BoolFlag{ Name: "minefruit", Usage: "only mine fruit", } MinerThreadsFlag = cli.IntFlag{ Name: "minerthreads", Usage: "Number of CPU threads to use for mining", Value: runtime.NumCPU() - 1, } GasTargetFlag = cli.Uint64Flag{ Name: "gastarget", Usage: "Target gas floor for fast block", Value: abey.DefaultConfig.MinerGasFloor, } GasLimitFlag = cli.Uint64Flag{ Name: "gaslimit", Usage: "Target gas ceiling for fast block", Value: abey.DefaultConfig.MinerGasCeil, } EtherbaseFlag = cli.StringFlag{ Name: "etherbase", Usage: "Public address for block mining rewards (default = first account created)", Value: "0", } CoinbaseFlag = cli.StringFlag{ Name: "coinbase", Usage: "Public address for block mining rewards (default = first account created)", Value: "0", } GasPriceFlag = BigFlag{ Name: "gasprice", Usage: "Minimal gas price to accept for mining a transactions", Value: abey.DefaultConfig.GasPrice, } 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-interactive password input", Value: "", } VMEnableDebugFlag = cli.BoolFlag{ Name: "vmdebug", Usage: "Record information useful for VM and contract debugging", } // Logging and debug settings AbeystatsURLFlag = cli.StringFlag{ Name: "abeystats", Usage: "Reporting URL of a abeystats service (nodename:secret@host:port)", } FakePoWFlag = cli.BoolFlag{ Name: "fakepow", Usage: "Disables proof-of-work verification", } NoCompactionFlag = cli.BoolFlag{ Name: "nocompaction", Usage: "Disables db compaction after import", } // 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: node.DefaultHTTPHost, } RPCPortFlag = cli.IntFlag{ Name: "rpcport", Usage: "HTTP-RPC server listening port", Value: node.DefaultHTTPPort, } 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: 30313, } 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: "", } 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)", } // ATM the url is left to the user and deployment to JSpathFlag = cli.StringFlag{ Name: "jspath", Usage: "JavaScript root path for `loadScript`", Value: ".", } // Gas price oracle settings GpoBlocksFlag = cli.IntFlag{ Name: "gpoblocks", Usage: "Number of recent blocks to check for gas prices", Value: abey.DefaultConfig.GPO.Blocks, } GpoPercentileFlag = cli.IntFlag{ Name: "gpopercentile", Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices", Value: abey.DefaultConfig.GPO.Percentile, } // Metrics flags MetricsEnabledFlag = cli.BoolFlag{ Name: metrics.MetricsEnabledFlag, 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: "gabey", } 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", } EWASMInterpreterFlag = cli.StringFlag{ Name: "vm.ewasm", Usage: "External ewasm configuration (default = built-in interpreter)", Value: "", } EVMInterpreterFlag = cli.StringFlag{ Name: "vm.evm", Usage: "External EVM configuration (default = built-in interpreter)", Value: "", } )
Functions ¶
func CheckExclusive ¶
func CheckExclusive(ctx *cli.Context, args ...interface{})
CheckExclusive verifies that only a single instance of the provided flags was set by the user. Each flag might optionally be followed by a string type to specialize it further.
func ExportAppendChain ¶
ExportAppendChain exports a blockchain into the specified file, appending to the file if data already exists in it.
func ExportAppendSnailChain ¶
func ExportAppendSnailChain(blockchain *snailchain.SnailBlockChain, fn string, first uint64, last uint64) error
ExportAppendChain exports a blockchain into the specified file, appending to the file if data already exists in it.
func ExportChain ¶
func ExportChain(blockchain *core.BlockChain, fn string) error
ExportChain exports a blockchain into the specified file, truncating any data already present in the file.
func ExportPreimages ¶
func ExportPreimages(db *abeydb.LDBDatabase, fn string) error
ExportPreimages exports all known hash preimages into the specified file, truncating any data already present in the file.
func ExportSnailChain ¶
func ExportSnailChain(blockchain *snailchain.SnailBlockChain, fn string) error
ExportChain exports a blockchain into the specified file, truncating any data already present in the file.
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 ImportChain ¶
func ImportChain(chain *core.BlockChain, fn string) error
func ImportPreimages ¶
func ImportPreimages(db *abeydb.LDBDatabase, fn string) error
ImportPreimages imports a batch of exported hash preimages into the database.
func ImportSnailChain ¶
func ImportSnailChain(chain *snailchain.SnailBlockChain, fn string) error
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 MakeChain ¶
func MakeChain(ctx *cli.Context, stack *node.Node) (fchain *core.BlockChain, schain *snailchain.SnailBlockChain, chainDb abeydb.Database)
MakeChain creates a chain manager from set command line flags.
func MakeChainDatabase ¶
MakeChainDatabase open an LevelDB using the flags passed to the client and will hard crash if it fails.
func MakeConsolePreloads ¶
func MakeConsolePreloads(ctx *cli.Context) []string
MakeConsolePreloads retrieves the absolute paths for the console JavaScript scripts to preload before starting.
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 MakeGenesis ¶
func MakePasswordList ¶
func MakePasswordList(ctx *cli.Context) []string
MakePasswordList reads password lines from the file specified by the global --password flag.
func MigrateFlags ¶
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. gabey account new --keystore /tmp/mykeystore --lightkdf
is equivalent after calling this method with:
gabey --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, gitDate, usage string) *cli.App
NewApp creates an app with sane defaults.
func RegisterAbeyService ¶
RegisterAbeyService adds an Abeychain client to the stack.
func RegisterAbeystatsService ¶
RegisterAbeystatsService configures the Abeychain Stats daemon and adds it to th egiven node.
func SetAbeychainConfig ¶
SetAbeychainConfig applies abey-related command line flags to the config.
func SetNodeConfig ¶
SetNodeConfig applies node-related command line flags to the config.
func SetP2PConfig ¶
func SetupMetrics ¶
func SetupMetrics(ctx *cli.Context)
Types ¶
type BigFlag ¶
BigFlag is a command line flag that accepts 256 bit big integers in decimal or hexadecimal syntax.
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. ~/.abeychain -> /home/username/.abeychain
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