move block util funcs into blockchain context

Author: envestcc

action/protocol/context.go

@@ -54,6 +54,10 @@ type (
 		ChainID uint32
 		// EvmNetworkID is the EVM network ID
 		EvmNetworkID uint32
+		// GetBlockHash is the function to get block hash by height
+		GetBlockHash func(uint64) (hash.Hash256, error)
+		// GetBlockTime is the function to get block time by height
+		GetBlockTime func(uint64) (time.Time, error)
 	}
 
 	// BlockCtx provides block auxiliary information.

action/protocol/execution/protocol.go

@@ -29,20 +29,19 @@ const (
 
 // Protocol defines the protocol of handling executions
 type Protocol struct {
-	getBlockHash evm.GetBlockHash
-	getBlockTime evm.GetBlockTime
-	depositGas   protocol.DepositGas
-	addr         address.Address
+	depositGas protocol.DepositGas
+	addr       address.Address
 }
 
 // NewProtocol instantiates the protocol of exeuction
-func NewProtocol(getBlockHash evm.GetBlockHash, depositGas protocol.DepositGas, getBlockTime evm.GetBlockTime) *Protocol {
+// TODO: remove unused getBlockHash and getBlockTime
+func NewProtocol(_ evm.GetBlockHash, depositGas protocol.DepositGas, _ evm.GetBlockTime) *Protocol {
 	h := hash.Hash160b([]byte(_protocolID))
 	addr, err := address.FromBytes(h[:])
 	if err != nil {
 		log.L().Panic("Error when constructing the address of vote protocol", zap.Error(err))
 	}
-	return &Protocol{getBlockHash: getBlockHash, depositGas: depositGas, addr: addr, getBlockTime: getBlockTime}
+	return &Protocol{depositGas: depositGas, addr: addr}
 }
 
 // FindProtocol finds the registered protocol from registry
@@ -66,9 +65,10 @@ func (p *Protocol) Handle(ctx context.Context, elp action.Envelope, sm protocol.
 	if _, ok := elp.Action().(*action.Execution); !ok {
 		return nil, nil
 	}
+	bcCtx := protocol.MustGetBlockchainCtx(ctx)
 	ctx = evm.WithHelperCtx(ctx, evm.HelperContext{
-		GetBlockHash:   p.getBlockHash,
-		GetBlockTime:   p.getBlockTime,
+		GetBlockHash:   bcCtx.GetBlockHash,
+		GetBlockTime:   bcCtx.GetBlockTime,
 		DepositGasFunc: p.depositGas,
 	})
 	_, receipt, err := evm.ExecuteContract(ctx, sm, elp)

action/protocol/execution/protocol_test.go

@@ -474,6 +474,7 @@ func (sct *SmartContractTest) prepareBlockchain(
 	r.NoError(err)
 	dao := blockdao.NewBlockDAOWithIndexersAndCache(store, []blockdao.BlockIndexer{sf, indexer}, cfg.DB.MaxCacheSize)
 	r.NotNil(dao)
+	btcd := testutil.DummyBlockTimeBuilder()
 	bc := blockchain.NewBlockchain(
 		cfg.Chain,
 		cfg.Genesis,
@@ -483,6 +484,7 @@ func (sct *SmartContractTest) prepareBlockchain(
 			sf,
 			protocol.NewGenericValidator(sf, accountutil.AccountState),
 		)),
+		blockchain.BlockTimeCalculatorBuilderOption(btcd),
 	)
 	reward := rewarding.NewProtocol(cfg.Genesis.Rewarding)
 	r.NoError(reward.Register(registry))
@@ -735,6 +737,7 @@ func TestProtocol_Handle(t *testing.T) {
 				sf,
 				protocol.NewGenericValidator(sf, accountutil.AccountState),
 			)),
+			blockchain.BlockTimeCalculatorBuilderOption(testutil.DummyBlockTimeBuilder()),
 		)
 		exeProtocol := execution.NewProtocol(dao.GetBlockHash, rewarding.DepositGas, getBlockTimeForTest)
 		require.NoError(exeProtocol.Register(registry))

action/protocol/poll/consortium.go

@@ -50,11 +50,11 @@ type consortiumCommittee struct {
 	bufferResult   state.CandidateList
 	indexer        *CandidateIndexer
 	addr           address.Address
-	getBlockHash   evm.GetBlockHash
 }
 
 // NewConsortiumCommittee creates a committee for consorium chain
-func NewConsortiumCommittee(indexer *CandidateIndexer, readContract ReadContract, getBlockHash evm.GetBlockHash) (Protocol, error) {
+// TODO: remove unused getBlockHash
+func NewConsortiumCommittee(indexer *CandidateIndexer, readContract ReadContract, _ evm.GetBlockHash) (Protocol, error) {
 	abi, err := abi.JSON(strings.NewReader(ConsortiumManagementABI))
 	if err != nil {
 		return nil, err
@@ -73,7 +73,6 @@ func NewConsortiumCommittee(indexer *CandidateIndexer, readContract ReadContract
 		abi:            abi,
 		addr:           addr,
 		indexer:        indexer,
-		getBlockHash:   getBlockHash,
 	}, nil
 }
 
@@ -143,7 +142,7 @@ func (cc *consortiumCommittee) CreateGenesisStates(ctx context.Context, sm proto
 	cc.contract = receipt.ContractAddress
 
 	ctx = evm.WithHelperCtx(ctx, evm.HelperContext{
-		GetBlockHash: cc.getBlockHash,
+		GetBlockHash: protocol.MustGetBlockchainCtx(ctx).GetBlockHash,
 		GetBlockTime: getBlockTime,
 	})
 	r := getContractReaderForGenesisStates(ctx, sm)

action/protocol/poll/governance_protocol.go

@@ -25,7 +25,6 @@ import (
 )
 
 type governanceChainCommitteeProtocol struct {
-	getBlockTime              GetBlockTime
 	electionCommittee         committee.Committee
 	initGravityChainHeight    uint64
 	addr                      address.Address
@@ -35,20 +34,18 @@ type governanceChainCommitteeProtocol struct {
 }
 
 // NewGovernanceChainCommitteeProtocol creates a Poll Protocol which fetch result from governance chain
+// TODO: remove getBlockTime
 func NewGovernanceChainCommitteeProtocol(
 	candidatesIndexer *CandidateIndexer,
 	electionCommittee committee.Committee,
 	initGravityChainHeight uint64,
-	getBlockTime GetBlockTime,
+	_ GetBlockTime,
 	initialCandidatesInterval time.Duration,
 	sh *Slasher,
 ) (Protocol, error) {
 	if electionCommittee == nil {
 		return nil, ErrNoElectionCommittee
 	}
-	if getBlockTime == nil {
-		return nil, errors.New("getBlockTime api is not provided")
-	}
 
 	h := hash.Hash160b([]byte(_protocolID))
 	addr, err := address.FromBytes(h[:])
@@ -59,7 +56,6 @@ func NewGovernanceChainCommitteeProtocol(
 	return &governanceChainCommitteeProtocol{
 		electionCommittee:         electionCommittee,
 		initGravityChainHeight:    initGravityChainHeight,
-		getBlockTime:              getBlockTime,
 		addr:                      addr,
 		initialCandidatesInterval: initialCandidatesInterval,
 		sh:                        sh,
@@ -234,7 +230,8 @@ func (p *governanceChainCommitteeProtocol) getGravityHeight(ctx context.Context,
 	rp := rolldpos.MustGetProtocol(protocol.MustGetRegistry(ctx))
 	epochNumber := rp.GetEpochNum(height)
 	epochHeight := rp.GetEpochHeight(epochNumber)
-	blkTime, err := p.getBlockTime(epochHeight)
+	bcCtx := protocol.MustGetBlockchainCtx(ctx)
+	blkTime, err := bcCtx.GetBlockTime(epochHeight)
 	if err != nil {
 		return 0, err
 	}

action/protocol/poll/governance_protocol_test.go

@@ -65,6 +65,12 @@ func initConstruct(ctrl *gomock.Controller) (Protocol, context.Context, protocol
 				Tip: protocol.TipInfo{
 					Height: epochStartHeight - 1,
 				},
+				GetBlockHash: func(u uint64) (hash.Hash256, error) {
+					return hash.Hash256b([]byte{0}), nil
+				},
+				GetBlockTime: func(h uint64) (time.Time, error) {
+					return time.Unix(1562382522, 0), nil
+				},
 			},
 		),
 		cfg.Genesis,

action/protocol/poll/protocol.go

@@ -133,10 +133,10 @@ func NewProtocol(
 	getUnproductiveDelegate GetUnproductiveDelegate,
 	electionCommittee committee.Committee,
 	stakingProto *staking.Protocol,
-	getBlockTimeFunc GetBlockTime,
+	_ GetBlockTime,
 	productivity Productivity,
-	getBlockHash evm.GetBlockHash,
-	getBlockTime evm.GetBlockTime,
+	_ evm.GetBlockHash,
+	_ evm.GetBlockTime,
 ) (Protocol, error) {
 	if scheme != _rollDPoSScheme {
 		return nil, nil
@@ -184,7 +184,7 @@ func NewProtocol(
 			candidateIndexer,
 			electionCommittee,
 			genesisConfig.GravityChainStartHeight,
-			getBlockTimeFunc,
+			nil,
 			chainConfig.PollInitialCandidatesInterval,
 			slasher,
 		)
@@ -220,7 +220,7 @@ func NewProtocol(
 		}
 		return NewStakingCommand(stakingV1, stakingV2)
 	case _modeConsortium:
-		return NewConsortiumCommittee(candidateIndexer, readContract, getBlockHash)
+		return NewConsortiumCommittee(candidateIndexer, readContract, nil)
 	default:
 		return nil, errors.Errorf("unsupported poll mode %s", genesisConfig.PollMode)
 	}

action/protocol/poll/staking_committee_test.go

@@ -180,6 +180,14 @@ func TestCreatePostSystemActions_StakingCommittee(t *testing.T) {
 	psac, ok := p.(protocol.PostSystemActionsCreator)
 	require.True(ok)
 	ctx = protocol.WithFeatureWithHeightCtx(ctx)
+	ctx = protocol.WithBlockchainCtx(ctx, protocol.BlockchainCtx{
+		GetBlockHash: func(uint64) (hash.Hash256, error) {
+			return hash.ZeroHash256, nil
+		},
+		GetBlockTime: func(uint64) (time.Time, error) {
+			return time.Now(), nil
+		},
+	})
 	elp, err := psac.CreatePostSystemActions(ctx, sr)
 	require.NoError(err)
 	require.Equal(1, len(elp))
@@ -331,6 +339,14 @@ func TestHandle_StakingCommittee(t *testing.T) {
 			},
 		)
 		ctx4 = protocol.WithFeatureWithHeightCtx(ctx4)
+		ctx4 = protocol.WithBlockchainCtx(ctx4, protocol.BlockchainCtx{
+			GetBlockHash: func(uint64) (hash.Hash256, error) {
+				return hash.ZeroHash256, nil
+			},
+			GetBlockTime: func(uint64) (time.Time, error) {
+				return time.Now(), nil
+			},
+		})
 		err = p4.Validate(ctx4, elp4, sm4)
 		require.Contains(err.Error(), "the proposed delegate list length")
 	})
@@ -361,6 +377,14 @@ func TestHandle_StakingCommittee(t *testing.T) {
 				Caller: caller,
 			},
 		)
+		ctx5 = protocol.WithBlockchainCtx(ctx5, protocol.BlockchainCtx{
+			GetBlockHash: func(uint64) (hash.Hash256, error) {
+				return hash.ZeroHash256, nil
+			},
+			GetBlockTime: func(uint64) (time.Time, error) {
+				return time.Now(), nil
+			},
+		})
 		err = p5.Validate(ctx5, elp5, sm5)
 		require.Contains(err.Error(), "delegates are not as expected")
 	})

api/coreservice.go

@@ -211,7 +211,6 @@ type (
 		readCache         *ReadCache
 		actionRadio       *ActionRadio
 		apiStats          *nodestats.APILocalStats
-		getBlockTime      evm.GetBlockTime
 	}
 
 	// jobDesc provides a struct to get and store logs in core.LogsInRange
@@ -275,7 +274,6 @@ func newCoreService(
 	bfIndexer blockindex.BloomFilterIndexer,
 	actPool actpool.ActPool,
 	registry *protocol.Registry,
-	getBlockTime evm.GetBlockTime,
 	opts ...Option,
 ) (CoreService, error) {
 	if cfg == (Config{}) {
@@ -300,7 +298,6 @@ func newCoreService(
 		chainListener: NewChainListener(cfg.ListenerLimit),
 		gs:            gasstation.NewGasStation(chain, dao, cfg.GasStation),
 		readCache:     NewReadCache(),
-		getBlockTime:  getBlockTime,
 	}
 
 	for _, opt := range opts {
@@ -953,6 +950,10 @@ func (core *coreService) readState(ctx context.Context, p protocol.Protocol, hei
 	}
 
 	// TODO: need to complete the context
+	ctx, err := core.bc.Context(ctx)
+	if err != nil {
+		return nil, 0, err
+	}
 	ctx = protocol.WithBlockCtx(ctx, protocol.BlockCtx{
 		BlockHeight: tipHeight,
 	})
@@ -2008,15 +2009,20 @@ func (core *coreService) simulateExecution(
 	ctx = protocol.WithFeatureCtx(protocol.WithBlockCtx(ctx, protocol.BlockCtx{
 		BlockHeight: height,
 	}))
+	ctx, err = core.bc.Context(ctx)
+	if err != nil {
+		return nil, nil, status.Error(codes.Internal, err.Error())
+	}
+	bcCtx := protocol.MustGetBlockchainCtx(ctx)
 	if protocol.MustGetFeatureCtx(ctx).UseZeroNonceForFreshAccount {
 		pendingNonce = state.PendingNonceConsideringFreshAccount()
 	} else {
 		pendingNonce = state.PendingNonce()
 	}
 	elp.SetNonce(pendingNonce)
 	ctx = evm.WithHelperCtx(ctx, evm.HelperContext{
-		GetBlockHash:   core.dao.GetBlockHash,
-		GetBlockTime:   core.getBlockTime,
+		GetBlockHash:   bcCtx.GetBlockHash,
+		GetBlockTime:   bcCtx.GetBlockTime,
 		DepositGasFunc: rewarding.DepositGas,
 	})
 	return evm.SimulateExecution(ctx, ws, addr, elp, opts...)

api/coreservice_test.go

@@ -200,7 +200,7 @@ func setupTestCoreService() (CoreService, blockchain.Blockchain, blockdao.BlockD
 	opts := []Option{WithBroadcastOutbound(func(ctx context.Context, chainID uint32, msg proto.Message) error {
 		return nil
 	})}
-	svr, err := newCoreService(cfg.api, bc, nil, sf, dao, indexer, bfIndexer, ap, registry, func(u uint64) (time.Time, error) { return time.Time{}, nil }, opts...)
+	svr, err := newCoreService(cfg.api, bc, nil, sf, dao, indexer, bfIndexer, ap, registry, opts...)
 	if err != nil {
 		panic(err)
 	}