protocol

Documentation

Index

• Variables
• type Chain
  • func NewChain(initialBlockHash bc.Hash, store database.Store, txPool *TxPool) (*Chain, error)
  • func (c *Chain) BestBlock() *types.Block
  • func (c *Chain) BestBlockHash() *bc.Hash
  • func (c *Chain) BlockExist(hash *bc.Hash) bool
  • func (c *Chain) BlockSoonWaiter(ctx context.Context, height uint64) <-chan error
  • func (c *Chain) BlockWaiter(height uint64) <-chan struct{}
  • func (c *Chain) ConnectBlock(block *types.Block) error
  • func (c *Chain) GetBlockByHash(hash *bc.Hash) (*types.Block, error)
  • func (c *Chain) GetBlockByHeight(height uint64) (*types.Block, error)
  • func (c *Chain) GetSeed(height uint64, preBlock *bc.Hash) (*bc.Hash, 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) GetUtxo(hash *bc.Hash) (*storage.UtxoEntry, error)
  • func (c *Chain) Height() uint64
  • func (c *Chain) InMainChain(height uint64, hash bc.Hash) bool
  • func (c *Chain) ProcessBlock(block *types.Block) (bool, error)
  • func (c *Chain) SaveBlock(block *types.Block) error
  • func (c *Chain) Timestamp() uint64
  • func (c *Chain) ValidateTx(tx *types.Tx) 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)
• 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 is returned when waiting for a blockheight
	// too far in excess of the tip of the blockchain.
	ErrTheDistantFuture = errors.New("block height too far in future")
)

Types

type Chain

type Chain struct {
	InitialBlockHash  bc.Hash
	MaxIssuanceWindow time.Duration // only used by generators
	// contains filtered or unexported fields
}

Chain provides a complete, minimal blockchain database. It delegates the underlying storage to other objects, and uses validation logic from package validation to decide what objects can be safely stored.

func NewChain

func NewChain(initialBlockHash bc.Hash, store database.Store, txPool *TxPool) (*Chain, error)

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

func (*Chain) BestBlock

func (c *Chain) BestBlock() *types.Block

BestBlock returns the chain tail block

func (*Chain) BestBlockHash

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

BestBlockHash return the hash of the chain tail block

func (*Chain) BlockExist

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

BlockExist check is a block in chain or orphan

func (*Chain) BlockSoonWaiter

func (c *Chain) BlockSoonWaiter(ctx context.Context, height uint64) <-chan error

BlockSoonWaiter returns a channel that waits for the block at the given height, but it is an error to wait for a block far in the future. WaitForBlockSoon will timeout if the context times out. To wait unconditionally, the caller should use WaitForBlock.

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) ConnectBlock

func (c *Chain) ConnectBlock(block *types.Block) error

ConnectBlock append block to end of chain

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) GetSeed

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

GetSeed return the seed for the given block

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) GetUtxo

func (c *Chain) GetUtxo(hash *bc.Hash) (*storage.UtxoEntry, error)

GetUtxo try to find the utxo status in db

func (*Chain) Height

func (c *Chain) Height() uint64

Height returns the current height of the blockchain.

func (*Chain) InMainChain

func (c *Chain) InMainChain(height uint64, 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 handle block insert

func (*Chain) SaveBlock

func (c *Chain) SaveBlock(block *types.Block) error

SaveBlock will validate and save block into storage

func (*Chain) Timestamp

func (c *Chain) Timestamp() uint64

Timestamp returns the latest known block timestamp.

func (*Chain) ValidateTx

func (c *Chain) ValidateTx(tx *types.Tx) 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 delelte the block from OrphanManage

func (*OrphanManage) Get

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

Get return the orphan block by hash

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