github.com/SmartMeshFoundation/Spectrum@v0.0.0-20220621030607-452a266fee1e/core/types.go (about)

     1  // Copyright 2015 The Spectrum Authors
     2  // This file is part of the Spectrum library.
     3  //
     4  // The Spectrum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The Spectrum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the Spectrum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package core
    18  
    19  import (
    20  	"math/big"
    21  
    22  	"github.com/SmartMeshFoundation/Spectrum/core/state"
    23  	"github.com/SmartMeshFoundation/Spectrum/core/types"
    24  	"github.com/SmartMeshFoundation/Spectrum/core/vm"
    25  )
    26  
    27  // Validator is an interface which defines the standard for block validation. It
    28  // is only responsible for validating block contents, as the header validation is
    29  // done by the specific consensus engines.
    30  //
    31  type Validator interface {
    32  	// ValidateBody validates the given block's content.
    33  	ValidateBody(parent, block *types.Block) error
    34  
    35  	// ValidateState validates the given statedb and optionally the receipts and
    36  	// gas used.
    37  	ValidateState(block, parent *types.Block, state *state.StateDB, receipts types.Receipts, usedGas *big.Int) error
    38  }
    39  
    40  // Processor is an interface for processing blocks using a given initial state.
    41  //
    42  // Process takes the block to be processed and the statedb upon which the
    43  // initial state is based. It should return the receipts generated, amount
    44  // of gas used in the process and return an error if any of the internal rules
    45  // failed.
    46  type Processor interface {
    47  	Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, *big.Int, error)
    48  }