github.com/axiomzen/go-ethereum@v1.8.27/core/genesis.go (about) 1 // Copyright 2014 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 package core 18 19 import ( 20 "bytes" 21 "encoding/hex" 22 "encoding/json" 23 "errors" 24 "fmt" 25 "math/big" 26 "strings" 27 28 "github.com/ethereum/go-ethereum/common" 29 "github.com/ethereum/go-ethereum/common/hexutil" 30 "github.com/ethereum/go-ethereum/common/math" 31 "github.com/ethereum/go-ethereum/core/rawdb" 32 "github.com/ethereum/go-ethereum/core/state" 33 "github.com/ethereum/go-ethereum/core/types" 34 "github.com/ethereum/go-ethereum/ethdb" 35 "github.com/ethereum/go-ethereum/log" 36 "github.com/ethereum/go-ethereum/params" 37 "github.com/ethereum/go-ethereum/rlp" 38 ) 39 40 //go:generate gencodec -type Genesis -field-override genesisSpecMarshaling -out gen_genesis.go 41 //go:generate gencodec -type GenesisAccount -field-override genesisAccountMarshaling -out gen_genesis_account.go 42 43 var errGenesisNoConfig = errors.New("genesis has no chain configuration") 44 45 // Genesis specifies the header fields, state of a genesis block. It also defines hard 46 // fork switch-over blocks through the chain configuration. 47 type Genesis struct { 48 Config *params.ChainConfig `json:"config"` 49 Nonce uint64 `json:"nonce"` 50 Timestamp uint64 `json:"timestamp"` 51 ExtraData []byte `json:"extraData"` 52 GasLimit uint64 `json:"gasLimit" gencodec:"required"` 53 Difficulty *big.Int `json:"difficulty" gencodec:"required"` 54 Mixhash common.Hash `json:"mixHash"` 55 Coinbase common.Address `json:"coinbase"` 56 Alloc GenesisAlloc `json:"alloc" gencodec:"required"` 57 58 // These fields are used for consensus tests. Please don't use them 59 // in actual genesis blocks. 60 Number uint64 `json:"number"` 61 GasUsed uint64 `json:"gasUsed"` 62 ParentHash common.Hash `json:"parentHash"` 63 } 64 65 // GenesisAlloc specifies the initial state that is part of the genesis block. 66 type GenesisAlloc map[common.Address]GenesisAccount 67 68 func (ga *GenesisAlloc) UnmarshalJSON(data []byte) error { 69 m := make(map[common.UnprefixedAddress]GenesisAccount) 70 if err := json.Unmarshal(data, &m); err != nil { 71 return err 72 } 73 *ga = make(GenesisAlloc) 74 for addr, a := range m { 75 (*ga)[common.Address(addr)] = a 76 } 77 return nil 78 } 79 80 // GenesisAccount is an account in the state of the genesis block. 81 type GenesisAccount struct { 82 Code []byte `json:"code,omitempty"` 83 Storage map[common.Hash]common.Hash `json:"storage,omitempty"` 84 Balance *big.Int `json:"balance" gencodec:"required"` 85 Nonce uint64 `json:"nonce,omitempty"` 86 PrivateKey []byte `json:"secretKey,omitempty"` // for tests 87 } 88 89 // field type overrides for gencodec 90 type genesisSpecMarshaling struct { 91 Nonce math.HexOrDecimal64 92 Timestamp math.HexOrDecimal64 93 ExtraData hexutil.Bytes 94 GasLimit math.HexOrDecimal64 95 GasUsed math.HexOrDecimal64 96 Number math.HexOrDecimal64 97 Difficulty *math.HexOrDecimal256 98 Alloc map[common.UnprefixedAddress]GenesisAccount 99 } 100 101 type genesisAccountMarshaling struct { 102 Code hexutil.Bytes 103 Balance *math.HexOrDecimal256 104 Nonce math.HexOrDecimal64 105 Storage map[storageJSON]storageJSON 106 PrivateKey hexutil.Bytes 107 } 108 109 // storageJSON represents a 256 bit byte array, but allows less than 256 bits when 110 // unmarshaling from hex. 111 type storageJSON common.Hash 112 113 func (h *storageJSON) UnmarshalText(text []byte) error { 114 text = bytes.TrimPrefix(text, []byte("0x")) 115 if len(text) > 64 { 116 return fmt.Errorf("too many hex characters in storage key/value %q", text) 117 } 118 offset := len(h) - len(text)/2 // pad on the left 119 if _, err := hex.Decode(h[offset:], text); err != nil { 120 fmt.Println(err) 121 return fmt.Errorf("invalid hex storage key/value %q", text) 122 } 123 return nil 124 } 125 126 func (h storageJSON) MarshalText() ([]byte, error) { 127 return hexutil.Bytes(h[:]).MarshalText() 128 } 129 130 // GenesisMismatchError is raised when trying to overwrite an existing 131 // genesis block with an incompatible one. 132 type GenesisMismatchError struct { 133 Stored, New common.Hash 134 } 135 136 func (e *GenesisMismatchError) Error() string { 137 return fmt.Sprintf("database already contains an incompatible genesis block (have %x, new %x)", e.Stored[:8], e.New[:8]) 138 } 139 140 // SetupGenesisBlock writes or updates the genesis block in db. 141 // The block that will be used is: 142 // 143 // genesis == nil genesis != nil 144 // +------------------------------------------ 145 // db has no genesis | main-net default | genesis 146 // db has genesis | from DB | genesis (if compatible) 147 // 148 // The stored chain configuration will be updated if it is compatible (i.e. does not 149 // specify a fork block below the local head block). In case of a conflict, the 150 // error is a *params.ConfigCompatError and the new, unwritten config is returned. 151 // 152 // The returned chain configuration is never nil. 153 func SetupGenesisBlock(db ethdb.Database, genesis *Genesis) (*params.ChainConfig, common.Hash, error) { 154 return SetupGenesisBlockWithOverride(db, genesis, nil) 155 } 156 func SetupGenesisBlockWithOverride(db ethdb.Database, genesis *Genesis, constantinopleOverride *big.Int) (*params.ChainConfig, common.Hash, error) { 157 if genesis != nil && genesis.Config == nil { 158 return params.AllEthashProtocolChanges, common.Hash{}, errGenesisNoConfig 159 } 160 // Just commit the new block if there is no stored genesis block. 161 stored := rawdb.ReadCanonicalHash(db, 0) 162 if (stored == common.Hash{}) { 163 if genesis == nil { 164 log.Info("Writing default main-net genesis block") 165 genesis = DefaultGenesisBlock() 166 } else { 167 log.Info("Writing custom genesis block") 168 } 169 block, err := genesis.Commit(db) 170 return genesis.Config, block.Hash(), err 171 } 172 173 // Check whether the genesis block is already written. 174 if genesis != nil { 175 hash := genesis.ToBlock(nil).Hash() 176 if hash != stored { 177 return genesis.Config, hash, &GenesisMismatchError{stored, hash} 178 } 179 } 180 181 // Get the existing chain configuration. 182 newcfg := genesis.configOrDefault(stored) 183 if constantinopleOverride != nil { 184 newcfg.ConstantinopleBlock = constantinopleOverride 185 newcfg.PetersburgBlock = constantinopleOverride 186 } 187 storedcfg := rawdb.ReadChainConfig(db, stored) 188 if storedcfg == nil { 189 log.Warn("Found genesis block without chain config") 190 rawdb.WriteChainConfig(db, stored, newcfg) 191 return newcfg, stored, nil 192 } 193 // Special case: don't change the existing config of a non-mainnet chain if no new 194 // config is supplied. These chains would get AllProtocolChanges (and a compat error) 195 // if we just continued here. 196 if genesis == nil && stored != params.MainnetGenesisHash { 197 return storedcfg, stored, nil 198 } 199 200 // Check config compatibility and write the config. Compatibility errors 201 // are returned to the caller unless we're already at block zero. 202 height := rawdb.ReadHeaderNumber(db, rawdb.ReadHeadHeaderHash(db)) 203 if height == nil { 204 return newcfg, stored, fmt.Errorf("missing block number for head header hash") 205 } 206 compatErr := storedcfg.CheckCompatible(newcfg, *height) 207 if compatErr != nil && *height != 0 && compatErr.RewindTo != 0 { 208 return newcfg, stored, compatErr 209 } 210 rawdb.WriteChainConfig(db, stored, newcfg) 211 return newcfg, stored, nil 212 } 213 214 func (g *Genesis) configOrDefault(ghash common.Hash) *params.ChainConfig { 215 switch { 216 case g != nil: 217 return g.Config 218 case ghash == params.MainnetGenesisHash: 219 return params.MainnetChainConfig 220 case ghash == params.TestnetGenesisHash: 221 return params.TestnetChainConfig 222 default: 223 return params.AllEthashProtocolChanges 224 } 225 } 226 227 // ToBlock creates the genesis block and writes state of a genesis specification 228 // to the given database (or discards it if nil). 229 func (g *Genesis) ToBlock(db ethdb.Database) *types.Block { 230 if db == nil { 231 db = ethdb.NewMemDatabase() 232 } 233 statedb, _ := state.New(common.Hash{}, state.NewDatabase(db)) 234 for addr, account := range g.Alloc { 235 statedb.AddBalance(addr, account.Balance) 236 statedb.SetCode(addr, account.Code) 237 statedb.SetNonce(addr, account.Nonce) 238 for key, value := range account.Storage { 239 statedb.SetState(addr, key, value) 240 } 241 } 242 root := statedb.IntermediateRoot(false) 243 head := &types.Header{ 244 Number: new(big.Int).SetUint64(g.Number), 245 Nonce: types.EncodeNonce(g.Nonce), 246 Time: g.Timestamp, 247 ParentHash: g.ParentHash, 248 Extra: g.ExtraData, 249 GasLimit: g.GasLimit, 250 GasUsed: g.GasUsed, 251 Difficulty: g.Difficulty, 252 MixDigest: g.Mixhash, 253 Coinbase: g.Coinbase, 254 Root: root, 255 } 256 if g.GasLimit == 0 { 257 head.GasLimit = params.GenesisGasLimit 258 } 259 if g.Difficulty == nil { 260 head.Difficulty = params.GenesisDifficulty 261 } 262 statedb.Commit(false) 263 statedb.Database().TrieDB().Commit(root, true) 264 265 return types.NewBlock(head, nil, nil, nil) 266 } 267 268 // Commit writes the block and state of a genesis specification to the database. 269 // The block is committed as the canonical head block. 270 func (g *Genesis) Commit(db ethdb.Database) (*types.Block, error) { 271 block := g.ToBlock(db) 272 if block.Number().Sign() != 0 { 273 return nil, fmt.Errorf("can't commit genesis block with number > 0") 274 } 275 rawdb.WriteTd(db, block.Hash(), block.NumberU64(), g.Difficulty) 276 rawdb.WriteBlock(db, block) 277 rawdb.WriteReceipts(db, block.Hash(), block.NumberU64(), nil) 278 rawdb.WriteCanonicalHash(db, block.Hash(), block.NumberU64()) 279 rawdb.WriteHeadBlockHash(db, block.Hash()) 280 rawdb.WriteHeadHeaderHash(db, block.Hash()) 281 282 config := g.Config 283 if config == nil { 284 config = params.AllEthashProtocolChanges 285 } 286 rawdb.WriteChainConfig(db, block.Hash(), config) 287 return block, nil 288 } 289 290 // MustCommit writes the genesis block and state to db, panicking on error. 291 // The block is committed as the canonical head block. 292 func (g *Genesis) MustCommit(db ethdb.Database) *types.Block { 293 block, err := g.Commit(db) 294 if err != nil { 295 panic(err) 296 } 297 return block 298 } 299 300 // GenesisBlockForTesting creates and writes a block in which addr has the given wei balance. 301 func GenesisBlockForTesting(db ethdb.Database, addr common.Address, balance *big.Int) *types.Block { 302 g := Genesis{Alloc: GenesisAlloc{addr: {Balance: balance}}} 303 return g.MustCommit(db) 304 } 305 306 // DefaultGenesisBlock returns the Ethereum main net genesis block. 307 func DefaultGenesisBlock() *Genesis { 308 return &Genesis{ 309 Config: params.MainnetChainConfig, 310 Nonce: 66, 311 ExtraData: hexutil.MustDecode("0x11bbe8db4e347b4e8c937c1c8370e4b5ed33adb3db69cbdb7a38e1e50b1b82fa"), 312 GasLimit: 5000, 313 Difficulty: big.NewInt(17179869184), 314 Alloc: decodePrealloc(mainnetAllocData), 315 } 316 } 317 318 // DefaultTestnetGenesisBlock returns the Ropsten network genesis block. 319 func DefaultTestnetGenesisBlock() *Genesis { 320 return &Genesis{ 321 Config: params.TestnetChainConfig, 322 Nonce: 66, 323 ExtraData: hexutil.MustDecode("0x3535353535353535353535353535353535353535353535353535353535353535"), 324 GasLimit: 16777216, 325 Difficulty: big.NewInt(1048576), 326 Alloc: decodePrealloc(testnetAllocData), 327 } 328 } 329 330 // DefaultRinkebyGenesisBlock returns the Rinkeby network genesis block. 331 func DefaultRinkebyGenesisBlock() *Genesis { 332 return &Genesis{ 333 Config: params.RinkebyChainConfig, 334 Timestamp: 1492009146, 335 ExtraData: hexutil.MustDecode("0x52657370656374206d7920617574686f7269746168207e452e436172746d616e42eb768f2244c8811c63729a21a3569731535f067ffc57839b00206d1ad20c69a1981b489f772031b279182d99e65703f0076e4812653aab85fca0f00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"), 336 GasLimit: 4700000, 337 Difficulty: big.NewInt(1), 338 Alloc: decodePrealloc(rinkebyAllocData), 339 } 340 } 341 342 // DefaultGoerliGenesisBlock returns the Görli network genesis block. 343 func DefaultGoerliGenesisBlock() *Genesis { 344 return &Genesis{ 345 Config: params.GoerliChainConfig, 346 Timestamp: 1548854791, 347 ExtraData: hexutil.MustDecode("0x22466c6578692069732061207468696e6722202d204166726900000000000000e0a2bd4258d2768837baa26a28fe71dc079f84c70000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"), 348 GasLimit: 10485760, 349 Difficulty: big.NewInt(1), 350 Alloc: decodePrealloc(goerliAllocData), 351 } 352 } 353 354 // DeveloperGenesisBlock returns the 'geth --dev' genesis block. Note, this must 355 // be seeded with the 356 func DeveloperGenesisBlock(period uint64, faucet common.Address) *Genesis { 357 // Override the default period to the user requested one 358 config := *params.AllCliqueProtocolChanges 359 config.Clique.Period = period 360 361 // Assemble and return the genesis with the precompiles and faucet pre-funded 362 return &Genesis{ 363 Config: &config, 364 ExtraData: append(append(make([]byte, 32), faucet[:]...), make([]byte, 65)...), 365 GasLimit: 6283185, 366 Difficulty: big.NewInt(1), 367 Alloc: map[common.Address]GenesisAccount{ 368 common.BytesToAddress([]byte{1}): {Balance: big.NewInt(1)}, // ECRecover 369 common.BytesToAddress([]byte{2}): {Balance: big.NewInt(1)}, // SHA256 370 common.BytesToAddress([]byte{3}): {Balance: big.NewInt(1)}, // RIPEMD 371 common.BytesToAddress([]byte{4}): {Balance: big.NewInt(1)}, // Identity 372 common.BytesToAddress([]byte{5}): {Balance: big.NewInt(1)}, // ModExp 373 common.BytesToAddress([]byte{6}): {Balance: big.NewInt(1)}, // ECAdd 374 common.BytesToAddress([]byte{7}): {Balance: big.NewInt(1)}, // ECScalarMul 375 common.BytesToAddress([]byte{8}): {Balance: big.NewInt(1)}, // ECPairing 376 faucet: {Balance: new(big.Int).Sub(new(big.Int).Lsh(big.NewInt(1), 256), big.NewInt(9))}, 377 }, 378 } 379 } 380 381 func decodePrealloc(data string) GenesisAlloc { 382 var p []struct{ Addr, Balance *big.Int } 383 if err := rlp.NewStream(strings.NewReader(data), 0).Decode(&p); err != nil { 384 panic(err) 385 } 386 ga := make(GenesisAlloc, len(p)) 387 for _, account := range p { 388 ga[common.BigToAddress(account.Addr)] = GenesisAccount{Balance: account.Balance} 389 } 390 return ga 391 }