Documentation ¶
Overview ¶
Package utils contains internal helper functions for aquachain commands.
Package utils contains internal helper functions for aquachain 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 GlobalBig(ctx *cli.Context, name string) *big.Int
- func ImportChain(chain *core.BlockChain, fn string) error
- func MakeAddress(ks *keystore.KeyStore, account string) (accounts.Account, error)
- func MakeChain(ctx *cli.Context, stack *node.Node) (chain *core.BlockChain, chainDb aquadb.Database)
- func MakeChainDatabase(ctx *cli.Context, stack *node.Node) aquadb.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, usage string) *cli.App
- func RegisterAquaService(stack *node.Node, cfg *aqua.Config)
- func RegisterAquaStatsService(stack *node.Node, url string)
- func SetAquaConfig(ctx *cli.Context, stack *node.Node, cfg *aqua.Config)
- func SetChainId(ctx *cli.Context, cfg *aqua.Config) *params.ChainConfig
- func SetHardforkParams(ctx *cli.Context, chaincfg *params.ChainConfig)
- func SetNodeConfig(ctx *cli.Context, cfg *node.Config) error
- func SetP2PConfig(ctx *cli.Context, cfg *p2p.Config)
- func SetupNetworkGasLimit(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 ( // General settings JsonFlag = cli.BoolFlag{ Name: "json", Usage: "Print paper keypair in machine-readable JSON format", } VanityFlag = cli.StringFlag{ Name: "vanity", Usage: "Prefix for generating a vanity address (do not include 0x, start small)", } VanityEndFlag = cli.StringFlag{ Name: "vanityend", Usage: "Suffix for generating a vanity address (start small)", } // General settings DataDirFlag = DirectoryFlag{ Name: "datadir", Usage: "Data directory for the databases, IPC socket, and keystore (also see -keystore flag)", Value: DirectoryString{node.DefaultDataDir()}, } KeyStoreDirFlag = DirectoryFlag{ Name: "keystore", Usage: "Directory for the keystore (default = inside the datadir)", } UseUSBFlag = cli.BoolFlag{ Name: "usb", Usage: "Enables monitoring for and managing USB hardware wallets (disabled in pure-go builds)", } NetworkIdFlag = cli.Uint64Flag{ Name: "networkid", Usage: "Network identifier (integer)", Value: aqua.DefaultConfig.NetworkId, } ChainFlag = cli.StringFlag{ Name: "chain", Usage: "Chain select (aqua, testnet, testnet2, testnet3)", Value: "aqua", } TestnetFlag = cli.BoolFlag{ Name: "testnet", Usage: "Aquachain Regression Test Network", } Testnet2Flag = cli.BoolFlag{ Name: "testnet2", Usage: "Aquachain Simulation Test Network (nodiscover)", } NetworkEthFlag = cli.BoolFlag{ Name: "ethereum", Usage: "Connect to Ethereum network (*experimental*)", } DeveloperFlag = cli.BoolFlag{ Name: "dev", Usage: "Ephemeral proof-of-authority network with a pre-funded developer account, mining enabled", } DeveloperPeriodFlag = cli.IntFlag{ Name: "dev.period", Usage: "Block period to use in developer mode (0 = mine only if transaction pending)", } IdentityFlag = cli.StringFlag{ Name: "identity", Usage: "Custom node name (used in p2p networking, default is aquachain version)", } DocRootFlag = DirectoryFlag{ Name: "docroot", Usage: "Working directory for importing JS files into console (default $HOME)", Value: DirectoryString{homeDir()}, } FastSyncFlag = cli.BoolFlag{ Name: "fast", Usage: "Enable fast syncing through state downloads", } SyncModeFlag = TextMarshalerFlag{ Name: "syncmode", Usage: `Blockchain sync mode ("fast", "full")`, Value: &defaultSyncMode, } GCModeFlag = cli.StringFlag{ Name: "gcmode", Usage: `GC mode to use, either "full" or "archive". Use "archive" for full, accurate state (for example, 'admin.supply')`, Value: "full", } // Aquahash settings AquahashCacheDirFlag = DirectoryFlag{ Name: "aquahash.cachedir", Usage: "Directory to store the aquahash verification caches (default = inside the datadir)", } AquahashCachesInMemoryFlag = cli.IntFlag{ Name: "aquahash.cachesinmem", Usage: "Number of recent aquahash caches to keep in memory (16MB each)", Value: aqua.DefaultConfig.Aquahash.CachesInMem, } AquahashCachesOnDiskFlag = cli.IntFlag{ Name: "aquahash.cachesondisk", Usage: "Number of recent aquahash caches to keep on disk (16MB each)", Value: aqua.DefaultConfig.Aquahash.CachesOnDisk, } AquahashDatasetDirFlag = DirectoryFlag{ Name: "aquahash.dagdir", Usage: "Directory to store the aquahash mining DAGs (default = inside home folder)", Value: DirectoryString{aqua.DefaultConfig.Aquahash.DatasetDir}, } AquahashDatasetsInMemoryFlag = cli.IntFlag{ Name: "aquahash.dagsinmem", Usage: "Number of recent aquahash mining DAGs to keep in memory (1+GB each)", Value: aqua.DefaultConfig.Aquahash.DatasetsInMem, } AquahashDatasetsOnDiskFlag = cli.IntFlag{ Name: "aquahash.dagsondisk", Usage: "Number of recent aquahash mining DAGs to keep on disk (1+GB each)", Value: aqua.DefaultConfig.Aquahash.DatasetsOnDisk, } // 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: aqua.DefaultConfig.TxPool.PriceLimit, } TxPoolPriceBumpFlag = cli.Uint64Flag{ Name: "txpool.pricebump", Usage: "Price bump percentage to replace an already existing transaction", Value: aqua.DefaultConfig.TxPool.PriceBump, } TxPoolAccountSlotsFlag = cli.Uint64Flag{ Name: "txpool.accountslots", Usage: "Minimum number of executable transaction slots guaranteed per account", Value: aqua.DefaultConfig.TxPool.AccountSlots, } TxPoolGlobalSlotsFlag = cli.Uint64Flag{ Name: "txpool.globalslots", Usage: "Maximum number of executable transaction slots for all accounts", Value: aqua.DefaultConfig.TxPool.GlobalSlots, } TxPoolAccountQueueFlag = cli.Uint64Flag{ Name: "txpool.accountqueue", Usage: "Maximum number of non-executable transaction slots permitted per account", Value: aqua.DefaultConfig.TxPool.AccountQueue, } TxPoolGlobalQueueFlag = cli.Uint64Flag{ Name: "txpool.globalqueue", Usage: "Maximum number of non-executable transaction slots for all accounts", Value: aqua.DefaultConfig.TxPool.GlobalQueue, } TxPoolLifetimeFlag = cli.DurationFlag{ Name: "txpool.lifetime", Usage: "Maximum amount of time non-executable transaction are queued", Value: aqua.DefaultConfig.TxPool.Lifetime, } // Performance tuning settings CacheFlag = cli.IntFlag{ Name: "cache", Usage: "Megabytes of memory allocated to internal caching (consider 2048)", 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 (not optimized, not recommended for mainnet)", } MinerThreadsFlag = cli.IntFlag{ Name: "minerthreads", Usage: "Number of CPU threads to use for mining", Value: runtime.NumCPU(), } TargetGasLimitFlag = cli.Uint64Flag{ Name: "targetgaslimit", Usage: "Target gas limit sets the artificial target gas floor for the blocks to mine", Value: params.GenesisGasLimit, } AquabaseFlag = cli.StringFlag{ Name: "aquabase", 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: aqua.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 (CAREFUL!)", 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 AquaStatsURLFlag = cli.StringFlag{ Name: "aquastats", Usage: "Reporting URL of a aquastats service (nodename:secret@host:port)", } MetricsEnabledFlag = cli.BoolFlag{ Name: metrics.MetricsEnabledFlag, Usage: "Enable metrics collection and reporting", } 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: "localhost", } RPCApiFlag = cli.StringFlag{ Name: "rpcapi", Usage: "API's offered over the HTTP-RPC interface", Value: "", } RPCUnlockFlag = cli.BoolFlag{ Name: "UNSAFE_RPC_UNLOCK", Usage: "", } 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: "", } RPCAllowIPFlag = cli.StringFlag{ Name: "allowip", Usage: "Comma separated allowed RPC clients (CIDR notation OK) (http/ws)", Value: "127.0.0.1/24", } RPCBehindProxyFlag = cli.BoolFlag{ Name: "behindproxy", Usage: "If RPC is behind a reverse proxy. Changes the way IP is fetched when comparing to allowed IP addresses", } 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: 21303, } ListenAddrFlag = cli.StringFlag{ Name: "addr", Usage: "Network listening addr (default all interfaces, port 21303)", Value: "", } 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: "", } 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)", } OfflineFlag = cli.BoolFlag{ Name: "offline", Usage: "Disables peer discovery and sets nat=none, still listens on tcp/udp port", } NoKeysFlag = cli.BoolFlag{ Name: "nokeys", Usage: "Disables keystore", } 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: aqua.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: aqua.DefaultConfig.GPO.Percentile, } HF8MainnetFlag = cli.Int64Flag{ Name: "hf8", Usage: "Hard fork #8 activation block", Value: -1, } )
var (
CommandHelpTemplate = `` /* 486-byte string literal not displayed */
)
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 ImportChain ¶
func ImportChain(chain *core.BlockChain, 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) (chain *core.BlockChain, chainDb aquadb.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 ¶
MakeConsolePreloads retrieves the absolute paths for the console JavaScript scripts to preload before starting.
func MakeDataDir ¶
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 MakePasswordList ¶
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. aquachain account new --keystore /tmp/mykeystore
is equivalent after calling this method with:
aquachain --keystore /tmp/mykeystore 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 RegisterAquaService ¶
RegisterAquaService adds an Aquachain client to the stack.
func RegisterAquaStatsService ¶
RegisterAquaStatsService configures the Aquachain Stats daemon and adds it to th egiven node.
func SetAquaConfig ¶
SetAquaConfig applies aqua-related command line flags to the config.
func SetChainId ¶ added in v1.7.9
SetChainId returns the chain config from the command line flags
func SetHardforkParams ¶ added in v1.7.10
func SetHardforkParams(ctx *cli.Context, chaincfg *params.ChainConfig)
func SetNodeConfig ¶
SetNodeConfig applies node-related command line flags to the config.
func SetupNetworkGasLimit ¶ added in v1.7.10
SetupNetwork configures the system for either the main net or some test network.
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. ~/.aquachain -> /home/username/.aquachain
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