engine

Documentation

Index

• func ApplyDBlock(ctx context.Context, c *factom.Client, h uint32, state State) error
• func ApplyPendingEntries(ctx context.Context, c *factom.Client, state State) error
• func Get(ctx context.Context, chainID *factom.Bytes32, includePending bool) (state.Chain, func(), error)
• func GetSyncStatus() (sync, current uint32)
• func IssuedIDs() []*factom.Bytes32
• func Start(ctx context.Context, c *factom.Client) (done <-chan struct{})
• func TrackedIDs() []*factom.Bytes32
• type State

Functions

func ApplyDBlock

func ApplyDBlock(ctx context.Context, c *factom.Client, h uint32, state State) error

func ApplyPendingEntries

func ApplyPendingEntries(ctx context.Context, c *factom.Client, state State) error

func Get

func Get(ctx context.Context, chainID *factom.Bytes32, includePending bool) (
	state.Chain, func(), error)

func GetSyncStatus

func GetSyncStatus() (sync, current uint32)

GetSyncStatus is a threadsafe way to get the sync height and current Factom Blockchain height.

func IssuedIDs

func IssuedIDs() []*factom.Bytes32

func Start

func Start(ctx context.Context, c *factom.Client) (done <-chan struct{})

Start launches the main engine goroutine, which loads state and starts the worker goroutines. If stop is closed or if an error occurs, the engine will finish processing the current DBlock, cleanup and close state, all goroutines will exit, and done will be closed. If the done channel is closed before the stop channel is closed, an error occurred.

func TrackedIDs

func TrackedIDs() []*factom.Bytes32

Types

type State

type State interface {
	ApplyEBlock(context.Context, *factom.Bytes32, factom.EBlock) error
	ApplyPendingEntries(context.Context, []factom.Entry) error
	SetSync(context.Context, uint32, *factom.Bytes32) error
	GetSync() uint32
	TrackedIDs() []*factom.Bytes32
	IssuedIDs() []*factom.Bytes32
	Get(context.Context, *factom.Bytes32, bool) (state.Chain, func(), error)
	Close()
}