chain

package

v2.5.2 Latest Latest Go to latest Published: Feb 20, 2024 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aergoio/aergo

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ConnectBlock(hs component.ICompSyncRequester, block *types.Block, ...) error
func FetchTXs(hs component.ICompSyncRequester, maxBlockBodySize uint32) []types.Transaction
func GetBestBlock(hs component.ICompSyncRequester) *types.Block
func Lock()
func LockNonblock() error
func MaxBlockBodySize() uint32
func SyncChain(hs *component.ComponentHub, targetHash []byte, targetNo types.BlockNo, ...) error
func Unlock()
type BlockGenerator
- func NewBlockGenerator(hs component.ICompSyncRequester, ctx context.Context, ...) *BlockGenerator
- func (g *BlockGenerator) GatherTXs() ([]types.Transaction, error)
- func (g *BlockGenerator) GenerateBlock() (*types.Block, error)
- func (g *BlockGenerator) Rejected() *RejTxInfo
- func (g *BlockGenerator) SetNoTTE(noTTE bool) *BlockGenerator
- func (g *BlockGenerator) SetTimeoutTx(tx types.Transaction)
- func (g *BlockGenerator) WithDeco(fn FetchDeco) *BlockGenerator
type ErrBlockConnect
- func (e ErrBlockConnect) Error() string
type ErrTimeout
- func (e ErrTimeout) Error() string
type FetchDeco
type FetchFn
type RejTxInfo
- func (r *RejTxInfo) Evictable() bool
- func (r *RejTxInfo) Hash() []byte
- func (r *RejTxInfo) Tx() types.Transaction
type TxOp
- func NewCompTxOp(fn ...TxOp) TxOp
type TxOpFn
- func (f TxOpFn) Apply(bState *state.BlockState, tx types.Transaction) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrQuit indicates that shutdown is initiated.
	ErrQuit       = errors.New("shutdown initiated")
	ErrBlockEmpty = errors.New("no transactions in block")
	ErrSyncChain  = errors.New("failed to sync request")
)

View Source

var (
	// ErrBestBlock indicates that the best block is being changed in
	// chainservice soon.
	ErrBestBlock = errors.New("best block changed in chainservice")
)

Functions ¶

func ConnectBlock ¶

func ConnectBlock(hs component.ICompSyncRequester, block *types.Block, blockState *state.BlockState, timeout time.Duration) error

ConnectBlock send an AddBlock request to the chain service. This method is called only when this node produced a block.

func FetchTXs ¶

func FetchTXs(hs component.ICompSyncRequester, maxBlockBodySize uint32) []types.Transaction

FetchTXs requests to mempool and returns types.Tx array.

func GetBestBlock ¶

func GetBestBlock(hs component.ICompSyncRequester) *types.Block

GetBestBlock returns the current best block from chainservice

func Lock ¶

func Lock()

Lock acquires the chain lock in a blocking mode.

func LockNonblock ¶

func LockNonblock() error

LockNonblock acquires the chain lock in a non-blocking mode. It returns ErrBestBlock upon failure.

func MaxBlockBodySize ¶

func MaxBlockBodySize() uint32

MaxBlockBodySize returns the maximum block body size.

func SyncChain ¶

func SyncChain(hs *component.ComponentHub, targetHash []byte, targetNo types.BlockNo, peerID types.PeerID) error

func Unlock ¶

func Unlock()

Unlock release the chain lock.

Types ¶

type BlockGenerator ¶

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

func NewBlockGenerator ¶

func NewBlockGenerator(hs component.ICompSyncRequester, ctx context.Context, bi *types.BlockHeaderInfo, bState *state.BlockState, txOp TxOp, skipEmpty bool) *BlockGenerator

func (*BlockGenerator) GatherTXs ¶

func (g *BlockGenerator) GatherTXs() ([]types.Transaction, error)

GatherTXs returns transactions from txIn. The selection is done by applying txDo.

func (*BlockGenerator) GenerateBlock ¶

func (g *BlockGenerator) GenerateBlock() (*types.Block, error)

GenerateBlock generate & return a new block.

func (*BlockGenerator) Rejected ¶

func (g *BlockGenerator) Rejected() *RejTxInfo

func (*BlockGenerator) SetNoTTE ¶

func (g *BlockGenerator) SetNoTTE(noTTE bool) *BlockGenerator

func (*BlockGenerator) SetTimeoutTx ¶

func (g *BlockGenerator) SetTimeoutTx(tx types.Transaction)

SetTimeoutTx set bState.timeoutTx to tx.

func (*BlockGenerator) WithDeco ¶

func (g *BlockGenerator) WithDeco(fn FetchDeco) *BlockGenerator

type ErrBlockConnect ¶

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

ErrBlockConnect indicates a error indicating a failed block connected request.

func (ErrBlockConnect) Error ¶

func (e ErrBlockConnect) Error() string

type ErrTimeout ¶

type ErrTimeout struct {
	Kind    string
	Timeout int64
}

ErrTimeout can be used to indicate for any kind of timeout.

func (ErrTimeout) Error ¶

func (e ErrTimeout) Error() string

type FetchDeco ¶

type FetchDeco = func(FetchFn) FetchFn

type FetchFn ¶

type FetchFn = func(component.ICompSyncRequester, uint32) []types.Transaction

type RejTxInfo ¶

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

func (*RejTxInfo) Evictable ¶

func (r *RejTxInfo) Evictable() bool

func (*RejTxInfo) Hash ¶

func (r *RejTxInfo) Hash() []byte

func (*RejTxInfo) Tx ¶

func (r *RejTxInfo) Tx() types.Transaction

type TxOp ¶

type TxOp interface {
	Apply(bState *state.BlockState, tx types.Transaction) error
}

TxOp is an interface used by GatherTXs for apply some transaction related operation.

func NewCompTxOp ¶

func NewCompTxOp(fn ...TxOp) TxOp

NewCompTxOp returns a function which applies each function in fn.

type TxOpFn ¶

type TxOpFn func(bState *state.BlockState, tx types.Transaction) error

TxOpFn is the type of arguments for CompositeTxDo.

func (TxOpFn) Apply ¶

func (f TxOpFn) Apply(bState *state.BlockState, tx types.Transaction) error

Apply applies f to tx.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL