app

Documentation

Index

• type InfoServer
• type InfoServerWrapper
  • func (i *InfoServerWrapper) Info(ctx context.Context, req *connect.Request[pbfirehose.InfoRequest]) (*connect.Response[pbfirehose.InfoResponse], error)
• type Tier1App
  • func NewTier1(logger *zap.Logger, config *Tier1Config, modules *Tier1Modules) *Tier1App
  • func (a *Tier1App) HealthCheck(ctx context.Context) (bool, interface{}, error)
  • func (a *Tier1App) IsReady(ctx context.Context) bool
  • func (a *Tier1App) Run() error
• type Tier1Config
  • func (config *Tier1Config) Validate() error
• type Tier1Modules
• type Tier2App
  • func NewTier2(logger *zap.Logger, config *Tier2Config, modules *Tier2Modules) *Tier2App
  • func (a *Tier2App) HealthCheck(ctx context.Context) (bool, interface{}, error)
  • func (a *Tier2App) IsReady(ctx context.Context) bool
  • func (a *Tier2App) Run() error
• type Tier2Config
  • func (config *Tier2Config) Validate() error
• type Tier2Modules

Types

type InfoServer

type InfoServer interface {
	Init(ctx context.Context, fhub *hub.ForkableHub, mergedBlocksStore dstore.Store, oneBlockStore dstore.Store, logger *zap.Logger) error
	Info(ctx context.Context, request *pbfirehose.InfoRequest) (*pbfirehose.InfoResponse, error)
}

type InfoServerWrapper

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

func (*InfoServerWrapper) Info

func (i *InfoServerWrapper) Info(ctx context.Context, req *connect.Request[pbfirehose.InfoRequest]) (*connect.Response[pbfirehose.InfoResponse], error)

Info implements pbsubstreamsrpcconnect.EndpointInfoHandler.

type Tier1App

type Tier1App struct {
	*shutter.Shutter
	// contains filtered or unexported fields
}

func NewTier1

func NewTier1(logger *zap.Logger, config *Tier1Config, modules *Tier1Modules) *Tier1App

func (*Tier1App) HealthCheck

func (a *Tier1App) HealthCheck(ctx context.Context) (bool, interface{}, error)

func (*Tier1App) IsReady

func (a *Tier1App) IsReady(ctx context.Context) bool

IsReady return `true` if the apps is ready to accept requests, `false` is returned otherwise.

func (*Tier1App) Run

func (a *Tier1App) Run() error

type Tier1Config

type Tier1Config struct {
	MeteringConfig string

	MergedBlocksStoreURL    string
	OneBlocksStoreURL       string
	ForkedBlocksStoreURL    string
	BlockStreamAddr         string        // gRPC endpoint to get real-time blocks, can be "" in which live streams is disabled
	GRPCListenAddr          string        // gRPC address where this app will listen to
	GRPCShutdownGracePeriod time.Duration // The duration we allow for gRPC connections to terminate gracefully prior forcing shutdown
	ServiceDiscoveryURL     *url.URL
	BlockExecutionTimeout   time.Duration
	TmpDir                  string

	StateStoreURL           string
	StateStoreDefaultTag    string
	BlockType               string
	StateBundleSize         uint64
	EnforceCompression      bool // refuse incoming requests that do not accept gzip compression (ConnectRPC or GRPC)
	ActiveRequestsSoftLimit int  // maximum number of active requests a tier1 app can have with external clients before starting to advertise itself as unready in the health check
	ActiveRequestsHardLimit int  // maximum number of active requests a tier1 app can have with external clients, refuse with CodeUnavailable if reached

	MaxSubrequests       uint64
	SubrequestsEndpoint  string
	SubrequestsInsecure  bool
	SubrequestsPlaintext bool

	WASMExtensions wasm.WASMExtensioner

	Tracing bool
}

func (*Tier1Config) Validate

func (config *Tier1Config) Validate() error

Validate inspects itself to determine if the current config is valid according to substreams rules.

type Tier1Modules

type Tier1Modules struct {
	// Required dependencies
	Authenticator         dauth.Authenticator
	HeadTimeDriftMetric   *dmetrics.HeadTimeDrift
	HeadBlockNumberMetric *dmetrics.HeadBlockNum
	CheckPendingShutDown  func() bool
	InfoServer            InfoServer
}

type Tier2App

type Tier2App struct {
	*shutter.Shutter
	// contains filtered or unexported fields
}

func NewTier2

func NewTier2(logger *zap.Logger, config *Tier2Config, modules *Tier2Modules) *Tier2App

func (*Tier2App) HealthCheck

func (a *Tier2App) HealthCheck(ctx context.Context) (bool, interface{}, error)

func (*Tier2App) IsReady

func (a *Tier2App) IsReady(ctx context.Context) bool

IsReady return `true` if the apps is ready to accept requests, `false` is returned otherwise.

func (*Tier2App) Run

func (a *Tier2App) Run() error

type Tier2Config

type Tier2Config struct {
	GRPCListenAddr      string // gRPC address where this app will listen to
	ServiceDiscoveryURL *url.URL

	PipelineOptions []pipeline.Option

	MaximumConcurrentRequests uint64
	WASMExtensions            wasm.WASMExtensioner
	BlockExecutionTimeout     time.Duration
	TmpDir                    string

	Tracing bool
}

func (*Tier2Config) Validate

func (config *Tier2Config) Validate() error

Validate inspects itself to determine if the current config is valid according to substreams rules.

type Tier2Modules

type Tier2Modules struct {
	CheckPendingShutDown func() bool
}