state_stream

Documentation

Index

• type API
• type Config
• type Engine
  • func NewEng(config Config, execDataStore execution_data.ExecutionDataStore, ...) *Engine
• type Handler
  • func NewHandler(api API, chain flow.Chain, options ...HandlerOption) *Handler
  • func (h *Handler) GetExecutionDataByBlockID(ctx context.Context, request *access.GetExecutionDataByBlockIDRequest) (*access.GetExecutionDataByBlockIDResponse, error)
• type HandlerOption
• type StateStreamBackend
  • func New(headers storage.Headers, seals storage.Seals, results storage.ExecutionResults, ...) *StateStreamBackend
  • func (s *StateStreamBackend) GetExecutionDataByBlockID(ctx context.Context, blockID flow.Identifier) (*entities.BlockExecutionData, error)

Types

type API

type API interface {
	GetExecutionDataByBlockID(ctx context.Context, blockID flow.Identifier) (*entities.BlockExecutionData, error)
}

type Config

type Config struct {
	ListenAddr              string
	MaxExecutionDataMsgSize int  // in bytes
	RpcMetricsEnabled       bool // enable GRPC metrics
}

Config defines the configurable options for the ingress server.

type Engine

type Engine struct {
	*component.ComponentManager
	// contains filtered or unexported fields
}

Engine exposes the server with the state stream API. By default, this engine is not enabled. In order to run this engine a port for the GRPC server to be served on should be specified in the run config.

func NewEng

func NewEng(
	config Config,
	execDataStore execution_data.ExecutionDataStore,
	headers storage.Headers,
	seals storage.Seals,
	results storage.ExecutionResults,
	log zerolog.Logger,
	chainID flow.ChainID,
	apiRatelimits map[string]int,
	apiBurstLimits map[string]int,
) *Engine

New returns a new ingress server.

type Handler

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

func NewHandler

func NewHandler(api API, chain flow.Chain, options ...HandlerOption) *Handler

func (*Handler) GetExecutionDataByBlockID

func (h *Handler) GetExecutionDataByBlockID(ctx context.Context, request *access.GetExecutionDataByBlockIDRequest) (*access.GetExecutionDataByBlockIDResponse, error)

type HandlerOption

type HandlerOption func(*Handler)

HandlerOption is used to hand over optional constructor parameters

type StateStreamBackend

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

func New

func New(
	headers storage.Headers,
	seals storage.Seals,
	results storage.ExecutionResults,
	execDataStore execution_data.ExecutionDataStore,
) *StateStreamBackend

func (*StateStreamBackend) GetExecutionDataByBlockID

func (s *StateStreamBackend) GetExecutionDataByBlockID(ctx context.Context, blockID flow.Identifier) (*entities.BlockExecutionData, error)