55 lines
1.9 KiB
Go
55 lines
1.9 KiB
Go
// Package abci contains shared data between the host and plugins.
|
|
package streaming
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/hashicorp/go-plugin"
|
|
"google.golang.org/grpc"
|
|
)
|
|
|
|
// Listener is the interface that we're exposing as a streaming service.
|
|
// It hooks into the ABCI message processing of the BaseApp.
|
|
// The error results are propagated to consensus state machine,
|
|
// if you don't want to affect consensus, handle the errors internally and always return `nil` in these APIs.
|
|
type Listener interface {
|
|
// ListenDeliverBlock updates the streaming service with the latest Delivered Block messages
|
|
ListenDeliverBlock(context.Context, ListenDeliverBlockRequest) error
|
|
// ListenCommit updates the steaming service with the latest Commit messages and state changes
|
|
ListenStateChanges(ctx context.Context, changeSet []*StoreKVPair) error
|
|
}
|
|
|
|
// Handshake is a common handshake that is shared by streaming and host.
|
|
// This prevents users from executing bad plugins or executing a plugin
|
|
// directory. It is a UX feature, not a security feature.
|
|
var Handshake = plugin.HandshakeConfig{
|
|
// This isn't required when using VersionedPlugins
|
|
ProtocolVersion: 1,
|
|
MagicCookieKey: "ABCI_LISTENER_PLUGIN",
|
|
MagicCookieValue: "ef78114d-7bdf-411c-868f-347c99a78345",
|
|
}
|
|
|
|
var _ plugin.GRPCPlugin = (*ListenerGRPCPlugin)(nil)
|
|
|
|
// ListenerGRPCPlugin is the implementation of plugin.GRPCPlugin, so we can serve/consume this.
|
|
type ListenerGRPCPlugin struct {
|
|
// GRPCPlugin must still implement the Plugin interface
|
|
plugin.Plugin
|
|
// Concrete implementation, written in Go. This is only used for plugins
|
|
// that are written in Go.
|
|
Impl Listener
|
|
}
|
|
|
|
func (p *ListenerGRPCPlugin) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error {
|
|
RegisterListenerServiceServer(s, &GRPCServer{Impl: p.Impl})
|
|
return nil
|
|
}
|
|
|
|
func (p *ListenerGRPCPlugin) GRPCClient(
|
|
_ context.Context,
|
|
_ *plugin.GRPCBroker,
|
|
c *grpc.ClientConn,
|
|
) (interface{}, error) {
|
|
return &GRPCClient{client: NewListenerServiceClient(c)}, nil
|
|
}
|