state

Documentation

Index

• type BlockStore
• type ErrAppBlockHeightTooHigh
  • func (e ErrAppBlockHeightTooHigh) Error() string
• type ErrBlockHashMismatch
  • func (e ErrBlockHashMismatch) Error() string
• type ErrInvalidBlock
• type ErrLastStateMismatch
  • func (e ErrLastStateMismatch) Error() string
• type ErrProxyAppConn
• type ErrStateMismatch
  • func (e ErrStateMismatch) Error() string
• type ErrUnknownBlock
  • func (e ErrUnknownBlock) Error() string
• type Handshaker
  • func NewHandshaker(config cfg.Config, state *State, store BlockStore) *Handshaker
  • func (h *Handshaker) Handshake(proxyApp proxy.AppConns) error
  • func (h *Handshaker) ReplayBlocks(appHash []byte, appBlockHeight int, appConnConsensus proxy.AppConnConsensus) error
• type Mempool
• type MockMempool
  • func (m MockMempool) Lock()
  • func (m MockMempool) Unlock()
  • func (m MockMempool) Update(height int, txs []types.Tx)
• type State
  • func GetState(config cfg.Config, stateDB dbm.DB) *State
  • func LoadState(db dbm.DB) *State
  • func MakeGenesisState(db dbm.DB, genDoc *types.GenesisDoc) *State
  • func MakeGenesisStateFromFile(db dbm.DB, genDocFile string) *State
  • func (s *State) ApplyBlock(eventCache types.Fireable, proxyAppConn proxy.AppConnConsensus, ...) error
  • func (s *State) Bytes() []byte
  • func (s *State) CommitStateUpdateMempool(proxyAppConn proxy.AppConnConsensus, block *types.Block, mempool Mempool) error
  • func (s *State) Copy() *State
  • func (s *State) Equals(s2 *State) bool
  • func (s *State) ExecBlock(eventCache types.Fireable, proxyAppConn proxy.AppConnConsensus, ...) error
  • func (s *State) GetValidators() (*types.ValidatorSet, *types.ValidatorSet)
  • func (s *State) LoadIntermediate()
  • func (s *State) Save()
  • func (s *State) SaveIntermediate()
  • func (s *State) SetBlockAndValidators(header *types.Header, blockPartsHeader types.PartSetHeader, ...)
  • func (s *State) ValidateBlock(block *types.Block) error

Types

type BlockStore

type BlockStore interface {
	Height() int
	LoadBlock(height int) *types.Block
	LoadBlockMeta(height int) *types.BlockMeta
}

TODO: Should we move blockchain/store.go to its own package?

type ErrAppBlockHeightTooHigh

type ErrAppBlockHeightTooHigh struct {
	// contains filtered or unexported fields
}

func (ErrAppBlockHeightTooHigh) Error

func (e ErrAppBlockHeightTooHigh) Error() string

type ErrBlockHashMismatch

type ErrBlockHashMismatch struct {
	// contains filtered or unexported fields
}

func (ErrBlockHashMismatch) Error

func (e ErrBlockHashMismatch) Error() string

type ErrInvalidBlock

type ErrInvalidBlock error

type ErrLastStateMismatch

type ErrLastStateMismatch struct {
	// contains filtered or unexported fields
}

func (ErrLastStateMismatch) Error

func (e ErrLastStateMismatch) Error() string

type ErrProxyAppConn

type ErrProxyAppConn error

type ErrStateMismatch

type ErrStateMismatch struct {
	// contains filtered or unexported fields
}

func (ErrStateMismatch) Error

func (e ErrStateMismatch) Error() string

type ErrUnknownBlock

type ErrUnknownBlock struct {
	// contains filtered or unexported fields
}

func (ErrUnknownBlock) Error

func (e ErrUnknownBlock) Error() string

type Handshaker

type Handshaker struct {
	// contains filtered or unexported fields
}

func NewHandshaker

func NewHandshaker(config cfg.Config, state *State, store BlockStore) *Handshaker

func (*Handshaker) Handshake

func (h *Handshaker) Handshake(proxyApp proxy.AppConns) error

TODO: retry the handshake/replay if it fails ?

func (*Handshaker) ReplayBlocks

func (h *Handshaker) ReplayBlocks(appHash []byte, appBlockHeight int, appConnConsensus proxy.AppConnConsensus) error

Replay all blocks after blockHeight and ensure the result matches the current state.

type Mempool

type Mempool interface {
	Lock()
	Unlock()
	Update(height int, txs []types.Tx)
}

Updates to the mempool need to be synchronized with committing a block so apps can reset their transient state on Commit

type MockMempool

type MockMempool struct {
}

func (MockMempool) Lock

func (m MockMempool) Lock()

func (MockMempool) Unlock

func (m MockMempool) Unlock()

func (MockMempool) Update

func (m MockMempool) Update(height int, txs []types.Tx)

type State

type State struct {

	// should not change
	GenesisDoc *types.GenesisDoc
	ChainID    string

	// updated at end of ExecBlock
	LastBlockHeight int // Genesis state has this set to 0.  So, Block(H=0) does not exist.
	LastBlockID     types.BlockID
	LastBlockTime   time.Time
	Validators      *types.ValidatorSet
	LastValidators  *types.ValidatorSet // block.LastCommit validated against this

	// AppHash is updated after Commit
	AppHash []byte
	// contains filtered or unexported fields
}

NOTE: not goroutine-safe.

func GetState

func GetState(config cfg.Config, stateDB dbm.DB) *State

Load the most recent state from "state" db, or create a new one (and save) from genesis.

func LoadState

func LoadState(db dbm.DB) *State

func MakeGenesisState

func MakeGenesisState(db dbm.DB, genDoc *types.GenesisDoc) *State

func MakeGenesisStateFromFile

func MakeGenesisStateFromFile(db dbm.DB, genDocFile string) *State

func (*State) ApplyBlock

func (s *State) ApplyBlock(eventCache types.Fireable, proxyAppConn proxy.AppConnConsensus,
	block *types.Block, partsHeader types.PartSetHeader, mempool Mempool) error

Execute and commit block against app, save block and state

func (*State) Bytes

func (s *State) Bytes() []byte

func (*State) CommitStateUpdateMempool

func (s *State) CommitStateUpdateMempool(proxyAppConn proxy.AppConnConsensus, block *types.Block, mempool Mempool) error

mempool must be locked during commit and update because state is typically reset on Commit and old txs must be replayed against committed state before new txs are run in the mempool, lest they be invalid

func (*State) Copy

func (s *State) Copy() *State

func (*State) Equals

func (s *State) Equals(s2 *State) bool

func (*State) ExecBlock

func (s *State) ExecBlock(eventCache types.Fireable, proxyAppConn proxy.AppConnConsensus, block *types.Block, blockPartsHeader types.PartSetHeader) error

Execute the block to mutate State. Validates block and then executes Data.Txs in the block.

func (*State) GetValidators

func (s *State) GetValidators() (*types.ValidatorSet, *types.ValidatorSet)

func (*State) LoadIntermediate

func (s *State) LoadIntermediate()

Load the intermediate state into the current state and do some sanity checks

func (*State) Save

func (s *State) Save()

func (*State) SaveIntermediate

func (s *State) SaveIntermediate()

func (*State) SetBlockAndValidators

func (s *State) SetBlockAndValidators(header *types.Header, blockPartsHeader types.PartSetHeader, prevValSet, nextValSet *types.ValidatorSet)

Mutate state variables to match block and validators after running EndBlock

func (*State) ValidateBlock

func (s *State) ValidateBlock(block *types.Block) error