streaming

README

Cosmos-SDK Plugins

This package contains an extensible plugin system for the Cosmos-SDK. The plugin system leverages the hashicorp/go-plugin system. This system is designed to work over RPC.

Although the go-plugin is built to work over RPC, it is currently only designed to work over a local network.

Pre requisites

For an overview of supported features by the go-plugin system, please see https://github.com/hashicorp/go-plugin. The go-plugin documentation is located here. You can also directly visit any of the links below:

• Writing plugins without Go
• Go Plugin Tutorial
• Plugin Internals
• Plugin Architecture (start here)

Exposing plugins

To expose plugins to the plugin system, you will need to:

1. Implement the gRPC message protocol service of the plugin
2. Build the plugin binary
3. Export it

Read the plugin documentation in the Streaming Plugins section for examples on how to build a plugin.

Streaming Plugins

List of support streaming plugins

• ABCI State Streaming Plugin

Documentation

Index

• Variables
• func GetPluginEnvKey(name string) string
• func NewStreamingPlugin(name, logLevel string) (interface{}, error)

Variables

var HandshakeMap = map[string]plugin.HandshakeConfig{
	"abci": streamingabci.Handshake,
}

HandshakeMap contains a map of each supported streaming's handshake config

var PluginMap = map[string]plugin.Plugin{
	"abci": &streamingabci.ListenerGRPCPlugin{},
}

PluginMap contains a map of supported gRPC plugins

Functions

func GetPluginEnvKey

func GetPluginEnvKey(name string) string

func NewStreamingPlugin

func NewStreamingPlugin(name, logLevel string) (interface{}, error)