go-ethereum/ethclient/simulated/backend.go

// Copyright 2015 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 simulated

import (
	"context"
	"errors"
	"fmt"
	gomath "math"
	"math/big"
	"os"
	"sort"
	"sync"
	"time"

	ethereum "github.com/XinFinOrg/XDPoSChain"
	"github.com/XinFinOrg/XDPoSChain/XDCx"
	"github.com/XinFinOrg/XDPoSChain/XDCxlending"
	"github.com/XinFinOrg/XDPoSChain/accounts"
	"github.com/XinFinOrg/XDPoSChain/accounts/abi"
	"github.com/XinFinOrg/XDPoSChain/accounts/abi/bind"
	"github.com/XinFinOrg/XDPoSChain/accounts/keystore"
	"github.com/XinFinOrg/XDPoSChain/common"
	"github.com/XinFinOrg/XDPoSChain/common/hexutil"
	"github.com/XinFinOrg/XDPoSChain/common/math"
	"github.com/XinFinOrg/XDPoSChain/consensus/XDPoS"
	"github.com/XinFinOrg/XDPoSChain/consensus/XDPoS/utils"
	"github.com/XinFinOrg/XDPoSChain/consensus/ethash"
	"github.com/XinFinOrg/XDPoSChain/core"
	"github.com/XinFinOrg/XDPoSChain/core/bloombits"
	"github.com/XinFinOrg/XDPoSChain/core/rawdb"
	"github.com/XinFinOrg/XDPoSChain/core/state"
	"github.com/XinFinOrg/XDPoSChain/core/types"
	"github.com/XinFinOrg/XDPoSChain/core/vm"
	"github.com/XinFinOrg/XDPoSChain/crypto"
	"github.com/XinFinOrg/XDPoSChain/eth/filters"
	"github.com/XinFinOrg/XDPoSChain/ethdb"
	"github.com/XinFinOrg/XDPoSChain/event"
	"github.com/XinFinOrg/XDPoSChain/log"
	"github.com/XinFinOrg/XDPoSChain/node"
	"github.com/XinFinOrg/XDPoSChain/params"
	"github.com/XinFinOrg/XDPoSChain/rpc"
)

// This nil assignment ensures at compile time that SimulatedBackend implements bind.ContractBackend.
var _ bind.ContractBackend = (*Backend)(nil)

var (
	errBlockNumberUnsupported  = errors.New("simulatedBackend cannot access blocks other than the latest block")
	errBlockHashUnsupported    = errors.New("simulatedBackend cannot access blocks by hash other than the latest block")
	errBlockDoesNotExist       = errors.New("block does not exist in blockchain")
	errTransactionDoesNotExist = errors.New("transaction does not exist")
)

// SimulatedBackend implements bind.ContractBackend, simulating a blockchain in
// the background. Its main purpose is to allow for easy testing of contract bindings.
// Simulated backend implements the following interfaces:
// ChainReader, ChainStateReader, ContractBackend, ContractCaller, ContractFilterer, ContractTransactor,
// DeployBackend, GasEstimator, GasPricer, LogFilterer, PendingContractCaller, TransactionReader, and TransactionSender
type Backend struct {
	database   ethdb.Database   // In memory database to store our testing data
	blockchain *core.BlockChain // Ethereum blockchain to handle the consensus

	mu              sync.Mutex
	pendingBlock    *types.Block   // Currently pending block that will be imported on request
	pendingState    *state.StateDB // Currently pending state that will be the active on request
	pendingReceipts types.Receipts // Currently receipts for the pending block

	events       *filters.EventSystem  // for filtering log events live
	filterSystem *filters.FilterSystem // for filtering database logs

	config *params.ChainConfig
}

// Client exposes the methods provided by the simulated backend client.
type Client interface {
	ethereum.BlockNumberReader
	ethereum.ChainReader
	ethereum.ChainStateReader
	ethereum.ContractCaller
	ethereum.GasEstimator
	ethereum.GasPricer
	ethereum.GasPricer1559
	ethereum.FeeHistoryReader
	ethereum.LogFilterer
	ethereum.PendingStateReader
	ethereum.PendingContractCaller
	ethereum.TransactionReader
	ethereum.TransactionSender
	ethereum.ChainIDReader
}

func SimulateWalletAddressAndSignFn() (common.Address, func(account accounts.Account, hash []byte) ([]byte, error), error) {
	veryLightScryptN := 2
	veryLightScryptP := 1
	dir, _ := os.MkdirTemp("", "eth-SimulateWalletAddressAndSignFn-test")
	defer os.RemoveAll(dir)

	ks := keystore.NewKeyStore(dir, veryLightScryptN, veryLightScryptP)
	pass := "" // not used but required by API
	a1, err := ks.NewAccount(pass)
	if err != nil {
		return common.Address{}, nil, err
	}
	if err := ks.Unlock(a1, ""); err != nil {
		return a1.Address, nil, err
	}
	return a1.Address, ks.SignHash, nil
}

// New creates a new simulated backend for testing.
//
// If chainconfig is supplied, XDPoS-compatible backend is used.
// Otherwise an ethash backend is used.
func New(alloc types.GenesisAlloc, gasLimit uint64, chainconfig ...*params.ChainConfig) *Backend {
	if len(chainconfig) > 0 && chainconfig[0] != nil {
		if chainconfig[0].XDPoS != nil {
			return newXDCSimulatedBackend(alloc, gasLimit, chainconfig[0])
		}
		return newEthashSimulatedBackendWithConfig(alloc, gasLimit, chainconfig[0])
	}
	return newEthashSimulatedBackend(alloc, gasLimit)
}

// newXDCSimulatedBackend creates a new backend for testing purpose.
func newXDCSimulatedBackend(alloc types.GenesisAlloc, gasLimit uint64, chainConfig *params.ChainConfig) *Backend {
	database := rawdb.NewMemoryDatabase()
	genesis := core.Genesis{
		GasLimit:  gasLimit, // need this big, support initial smart contract
		Config:    chainConfig,
		Alloc:     alloc,
		ExtraData: append(make([]byte, 32), make([]byte, crypto.SignatureLength)...),
	}
	genesis.MustCommit(database)
	consensus := XDPoS.NewFaker(database, chainConfig)

	// Attach mock trading and lending service
	var DefaultConfig = XDCx.Config{
		DataDir: "",
	}
	stack, err := node.New(&node.Config{DataDir: ""})
	if err != nil {
		log.Error("Could not create new node: %v", err)
		return nil
	}
	defer stack.Close()

	XDCXServ := XDCx.New(stack, &DefaultConfig)

	lendingServ := XDCxlending.New(stack, XDCXServ)

	consensus.GetXDCXService = func() utils.TradingService {
		return XDCXServ
	}
	consensus.GetLendingService = func() utils.LendingService {
		return lendingServ
	}

	cacheConfig := &core.CacheConfig{
		TrieCleanLimit: 256,
		TrieDirtyLimit: 256,
		TrieTimeLimit:  5 * time.Minute,
		Preimages:      true,
	}
	blockchain, _ := core.NewBlockChain(database, cacheConfig, &genesis, consensus, vm.Config{})

	backend := &Backend{
		database:   database,
		blockchain: blockchain,
		config:     genesis.Config,
	}

	filterBackend := &filterBackend{database, blockchain, backend}
	backend.filterSystem = filters.NewFilterSystem(filterBackend, filters.Config{})
	backend.events = filters.NewEventSystem(backend.filterSystem, false)

	blockchain.Client = backend

	header := backend.blockchain.CurrentBlock()
	block := backend.blockchain.GetBlock(header.Hash(), header.Number.Uint64())

	backend.rollback(block)
	return backend
}

// newEthashSimulatedBackend creates a new binding backend based on the given database
// and uses a simulated blockchain for testing purposes.
// A simulated backend always uses chainID 1337.
func newEthashSimulatedBackend(alloc types.GenesisAlloc, gasLimit uint64) *Backend {
	config := *params.AllEthashProtocolChanges
	if config.Eip1559Block == nil {
		config.Eip1559Block = big.NewInt(0)
	}
	return newEthashSimulatedBackendWithConfig(alloc, gasLimit, &config)
}

func newEthashSimulatedBackendWithConfig(alloc types.GenesisAlloc, gasLimit uint64, chainConfig *params.ChainConfig) *Backend {
	database := rawdb.NewMemoryDatabase()
	config := *chainConfig
	genesis := core.Genesis{Config: &config, GasLimit: gasLimit, Alloc: alloc}
	genesis.MustCommit(database)
	blockchain, _ := core.NewBlockChain(database, nil, &genesis, ethash.NewFaker(), vm.Config{})

	backend := &Backend{
		database:   database,
		blockchain: blockchain,
		config:     genesis.Config,
	}

	filterBackend := &filterBackend{database, blockchain, backend}
	backend.filterSystem = filters.NewFilterSystem(filterBackend, filters.Config{})
	backend.events = filters.NewEventSystem(backend.filterSystem, false)

	header := backend.blockchain.CurrentBlock()
	block := backend.blockchain.GetBlock(header.Hash(), header.Number.Uint64())

	backend.rollback(block)
	return backend
}

// Close terminates the underlying blockchain's update loop.
func (b *Backend) Close() error {
	b.blockchain.Stop()
	return nil
}

// Commit imports all the pending transactions as a single block and starts a
// fresh new state.
func (b *Backend) Commit() common.Hash {
	b.mu.Lock()
	defer b.mu.Unlock()

	if _, err := b.blockchain.InsertChain([]*types.Block{b.pendingBlock}); err != nil {
		panic(err) // This cannot happen unless the simulator is wrong, fail in that case
	}
	blockHash := b.pendingBlock.Hash()

	// Using the last inserted block here makes it possible to build on a side
	// chain after a fork.
	b.rollback(b.pendingBlock)

	return blockHash
}

// Rollback aborts all pending transactions, reverting to the last committed state.
func (b *Backend) Rollback() {
	b.mu.Lock()
	defer b.mu.Unlock()

	header := b.blockchain.CurrentBlock()
	block := b.blockchain.GetBlock(header.Hash(), header.Number.Uint64())

	b.rollback(block)
}

func (b *Backend) rollback(parent *types.Block) {
	blocks, _ := core.GenerateChain(b.config, parent, b.blockchain.Engine(), b.database, 1, func(int, *core.BlockGen) {})
	stateDB, _ := b.blockchain.State()

	b.pendingBlock = blocks[0]
	b.pendingState, _ = state.New(b.pendingBlock.Root(), stateDB.Database())
}

// Fork creates a side-chain that can be used to simulate reorgs.
//
// This function should be called with the ancestor block where the new side
// chain should be started. Transactions (old and new) can then be applied on
// top and Commit-ed.
//
// Note, the side-chain will only become canonical (and trigger the events) when
// it becomes longer. Until then CallContract will still operate on the current
// canonical chain.
//
// There is a % chance that the side chain becomes canonical at the same length
// to simulate live network behavior.
func (b *Backend) Fork(parent common.Hash) error {
	b.mu.Lock()
	defer b.mu.Unlock()

	if len(b.pendingBlock.Transactions()) != 0 {
		return errors.New("pending block dirty")
	}
	block, err := b.blockByHash(context.Background(), parent)
	if err != nil {
		return err
	}
	b.rollback(block)
	return nil
}

// BlockNumber returns the current block number.
func (b *Backend) BlockNumber(ctx context.Context) (uint64, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	return b.blockchain.CurrentBlock().Number.Uint64(), nil
}

// ChainID returns the chain ID configured for this backend.
func (b *Backend) ChainID(ctx context.Context) (*big.Int, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	if b.config == nil || b.config.ChainID == nil {
		return nil, errors.New("chain id not configured")
	}
	return new(big.Int).Set(b.config.ChainID), nil
}

// Client returns a client interface to the simulated chain.
func (b *Backend) Client() Client {
	return b
}

// stateByBlockNumber retrieves a state by a given blocknumber.
func (b *Backend) stateByBlockNumber(ctx context.Context, blockNumber *big.Int) (*state.StateDB, error) {
	if blockNumber == nil || blockNumber.Cmp(b.blockchain.CurrentBlock().Number) == 0 {
		return b.blockchain.State()
	}
	block, err := b.blockByNumber(ctx, blockNumber)
	if err != nil {
		return nil, err
	}
	return b.blockchain.StateAt(block.Root())
}

// CodeAt returns the code associated with a certain account in the blockchain.
func (b *Backend) CodeAt(ctx context.Context, contract common.Address, blockNumber *big.Int) ([]byte, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	stateDB, err := b.stateByBlockNumber(ctx, blockNumber)
	if err != nil {
		return nil, err
	}
	return stateDB.GetCode(contract), nil
}

// CodeAtHash returns the code associated with a certain account in the blockchain.
func (b *Backend) CodeAtHash(ctx context.Context, contract common.Address, blockHash common.Hash) ([]byte, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	header, err := b.headerByHash(blockHash)
	if err != nil {
		return nil, err
	}

	stateDB, err := b.blockchain.StateAt(header.Root)
	if err != nil {
		return nil, err
	}

	return stateDB.GetCode(contract), nil
}

// BalanceAt returns the wei balance of a certain account in the blockchain.
func (b *Backend) BalanceAt(ctx context.Context, contract common.Address, blockNumber *big.Int) (*big.Int, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	stateDB, err := b.stateByBlockNumber(ctx, blockNumber)
	if err != nil {
		return nil, err
	}
	return stateDB.GetBalance(contract), nil
}

// NonceAt returns the nonce of a certain account in the blockchain.
func (b *Backend) NonceAt(ctx context.Context, contract common.Address, blockNumber *big.Int) (uint64, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	stateDB, err := b.stateByBlockNumber(ctx, blockNumber)
	if err != nil {
		return 0, err
	}
	return stateDB.GetNonce(contract), nil
}

// StorageAt returns the value of key in the storage of an account in the blockchain.
func (b *Backend) StorageAt(ctx context.Context, contract common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	stateDB, err := b.stateByBlockNumber(ctx, blockNumber)
	if err != nil {
		return nil, err
	}
	val := stateDB.GetState(contract, key)
	return val[:], nil
}

// ForEachStorageAt returns func to read all keys, values in the storage
func (b *Backend) ForEachStorageAt(ctx context.Context, contract common.Address, blockNumber *big.Int, f func(key, val common.Hash) bool) error {
	b.mu.Lock()
	defer b.mu.Unlock()

	if blockNumber != nil && blockNumber.Cmp(b.blockchain.CurrentBlock().Number) != 0 {
		return errBlockNumberUnsupported
	}
	stateDB, _ := b.blockchain.State()
	stateDB.ForEachStorage(contract, f)
	return nil
}

// TransactionReceipt returns the receipt of a transaction.
func (b *Backend) TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	receipt, _, _, _ := rawdb.ReadReceipt(b.database, txHash, b.config)
	if receipt == nil {
		return nil, ethereum.ErrNotFound
	}
	return receipt, nil
}

// TransactionByHash checks the pool of pending transactions in addition to the
// blockchain. The isPending return value indicates whether the transaction has been
// mined yet. Note that the transaction may not be part of the canonical chain even if
// it's not pending.
func (b *Backend) TransactionByHash(ctx context.Context, txHash common.Hash) (*types.Transaction, bool, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	tx := b.pendingBlock.Transaction(txHash)
	if tx != nil {
		return tx, true, nil
	}
	tx, _, _, _ = rawdb.ReadTransaction(b.database, txHash)
	if tx != nil {
		return tx, false, nil
	}
	return nil, false, ethereum.ErrNotFound
}

// BlockByHash retrieves a block based on the block hash.
func (b *Backend) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	return b.blockByHash(ctx, hash)
}

// blockByHash retrieves a block based on the block hash without Locking.
func (b *Backend) blockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) {
	if hash == b.pendingBlock.Hash() {
		return b.pendingBlock, nil
	}

	block := b.blockchain.GetBlockByHash(hash)
	if block != nil {
		return block, nil
	}

	return nil, errBlockDoesNotExist
}

// BlockByNumber retrieves a block from the database by number, caching it
// (associated with its hash) if found.
func (b *Backend) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	return b.blockByNumber(ctx, number)
}

// blockByNumber retrieves a block from the database by number, caching it
// (associated with its hash) if found without Lock.
func (b *Backend) blockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) {
	if number == nil || number.Cmp(b.pendingBlock.Number()) == 0 {
		return b.blockByHash(ctx, b.blockchain.CurrentBlock().Hash())
	}

	block := b.blockchain.GetBlockByNumber(uint64(number.Int64()))
	if block == nil {
		return nil, errBlockDoesNotExist
	}

	return block, nil
}

// HeaderByHash returns a block header from the current canonical chain.
func (b *Backend) HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error) {
	b.mu.Lock()
	defer b.mu.Unlock()
	return b.headerByHash(hash)
}

// headerByHash retrieves a header from the database by hash without Lock.
func (b *Backend) headerByHash(hash common.Hash) (*types.Header, error) {
	if hash == b.pendingBlock.Hash() {
		return b.pendingBlock.Header(), nil
	}

	header := b.blockchain.GetHeaderByHash(hash)
	if header == nil {
		return nil, errBlockDoesNotExist
	}

	return header, nil
}

// HeaderByNumber returns a block header from the current canonical chain. If number is
// nil, the latest known header is returned.
func (b *Backend) HeaderByNumber(ctx context.Context, block *big.Int) (*types.Header, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	if block == nil || block.Cmp(b.pendingBlock.Number()) == 0 {
		return b.blockchain.CurrentHeader(), nil
	}

	return b.blockchain.GetHeaderByNumber(uint64(block.Int64())), nil
}

// TransactionCount returns the number of transactions in a given block.
func (b *Backend) TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	if blockHash == b.pendingBlock.Hash() {
		return uint(b.pendingBlock.Transactions().Len()), nil
	}

	block := b.blockchain.GetBlockByHash(blockHash)
	if block == nil {
		return uint(0), errBlockDoesNotExist
	}

	return uint(block.Transactions().Len()), nil
}

// TransactionInBlock returns the transaction for a specific block at a specific index.
func (b *Backend) TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	if blockHash == b.pendingBlock.Hash() {
		transactions := b.pendingBlock.Transactions()
		if uint(len(transactions)) < index+1 {
			return nil, errTransactionDoesNotExist
		}

		return transactions[index], nil
	}

	block := b.blockchain.GetBlockByHash(blockHash)
	if block == nil {
		return nil, errBlockDoesNotExist
	}

	transactions := block.Transactions()
	if uint(len(transactions)) < index+1 {
		return nil, errTransactionDoesNotExist
	}

	return transactions[index], nil
}

// PendingCodeAt returns the code associated with an account in the pending state.
func (b *Backend) PendingCodeAt(ctx context.Context, contract common.Address) ([]byte, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	return b.pendingState.GetCode(contract), nil
}

// PendingBalanceAt returns the wei balance of an account in the pending state.
func (b *Backend) PendingBalanceAt(ctx context.Context, account common.Address) (*big.Int, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	return b.pendingState.GetBalance(account), nil
}

// PendingStorageAt returns the storage value of an account in the pending state.
func (b *Backend) PendingStorageAt(ctx context.Context, account common.Address, key common.Hash) ([]byte, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	value := b.pendingState.GetState(account, key)
	return value[:], nil
}

// PendingTransactionCount returns the number of pending transactions in the pending block.
func (b *Backend) PendingTransactionCount(ctx context.Context) (uint, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	return uint(len(b.pendingBlock.Transactions())), nil
}

func newRevertError(result *core.ExecutionResult) *revertError {
	reason, errUnpack := abi.UnpackRevert(result.Revert())
	err := errors.New("execution reverted")
	if errUnpack == nil {
		err = fmt.Errorf("execution reverted: %v", reason)
	}
	return &revertError{
		error:  err,
		reason: hexutil.Encode(result.Revert()),
	}
}

// revertError is an API error that encompasses an EVM revert with JSON error
// code and a binary data blob.
type revertError struct {
	error
	reason string // revert reason hex encoded
}

// ErrorCode returns the JSON error code for a revert.
// See: https://github.com/ethereum/wiki/wiki/JSON-RPC-Error-Codes-Improvement-Proposal
func (e *revertError) ErrorCode() int {
	return 3
}

// ErrorData returns the hex encoded revert reason.
func (e *revertError) ErrorData() interface{} {
	return e.reason
}

// CallContract executes a contract call.
func (b *Backend) CallContract(ctx context.Context, call ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	if blockNumber != nil && blockNumber.Cmp(b.blockchain.CurrentBlock().Number) != 0 {
		return nil, errBlockNumberUnsupported
	}
	return b.callContractAtHead(ctx, call)
}

// CallContractAtHash executes a contract call on a specific block hash.
func (b *Backend) CallContractAtHash(ctx context.Context, call ethereum.CallMsg, blockHash common.Hash) ([]byte, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	if blockHash != b.blockchain.CurrentBlock().Hash() {
		return nil, errBlockHashUnsupported
	}
	return b.callContractAtHead(ctx, call)
}

// callContractAtHead executes a contract call against the latest block state.
func (b *Backend) callContractAtHead(ctx context.Context, call ethereum.CallMsg) ([]byte, error) {
	stateDB, err := b.blockchain.State()
	if err != nil {
		return nil, err
	}
	header := b.blockchain.CurrentBlock()
	res, err := b.callContract(ctx, call, header, stateDB)
	if err != nil {
		return nil, err
	}
	// If the result contains a revert reason, try to unpack and return it.
	if len(res.Revert()) > 0 {
		return nil, newRevertError(res)
	}
	return res.Return(), res.Err
}

// PendingCallContract executes a contract call on the pending state.
func (b *Backend) PendingCallContract(ctx context.Context, call ethereum.CallMsg) ([]byte, error) {
	b.mu.Lock()
	defer b.mu.Unlock()
	defer b.pendingState.RevertToSnapshot(b.pendingState.Snapshot())

	res, err := b.callContract(ctx, call, b.pendingBlock.Header(), b.pendingState)
	if err != nil {
		return nil, err
	}
	// If the result contains a revert reason, try to unpack and return it.
	if len(res.Revert()) > 0 {
		return nil, newRevertError(res)
	}
	return res.Return(), res.Err
}

// PendingNonceAt implements PendingStateReader.PendingNonceAt, retrieving
// the nonce currently pending for the account.
func (b *Backend) PendingNonceAt(ctx context.Context, account common.Address) (uint64, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	return b.pendingState.GetOrNewStateObject(account).Nonce(), nil
}

// SuggestGasPrice implements ContractTransactor.SuggestGasPrice. Since the simulated
// chain doesn't have miners, we just return a gas price of 1 for any call.
func (b *Backend) SuggestGasPrice(ctx context.Context) (*big.Int, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	if b.pendingBlock.Header().BaseFee != nil {
		return b.pendingBlock.Header().BaseFee, nil
	}
	return big.NewInt(1), nil
}

// SuggestGasTipCap implements ContractTransactor.SuggestGasTipCap. Since the simulated
// chain doesn't have miners, we just return a gas tip of 1 for any call.
func (b *Backend) SuggestGasTipCap(ctx context.Context) (*big.Int, error) {
	return big.NewInt(1), nil
}

// FeeHistory retrieves recent fee market data from the simulated chain.
func (b *Backend) FeeHistory(ctx context.Context, blockCount uint64, lastBlock *big.Int, rewardPercentiles []float64) (*ethereum.FeeHistory, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	for i, p := range rewardPercentiles {
		if p < 0 || p > 100 {
			return nil, fmt.Errorf("invalid reward percentile: %f", p)
		}
		if i > 0 && p < rewardPercentiles[i-1] {
			return nil, fmt.Errorf("invalid reward percentile: %f", p)
		}
	}

	head := b.blockchain.CurrentBlock().Number.Uint64()
	end := head
	if lastBlock != nil {
		if lastBlock.Sign() < 0 {
			return nil, errors.New("invalid last block")
		}
		if lastBlock.Uint64() < head {
			end = lastBlock.Uint64()
		}
	}

	available := end + 1
	if blockCount > available {
		blockCount = available
	}
	if blockCount == 0 {
		return &ethereum.FeeHistory{
			OldestBlock:  new(big.Int).SetUint64(end + 1),
			Reward:       nil,
			BaseFee:      nil,
			GasUsedRatio: nil,
		}, nil
	}

	start := end + 1 - blockCount
	history := &ethereum.FeeHistory{
		OldestBlock:  new(big.Int).SetUint64(start),
		BaseFee:      make([]*big.Int, blockCount+1),
		GasUsedRatio: make([]float64, blockCount),
	}
	if len(rewardPercentiles) > 0 {
		history.Reward = make([][]*big.Int, blockCount)
	}

	type pricedGas struct {
		tip *big.Int
		gas uint64
	}

	for i := uint64(0); i < blockCount; i++ {
		number := start + i
		block := b.blockchain.GetBlockByNumber(number)
		if block == nil {
			return nil, errBlockDoesNotExist
		}
		header := block.Header()

		if header.BaseFee != nil {
			history.BaseFee[i] = new(big.Int).Set(header.BaseFee)
		}
		if header.GasLimit > 0 {
			history.GasUsedRatio[i] = float64(header.GasUsed) / float64(header.GasLimit)
		}

		if len(rewardPercentiles) == 0 {
			continue
		}

		txs := block.Transactions()
		if len(txs) == 0 {
			history.Reward[i] = make([]*big.Int, len(rewardPercentiles))
			for j := range history.Reward[i] {
				history.Reward[i][j] = new(big.Int)
			}
			continue
		}

		prices := make([]pricedGas, 0, len(txs))
		var totalGas uint64
		for _, tx := range txs {
			tip := tx.EffectiveGasTipValue(header.BaseFee)
			prices = append(prices, pricedGas{tip: tip, gas: tx.Gas()})
			totalGas += tx.Gas()
		}
		sort.Slice(prices, func(a, b int) bool {
			return prices[a].tip.Cmp(prices[b].tip) < 0
		})

		history.Reward[i] = make([]*big.Int, len(rewardPercentiles))
		for j, p := range rewardPercentiles {
			if totalGas == 0 {
				history.Reward[i][j] = new(big.Int)
				continue
			}
			threshold := uint64(gomath.Ceil(float64(totalGas) * (p / 100.0)))
			if threshold == 0 {
				threshold = 1
			}
			var cumulative uint64
			selected := prices[len(prices)-1].tip
			for _, item := range prices {
				cumulative += item.gas
				if cumulative >= threshold {
					selected = item.tip
					break
				}
			}
			history.Reward[i][j] = new(big.Int).Set(selected)
		}
	}

	last := b.blockchain.GetBlockByNumber(end)
	if last == nil {
		return nil, errBlockDoesNotExist
	}
	if last.BaseFee() != nil {
		history.BaseFee[blockCount] = new(big.Int).Set(last.BaseFee())
	}

	return history, nil
}

// EstimateGas executes the requested code against the currently pending block/state and
// returns the used amount of gas.
func (b *Backend) EstimateGas(ctx context.Context, call ethereum.CallMsg) (uint64, error) {
	b.mu.Lock()
	defer b.mu.Unlock()

	// Determine the lowest and highest possible gas limits to binary search in between
	var (
		lo  uint64 = params.TxGas - 1
		hi  uint64
		cap uint64
	)
	if call.Gas >= params.TxGas {
		hi = call.Gas
	} else {
		hi = b.pendingBlock.GasLimit()
	}
	cap = hi

	// Create a helper to check if a gas allowance results in an executable transaction
	executable := func(gas uint64) (bool, *core.ExecutionResult, error) {
		call.Gas = gas

		snapshot := b.pendingState.Snapshot()
		res, err := b.callContract(ctx, call, b.pendingBlock.Header(), b.pendingState)
		b.pendingState.RevertToSnapshot(snapshot)

		if err != nil {
			if errors.Is(err, core.ErrIntrinsicGas) {
				return true, nil, nil // Special case, raise gas limit
			}
			return true, nil, err // Bail out
		}
		return res.Failed(), res, nil
	}
	// Execute the binary search and hone in on an executable gas limit
	for lo+1 < hi {
		mid := (hi + lo) / 2
		failed, _, err := executable(mid)

		// If the error is not nil(consensus error), it means the provided message
		// call or transaction will never be accepted no matter how much gas it is
		// assigned. Return the error directly, don't struggle any more
		if err != nil {
			return 0, err
		}
		if failed {
			lo = mid
		} else {
			hi = mid
		}
	}
	// Reject the transaction as invalid if it still fails at the highest allowance
	if hi == cap {
		failed, result, err := executable(hi)
		if err != nil {
			return 0, err
		}
		if failed {
			if result != nil && !errors.Is(result.Err, vm.ErrOutOfGas) {
				if len(result.Revert()) > 0 {
					return 0, newRevertError(result)
				}
				return 0, result.Err
			}
			// Otherwise, the specified gas cap is too low
			return 0, fmt.Errorf("gas required exceeds allowance (%d)", cap)
		}
	}
	return hi, nil
}

// callContract implements common code between normal and pending contract calls.
// state is modified during execution, make sure to copy it if necessary.
func (b *Backend) callContract(ctx context.Context, call ethereum.CallMsg, block *types.Header, stateDB *state.StateDB) (*core.ExecutionResult, error) {
	// Gas prices post 1559 need to be initialized
	if call.GasPrice != nil && (call.GasFeeCap != nil || call.GasTipCap != nil) {
		return nil, errors.New("both gasPrice and (maxFeePerGas or maxPriorityFeePerGas) specified")
	}
	head := b.blockchain.CurrentHeader()
	if !b.blockchain.Config().IsEIP1559(head.Number) {
		// If there's no basefee, then it must be a non-1559 execution
		if call.GasPrice == nil {
			call.GasPrice = new(big.Int)
		}
		call.GasFeeCap, call.GasTipCap = call.GasPrice, call.GasPrice
	} else {
		// A basefee is provided, necessitating 1559-type execution
		if call.GasPrice != nil {
			// User specified the legacy gas field, convert to 1559 gas typing
			call.GasFeeCap, call.GasTipCap = call.GasPrice, call.GasPrice
		} else {
			// User specified 1559 gas fields (or none), use those
			if call.GasFeeCap == nil {
				call.GasFeeCap = new(big.Int)
			}
			if call.GasTipCap == nil {
				call.GasTipCap = new(big.Int)
			}
			// Backfill the legacy gasPrice for EVM execution, unless we're all zeroes
			call.GasPrice = new(big.Int)
			if call.GasFeeCap.BitLen() > 0 || call.GasTipCap.BitLen() > 0 {
				call.GasPrice = new(big.Int).Add(call.GasTipCap, head.BaseFee)
				if call.GasPrice.Cmp(call.GasFeeCap) > 0 {
					call.GasPrice.Set(call.GasFeeCap)
				}
			}
		}
	}
	// Ensure message is initialized properly.
	if call.Gas == 0 {
		call.Gas = 10 * head.GasLimit
	}
	if call.Value == nil {
		call.Value = new(big.Int)
	}

	// Set infinite balance to the fake caller account.
	from := stateDB.GetOrNewStateObject(call.From)
	from.SetBalance(math.MaxBig256)

	// Execute the call.
	msg := &core.Message{
		From:             call.From,
		To:               call.To,
		Value:            call.Value,
		GasLimit:         call.Gas,
		GasPrice:         call.GasPrice,
		GasFeeCap:        call.GasFeeCap,
		GasTipCap:        call.GasTipCap,
		Data:             call.Data,
		AccessList:       call.AccessList,
		SkipNonceChecks:  true,
		SkipFromEOACheck: true,
	}
	feeCapacity := stateDB.GetTRC21FeeCapacityFromState()
	if msg.To != nil {
		if value, ok := feeCapacity[*msg.To]; ok {
			msg.BalanceTokenFee = value
		}
	}

	// Create a new environment which holds all relevant information
	// about the transaction and calling mechanisms.
	txContext := core.NewEVMTxContext(msg)
	evmContext := core.NewEVMBlockContext(block, b.blockchain, nil)
	// Create a new environment which holds all relevant information
	// about the transaction and calling mechanisms.
	evm := vm.NewEVM(evmContext, stateDB, nil, b.config, vm.Config{NoBaseFee: true})
	evm.SetTxContext(txContext)
	gaspool := new(core.GasPool).AddGas(gomath.MaxUint64)
	return core.NewStateTransition(evm, msg, gaspool).TransitionDb(common.Address{})
}

// SendTransaction updates the pending block to include the given transaction.
func (b *Backend) SendTransaction(ctx context.Context, tx *types.Transaction) error {
	b.mu.Lock()
	defer b.mu.Unlock()

	// Get the last block
	block, err := b.blockByHash(ctx, b.pendingBlock.ParentHash())
	if err != nil {
		return errors.New("could not fetch parent")
	}
	// Check transaction validity
	signer := types.MakeSigner(b.blockchain.Config(), block.Number())
	sender, err := types.Sender(signer, tx)
	if err != nil {
		return fmt.Errorf("invalid transaction: %v", err)
	}
	nonce := b.pendingState.GetNonce(sender)
	if tx.Nonce() != nonce {
		return fmt.Errorf("invalid transaction nonce: got %d, want %d", tx.Nonce(), nonce)
	}
	// Include tx in chain
	blocks, receipts := core.GenerateChain(b.config, block, b.blockchain.Engine(), b.database, 1, func(number int, block *core.BlockGen) {
		for _, tx := range b.pendingBlock.Transactions() {
			block.AddTxWithChain(b.blockchain, tx)
		}
		block.AddTxWithChain(b.blockchain, tx)
	})
	stateDB, err := b.blockchain.State()
	if err != nil {
		return err
	}
	b.pendingBlock = blocks[0]
	b.pendingState, _ = state.New(b.pendingBlock.Root(), stateDB.Database())
	b.pendingReceipts = receipts[0]
	return nil
}

// FilterLogs executes a log filter operation, blocking during execution and
// returning all the results in one batch.
//
// TODO(karalabe): Deprecate when the subscription one can return past data too.
func (b *Backend) FilterLogs(ctx context.Context, query ethereum.FilterQuery) ([]types.Log, error) {
	var filter *filters.Filter
	if query.BlockHash != nil {
		// Block filter requested, construct a single-shot filter
		filter = b.filterSystem.NewBlockFilter(*query.BlockHash, query.Addresses, query.Topics)
	} else {
		// Initialize unset filter boundaried to run from genesis to chain head
		from := rpc.EarliestBlockNumber.Int64()
		if query.FromBlock != nil {
			from = query.FromBlock.Int64()
		}
		to := rpc.LatestBlockNumber.Int64()
		if query.ToBlock != nil {
			to = query.ToBlock.Int64()
		}
		// Construct the range filter
		filter = b.filterSystem.NewRangeFilter(from, to, query.Addresses, query.Topics, 0)
	}
	// Run the filter and return all the logs
	logs, err := filter.Logs(ctx)
	if err != nil {
		return nil, err
	}
	res := make([]types.Log, len(logs))
	for i, log := range logs {
		res[i] = *log
	}
	return res, nil
}

// SubscribeFilterLogs creates a background log filtering operation, returning a
// subscription immediately, which can be used to stream the found events.
func (b *Backend) SubscribeFilterLogs(ctx context.Context, query ethereum.FilterQuery, ch chan<- types.Log) (ethereum.Subscription, error) {
	// Subscribe to contract events
	sink := make(chan []*types.Log)

	sub, err := b.events.SubscribeLogs(query, sink)
	if err != nil {
		return nil, err
	}
	// Since we're getting logs in batches, we need to flatten them into a plain stream
	return event.NewSubscription(func(quit <-chan struct{}) error {
		defer sub.Unsubscribe()
		for {
			select {
			case logs := <-sink:
				for _, log := range logs {
					select {
					case ch <- *log:
					case err := <-sub.Err():
						return err
					case <-quit:
						return nil
					}
				}
			case err := <-sub.Err():
				return err
			case <-quit:
				return nil
			}
		}
	}), nil
}

// SubscribeNewHead returns an event subscription for a new header.
func (b *Backend) SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (ethereum.Subscription, error) {
	// subscribe to a new head
	sink := make(chan *types.Header)
	sub := b.events.SubscribeNewHeads(sink)

	return event.NewSubscription(func(quit <-chan struct{}) error {
		defer sub.Unsubscribe()
		for {
			select {
			case head := <-sink:
				select {
				case ch <- head:
				case err := <-sub.Err():
					return err
				case <-quit:
					return nil
				}
			case err := <-sub.Err():
				return err
			case <-quit:
				return nil
			}
		}
	}), nil
}

// AdjustTime adds a time shift to the simulated clock.
// It can only be called on empty blocks.
func (b *Backend) AdjustTime(adjustment time.Duration) error {
	b.mu.Lock()
	defer b.mu.Unlock()

	if len(b.pendingBlock.Transactions()) != 0 {
		return errors.New("could not adjust time on non-empty block")
	}
	// Get the last block
	block := b.blockchain.GetBlockByHash(b.pendingBlock.ParentHash())
	if block == nil {
		return errors.New("could not find parent")
	}
	// Determine the default timestamp increment used by chain generation,
	// then offset relative to that value so the resulting timestamp shift
	// equals the requested adjustment exactly.
	probeBlocks, _ := core.GenerateChain(b.config, block, b.blockchain.Engine(), b.database, 1, func(int, *core.BlockGen) {})
	if len(probeBlocks) == 0 {
		return errors.New("could not generate probe block")
	}
	defaultStep := int64(probeBlocks[0].Time()) - int64(block.Time())

	blocks, _ := core.GenerateChain(b.config, block, b.blockchain.Engine(), b.database, 1, func(number int, block *core.BlockGen) {
		block.OffsetTime(int64(adjustment.Seconds()) - defaultStep)
	})
	if _, err := b.blockchain.InsertChain(blocks); err != nil {
		return err
	}
	b.pendingBlock = blocks[0]
	b.rollback(b.pendingBlock)

	stateDB, _ := b.blockchain.State()
	b.pendingState, _ = state.New(b.pendingBlock.Root(), stateDB.Database())

	return nil
}

// Blockchain returns the underlying blockchain.
func (b *Backend) BlockChain() *core.BlockChain {
	return b.blockchain
}

// filterBackend implements filters.Backend to support filtering for logs without
// taking bloom-bits acceleration structures into account.
type filterBackend struct {
	db      ethdb.Database
	bc      *core.BlockChain
	backend *Backend
}

func (fb *filterBackend) ChainDb() ethdb.Database  { return fb.db }
func (fb *filterBackend) EventMux() *event.TypeMux { panic("not supported") }

func (fb *filterBackend) HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error) {
	switch number {
	case rpc.PendingBlockNumber:
		if block := fb.backend.pendingBlock; block != nil {
			return block.Header(), nil
		}
		return nil, nil
	case rpc.LatestBlockNumber:
		return fb.bc.CurrentHeader(), nil
	case rpc.FinalizedBlockNumber:
		if fb.bc.Config().XDPoS == nil {
			return nil, errors.New("only XDPoS v2 supports committed block lookup")
		}
		current := fb.bc.CurrentBlock()
		if fb.bc.Config().XDPoS.BlockConsensusVersion(current.Number) == params.ConsensusEngineVersion2 {
			confirmedHash := fb.bc.Engine().(*XDPoS.XDPoS).EngineV2.GetLatestCommittedBlockInfo().Hash
			return fb.bc.GetHeaderByHash(confirmedHash), nil
		}
		return nil, errors.New("only XDPoS v2 can lookup committed block")
	default:
		return fb.bc.GetHeaderByNumber(uint64(number.Int64())), nil
	}
}

func (fb *filterBackend) HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error) {
	return fb.bc.GetHeaderByHash(hash), nil
}

func (fb *filterBackend) GetReceipts(ctx context.Context, hash common.Hash) (types.Receipts, error) {
	number := rawdb.ReadHeaderNumber(fb.db, hash)
	if number == nil {
		return nil, nil
	}
	return rawdb.ReadReceipts(fb.db, hash, *number, fb.bc.Config()), nil
}

func (fb *filterBackend) GetBody(ctx context.Context, hash common.Hash, number rpc.BlockNumber) (*types.Body, error) {
	if body := fb.bc.GetBody(hash); body != nil {
		return body, nil
	}
	return nil, errors.New("block body not found")
}

func (fb *filterBackend) PendingBlockAndReceipts() (*types.Block, types.Receipts) {
	return fb.backend.pendingBlock, fb.backend.pendingReceipts
}

func (fb *filterBackend) GetLogs(ctx context.Context, hash common.Hash, number uint64) ([][]*types.Log, error) {
	logs := rawdb.ReadLogs(fb.db, hash, number)
	return logs, nil
}

func (fb *filterBackend) SubscribeNewTxsEvent(ch chan<- core.NewTxsEvent) event.Subscription {
	return nullSubscription()
}

func (fb *filterBackend) SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription {
	return fb.bc.SubscribeChainEvent(ch)
}

func (fb *filterBackend) SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription {
	return fb.bc.SubscribeRemovedLogsEvent(ch)
}

func (fb *filterBackend) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription {
	return fb.bc.SubscribeLogsEvent(ch)
}

func (fb *filterBackend) SubscribePendingLogsEvent(ch chan<- []*types.Log) event.Subscription {
	return nullSubscription()
}

func (fb *filterBackend) BloomStatus() (uint64, uint64) { return 4096, 0 }

func (fb *filterBackend) ServiceFilter(ctx context.Context, ms *bloombits.MatcherSession) {
	panic("not supported")
}

func (fb *filterBackend) ChainConfig() *params.ChainConfig {
	panic("not supported")
}

func (fb *filterBackend) CurrentHeader() *types.Header {
	panic("not supported")
}

func nullSubscription() event.Subscription {
	return event.NewSubscription(func(quit <-chan struct{}) error {
		<-quit
		return nil
	})
}