github.com/matthieu/go-ethereum@v1.13.2/mobile/geth.go (about) 1 // Copyright 2016 The go-ethereum Authors 2 // This file is part of the go-ethereum library. 3 // 4 // The go-ethereum library is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU Lesser General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // The go-ethereum library is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU Lesser General Public License for more details. 13 // 14 // You should have received a copy of the GNU Lesser General Public License 15 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. 16 17 // Contains all the wrappers from the node package to support client side node 18 // management on mobile platforms. 19 20 package geth 21 22 import ( 23 "encoding/json" 24 "fmt" 25 "path/filepath" 26 27 "github.com/matthieu/go-ethereum/core" 28 "github.com/matthieu/go-ethereum/eth" 29 "github.com/matthieu/go-ethereum/eth/downloader" 30 "github.com/matthieu/go-ethereum/ethclient" 31 "github.com/matthieu/go-ethereum/ethstats" 32 "github.com/matthieu/go-ethereum/internal/debug" 33 "github.com/matthieu/go-ethereum/les" 34 "github.com/matthieu/go-ethereum/node" 35 "github.com/matthieu/go-ethereum/p2p" 36 "github.com/matthieu/go-ethereum/p2p/nat" 37 "github.com/matthieu/go-ethereum/params" 38 whisper "github.com/matthieu/go-ethereum/whisper/whisperv6" 39 ) 40 41 // NodeConfig represents the collection of configuration values to fine tune the Geth 42 // node embedded into a mobile process. The available values are a subset of the 43 // entire API provided by go-ethereum to reduce the maintenance surface and dev 44 // complexity. 45 type NodeConfig struct { 46 // Bootstrap nodes used to establish connectivity with the rest of the network. 47 BootstrapNodes *Enodes 48 49 // MaxPeers is the maximum number of peers that can be connected. If this is 50 // set to zero, then only the configured static and trusted peers can connect. 51 MaxPeers int 52 53 // EthereumEnabled specifies whether the node should run the Ethereum protocol. 54 EthereumEnabled bool 55 56 // EthereumNetworkID is the network identifier used by the Ethereum protocol to 57 // decide if remote peers should be accepted or not. 58 EthereumNetworkID int64 // uint64 in truth, but Java can't handle that... 59 60 // EthereumGenesis is the genesis JSON to use to seed the blockchain with. An 61 // empty genesis state is equivalent to using the mainnet's state. 62 EthereumGenesis string 63 64 // EthereumDatabaseCache is the system memory in MB to allocate for database caching. 65 // A minimum of 16MB is always reserved. 66 EthereumDatabaseCache int 67 68 // EthereumNetStats is a netstats connection string to use to report various 69 // chain, transaction and node stats to a monitoring server. 70 // 71 // It has the form "nodename:secret@host:port" 72 EthereumNetStats string 73 74 // WhisperEnabled specifies whether the node should run the Whisper protocol. 75 WhisperEnabled bool 76 77 // Listening address of pprof server. 78 PprofAddress string 79 } 80 81 // defaultNodeConfig contains the default node configuration values to use if all 82 // or some fields are missing from the user's specified list. 83 var defaultNodeConfig = &NodeConfig{ 84 BootstrapNodes: FoundationBootnodes(), 85 MaxPeers: 25, 86 EthereumEnabled: true, 87 EthereumNetworkID: 1, 88 EthereumDatabaseCache: 16, 89 } 90 91 // NewNodeConfig creates a new node option set, initialized to the default values. 92 func NewNodeConfig() *NodeConfig { 93 config := *defaultNodeConfig 94 return &config 95 } 96 97 // Node represents a Geth Ethereum node instance. 98 type Node struct { 99 node *node.Node 100 } 101 102 // NewNode creates and configures a new Geth node. 103 func NewNode(datadir string, config *NodeConfig) (stack *Node, _ error) { 104 // If no or partial configurations were specified, use defaults 105 if config == nil { 106 config = NewNodeConfig() 107 } 108 if config.MaxPeers == 0 { 109 config.MaxPeers = defaultNodeConfig.MaxPeers 110 } 111 if config.BootstrapNodes == nil || config.BootstrapNodes.Size() == 0 { 112 config.BootstrapNodes = defaultNodeConfig.BootstrapNodes 113 } 114 115 if config.PprofAddress != "" { 116 debug.StartPProf(config.PprofAddress, true) 117 } 118 119 // Create the empty networking stack 120 nodeConf := &node.Config{ 121 Name: clientIdentifier, 122 Version: params.VersionWithMeta, 123 DataDir: datadir, 124 KeyStoreDir: filepath.Join(datadir, "keystore"), // Mobile should never use internal keystores! 125 P2P: p2p.Config{ 126 NoDiscovery: true, 127 DiscoveryV5: true, 128 BootstrapNodesV5: config.BootstrapNodes.nodes, 129 ListenAddr: ":0", 130 NAT: nat.Any(), 131 MaxPeers: config.MaxPeers, 132 }, 133 } 134 135 rawStack, err := node.New(nodeConf) 136 if err != nil { 137 return nil, err 138 } 139 140 debug.Memsize.Add("node", rawStack) 141 142 var genesis *core.Genesis 143 if config.EthereumGenesis != "" { 144 // Parse the user supplied genesis spec if not mainnet 145 genesis = new(core.Genesis) 146 if err := json.Unmarshal([]byte(config.EthereumGenesis), genesis); err != nil { 147 return nil, fmt.Errorf("invalid genesis spec: %v", err) 148 } 149 // If we have the Ropsten testnet, hard code the chain configs too 150 if config.EthereumGenesis == RopstenGenesis() { 151 genesis.Config = params.RopstenChainConfig 152 if config.EthereumNetworkID == 1 { 153 config.EthereumNetworkID = 3 154 } 155 } 156 // If we have the Rinkeby testnet, hard code the chain configs too 157 if config.EthereumGenesis == RinkebyGenesis() { 158 genesis.Config = params.RinkebyChainConfig 159 if config.EthereumNetworkID == 1 { 160 config.EthereumNetworkID = 4 161 } 162 } 163 // If we have the Goerli testnet, hard code the chain configs too 164 if config.EthereumGenesis == GoerliGenesis() { 165 genesis.Config = params.GoerliChainConfig 166 if config.EthereumNetworkID == 1 { 167 config.EthereumNetworkID = 5 168 } 169 } 170 } 171 // Register the Ethereum protocol if requested 172 if config.EthereumEnabled { 173 ethConf := eth.DefaultConfig 174 ethConf.Genesis = genesis 175 ethConf.SyncMode = downloader.LightSync 176 ethConf.NetworkId = uint64(config.EthereumNetworkID) 177 ethConf.DatabaseCache = config.EthereumDatabaseCache 178 if err := rawStack.Register(func(ctx *node.ServiceContext) (node.Service, error) { 179 return les.New(ctx, ðConf) 180 }); err != nil { 181 return nil, fmt.Errorf("ethereum init: %v", err) 182 } 183 // If netstats reporting is requested, do it 184 if config.EthereumNetStats != "" { 185 if err := rawStack.Register(func(ctx *node.ServiceContext) (node.Service, error) { 186 var lesServ *les.LightEthereum 187 ctx.Service(&lesServ) 188 189 return ethstats.New(config.EthereumNetStats, nil, lesServ) 190 }); err != nil { 191 return nil, fmt.Errorf("netstats init: %v", err) 192 } 193 } 194 } 195 // Register the Whisper protocol if requested 196 if config.WhisperEnabled { 197 if err := rawStack.Register(func(*node.ServiceContext) (node.Service, error) { 198 return whisper.New(&whisper.DefaultConfig), nil 199 }); err != nil { 200 return nil, fmt.Errorf("whisper init: %v", err) 201 } 202 } 203 return &Node{rawStack}, nil 204 } 205 206 // Close terminates a running node along with all it's services, tearing internal 207 // state doen too. It's not possible to restart a closed node. 208 func (n *Node) Close() error { 209 return n.node.Close() 210 } 211 212 // Start creates a live P2P node and starts running it. 213 func (n *Node) Start() error { 214 return n.node.Start() 215 } 216 217 // Stop terminates a running node along with all it's services. If the node was 218 // not started, an error is returned. 219 func (n *Node) Stop() error { 220 return n.node.Stop() 221 } 222 223 // GetEthereumClient retrieves a client to access the Ethereum subsystem. 224 func (n *Node) GetEthereumClient() (client *EthereumClient, _ error) { 225 rpc, err := n.node.Attach() 226 if err != nil { 227 return nil, err 228 } 229 return &EthereumClient{ethclient.NewClient(rpc)}, nil 230 } 231 232 // GetNodeInfo gathers and returns a collection of metadata known about the host. 233 func (n *Node) GetNodeInfo() *NodeInfo { 234 return &NodeInfo{n.node.Server().NodeInfo()} 235 } 236 237 // GetPeersInfo returns an array of metadata objects describing connected peers. 238 func (n *Node) GetPeersInfo() *PeerInfos { 239 return &PeerInfos{n.node.Server().PeersInfo()} 240 }