flags.go 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265
  1. package utils
  2. import (
  3. "crypto/ecdsa"
  4. "fmt"
  5. "net"
  6. "net/http"
  7. "os"
  8. "path"
  9. "runtime"
  10. "github.com/codegangsta/cli"
  11. "github.com/ethereum/go-ethereum/accounts"
  12. "github.com/ethereum/go-ethereum/common"
  13. "github.com/ethereum/go-ethereum/core"
  14. "github.com/ethereum/go-ethereum/crypto"
  15. "github.com/ethereum/go-ethereum/eth"
  16. "github.com/ethereum/go-ethereum/ethdb"
  17. "github.com/ethereum/go-ethereum/event"
  18. "github.com/ethereum/go-ethereum/logger"
  19. "github.com/ethereum/go-ethereum/p2p/nat"
  20. "github.com/ethereum/go-ethereum/rpc"
  21. "github.com/ethereum/go-ethereum/xeth"
  22. )
  23. func init() {
  24. cli.AppHelpTemplate = `{{.Name}} {{if .Flags}}[global options] {{end}}command{{if .Flags}} [command options]{{end}} [arguments...]
  25. VERSION:
  26. {{.Version}}
  27. COMMANDS:
  28. {{range .Commands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
  29. {{end}}{{if .Flags}}
  30. GLOBAL OPTIONS:
  31. {{range .Flags}}{{.}}
  32. {{end}}{{end}}
  33. `
  34. cli.CommandHelpTemplate = `{{.Name}}{{if .Subcommands}} command{{end}}{{if .Flags}} [command options]{{end}} [arguments...]
  35. {{if .Description}}{{.Description}}
  36. {{end}}{{if .Subcommands}}
  37. SUBCOMMANDS:
  38. {{range .Subcommands}}{{.Name}}{{with .ShortName}}, {{.}}{{end}}{{ "\t" }}{{.Usage}}
  39. {{end}}{{end}}{{if .Flags}}
  40. OPTIONS:
  41. {{range .Flags}}{{.}}
  42. {{end}}{{end}}
  43. `
  44. }
  45. // NewApp creates an app with sane defaults.
  46. func NewApp(version, usage string) *cli.App {
  47. app := cli.NewApp()
  48. app.Name = path.Base(os.Args[0])
  49. app.Author = ""
  50. app.Authors = nil
  51. app.Email = ""
  52. app.Version = version
  53. app.Usage = usage
  54. return app
  55. }
  56. // These are all the command line flags we support.
  57. // If you add to this list, please remember to include the
  58. // flag in the appropriate command definition.
  59. //
  60. // The flags are defined here so their names and help texts
  61. // are the same for all commands.
  62. var (
  63. // General settings
  64. DataDirFlag = cli.StringFlag{
  65. Name: "datadir",
  66. Usage: "Data directory to be used",
  67. Value: common.DefaultDataDir(),
  68. }
  69. ProtocolVersionFlag = cli.IntFlag{
  70. Name: "protocolversion",
  71. Usage: "ETH protocol version",
  72. Value: eth.ProtocolVersion,
  73. }
  74. NetworkIdFlag = cli.IntFlag{
  75. Name: "networkid",
  76. Usage: "Network Id",
  77. Value: eth.NetworkId,
  78. }
  79. // miner settings
  80. MinerThreadsFlag = cli.IntFlag{
  81. Name: "minerthreads",
  82. Usage: "Number of miner threads",
  83. Value: runtime.NumCPU(),
  84. }
  85. MiningEnabledFlag = cli.BoolFlag{
  86. Name: "mine",
  87. Usage: "Enable mining",
  88. }
  89. // key settings
  90. UnencryptedKeysFlag = cli.BoolFlag{
  91. Name: "unencrypted-keys",
  92. Usage: "disable private key disk encryption (for testing)",
  93. }
  94. UnlockedAccountFlag = cli.StringFlag{
  95. Name: "unlock",
  96. Usage: "Unlock a given account untill this programs exits (address:password)",
  97. }
  98. // logging and debug settings
  99. LogFileFlag = cli.StringFlag{
  100. Name: "logfile",
  101. Usage: "Send log output to a file",
  102. }
  103. LogLevelFlag = cli.IntFlag{
  104. Name: "loglevel",
  105. Usage: "0-5 (silent, error, warn, info, debug, debug detail)",
  106. Value: int(logger.InfoLevel),
  107. }
  108. LogFormatFlag = cli.StringFlag{
  109. Name: "logformat",
  110. Usage: `"std" or "raw"`,
  111. Value: "std",
  112. }
  113. VMDebugFlag = cli.BoolFlag{
  114. Name: "vmdebug",
  115. Usage: "Virtual Machine debug output",
  116. }
  117. // RPC settings
  118. RPCEnabledFlag = cli.BoolFlag{
  119. Name: "rpc",
  120. Usage: "Whether RPC server is enabled",
  121. }
  122. RPCListenAddrFlag = cli.StringFlag{
  123. Name: "rpcaddr",
  124. Usage: "Listening address for the JSON-RPC server",
  125. Value: "127.0.0.1",
  126. }
  127. RPCPortFlag = cli.IntFlag{
  128. Name: "rpcport",
  129. Usage: "Port on which the JSON-RPC server should listen",
  130. Value: 8545,
  131. }
  132. // Network Settings
  133. MaxPeersFlag = cli.IntFlag{
  134. Name: "maxpeers",
  135. Usage: "Maximum number of network peers",
  136. Value: 16,
  137. }
  138. ListenPortFlag = cli.IntFlag{
  139. Name: "port",
  140. Usage: "Network listening port",
  141. Value: 30303,
  142. }
  143. BootnodesFlag = cli.StringFlag{
  144. Name: "bootnodes",
  145. Usage: "Space-separated enode URLs for discovery bootstrap",
  146. Value: "",
  147. }
  148. NodeKeyFileFlag = cli.StringFlag{
  149. Name: "nodekey",
  150. Usage: "P2P node key file",
  151. }
  152. NodeKeyHexFlag = cli.StringFlag{
  153. Name: "nodekeyhex",
  154. Usage: "P2P node key as hex (for testing)",
  155. }
  156. NATFlag = cli.StringFlag{
  157. Name: "nat",
  158. Usage: "Port mapping mechanism (any|none|upnp|pmp|extip:<IP>)",
  159. Value: "any",
  160. }
  161. JSpathFlag = cli.StringFlag{
  162. Name: "jspath",
  163. Usage: "JS library path to be used with console and js subcommands",
  164. Value: ".",
  165. }
  166. )
  167. func GetNAT(ctx *cli.Context) nat.Interface {
  168. natif, err := nat.Parse(ctx.GlobalString(NATFlag.Name))
  169. if err != nil {
  170. Fatalf("Option %s: %v", NATFlag.Name, err)
  171. }
  172. return natif
  173. }
  174. func GetNodeKey(ctx *cli.Context) (key *ecdsa.PrivateKey) {
  175. hex, file := ctx.GlobalString(NodeKeyHexFlag.Name), ctx.GlobalString(NodeKeyFileFlag.Name)
  176. var err error
  177. switch {
  178. case file != "" && hex != "":
  179. Fatalf("Options %q and %q are mutually exclusive", NodeKeyFileFlag.Name, NodeKeyHexFlag.Name)
  180. case file != "":
  181. if key, err = crypto.LoadECDSA(file); err != nil {
  182. Fatalf("Option %q: %v", NodeKeyFileFlag.Name, err)
  183. }
  184. case hex != "":
  185. if key, err = crypto.HexToECDSA(hex); err != nil {
  186. Fatalf("Option %q: %v", NodeKeyHexFlag.Name, err)
  187. }
  188. }
  189. return key
  190. }
  191. func MakeEthConfig(clientID, version string, ctx *cli.Context) *eth.Config {
  192. return &eth.Config{
  193. Name: common.MakeName(clientID, version),
  194. DataDir: ctx.GlobalString(DataDirFlag.Name),
  195. ProtocolVersion: ctx.GlobalInt(ProtocolVersionFlag.Name),
  196. NetworkId: ctx.GlobalInt(NetworkIdFlag.Name),
  197. LogFile: ctx.GlobalString(LogFileFlag.Name),
  198. LogLevel: ctx.GlobalInt(LogLevelFlag.Name),
  199. LogFormat: ctx.GlobalString(LogFormatFlag.Name),
  200. MinerThreads: ctx.GlobalInt(MinerThreadsFlag.Name),
  201. AccountManager: GetAccountManager(ctx),
  202. VmDebug: ctx.GlobalBool(VMDebugFlag.Name),
  203. MaxPeers: ctx.GlobalInt(MaxPeersFlag.Name),
  204. Port: ctx.GlobalString(ListenPortFlag.Name),
  205. NAT: GetNAT(ctx),
  206. NodeKey: GetNodeKey(ctx),
  207. Shh: true,
  208. Dial: true,
  209. BootNodes: ctx.GlobalString(BootnodesFlag.Name),
  210. }
  211. }
  212. func GetChain(ctx *cli.Context) (*core.ChainManager, common.Database, common.Database) {
  213. dataDir := ctx.GlobalString(DataDirFlag.Name)
  214. blockDb, err := ethdb.NewLDBDatabase(path.Join(dataDir, "blockchain"))
  215. if err != nil {
  216. Fatalf("Could not open database: %v", err)
  217. }
  218. stateDb, err := ethdb.NewLDBDatabase(path.Join(dataDir, "state"))
  219. if err != nil {
  220. Fatalf("Could not open database: %v", err)
  221. }
  222. return core.NewChainManager(blockDb, stateDb, new(event.TypeMux)), blockDb, stateDb
  223. }
  224. func GetAccountManager(ctx *cli.Context) *accounts.Manager {
  225. dataDir := ctx.GlobalString(DataDirFlag.Name)
  226. var ks crypto.KeyStore2
  227. if ctx.GlobalBool(UnencryptedKeysFlag.Name) {
  228. ks = crypto.NewKeyStorePlain(path.Join(dataDir, "plainkeys"))
  229. } else {
  230. ks = crypto.NewKeyStorePassphrase(path.Join(dataDir, "keys"))
  231. }
  232. return accounts.NewManager(ks)
  233. }
  234. func StartRPC(eth *eth.Ethereum, ctx *cli.Context) {
  235. addr := ctx.GlobalString(RPCListenAddrFlag.Name)
  236. port := ctx.GlobalInt(RPCPortFlag.Name)
  237. dataDir := ctx.GlobalString(DataDirFlag.Name)
  238. l, err := net.Listen("tcp", fmt.Sprintf("%s:%d", addr, port))
  239. if err != nil {
  240. Fatalf("Can't listen on %s:%d: %v", addr, port, err)
  241. }
  242. go http.Serve(l, rpc.JSONRPC(xeth.New(eth, nil), dataDir))
  243. }