state

Documentation

Index

• func IsInvalidExtensionError(err error) bool
• func IsNoValidChildBlockError(err error) bool
• func IsOutdatedExtensionError(err error) bool
• func NewInvalidExtensionError(msg string) error
• func NewInvalidExtensionErrorf(msg string, args ...interface{}) error
• func NewNoValidChildBlockError(msg string) error
• func NewNoValidChildBlockErrorf(msg string, args ...interface{}) error
• func NewOutdatedExtensionError(msg string) error
• func NewOutdatedExtensionErrorf(msg string, args ...interface{}) error
• func TraverseBackward(headers storage.Headers, startBlockID flow.Identifier, visitor onVisitBlock, ...) error
• func TraverseForward(headers storage.Headers, forkHead flow.Identifier, visitor onVisitBlock, ...) error
• type InvalidExtensionError
  • func (e InvalidExtensionError) Error() string
  • func (e InvalidExtensionError) Unwrap() error
• type NoValidChildBlockError
  • func (e NoValidChildBlockError) Error() string
  • func (e NoValidChildBlockError) Unwrap() error
• type OutdatedExtensionError
  • func (e OutdatedExtensionError) Error() string
  • func (e OutdatedExtensionError) Unwrap() error

Functions

func IsInvalidExtensionError

func IsInvalidExtensionError(err error) bool

IsInvalidExtensionError returns whether the given error is an InvalidExtensionError error

func IsNoValidChildBlockError

func IsNoValidChildBlockError(err error) bool

func IsOutdatedExtensionError

func IsOutdatedExtensionError(err error) bool

func NewInvalidExtensionError

func NewInvalidExtensionError(msg string) error

func NewInvalidExtensionErrorf

func NewInvalidExtensionErrorf(msg string, args ...interface{}) error

func NewNoValidChildBlockError

func NewNoValidChildBlockError(msg string) error

func NewNoValidChildBlockErrorf

func NewNoValidChildBlockErrorf(msg string, args ...interface{}) error

func NewOutdatedExtensionError

func NewOutdatedExtensionError(msg string) error

func NewOutdatedExtensionErrorf

func NewOutdatedExtensionErrorf(msg string, args ...interface{}) error

func TraverseBackward

func TraverseBackward(headers storage.Headers, startBlockID flow.Identifier, visitor onVisitBlock, shouldVisitParent shouldVisitParent) error

TraverseBackward traverses a chain segment beginning with the start block (inclusive) Blocks are traversed in reverse height order, meaning the end block must be an ancestor of the start block. The callback is called for each block in this segment. Return value of callback is used to decide if it should continue or not.

func TraverseForward

func TraverseForward(headers storage.Headers,
	forkHead flow.Identifier,
	visitor onVisitBlock,
	shouldVisitParent shouldVisitParent,
) error

TraverseForward traverses a chain segment in forward order. The algorithm starts at the `forkHead` and walks the chain backwards towards the genesis block. The descend continues as long as `shouldVisitParent` returns true. Starting with the first block where `shouldVisitParent` returned false, the visited blocks are fed into `visitor` in a forward order (order of increasing height). The last block that is fed into `visitor` is `forkHead`.

Types

type InvalidExtensionError

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

InvalidExtensionError is an error for invalid extension of the state

func (InvalidExtensionError) Error

func (e InvalidExtensionError) Error() string

func (InvalidExtensionError) Unwrap

func (e InvalidExtensionError) Unwrap() error

type NoValidChildBlockError

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

NoValidChildBlockError is a sentinel error when the case where a certain block has no valid child.

func (NoValidChildBlockError) Error

func (e NoValidChildBlockError) Error() string

func (NoValidChildBlockError) Unwrap

func (e NoValidChildBlockError) Unwrap() error

type OutdatedExtensionError

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

OutdatedExtensionError is an error for the extension of the state being outdated. Being outdated doesn't mean it's invalid or not. Knowing whether an outdated extension is an invalid extension or not would take more state queries.

func (OutdatedExtensionError) Error

func (e OutdatedExtensionError) Error() string

func (OutdatedExtensionError) Unwrap

func (e OutdatedExtensionError) Unwrap() error