-
Notifications
You must be signed in to change notification settings - Fork 459
/
genesis.go
553 lines (505 loc) · 19.5 KB
/
genesis.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
package core
import (
"bytes"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"math/big"
"os"
"github.com/dominant-strategies/go-quai/common"
"github.com/dominant-strategies/go-quai/common/hexutil"
"github.com/dominant-strategies/go-quai/common/math"
"github.com/dominant-strategies/go-quai/core/rawdb"
"github.com/dominant-strategies/go-quai/core/state"
"github.com/dominant-strategies/go-quai/core/types"
"github.com/dominant-strategies/go-quai/crypto"
"github.com/dominant-strategies/go-quai/ethdb"
"github.com/dominant-strategies/go-quai/log"
"github.com/dominant-strategies/go-quai/params"
)
//go:generate gencodec -type Genesis -field-override genesisSpecMarshaling -out gen_genesis.go
//go:generate gencodec -type GenesisAccount -field-override genesisAccountMarshaling -out gen_genesis_account.go
var errGenesisNoConfig = errors.New("genesis has no chain configuration")
// Genesis specifies the header fields, state of a genesis block. It also defines hard
// fork switch-over blocks through the chain configuration.
type Genesis struct {
Config *params.ChainConfig `json:"config"`
Nonce uint64 `json:"nonce"`
Timestamp uint64 `json:"timestamp"`
ExtraData []byte `json:"extraData"`
GasLimit uint64 `json:"gasLimit" gencodec:"required"`
Difficulty *big.Int `json:"difficulty" gencodec:"required"`
Mixhash common.Hash `json:"mixHash"`
Coinbase common.Address `json:"coinbase"`
// These fields are used for consensus tests. Please don't use them
// in actual genesis blocks.
Number []uint64 `json:"number"`
GasUsed uint64 `json:"gasUsed"`
ParentHash []common.Hash `json:"parentHash"`
BaseFee *big.Int `json:"baseFeePerGas"`
}
// GenesisAlloc specifies the initial state that is part of the genesis block.
type GenesisAlloc map[common.Address]GenesisAccount
func (ga *GenesisAlloc) UnmarshalJSON(data []byte) error {
m := make(map[common.UnprefixedAddress]GenesisAccount)
if err := json.Unmarshal(data, &m); err != nil {
return err
}
*ga = make(GenesisAlloc)
for addr, a := range m {
internal := common.InternalAddress(addr)
(*ga)[common.NewAddressFromData(&internal)] = a
}
return nil
}
// GenesisAccount is an account in the state of the genesis block.
type GenesisAccount struct {
Code []byte `json:"code,omitempty"`
Storage map[common.Hash]common.Hash `json:"storage,omitempty"`
Balance *big.Int `json:"balance" gencodec:"required"`
Nonce uint64 `json:"nonce,omitempty"`
PrivateKey []byte `json:"secretKey,omitempty"` // for tests
}
type GenesisUTXO struct {
Denomination uint32 `json:"denomination"`
Index uint32 `json:"index"`
Hash string `json:"hash"`
}
// field type overrides for gencodec
type genesisSpecMarshaling struct {
Nonce math.HexOrDecimal64
Timestamp math.HexOrDecimal64
ExtraData hexutil.Bytes
GasLimit math.HexOrDecimal64
GasUsed math.HexOrDecimal64
Number math.HexOrDecimal64
Difficulty *math.HexOrDecimal256
BaseFee *math.HexOrDecimal256
Alloc map[common.UnprefixedAddress]GenesisAccount
}
type genesisAccountMarshaling struct {
Code hexutil.Bytes
Balance *math.HexOrDecimal256
Nonce math.HexOrDecimal64
Storage map[storageJSON]storageJSON
PrivateKey hexutil.Bytes
}
// storageJSON represents a 256 bit byte array, but allows less than 256 bits when
// unmarshaling from hex.
type storageJSON common.Hash
func (h *storageJSON) UnmarshalText(text []byte) error {
text = bytes.TrimPrefix(text, []byte("0x"))
if len(text) > 64 {
return fmt.Errorf("too many hex characters in storage key/value %q", text)
}
offset := len(h) - len(text)/2 // pad on the left
if _, err := hex.Decode(h[offset:], text); err != nil {
fmt.Println(err)
return fmt.Errorf("invalid hex storage key/value %q", text)
}
return nil
}
func (h storageJSON) MarshalText() ([]byte, error) {
return hexutil.Bytes(h[:]).MarshalText()
}
// GenesisMismatchError is raised when trying to overwrite an existing
// genesis block with an incompatible one.
type GenesisMismatchError struct {
Stored, New common.Hash
}
func (e *GenesisMismatchError) Error() string {
return fmt.Sprintf("database contains incompatible genesis (have %x, new %x)", e.Stored, e.New)
}
// SetupGenesisBlock writes or updates the genesis block in db.
// The block that will be used is:
//
// genesis == nil genesis != nil
// +------------------------------------------
// db has no genesis | main-net default | genesis
// db has genesis | from DB | genesis (if compatible)
//
// The stored chain configuration will be updated if it is compatible (i.e. does not
// specify a fork block below the local head block). In case of a conflict, the
// error is a *params.ConfigCompatError and the new, unwritten config is returned.
//
// The returned chain configuration is never nil.
func SetupGenesisBlock(db ethdb.Database, genesis *Genesis, nodeLocation common.Location, logger *log.Logger) (*params.ChainConfig, common.Hash, error) {
return SetupGenesisBlockWithOverride(db, genesis, nodeLocation, 0, logger)
}
func SetupGenesisBlockWithOverride(db ethdb.Database, genesis *Genesis, nodeLocation common.Location, startingExpansionNumber uint64, logger *log.Logger) (*params.ChainConfig, common.Hash, error) {
if genesis != nil && genesis.Config == nil {
return params.AllProgpowProtocolChanges, common.Hash{}, errGenesisNoConfig
}
// Just commit the new block if there is no stored genesis block.
stored := rawdb.ReadCanonicalHash(db, 0)
if (stored == common.Hash{}) {
if genesis == nil {
logger.Info("Writing default main-net genesis block")
genesis = DefaultGenesisBlock()
} else {
logger.Info("Writing custom genesis block")
}
block, err := genesis.Commit(db, nodeLocation, startingExpansionNumber)
if err != nil {
return genesis.Config, common.Hash{}, err
}
return genesis.Config, block.Hash(), nil
}
// We have the genesis block in database(perhaps in ancient database)
// but the corresponding state is missing.
header := rawdb.ReadHeader(db, stored)
if _, err := state.New(header.EVMRoot(), header.UTXORoot(), header.EtxSetRoot(), state.NewDatabaseWithConfig(db, nil), state.NewDatabaseWithConfig(db, nil), state.NewDatabaseWithConfig(db, nil), nil, nodeLocation, logger); err != nil {
if genesis == nil {
genesis = DefaultGenesisBlock()
}
// Ensure the stored genesis matches with the given one.
hash := genesis.ToBlock(startingExpansionNumber).Hash()
if hash != stored {
return genesis.Config, hash, &GenesisMismatchError{stored, hash}
}
block, err := genesis.Commit(db, nodeLocation, startingExpansionNumber)
if err != nil {
return genesis.Config, hash, err
}
return genesis.Config, block.Hash(), nil
}
// Check whether the genesis block is already written.
if genesis != nil {
hash := genesis.ToBlock(startingExpansionNumber).Hash()
if hash != stored {
return genesis.Config, hash, &GenesisMismatchError{stored, hash}
}
}
// Get the existing chain configuration.
newcfg := genesis.configOrDefault(stored)
storedcfg := rawdb.ReadChainConfig(db, stored)
if storedcfg == nil {
logger.Warn("Found genesis block without chain config")
rawdb.WriteChainConfig(db, stored, newcfg)
return newcfg, stored, nil
}
// Special case: don't change the existing config of a non-mainnet chain if no new
// config is supplied. These chains would get AllProtocolChanges (and a compat error)
// if we just continued here.
if genesis == nil && stored != params.ProgpowColosseumGenesisHash {
return storedcfg, stored, nil
}
// Check config compatibility and write the config. Compatibility errors
// are returned to the caller unless we're already at block zero.
height := rawdb.ReadHeaderNumber(db, rawdb.ReadHeadHeaderHash(db))
if height == nil {
return newcfg, stored, fmt.Errorf("missing block number for head header hash")
}
rawdb.WriteChainConfig(db, stored, newcfg)
return newcfg, stored, nil
}
func (g *Genesis) configOrDefault(ghash common.Hash) *params.ChainConfig {
switch {
case g != nil:
return g.Config
case ghash == params.ProgpowColosseumGenesisHash:
return params.ProgpowColosseumChainConfig
case ghash == params.ProgpowGardenGenesisHash:
return params.ProgpowGardenChainConfig
case ghash == params.ProgpowOrchardGenesisHash:
return params.ProgpowOrchardChainConfig
case ghash == params.ProgpowLighthouseGenesisHash:
return params.ProgpowLighthouseChainConfig
case ghash == params.ProgpowLocalGenesisHash:
return params.ProgpowLocalChainConfig
// Blake3 chain configs
case ghash == params.Blake3PowColosseumGenesisHash:
return params.Blake3PowColosseumChainConfig
case ghash == params.Blake3PowGardenGenesisHash:
return params.Blake3PowGardenChainConfig
case ghash == params.Blake3PowOrchardGenesisHash:
return params.Blake3PowOrchardChainConfig
case ghash == params.Blake3PowLighthouseGenesisHash:
return params.Blake3PowLighthouseChainConfig
case ghash == params.Blake3PowLocalGenesisHash:
return params.Blake3PowLocalChainConfig
default:
return params.AllProgpowProtocolChanges
}
}
// ToBlock creates the genesis block and writes state of a genesis specification
// to the given database (or discards it if nil).
func (g *Genesis) ToBlock(startingExpansionNumber uint64) *types.WorkObject {
wo := types.EmptyWorkObject(g.Config.Location.Context())
wo.WorkObjectHeader().SetNonce(types.EncodeNonce(g.Nonce))
wo.WorkObjectHeader().SetDifficulty(g.Difficulty)
wo.WorkObjectHeader().SetPrimeTerminusNumber(big.NewInt(0))
wo.WorkObjectHeader().SetTime(g.Timestamp)
wo.WorkObjectHeader().SetCoinbase(common.Zero)
wo.Header().SetExtra(g.ExtraData)
wo.Header().SetGasLimit(g.GasLimit)
wo.Header().SetGasUsed(0)
wo.Header().SetExpansionNumber(uint8(startingExpansionNumber))
if startingExpansionNumber > 0 {
// Fill each byte with 0xFF to set all bits to 1
var etxEligibleSlices common.Hash
for i := 0; i < common.HashLength; i++ {
etxEligibleSlices[i] = 0xFF
}
wo.Header().SetEtxEligibleSlices(etxEligibleSlices)
} else {
wo.Header().SetEtxEligibleSlices(common.Hash{})
}
wo.Header().SetBaseFee(new(big.Int).SetUint64(params.InitialBaseFee))
wo.Header().SetEtxSetRoot(types.EmptyRootHash)
if g.GasLimit == 0 {
wo.Header().SetGasLimit(params.GenesisGasLimit)
}
for i := 0; i < common.HierarchyDepth; i++ {
wo.SetNumber(big.NewInt(0), i)
wo.SetParentHash(common.Hash{}, i)
}
return wo
}
// Commit writes the block and state of a genesis specification to the database.
// The block is committed as the canonical head block.
func (g *Genesis) Commit(db ethdb.Database, nodeLocation common.Location, startingExpansionNumber uint64) (*types.WorkObject, error) {
nodeCtx := nodeLocation.Context()
block := g.ToBlock(startingExpansionNumber)
if block.Number(nodeCtx).Sign() != 0 {
return nil, fmt.Errorf("can't commit genesis block with number > 0")
}
config := g.Config
if config == nil {
config = params.AllProgpowProtocolChanges
}
rawdb.WriteGenesisHashes(db, common.Hashes{block.Hash()})
rawdb.WriteTermini(db, block.Hash(), types.EmptyTermini())
rawdb.WriteWorkObject(db, block.Hash(), block, types.BlockObject, nodeCtx)
rawdb.WriteReceipts(db, block.Hash(), block.NumberU64(nodeCtx), nil)
rawdb.WriteCanonicalHash(db, block.Hash(), block.NumberU64(nodeCtx))
rawdb.WriteHeadBlockHash(db, block.Hash())
rawdb.WriteHeadHeaderHash(db, block.Hash())
rawdb.WriteChainConfig(db, block.Hash(), config)
return block, nil
}
// MustCommit writes the genesis block and state to db, panicking on error.
// The block is committed as the canonical head block.
func (g *Genesis) MustCommit(db ethdb.Database, nodeLocation common.Location) *types.WorkObject {
block, err := g.Commit(db, nodeLocation, 0)
if err != nil {
panic(err)
}
return block
}
// GenesisBlockForTesting creates and writes a block in which addr has the given wei balance.
func GenesisBlockForTesting(db ethdb.Database, addr common.Address, balance *big.Int, nodeLocation common.Location) *types.WorkObject {
g := Genesis{
BaseFee: big.NewInt(params.InitialBaseFee),
}
return g.MustCommit(db, nodeLocation)
}
// DefaultGenesisBlock returns the Latest default Genesis block.
// Currently it returns the DefaultColosseumGenesisBlock.
func DefaultGenesisBlock() *Genesis {
return DefaultColosseumGenesisBlock("progpow")
}
// DefaultColosseumGenesisBlock returns the Quai Colosseum testnet genesis block.
func DefaultColosseumGenesisBlock(consensusEngine string) *Genesis {
if consensusEngine == "blake3" {
return &Genesis{
Config: params.Blake3PowColosseumChainConfig,
Nonce: 66,
ExtraData: hexutil.MustDecode("0x11bbe8db4e347b4e8c937c1c8370e4b5ed33adb3db69cbdb7a38e1e50b1b82fb"),
GasLimit: 5000000,
Difficulty: big.NewInt(2000000),
}
}
return &Genesis{
Config: params.ProgpowColosseumChainConfig,
Nonce: 66,
ExtraData: hexutil.MustDecode("0x11bbe8db4e347b4e8c937c1c8370e4b5ed33adb3db69cbdb7a38e1e50b1b82fb"),
GasLimit: 5000000,
Difficulty: big.NewInt(1000000000),
}
}
// DefaultGardenGenesisBlock returns the Garden testnet genesis block.
func DefaultGardenGenesisBlock(consensusEngine string) *Genesis {
if consensusEngine == "blake3" {
return &Genesis{
Config: params.Blake3PowGardenChainConfig,
Nonce: 66,
ExtraData: hexutil.MustDecode("0x11bbe8db4e347b4e8c937c1c8370e4b5ed33adb3db69cbdb7a38e1e50b1b82fa"),
GasLimit: 160000000,
Difficulty: big.NewInt(1000000),
}
}
return &Genesis{
Config: params.ProgpowGardenChainConfig,
Nonce: 0,
ExtraData: hexutil.MustDecode("0x3535353535353535353535353535353535353535353535353535353535353539"),
GasLimit: 5000000,
Difficulty: big.NewInt(300000000),
}
}
// DefaultOrchardGenesisBlock returns the Orchard testnet genesis block.
func DefaultOrchardGenesisBlock(consensusEngine string) *Genesis {
if consensusEngine == "blake3" {
return &Genesis{
Config: params.Blake3PowOrchardChainConfig,
Nonce: 66,
ExtraData: hexutil.MustDecode("0x11bbe8db4e347b4e8c937c1c8370e4b5ed33adb3db69cbdb7a38e1e50b1b82fc"),
GasLimit: 5000000,
Difficulty: big.NewInt(900000),
}
}
return &Genesis{
Config: params.ProgpowOrchardChainConfig,
Nonce: 0,
ExtraData: hexutil.MustDecode("0x3535353535353535353535353535353535353535353535353535353535353536"),
GasLimit: 5000000,
Difficulty: big.NewInt(300000000),
}
}
// DefaultLighthouseGenesisBlock returns the Lighthouse testnet genesis block.
func DefaultLighthouseGenesisBlock(consensusEngine string) *Genesis {
if consensusEngine == "blake3" {
return &Genesis{
Config: params.Blake3PowLighthouseChainConfig,
Nonce: 66,
ExtraData: hexutil.MustDecode("0x11bbe8db4e347b4e8c937c1c8370e4b5ed33adb3db69cbdb7a38e1e50b1b82fb"),
GasLimit: 40000000,
Difficulty: big.NewInt(200000),
}
}
return &Genesis{
Config: params.ProgpowLighthouseChainConfig,
Nonce: 0,
ExtraData: hexutil.MustDecode("0x3535353535353535353535353535353535353535353535353535353535353537"),
GasLimit: 5000000,
Difficulty: big.NewInt(200000),
}
}
// DefaultLocalGenesisBlock returns the Local testnet genesis block.
func DefaultLocalGenesisBlock(consensusEngine string) *Genesis {
if consensusEngine == "blake3" {
return &Genesis{
Config: params.Blake3PowLocalChainConfig,
Nonce: 66,
ExtraData: hexutil.MustDecode("0x11bbe8db4e347b4e8c937c1c8370e4b5ed33adb3db69cbdb7a38e1e50b1b82fb"),
GasLimit: 5000000,
Difficulty: big.NewInt(500000),
}
}
return &Genesis{
Config: params.ProgpowLocalChainConfig,
Nonce: 0,
ExtraData: hexutil.MustDecode("0x3535353535353535353535353535353535353535353535353535353535353535"),
GasLimit: 5000000,
Difficulty: big.NewInt(1000),
}
}
// DeveloperGenesisBlock returns the 'quai --dev' genesis block.
func DeveloperGenesisBlock(period uint64, faucet common.Address) *Genesis {
// Override the default period to the user requested one
config := *params.AllProgpowProtocolChanges
// Assemble and return the genesis with the precompiles and faucet pre-funded
return &Genesis{
Config: &config,
ExtraData: append(append(make([]byte, 32), faucet.Bytes()[:]...), make([]byte, crypto.SignatureLength)...),
GasLimit: 0x47b760,
BaseFee: big.NewInt(params.InitialBaseFee),
Difficulty: big.NewInt(1),
}
}
func ReadGenesisAlloc(filename string, logger *log.Logger) map[string]GenesisAccount {
jsonFile, err := os.Open(filename)
if err != nil {
logger.Error(err.Error())
return nil
}
defer jsonFile.Close()
// Read the file contents
byteValue, err := ioutil.ReadAll(jsonFile)
if err != nil {
logger.Error(err.Error())
return nil
}
// Parse the JSON data
var data map[string]GenesisAccount
err = json.Unmarshal(byteValue, &data)
if err != nil {
logger.Error(err.Error())
return nil
}
// Use the parsed data
return data
}
func ReadGenesisQiAlloc(filename string, logger *log.Logger) map[string]GenesisUTXO {
jsonFile, err := os.Open(filename)
if err != nil {
logger.Error(err.Error())
return nil
}
defer jsonFile.Close()
// Read the file contents
byteValue, err := ioutil.ReadAll(jsonFile)
if err != nil {
logger.Error(err.Error())
return nil
}
// Parse the JSON data
var data map[string]GenesisUTXO
err = json.Unmarshal(byteValue, &data)
if err != nil {
logger.Error(err.Error())
return nil
}
// Use the parsed data
return data
}
// WriteGenesisUtxoSet writes the genesis utxo set to the database
func AddGenesisUtxos(state *state.StateDB, nodeLocation common.Location, addressOutpointMap map[string]map[string]*types.OutpointAndDenomination, logger *log.Logger) {
qiAlloc := ReadGenesisQiAlloc("genallocs/gen_alloc_qi_"+nodeLocation.Name()+".json", logger)
// logger.WithField("alloc", len(qiAlloc)).Info("Allocating genesis accounts")
for addressString, utxo := range qiAlloc {
addr := common.HexToAddress(addressString, nodeLocation)
internal, err := addr.InternalAddress()
if err != nil {
logger.Error("Provided address in genesis block is out of scope")
}
hash := common.HexToHash(utxo.Hash)
// check if utxo.Denomination is less than uint8
if utxo.Denomination > 255 {
logger.Error("Provided denomination is larger than uint8")
}
newUtxo := &types.UtxoEntry{
Address: internal.Bytes(),
Denomination: uint8(utxo.Denomination),
}
if err := state.CreateUTXO(hash, uint16(utxo.Index), newUtxo); err != nil {
panic(fmt.Sprintf("Failed to create genesis UTXO: %v", err))
}
outpointAndDenomination := &types.OutpointAndDenomination{
TxHash: hash,
Index: uint16(utxo.Index),
Denomination: uint8(utxo.Denomination),
}
if _, ok := addressOutpointMap[addr.Hex()]; !ok {
addressOutpointMap[addr.Hex()] = make(map[string]*types.OutpointAndDenomination)
}
addressOutpointMap[addr.Hex()][outpointAndDenomination.Key()] = outpointAndDenomination
}
}