github.com/avence12/go-ethereum@v1.5.10-0.20170320123548-1dfd65f6d047/core/types.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum 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 go-ethereum 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 go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package core
    18  
    19  import (
    20  	"math/big"
    21  
    22  	"github.com/ethereum/go-ethereum/core/state"
    23  	"github.com/ethereum/go-ethereum/core/types"
    24  	"github.com/ethereum/go-ethereum/core/vm"
    25  )
    26  
    27  // Validator is an interface which defines the standard for block validation.
    28  //
    29  // The validator is responsible for validating incoming block or, if desired,
    30  // validates headers for fast validation.
    31  //
    32  // ValidateBlock validates the given block and should return an error if it
    33  // failed to do so and should be used for "full" validation.
    34  //
    35  // ValidateHeader validates the given header and parent and returns an error
    36  // if it failed to do so.
    37  //
    38  // ValidateState validates the given statedb and optionally the receipts and
    39  // gas used. The implementer should decide what to do with the given input.
    40  type Validator interface {
    41  	HeaderValidator
    42  	ValidateBlock(block *types.Block) error
    43  	ValidateState(block, parent *types.Block, state *state.StateDB, receipts types.Receipts, usedGas *big.Int) error
    44  }
    45  
    46  // HeaderValidator is an interface for validating headers only
    47  //
    48  // ValidateHeader validates the given header and parent and returns an error
    49  // if it failed to do so.
    50  type HeaderValidator interface {
    51  	ValidateHeader(header, parent *types.Header, checkPow bool) error
    52  }
    53  
    54  // Processor is an interface for processing blocks using a given initial state.
    55  //
    56  // Process takes the block to be processed and the statedb upon which the
    57  // initial state is based. It should return the receipts generated, amount
    58  // of gas used in the process and return an error if any of the internal rules
    59  // failed.
    60  type Processor interface {
    61  	Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, *big.Int, error)
    62  }