protocol

Documentation

Index

• Variables
• type BlockStoreState
• type Chain
  • func NewChain(store Store, txPool *TxPool) (*Chain, error)
  • func (c *Chain) BestBlockHash() *bc.Hash
  • func (c *Chain) BestBlockHeader() *types.BlockHeader
  • func (c *Chain) BestBlockHeight() uint64
  • func (c *Chain) BlockExist(hash *bc.Hash) bool
  • func (c *Chain) BlockWaiter(height uint64) <-chan struct{}
  • func (c *Chain) CalcNextBits(preBlock *bc.Hash) (uint64, error)
  • func (c *Chain) CalcNextSeed(preBlock *bc.Hash) (*bc.Hash, error)
  • func (c *Chain) GetBlockByHash(hash *bc.Hash) (*types.Block, error)
  • func (c *Chain) GetBlockByHeight(height uint64) (*types.Block, error)
  • func (c *Chain) GetTransactionStatus(hash *bc.Hash) (*bc.TransactionStatus, error)
  • func (c *Chain) GetTransactionsUtxo(view *state.UtxoViewpoint, txs []*bc.Tx) error
  • func (c *Chain) GetTxPool() *TxPool
  • func (c *Chain) InMainChain(hash bc.Hash) bool
  • func (c *Chain) ProcessBlock(block *types.Block) (bool, error)
  • func (c *Chain) ValidateTx(tx *types.Tx) (bool, error)
• type OrphanManage
  • func NewOrphanManage() *OrphanManage
  • func (o *OrphanManage) Add(block *types.Block)
  • func (o *OrphanManage) BlockExist(hash *bc.Hash) bool
  • func (o *OrphanManage) Delete(hash *bc.Hash)
  • func (o *OrphanManage) Get(hash *bc.Hash) (*types.Block, bool)
  • func (o *OrphanManage) GetPrevOrphans(hash *bc.Hash) ([]*bc.Hash, bool)
• type Store
• type TxDesc
• type TxPool
  • func NewTxPool() *TxPool
  • func (tp *TxPool) AddErrCache(txHash *bc.Hash, err error)
  • func (tp *TxPool) AddTransaction(tx *types.Tx, gasOnlyTx bool, height, fee uint64) (*TxDesc, error)
  • func (tp *TxPool) Count() int
  • func (tp *TxPool) GetErrCache(txHash *bc.Hash) error
  • func (tp *TxPool) GetNewTxCh() chan *types.Tx
  • func (tp *TxPool) GetTransaction(txHash *bc.Hash) (*TxDesc, error)
  • func (tp *TxPool) GetTransactionUTXO(tx *bc.Tx) *state.UtxoViewpoint
  • func (tp *TxPool) GetTransactions() []*TxDesc
  • func (tp *TxPool) HaveTransaction(txHash *bc.Hash) bool
  • func (tp *TxPool) IsTransactionInErrCache(txHash *bc.Hash) bool
  • func (tp *TxPool) IsTransactionInPool(txHash *bc.Hash) bool
  • func (tp *TxPool) RemoveTransaction(txHash *bc.Hash)

Variables

var (
	// ErrBadBlock is returned when a block is invalid.
	ErrBadBlock = errors.New("invalid block")
	// ErrBadStateRoot is returned when the computed assets merkle root
	// disagrees with the one declared in a block header.
	ErrBadStateRoot = errors.New("invalid state merkle root")
)

var (

	// ErrTransactionNotExist is the pre-defined error message
	ErrTransactionNotExist = errors.New("transaction are not existed in the mempool")
	// ErrPoolIsFull indicates the pool is full
	ErrPoolIsFull = errors.New("transaction pool reach the max number")
)

var ErrBadTx = errors.New("invalid transaction")

ErrBadTx is returned for transactions failing validation

var ErrTheDistantFuture = errors.New("block height too far in future")

ErrTheDistantFuture is returned when waiting for a blockheight too far in excess of the tip of the blockchain.

Types

type BlockStoreState

type BlockStoreState struct {
	Height uint64
	Hash   *bc.Hash
}

BlockStoreState represents the core's db status

type Chain

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

Chain provides functions for working with the Bytom block chain.

func NewChain

func NewChain(store Store, txPool *TxPool) (*Chain, error)

NewChain returns a new Chain using store as the underlying storage.

func (*Chain) BestBlockHash

func (c *Chain) BestBlockHash() *bc.Hash

BestBlockHash return the hash of the chain tail block

func (*Chain) BestBlockHeader

func (c *Chain) BestBlockHeader() *types.BlockHeader

BestBlockHeader returns the chain tail block

func (*Chain) BestBlockHeight

func (c *Chain) BestBlockHeight() uint64

BestBlockHeight returns the current height of the blockchain.

func (*Chain) BlockExist

func (c *Chain) BlockExist(hash *bc.Hash) bool

BlockExist check is a block in chain or orphan

func (*Chain) BlockWaiter

func (c *Chain) BlockWaiter(height uint64) <-chan struct{}

BlockWaiter returns a channel that waits for the block at the given height.

func (*Chain) CalcNextBits

func (c *Chain) CalcNextBits(preBlock *bc.Hash) (uint64, error)

CalcNextBits return the seed for the given block

func (*Chain) CalcNextSeed

func (c *Chain) CalcNextSeed(preBlock *bc.Hash) (*bc.Hash, error)

CalcNextSeed return the seed for the given block

func (*Chain) GetBlockByHash

func (c *Chain) GetBlockByHash(hash *bc.Hash) (*types.Block, error)

GetBlockByHash return a block by given hash

func (*Chain) GetBlockByHeight

func (c *Chain) GetBlockByHeight(height uint64) (*types.Block, error)

GetBlockByHeight return a block by given height

func (*Chain) GetTransactionStatus

func (c *Chain) GetTransactionStatus(hash *bc.Hash) (*bc.TransactionStatus, error)

GetTransactionStatus return the transaction status of give block

func (*Chain) GetTransactionsUtxo

func (c *Chain) GetTransactionsUtxo(view *state.UtxoViewpoint, txs []*bc.Tx) error

GetTransactionsUtxo return all the utxos that related to the txs' inputs

func (*Chain) GetTxPool

func (c *Chain) GetTxPool() *TxPool

GetTxPool return chain txpool.

func (*Chain) InMainChain

func (c *Chain) InMainChain(hash bc.Hash) bool

InMainChain checks wheather a block is in the main chain

func (*Chain) ProcessBlock

func (c *Chain) ProcessBlock(block *types.Block) (bool, error)

ProcessBlock is the entry for chain update

func (*Chain) ValidateTx

func (c *Chain) ValidateTx(tx *types.Tx) (bool, error)

ValidateTx validates the given transaction. A cache holds per-transaction validation results and is consulted before performing full validation.

type OrphanManage

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

OrphanManage is use to handle all the orphan block

func NewOrphanManage

func NewOrphanManage() *OrphanManage

NewOrphanManage return a new orphan block

func (*OrphanManage) Add

func (o *OrphanManage) Add(block *types.Block)

Add will add the block to OrphanManage

func (*OrphanManage) BlockExist

func (o *OrphanManage) BlockExist(hash *bc.Hash) bool

BlockExist check is the block in OrphanManage

func (*OrphanManage) Delete

func (o *OrphanManage) Delete(hash *bc.Hash)

Delete will delete the block from OrphanManage

func (*OrphanManage) Get

func (o *OrphanManage) Get(hash *bc.Hash) (*types.Block, bool)

Get return the orphan block by hash

func (*OrphanManage) GetPrevOrphans

func (o *OrphanManage) GetPrevOrphans(hash *bc.Hash) ([]*bc.Hash, bool)

GetPrevOrphans return the list of child orphans

type Store

type Store interface {
	BlockExist(*bc.Hash) bool

	GetBlock(*bc.Hash) (*types.Block, error)
	GetStoreStatus() *BlockStoreState
	GetTransactionStatus(*bc.Hash) (*bc.TransactionStatus, error)
	GetTransactionsUtxo(*state.UtxoViewpoint, []*bc.Tx) error
	GetUtxo(*bc.Hash) (*storage.UtxoEntry, error)

	LoadBlockIndex() (*state.BlockIndex, error)
	SaveBlock(*types.Block, *bc.TransactionStatus) error
	SaveChainStatus(*state.BlockNode, *state.UtxoViewpoint) error
}

Store provides storage interface for blockchain data

type TxDesc

type TxDesc struct {
	Tx       *types.Tx
	Added    time.Time
	Height   uint64
	Weight   uint64
	Fee      uint64
	FeePerKB uint64
}

TxDesc store tx and related info for mining strategy

type TxPool

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

TxPool is use for store the unconfirmed transaction

func NewTxPool

func NewTxPool() *TxPool

NewTxPool init a new TxPool

func (*TxPool) AddErrCache

func (tp *TxPool) AddErrCache(txHash *bc.Hash, err error)

AddErrCache add a failed transaction record to lru cache

func (*TxPool) AddTransaction

func (tp *TxPool) AddTransaction(tx *types.Tx, gasOnlyTx bool, height, fee uint64) (*TxDesc, error)

AddTransaction add a verified transaction to pool

func (*TxPool) Count

func (tp *TxPool) Count() int

Count return number of transcation in pool

func (*TxPool) GetErrCache

func (tp *TxPool) GetErrCache(txHash *bc.Hash) error

GetErrCache return the error of the transaction

func (*TxPool) GetNewTxCh

func (tp *TxPool) GetNewTxCh() chan *types.Tx

GetNewTxCh return a unconfirmed transaction feed channel

func (*TxPool) GetTransaction

func (tp *TxPool) GetTransaction(txHash *bc.Hash) (*TxDesc, error)

GetTransaction return the TxDesc by hash

func (*TxPool) GetTransactionUTXO

func (tp *TxPool) GetTransactionUTXO(tx *bc.Tx) *state.UtxoViewpoint

GetTransactionUTXO return unconfirmed utxo

func (*TxPool) GetTransactions

func (tp *TxPool) GetTransactions() []*TxDesc

GetTransactions return all the transactions in the pool

func (*TxPool) HaveTransaction

func (tp *TxPool) HaveTransaction(txHash *bc.Hash) bool

HaveTransaction IsTransactionInErrCache check is transaction in errCache or pool

func (*TxPool) IsTransactionInErrCache

func (tp *TxPool) IsTransactionInErrCache(txHash *bc.Hash) bool

IsTransactionInErrCache check wheather a transaction in errCache or not

func (*TxPool) IsTransactionInPool

func (tp *TxPool) IsTransactionInPool(txHash *bc.Hash) bool

IsTransactionInPool check wheather a transaction in pool or not

func (*TxPool) RemoveTransaction

func (tp *TxPool) RemoveTransaction(txHash *bc.Hash)

RemoveTransaction remove a transaction from the pool