path: root/core/genesis.go

// 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"
    "math/big"
    "sort"
    "strings"

    "github.com/dexon-foundation/dexon/common"
    "github.com/dexon-foundation/dexon/common/hexutil"
    "github.com/dexon-foundation/dexon/common/math"
    "github.com/dexon-foundation/dexon/core/rawdb"
    "github.com/dexon-foundation/dexon/core/state"
    "github.com/dexon-foundation/dexon/core/types"
    "github.com/dexon-foundation/dexon/core/vm"
    "github.com/dexon-foundation/dexon/crypto"
    "github.com/dexon-foundation/dexon/ethdb"
    "github.com/dexon-foundation/dexon/log"
    "github.com/dexon-foundation/dexon/params"
    "github.com/dexon-foundation/dexon/rlp"
)

//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"`
    Alloc      GenesisAlloc        `json:"alloc"      gencodec:"required"`

    // 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"`
}

// 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 {
        (*ga)[common.Address(addr)] = a
    }
    return nil
}

// NodeInfo represents the info of a node.
type NodeInfo struct {
    Name     string `json:"name"`
    Email    string `json:"email"`
    Location string `json:"location"`
    Url      string `json:"url"`
}

// 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"`
    Staked     *big.Int                    `json:"staked"`
    PublicKey  []byte                      `json:"publicKey"`
    NodeInfo   NodeInfo                    `json:"info"`
    PrivateKey []byte                      `json:"secretKey,omitempty"` // for tests
}

// 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
    Alloc      map[common.UnprefixedAddress]GenesisAccount
}

type genesisAccountMarshaling struct {
    Code       hexutil.Bytes
    Balance    *math.HexOrDecimal256
    Staked     *math.HexOrDecimal256
    Nonce      math.HexOrDecimal64
    Storage    map[storageJSON]storageJSON
    PublicKey  hexutil.Bytes
    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 already contains an incompatible genesis block (have %x, new %x)", e.Stored[:8], e.New[:8])
}

// 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) (*params.ChainConfig, common.Hash, error) {
    return SetupGenesisBlockWithOverride(db, genesis, nil)
}
func SetupGenesisBlockWithOverride(db ethdb.Database, genesis *Genesis, constantinopleOverride *big.Int) (*params.ChainConfig, common.Hash, error) {
    rawdb.WriteLastRoundNumber(db, 0)

    if genesis != nil && genesis.Config == nil {
        return params.AllEthashProtocolChanges, 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 {
            log.Info("Writing default main-net genesis block")
            genesis = DefaultGenesisBlock()
        } else {
            log.Info("Writing custom genesis block")
        }
        block, err := genesis.Commit(db)
        return genesis.Config, block.Hash(), err
    }

    // Check whether the genesis block is already written.
    if genesis != nil {
        hash := genesis.ToBlock(nil).Hash()
        if hash != stored {
            return genesis.Config, hash, &GenesisMismatchError{stored, hash}
        }
    }

    // Get the existing chain configuration.
    newcfg := genesis.configOrDefault(stored)
    if constantinopleOverride != nil {
        newcfg.ConstantinopleBlock = constantinopleOverride
        newcfg.PetersburgBlock = constantinopleOverride
    }
    storedcfg := rawdb.ReadChainConfig(db, stored)
    if storedcfg == nil {
        log.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.MainnetGenesisHash {
        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")
    }
    compatErr := storedcfg.CheckCompatible(newcfg, *height)
    if compatErr != nil && *height != 0 && compatErr.RewindTo != 0 {
        return newcfg, stored, compatErr
    }
    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.MainnetGenesisHash:
        return params.MainnetChainConfig
    case ghash == params.TestnetGenesisHash:
        return params.TestnetChainConfig
    default:
        return params.AllEthashProtocolChanges
    }
}

type AllocKey []common.Address

func (a AllocKey) Len() int {
    return len(a)
}

func (a AllocKey) Less(i int, j int) bool {
    return bytes.Compare(a[i][:], a[j][:]) < 0
}

func (a AllocKey) Swap(i int, j int) {
    a[i], a[j] = a[j], a[i]
}

// 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(db ethdb.Database) *types.Block {
    if db == nil {
        db = ethdb.NewMemDatabase()
    }
    statedb, _ := state.New(common.Hash{}, state.NewDatabase(db))
    govStateHelper := vm.GovernanceStateHelper{StateDB: statedb}

    totalSupply := big.NewInt(0)
    totalStaked := big.NewInt(0)

    for addr, account := range g.Alloc {
        // For DEXON consensus genesis staking.
        if g.Config != nil && g.Config.Dexcon != nil {
            statedb.AddBalance(addr, new(big.Int).Sub(account.Balance, account.Staked))
            totalStaked = new(big.Int).Add(totalStaked, account.Staked)
        } else {
            statedb.AddBalance(addr, account.Balance)
        }

        statedb.SetCode(addr, account.Code)
        statedb.SetNonce(addr, account.Nonce)
        for key, value := range account.Storage {
            statedb.SetState(addr, key, value)
        }

        totalSupply = new(big.Int).Add(totalSupply, account.Balance)
    }

    // For DEXON consensus genesis staking.
    if g.Config != nil && g.Config.Dexcon != nil {
        // Move staked balance to governance contract.
        statedb.AddBalance(vm.GovernanceContractAddress, totalStaked)

        // Stake in governance state.
        keys := AllocKey{}
        for addr := range g.Alloc {
            keys = append(keys, addr)
        }
        sort.Sort(keys)

        for _, addr := range keys {
            account := g.Alloc[addr]
            if account.Staked.Cmp(big.NewInt(0)) > 0 {
                govStateHelper.Stake(addr, account.PublicKey, account.Staked,
                    account.NodeInfo.Name, account.NodeInfo.Email,
                    account.NodeInfo.Location, account.NodeInfo.Url)
            }
        }

        // Genesis CRS.
        crs := crypto.Keccak256Hash([]byte(g.Config.Dexcon.GenesisCRSText))
        govStateHelper.PushCRS(crs)

        // Round 0 height.
        govStateHelper.PushRoundHeight(big.NewInt(0))

        // Owner.
        govStateHelper.SetOwner(g.Config.Dexcon.Owner)

        // Governance configuration.
        govStateHelper.UpdateConfiguration(g.Config.Dexcon)

        // Set totalSupply.
        govStateHelper.IncTotalSupply(totalSupply)
    }

    root := statedb.IntermediateRoot(false)
    head := &types.Header{
        Number:     new(big.Int).SetUint64(g.Number),
        Nonce:      types.EncodeNonce(g.Nonce),
        Time:       g.Timestamp,
        ParentHash: g.ParentHash,
        Extra:      g.ExtraData,
        GasLimit:   g.GasLimit,
        GasUsed:    g.GasUsed,
        Difficulty: g.Difficulty,
        MixDigest:  g.Mixhash,
        Coinbase:   g.Coinbase,
        Root:       root,
    }
    if g.GasLimit == 0 {
        head.GasLimit = params.GenesisGasLimit
    }
    if g.Difficulty == nil {
        head.Difficulty = params.GenesisDifficulty
    }
    statedb.Commit(false)
    statedb.Database().TrieDB().Commit(root, true)

    return types.NewBlock(head, nil, nil, nil)
}

// 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) (*types.Block, error) {
    block := g.ToBlock(db)
    if block.Number().Sign() != 0 {
        return nil, fmt.Errorf("can't commit genesis block with number > 0")
    }
    rawdb.WriteTd(db, block.Hash(), block.NumberU64(), g.Difficulty)
    rawdb.WriteBlock(db, block)
    rawdb.WriteReceipts(db, block.Hash(), block.NumberU64(), nil)
    rawdb.WriteCanonicalHash(db, block.Hash(), block.NumberU64())
    rawdb.WriteHeadBlockHash(db, block.Hash())
    rawdb.WriteHeadHeaderHash(db, block.Hash())

    config := g.Config
    if config == nil {
        config = params.AllEthashProtocolChanges
    }
    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) *types.Block {
    block, err := g.Commit(db)
    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) *types.Block {
    g := Genesis{Alloc: GenesisAlloc{addr: {Balance: balance}}}
    return g.MustCommit(db)
}

// DefaultGenesisBlock returns the Ethereum main net genesis block.
func DefaultGenesisBlock() *Genesis {
    return &Genesis{
        Config:     params.MainnetChainConfig,
        Timestamp:  1540024964,
        Nonce:      0x42,
        ExtraData:  hexutil.MustDecode("0x5765692d4e696e6720536f6e696320426f6a696520323031382d31302d32302e"),
        GasLimit:   40000000,
        Difficulty: big.NewInt(1),
        Alloc:      decodePrealloc(mainnetAllocData),
    }
}

// DefaultTestnetGenesisBlock returns the Taiwan network genesis block.
func DefaultTestnetGenesisBlock() *Genesis {
    return &Genesis{
        Config:     params.TestnetChainConfig,
        Nonce:      0x42,
        ExtraData:  hexutil.MustDecode("0x3535353535353535353535353535353535353535353535353535353535353535"),
        GasLimit:   40000000,
        Difficulty: big.NewInt(1),
        Alloc:      decodePrealloc(testnetAllocData),
    }
}

// DefaultTaipeiGenesisBlock returns the Taipei network genesis block.
func DefaultTaipeiGenesisBlock() *Genesis {
    return &Genesis{
        Config:     params.TaipeiChainConfig,
        Nonce:      0x42,
        ExtraData:  hexutil.MustDecode("0x3535353535353535353535353535353535353535353535353535353535353535"),
        GasLimit:   40000000,
        Difficulty: big.NewInt(1),
        Alloc:      decodePrealloc(taipeiAllocData),
    }
}

// DeveloperGenesisBlock returns the 'geth --dev' genesis block. Note, this must
// be seeded with the
func DeveloperGenesisBlock(period uint64, faucet common.Address) *Genesis {
    // Override the default period to the user requested one
    config := *params.AllCliqueProtocolChanges
    config.Clique.Period = period

    // Assemble and return the genesis with the precompiles and faucet pre-funded
    return &Genesis{
        Config:     &config,
        ExtraData:  append(append(make([]byte, 32), faucet[:]...), make([]byte, 65)...),
        GasLimit:   6283185,
        Difficulty: big.NewInt(1),
        Alloc: map[common.Address]GenesisAccount{
            common.BytesToAddress([]byte{1}): {Balance: big.NewInt(1)}, // ECRecover
            common.BytesToAddress([]byte{2}): {Balance: big.NewInt(1)}, // SHA256
            common.BytesToAddress([]byte{3}): {Balance: big.NewInt(1)}, // RIPEMD
            common.BytesToAddress([]byte{4}): {Balance: big.NewInt(1)}, // Identity
            common.BytesToAddress([]byte{5}): {Balance: big.NewInt(1)}, // ModExp
            common.BytesToAddress([]byte{6}): {Balance: big.NewInt(1)}, // ECAdd
            common.BytesToAddress([]byte{7}): {Balance: big.NewInt(1)}, // ECScalarMul
            common.BytesToAddress([]byte{8}): {Balance: big.NewInt(1)}, // ECPairing
            faucet:                           {Balance: new(big.Int).Sub(new(big.Int).Lsh(big.NewInt(1), 256), big.NewInt(9))},
        },
    }
}

func decodePrealloc(data string) GenesisAlloc {
    type accountData struct {
        Balance   *big.Int
        Staked    *big.Int
        Code      []byte
        PublicKey []byte
        NodeInfo  NodeInfo
    }

    var p []struct {
        Addr    *big.Int
        Account accountData
    }
    if err := rlp.NewStream(strings.NewReader(data), 0).Decode(&p); err != nil {
        panic(err)
    }
    ga := make(GenesisAlloc, len(p))
    for _, account := range p {
        ga[common.BigToAddress(account.Addr)] = GenesisAccount{
            Balance:   account.Account.Balance,
            Staked:    account.Account.Staked,
            Code:      account.Account.Code,
            PublicKey: account.Account.PublicKey,
            NodeInfo:  account.Account.NodeInfo,
        }
    }
    return ga
}