Documentation
¶
Overview ¶
Package rpc implements accepting transactions into the system. It implements a subset of the Observation API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Backend ¶
type Backend interface {
// ProcessTransaction handles validating and ingesting a new transaction,
// ultimately for inclusion in a future collection.
ProcessTransaction(*flow.TransactionBody) error
}
Backend defines the core functionality required by the RPC API.
type Config ¶
type Config struct {
ListenAddr string
MaxRequestMsgSize uint // in bytes
MaxResponseMsgSize uint // in bytes
RpcMetricsEnabled bool // enable GRPC metrics
// holds value of deprecated MaxMsgSize flag for use during bootstrapping.
// will be removed in a future release.
DeprecatedMaxMsgSize uint // in bytes
}
Config defines the configurable options for the ingress server.
type Engine ¶
type Engine struct {
// contains filtered or unexported fields
}
Engine implements a gRPC server with a simplified version of the Observation API to enable receiving transactions into the system.
func New ¶
func New( config Config, backend Backend, log zerolog.Logger, chainID flow.ChainID, apiRatelimits map[string]int, apiBurstLimits map[string]int, ) *Engine
New returns a new ingress server.
Click to show internal directories.
Click to hide internal directories.