Documentation
¶
Index ¶
- Constants
- func NewProposerVMHandler(svc ProposerVMHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type ProposerVMClient
- type ProposerVMHandler
- type UnimplementedProposerVMHandler
- func (UnimplementedProposerVMHandler) GetCurrentEpoch(context.Context, *connect.Request[proposervm.GetCurrentEpochRequest]) (*connect.Response[proposervm.GetCurrentEpochReply], error)
- func (UnimplementedProposerVMHandler) GetProposedHeight(context.Context, *connect.Request[proposervm.GetProposedHeightRequest]) (*connect.Response[proposervm.GetProposedHeightReply], error)
Constants ¶
const ( // ProposerVMGetProposedHeightProcedure is the fully-qualified name of the ProposerVM's // GetProposedHeight RPC. ProposerVMGetProposedHeightProcedure = "/proposervm.ProposerVM/GetProposedHeight" // ProposerVMGetCurrentEpochProcedure is the fully-qualified name of the ProposerVM's // GetCurrentEpoch RPC. ProposerVMGetCurrentEpochProcedure = "/proposervm.ProposerVM/GetCurrentEpoch" )
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 (
// ProposerVMName is the fully-qualified name of the ProposerVM service.
ProposerVMName = "proposervm.ProposerVM"
)
Variables ¶
This section is empty.
Functions ¶
func NewProposerVMHandler ¶
func NewProposerVMHandler(svc ProposerVMHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewProposerVMHandler 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 ProposerVMClient ¶
type ProposerVMClient interface {
// GetProposedHeight returns the P-Chain height that would be included in a
// block if it were proposed right now.
GetProposedHeight(context.Context, *connect.Request[proposervm.GetProposedHeightRequest]) (*connect.Response[proposervm.GetProposedHeightReply], error)
// GetCurrentEpoch returns the epoch that would be included in a block if it
// were proposed right now.
GetCurrentEpoch(context.Context, *connect.Request[proposervm.GetCurrentEpochRequest]) (*connect.Response[proposervm.GetCurrentEpochReply], error)
}
ProposerVMClient is a client for the proposervm.ProposerVM service.
func NewProposerVMClient ¶
func NewProposerVMClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ProposerVMClient
NewProposerVMClient constructs a client for the proposervm.ProposerVM 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 ProposerVMHandler ¶
type ProposerVMHandler interface {
// GetProposedHeight returns the P-Chain height that would be included in a
// block if it were proposed right now.
GetProposedHeight(context.Context, *connect.Request[proposervm.GetProposedHeightRequest]) (*connect.Response[proposervm.GetProposedHeightReply], error)
// GetCurrentEpoch returns the epoch that would be included in a block if it
// were proposed right now.
GetCurrentEpoch(context.Context, *connect.Request[proposervm.GetCurrentEpochRequest]) (*connect.Response[proposervm.GetCurrentEpochReply], error)
}
ProposerVMHandler is an implementation of the proposervm.ProposerVM service.
type UnimplementedProposerVMHandler ¶
type UnimplementedProposerVMHandler struct{}
UnimplementedProposerVMHandler returns CodeUnimplemented from all methods.
func (UnimplementedProposerVMHandler) GetCurrentEpoch ¶
func (UnimplementedProposerVMHandler) GetCurrentEpoch(context.Context, *connect.Request[proposervm.GetCurrentEpochRequest]) (*connect.Response[proposervm.GetCurrentEpochReply], error)
func (UnimplementedProposerVMHandler) GetProposedHeight ¶
func (UnimplementedProposerVMHandler) GetProposedHeight(context.Context, *connect.Request[proposervm.GetProposedHeightRequest]) (*connect.Response[proposervm.GetProposedHeightReply], error)
Source Files