github.com/klaytn/klaytn@v1.12.1/cmd/homi/genesis/options.go

// Copyright 2018 The klaytn Authors
// Copyright 2017 AMIS Technologies
// 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 genesis

import (
	"math/big"
	"strings"

	"github.com/klaytn/klaytn/blockchain/system"
	"github.com/klaytn/klaytn/cmd/homi/extra"
	"github.com/klaytn/klaytn/consensus/clique"
	"github.com/klaytn/klaytn/contracts/reward/contract"
	"github.com/klaytn/klaytn/log"
	"github.com/klaytn/klaytn/params"

	"github.com/klaytn/klaytn/blockchain"
	"github.com/klaytn/klaytn/common"
	"github.com/klaytn/klaytn/common/hexutil"
)

type Option func(*blockchain.Genesis)

var logger = log.NewModuleLogger(log.CMDIstanbul)

func Validators(addrs ...common.Address) Option {
	return func(genesis *blockchain.Genesis) {
		extraData, err := extra.Encode("0x00", addrs)
		if err != nil {
			logger.Error("Failed to encode extra data", "err", err)
			return
		}
		genesis.ExtraData = hexutil.MustDecode(extraData)
	}
}

func ValidatorsOfClique(signers ...common.Address) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.ExtraData = make([]byte, clique.ExtraVanity+len(signers)*common.AddressLength+clique.ExtraSeal)
		for i, signer := range signers {
			copy(genesis.ExtraData[32+i*common.AddressLength:], signer[:])
		}
	}
}

func makeGenesisAccount(addrs []common.Address, balance *big.Int) map[common.Address]blockchain.GenesisAccount {
	alloc := make(map[common.Address]blockchain.GenesisAccount)
	for _, addr := range addrs {
		alloc[addr] = blockchain.GenesisAccount{Balance: balance}
	}
	return alloc
}

func Alloc(addrs []common.Address, balance *big.Int) Option {
	return func(genesis *blockchain.Genesis) {
		alloc := makeGenesisAccount(addrs, balance)
		genesis.Alloc = alloc
	}
}

func AllocWithPrecypressContract(addrs []common.Address, balance *big.Int) Option {
	return func(genesis *blockchain.Genesis) {
		alloc := makeGenesisAccount(addrs, balance)
		alloc[common.HexToAddress(contract.CypressCreditContractAddress)] = blockchain.GenesisAccount{
			Code:    common.FromHex(CypressCreditBin),
			Balance: big.NewInt(0),
		}
		alloc[common.HexToAddress(contract.AddressBookContractAddress)] = blockchain.GenesisAccount{
			Code:    common.FromHex(PreCypressAddressBookBin),
			Balance: big.NewInt(0),
		}
		genesis.Alloc = alloc
	}
}

func AllocWithCypressContract(addrs []common.Address, balance *big.Int) Option {
	return func(genesis *blockchain.Genesis) {
		alloc := makeGenesisAccount(addrs, balance)
		alloc[common.HexToAddress(contract.CypressCreditContractAddress)] = blockchain.GenesisAccount{
			Code:    common.FromHex(CypressCreditBin),
			Balance: big.NewInt(0),
		}
		alloc[common.HexToAddress(contract.AddressBookContractAddress)] = blockchain.GenesisAccount{
			Code:    common.FromHex(CypressAddressBookBin),
			Balance: big.NewInt(0),
		}
		genesis.Alloc = alloc
	}
}

func AllocWithPrebaobabContract(addrs []common.Address, balance *big.Int) Option {
	return func(genesis *blockchain.Genesis) {
		alloc := makeGenesisAccount(addrs, balance)
		alloc[common.HexToAddress(contract.AddressBookContractAddress)] = blockchain.GenesisAccount{
			Code:    common.FromHex(PrebaobabAddressBookBin),
			Balance: big.NewInt(0),
		}
		genesis.Alloc = alloc
	}
}

func AllocWithBaobabContract(addrs []common.Address, balance *big.Int) Option {
	return func(genesis *blockchain.Genesis) {
		alloc := makeGenesisAccount(addrs, balance)
		alloc[common.HexToAddress(contract.AddressBookContractAddress)] = blockchain.GenesisAccount{
			Code:    common.FromHex(BaobabAddressBookBin),
			Balance: big.NewInt(0),
		}
		genesis.Alloc = alloc
	}
}

// Patch the hardcoded line in AddressBook.sol:constructContract().
func PatchAddressBook(addr common.Address) Option {
	return func(genesis *blockchain.Genesis) {
		contractAddr := common.HexToAddress(contract.AddressBookContractAddress)
		contractAccount, ok := genesis.Alloc[contractAddr]
		if !ok {
			log.Fatalf("No AddressBook to patch")
		}

		codeHex := hexutil.Encode(contractAccount.Code)
		var oldAddr string
		switch codeHex {
		case CypressAddressBookBin:
			oldAddr = "854ca8508c8be2bb1f3c244045786410cb7d5d0a"
		case BaobabAddressBookBin:
			oldAddr = "88bb3838aa0a140acb73eeb3d4b25a8d3afd58d4"
		case PreCypressAddressBookBin, PrebaobabAddressBookBin:
			oldAddr = "fe1ffd5293fc94857a33dcd284fe82bc106be4c7"
		}

		// The hardcoded address appears exactly once, hence Replace(.., 1)
		newAddr := strings.ToLower(addr.Hex()[2:])
		codeHex = strings.Replace(codeHex, oldAddr, newAddr, 1)

		genesis.Alloc[contractAddr] = blockchain.GenesisAccount{
			Code:    common.FromHex(codeHex),
			Balance: contractAccount.Balance,
		}
	}
}

func AddressBookMock() Option {
	return func(genesis *blockchain.Genesis) {
		contractAddr := common.HexToAddress(contract.AddressBookContractAddress)
		contractAccount, ok := genesis.Alloc[contractAddr]
		if !ok {
			log.Fatalf("No AddressBook to patch")
		}

		code := contract.AddressBookMockBinRuntime
		genesis.Alloc[contractAddr] = blockchain.GenesisAccount{
			Code:    common.FromHex(code),
			Balance: contractAccount.Balance,
		}
	}
}

func AllocateRegistry(storage map[common.Hash]common.Hash) Option {
	return func(genesis *blockchain.Genesis) {
		registryCode := system.RegistryCode
		registryAddr := system.RegistryAddr

		genesis.Alloc[registryAddr] = blockchain.GenesisAccount{
			Code:    registryCode,
			Storage: storage,
			Balance: big.NewInt(0),
		}
	}
}

func RegistryMock() Option {
	return func(genesis *blockchain.Genesis) {
		registryMockCode := system.RegistryMockCode
		registryAddr := system.RegistryAddr

		registry, ok := genesis.Alloc[registryAddr]
		if !ok {
			log.Fatalf("No registry to patch")
		}

		genesis.Alloc[registryAddr] = blockchain.GenesisAccount{
			Code:    registryMockCode,
			Storage: registry.Storage,
			Balance: big.NewInt(0),
		}
	}
}

func AllocateKip113(kip113ProxyAddr, kip113LogicAddr common.Address, proxyStorage, logicStorage map[common.Hash]common.Hash) Option {
	return func(genesis *blockchain.Genesis) {
		proxyCode := system.ERC1967ProxyCode
		logicCode := system.Kip113Code

		genesis.Alloc[kip113ProxyAddr] = blockchain.GenesisAccount{
			Code:    proxyCode,
			Storage: proxyStorage,
			Balance: big.NewInt(0),
		}
		genesis.Alloc[kip113LogicAddr] = blockchain.GenesisAccount{
			Code:    logicCode,
			Storage: logicStorage,
			Balance: big.NewInt(0),
		}
	}
}

func Kip113Mock(kip113LogicAddr common.Address) Option {
	return func(genesis *blockchain.Genesis) {
		kip113MockCode := system.Kip113MockCode

		_, ok := genesis.Alloc[kip113LogicAddr]
		if !ok {
			log.Fatalf("No kip113 to patch")
		}

		genesis.Alloc[kip113LogicAddr] = blockchain.GenesisAccount{
			Code:    kip113MockCode,
			Balance: big.NewInt(0),
		}
	}
}

func ChainID(chainID *big.Int) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.Config.ChainID = chainID
	}
}

func UnitPrice(price uint64) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.Config.UnitPrice = price
	}
}

func Istanbul(config *params.IstanbulConfig) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.Config.Istanbul = config
	}
}

func DeriveShaImpl(impl int) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.Config.DeriveShaImpl = impl
	}
}

func Governance(config *params.GovernanceConfig) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.Config.Governance = config
	}
}

func Clique(config *params.CliqueConfig) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.Config.Clique = config
	}
}

func StakingInterval(interval uint64) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.Config.Governance.Reward.StakingUpdateInterval = interval
	}
}

func ProposerInterval(interval uint64) Option {
	return func(genesis *blockchain.Genesis) {
		genesis.Config.Governance.Reward.ProposerUpdateInterval = interval
	}
}