pbsubstreamsrpcconnect

Documentation

Index

• Constants
• func NewStreamHandler(svc StreamHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type StreamClient
  • func NewStreamClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) StreamClient
• type StreamHandler
• type UnimplementedStreamHandler
  • func (UnimplementedStreamHandler) Blocks(context.Context, *connect.Request[v2.Request], ...) error

Constants

const (
	// StreamBlocksProcedure is the fully-qualified name of the Stream's Blocks RPC.
	StreamBlocksProcedure = "/sf.substreams.rpc.v2.Stream/Blocks"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

const (
	// StreamName is the fully-qualified name of the Stream service.
	StreamName = "sf.substreams.rpc.v2.Stream"
)

Functions

func NewStreamHandler

func NewStreamHandler(svc StreamHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewStreamHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type StreamClient

type StreamClient interface {
	Blocks(context.Context, *connect.Request[v2.Request]) (*connect.ServerStreamForClient[v2.Response], error)
}

StreamClient is a client for the sf.substreams.rpc.v2.Stream service.

func NewStreamClient

func NewStreamClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) StreamClient

NewStreamClient constructs a client for the sf.substreams.rpc.v2.Stream service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type StreamHandler

type StreamHandler interface {
	Blocks(context.Context, *connect.Request[v2.Request], *connect.ServerStream[v2.Response]) error
}

StreamHandler is an implementation of the sf.substreams.rpc.v2.Stream service.

type UnimplementedStreamHandler

type UnimplementedStreamHandler struct{}

UnimplementedStreamHandler returns CodeUnimplemented from all methods.

func (UnimplementedStreamHandler) Blocks

func (UnimplementedStreamHandler) Blocks(context.Context, *connect.Request[v2.Request], *connect.ServerStream[v2.Response]) error