client

Documentation

Overview

Package client implements client.

Index

• type Client
  • func New(cfg Config) (Client, error)
• type Config
• type Op
• type OpOption
  • func WithCustomNodeConfigs(customNodeConfigs map[string]string) OpOption
  • func WithCustomVMs(customVMs map[string]string) OpOption
  • func WithExecPath(execPath string) OpOption
  • func WithGlobalNodeConfig(nodeConfig string) OpOption
  • func WithLogLevel(logLevel string) OpOption
  • func WithNumNodes(numNodes uint32) OpOption
  • func WithPluginDir(pluginDir string) OpOption
  • func WithRootDataDir(rootDataDir string) OpOption
  • func WithWhitelistedSubnets(whitelistedSubnets string) OpOption

Types

type Client

type Client interface {
	Ping(ctx context.Context) (*rpcpb.PingResponse, error)
	Start(ctx context.Context, execPath string, opts ...OpOption) (*rpcpb.StartResponse, error)
	Health(ctx context.Context) (*rpcpb.HealthResponse, error)
	URIs(ctx context.Context) ([]string, error)
	Status(ctx context.Context) (*rpcpb.StatusResponse, error)
	StreamStatus(ctx context.Context, pushInterval time.Duration) (<-chan *rpcpb.ClusterInfo, error)
	RemoveNode(ctx context.Context, name string) (*rpcpb.RemoveNodeResponse, error)
	RestartNode(ctx context.Context, name string, opts ...OpOption) (*rpcpb.RestartNodeResponse, error)
	AddNode(ctx context.Context, name string, execPath string, opts ...OpOption) (*rpcpb.AddNodeResponse, error)
	Stop(ctx context.Context) (*rpcpb.StopResponse, error)
	AttachPeer(ctx context.Context, nodeName string) (*rpcpb.AttachPeerResponse, error)
	SendOutboundMessage(ctx context.Context, nodeName string, peerID string, op uint32, msgBody []byte) (*rpcpb.SendOutboundMessageResponse, error)
	Close() error
}

func New

func New(cfg Config) (Client, error)

type Config

type Config struct {
	LogLevel    string
	Endpoint    string
	DialTimeout time.Duration
}

type Op

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

type OpOption

type OpOption func(*Op)

func WithCustomNodeConfigs

func WithCustomNodeConfigs(customNodeConfigs map[string]string) OpOption

Map from node name to its custom node config

func WithCustomVMs

func WithCustomVMs(customVMs map[string]string) OpOption

Map from VM name to its genesis path.

func WithExecPath

func WithExecPath(execPath string) OpOption

func WithGlobalNodeConfig

func WithGlobalNodeConfig(nodeConfig string) OpOption

func WithLogLevel

func WithLogLevel(logLevel string) OpOption

func WithNumNodes

func WithNumNodes(numNodes uint32) OpOption

func WithPluginDir

func WithPluginDir(pluginDir string) OpOption

func WithRootDataDir

func WithRootDataDir(rootDataDir string) OpOption

func WithWhitelistedSubnets

func WithWhitelistedSubnets(whitelistedSubnets string) OpOption