Make native staking contract be loadable from genesis (#1542)

Author: zjshen14

action/const.go

@@ -12,7 +12,7 @@ var (
 	// ErrActPool indicates the error of actpool
 	ErrActPool = errors.New("invalid actpool")
 	// ErrHitGasLimit is the error when hit gas limit
-	ErrHitGasLimit = errors.New("Hit Gas Limit")
+	ErrHitGasLimit = errors.New("Hit gas limit")
 	// ErrInsufficientBalanceForGas is the error that the balance in executor account is lower than gas
 	ErrInsufficientBalanceForGas = errors.New("Insufficient balance for gas")
 	// ErrOutOfGas is the error when running out of gas

action/protocol/execution/evm/evm.go

@@ -80,7 +80,7 @@ func NewParams(
 
 	gasLimit := execution.GasLimit()
 	// Reset gas limit to the system wide action gas limit cap if it's greater than it
-	if hu.IsPre(config.Aleutian, raCtx.BlockHeight) && gasLimit > preAleutianActionGasLimit {
+	if raCtx.BlockHeight > 0 && hu.IsPre(config.Aleutian, raCtx.BlockHeight) && gasLimit > preAleutianActionGasLimit {
 		gasLimit = preAleutianActionGasLimit
 	}
 

action/protocol/poll/nativestaking.go

@@ -60,7 +60,7 @@ type (
 )
 
 // NewNativeStaking creates a NativeStaking instance
-func NewNativeStaking(cm protocol.ChainManager, getTipBlockTime GetTipBlockTime, staking string) (*NativeStaking, error) {
+func NewNativeStaking(cm protocol.ChainManager, getTipBlockTime GetTipBlockTime) (*NativeStaking, error) {
 	abi, err := abi.JSON(strings.NewReader(NsAbi))
 	if err != nil {
 		return nil, err
@@ -71,10 +71,11 @@ func NewNativeStaking(cm protocol.ChainManager, getTipBlockTime GetTipBlockTime,
 	if getTipBlockTime == nil {
 		return nil, errors.New("failed to create native staking: empty getBlockTime")
 	}
-	if _, err := address.FromString(staking); err != nil {
-		return nil, errors.Errorf("invalid staking contract %s", staking)
-	}
-	return &NativeStaking{cm, getTipBlockTime, staking, abi}, nil
+	return &NativeStaking{
+		cm:              cm,
+		getTipBlockTime: getTipBlockTime,
+		abi:             abi,
+	}, nil
 }
 
 // Votes returns the votes on height
@@ -160,6 +161,15 @@ func (ns *NativeStaking) readBuckets(prevIndx, limit *big.Int) ([]*types.Bucket,
 	return buckets, nil
 }
 
+// SetContract sets the contract address
+func (ns *NativeStaking) SetContract(contract string) {
+	if _, err := address.FromString(contract); err != nil {
+		zap.S().Panicf("Invalid staking contract %s", contract)
+	}
+	ns.contract = contract
+	zap.S().Infof("Set native staking contract address = %s", contract)
+}
+
 func (vt *VoteTally) tally(buckets []*types.Bucket, now time.Time) error {
 	for i := range buckets {
 		v := buckets[i]

action/protocol/poll/nativestaking_test.go

@@ -39,13 +39,10 @@ func TestStaking(t *testing.T) {
 
 	mcm := &protocol.MockChainManager{}
 	getTime := func() (time.Time, error) { return time.Now(), nil }
-	ns, err := NewNativeStaking(nil, getTime, "")
+	ns, err := NewNativeStaking(mcm, nil)
 	require.Error(err)
-	ns, err = NewNativeStaking(mcm, nil, "")
-	require.Error(err)
-	ns, err = NewNativeStaking(mcm, getTime, "io1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqd39yn7")
-	require.Error(err)
-	ns, err = NewNativeStaking(mcm, getTime, "io1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqd39ym7")
+	ns, err = NewNativeStaking(mcm, getTime)
+	ns.SetContract("io1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqd39ym7")
 	require.NoError(err)
 
 	pygg := &pygg{}

action/protocol/poll/protocol.go

@@ -69,6 +69,8 @@ type Protocol interface {
 	DelegatesByHeight(uint64) (state.CandidateList, error)
 	// ReadState read the state on blockchain via protocol
 	ReadState(context.Context, protocol.StateManager, []byte, ...[]byte) ([]byte, error)
+	// SetContract sets the native staking contract address
+	SetNativeStakingContract(string)
 }
 
 type lifeLongDelegatesProtocol struct {
@@ -142,6 +144,10 @@ func (p *lifeLongDelegatesProtocol) ReadState(
 	}
 }
 
+func (p *lifeLongDelegatesProtocol) SetNativeStakingContract(contract string) {
+	zap.S().Panic("Not implemented")
+}
+
 func (p *lifeLongDelegatesProtocol) readBlockProducers() ([]byte, error) {
 	return p.delegates.Serialize()
 }
@@ -337,6 +343,10 @@ func (p *governanceChainCommitteeProtocol) ReadState(
 	}
 }
 
+func (p *governanceChainCommitteeProtocol) SetNativeStakingContract(contract string) {
+	zap.S().Panic("Not implemented")
+}
+
 func (p *governanceChainCommitteeProtocol) readDelegatesByEpoch(epochNum uint64) (state.CandidateList, error) {
 	epochHeight := p.getEpochHeight(epochNum)
 	return p.cm.CandidatesByHeight(epochHeight)

action/protocol/poll/staking_committee.go

@@ -49,7 +49,8 @@ func NewStakingCommittee(
 	getTipBlockTime GetTipBlockTime,
 	getEpochHeight GetEpochHeight,
 	getEpochNum GetEpochNum,
-	staking string,
+	nativeStakingContractAddress string,
+	nativeStakingContractCode string,
 	rp *rolldpos.Protocol,
 	scoreThreshold *big.Int,
 ) (Protocol, error) {
@@ -60,11 +61,14 @@ func NewStakingCommittee(
 		return nil, errors.New("failed to create native staking: empty getEpochNum")
 	}
 	var ns *NativeStaking
-	if staking != "" {
+	if nativeStakingContractAddress != "" || nativeStakingContractCode != "" {
 		var err error
-		if ns, err = NewNativeStaking(cm, getTipBlockTime, staking); err != nil {
+		if ns, err = NewNativeStaking(cm, getTipBlockTime); err != nil {
 			return nil, errors.New("failed to create native staking")
 		}
+		if nativeStakingContractAddress != "" {
+			ns.SetContract(nativeStakingContractAddress)
+		}
 	}
 	return &stakingCommittee{
 		hu:                hu,
@@ -125,6 +129,11 @@ func (sc *stakingCommittee) ReadState(ctx context.Context, sm protocol.StateMana
 	return sc.governanceStaking.ReadState(ctx, sm, method, args...)
 }
 
+// SetNativeStakingContract sets the address of native staking contract
+func (sc *stakingCommittee) SetNativeStakingContract(contract string) {
+	sc.nativeStaking.SetContract(contract)
+}
+
 func (sc *stakingCommittee) mergeDelegates(list state.CandidateList, votes *VoteTally, ts time.Time) state.CandidateList {
 	// as of now, native staking does not have register contract, only voting/staking contract
 	// it is assumed that all votes done on native staking target for delegates registered on Ethereum

blockchain/blockchain.go

@@ -15,16 +15,19 @@ import (
 	"sync/atomic"
 	"time"
 
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/common/hexutil"
+	ecrypto "github.com/ethereum/go-ethereum/crypto"
 	"github.com/facebookgo/clock"
-	"github.com/iotexproject/go-pkgs/bloom"
-	"github.com/iotexproject/go-pkgs/hash"
-	"github.com/iotexproject/iotex-address/address"
 	"github.com/pkg/errors"
 	"github.com/prometheus/client_golang/prometheus"
 	"go.uber.org/zap"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 
+	"github.com/iotexproject/go-pkgs/bloom"
+	"github.com/iotexproject/go-pkgs/hash"
+	"github.com/iotexproject/iotex-address/address"
 	"github.com/iotexproject/iotex-core/action"
 	"github.com/iotexproject/iotex-core/action/protocol"
 	"github.com/iotexproject/iotex-core/action/protocol/account"
@@ -45,6 +48,7 @@ import (
 	"github.com/iotexproject/iotex-core/pkg/util/fileutil"
 	"github.com/iotexproject/iotex-core/state"
 	"github.com/iotexproject/iotex-core/state/factory"
+	"github.com/iotexproject/iotex-proto/golang/iotextypes"
 )
 
 var (
@@ -944,6 +948,7 @@ func (bc *blockchain) startExistingBlockchain() error {
 	if err != nil {
 		return errors.Wrap(err, "failed to get factory's height")
 	}
+	bc.loadingNativeStakingContract()
 	log.L().Info("Restarting blockchain.",
 		zap.Uint64("chainHeight",
 			bc.tipHeight),
@@ -1330,6 +1335,11 @@ func (bc *blockchain) createGenesisStates(ws factory.WorkingSet) error {
 			return err
 		}
 	}
+	if bc.config.Genesis.NativeStakingContractCode != "" {
+		if err := bc.createNativeStakingContract(ctx, ws); err != nil {
+			return err
+		}
+	}
 	return bc.createRewardingGenesisStates(ctx, ws)
 }
 
@@ -1388,6 +1398,61 @@ func (bc *blockchain) createPollGenesisStates(ctx context.Context, ws factory.Wo
 	return nil
 }
 
+func (bc *blockchain) createNativeStakingContract(ctx context.Context, ws factory.WorkingSet) error {
+	raCtx := protocol.MustGetRunActionsCtx(ctx)
+	raCtx.Producer, _ = address.FromString(address.ZeroAddress)
+	raCtx.Caller, _ = address.FromString(address.ZeroAddress)
+	raCtx.GasLimit = bc.config.Genesis.BlockGasLimit
+	bytes, err := hexutil.Decode(bc.config.Genesis.NativeStakingContractCode)
+	if err != nil {
+		return err
+	}
+	hu := config.NewHeightUpgrade(bc.config)
+	execution, err := action.NewExecution(
+		"",
+		0,
+		big.NewInt(0),
+		bc.config.Genesis.BlockGasLimit,
+		big.NewInt(0),
+		bytes,
+	)
+	if err != nil {
+		return err
+	}
+	_, receipt, err := evm.ExecuteContract(protocol.WithRunActionsCtx(ctx, raCtx), ws, execution, bc, hu)
+	if err != nil {
+		return err
+	}
+	if receipt.Status != uint64(iotextypes.ReceiptStatus_Success) {
+		return errors.Errorf("error when deploying native staking contract, status=%d", receipt.Status)
+	}
+	p, ok := bc.registry.Find(poll.ProtocolID)
+	if ok {
+		pp, ok := p.(poll.Protocol)
+		if ok {
+			pp.SetNativeStakingContract(receipt.ContractAddress)
+			log.L().Info("Deployed native staking contract", zap.String("address", receipt.ContractAddress))
+		}
+	}
+	return nil
+}
+
+func (bc *blockchain) loadingNativeStakingContract() {
+	if bc.config.Genesis.NativeStakingContractAddress == "" && bc.config.Genesis.NativeStakingContractCode != "" {
+		p, ok := bc.registry.Find(poll.ProtocolID)
+		if ok {
+			pp, ok := p.(poll.Protocol)
+			if ok {
+				caller, _ := address.FromString(address.ZeroAddress)
+				ethAddr := ecrypto.CreateAddress(common.BytesToAddress(caller.Bytes()), 0)
+				iotxAddr, _ := address.FromBytes(ethAddr.Bytes())
+				pp.SetNativeStakingContract(iotxAddr.String())
+				log.L().Info("Loaded native staking contract", zap.String("address", iotxAddr.String()))
+			}
+		}
+	}
+}
+
 func (bc *blockchain) updateAleutianEpochRewardAmount(ctx context.Context, ws factory.WorkingSet) error {
 	p, ok := bc.registry.Find(rewarding.ProtocolID)
 	if !ok {

blockchain/genesis/genesis.go

@@ -142,8 +142,10 @@ type (
 		RegisterContractAddress string `yaml:"registerContractAddress"`
 		// StakingContractAddress is the address of staking contract
 		StakingContractAddress string `yaml:"stakingContractAddress"`
-		// NativeStakingContractAddress is the address of staking contract on mainnet
+		// NativeStakingContractAddress is the address of native staking contract
 		NativeStakingContractAddress string `yaml:"nativeStakingContractAddress"`
+		// NativeStakingContractCode is the code of native staking contract
+		NativeStakingContractCode string `yaml:"nativeStakingContractCode"`
 		// VoteThreshold is the vote threshold amount in decimal string format
 		VoteThreshold string `yaml:"voteThreshold"`
 		// ScoreThreshold is the score threshold amount in decimal string format

server/itx/server.go

@@ -319,6 +319,7 @@ func registerDefaultProtocols(cs *chainservice.ChainService, cfg config.Config)
 				rolldposProtocol.GetEpochHeight,
 				rolldposProtocol.GetEpochNum,
 				cfg.Genesis.NativeStakingContractAddress,
+				cfg.Genesis.NativeStakingContractCode,
 				rolldposProtocol,
 				scoreThreshold,
 			); err != nil {