rpcchainvm

Documentation

Index

• Variables
• type BlockClient
  • func (b *BlockClient) Accept() error
  • func (b *BlockClient) Bytes() []byte
  • func (b *BlockClient) Height() uint64
  • func (b *BlockClient) ID() ids.ID
  • func (b *BlockClient) Parent() snowman.Block
  • func (b *BlockClient) Reject() error
  • func (b *BlockClient) Status() choices.Status
  • func (b *BlockClient) Verify() error
• type Factory
  • func (f *Factory) New(ctx *snow.Context) (interface{}, error)
• type Plugin
  • func New(vm block.ChainVM) *Plugin
  • func (p *Plugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *Plugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
• type VMClient
  • func NewClient(client vmproto.VMClient, broker *plugin.GRPCBroker) *VMClient
  • func (vm *VMClient) Bootstrapped() error
  • func (vm *VMClient) Bootstrapping() error
  • func (vm *VMClient) BuildBlock() (snowman.Block, error)
  • func (vm *VMClient) CreateHandlers() (map[string]*common.HTTPHandler, error)
  • func (vm *VMClient) GetBlock(id ids.ID) (snowman.Block, error)
  • func (vm *VMClient) HealthCheck() (interface{}, error)
  • func (vm *VMClient) Initialize(ctx *snow.Context, db database.Database, genesisBytes []byte, ...) error
  • func (vm *VMClient) LastAccepted() (ids.ID, error)
  • func (vm *VMClient) ParseBlock(bytes []byte) (snowman.Block, error)
  • func (vm *VMClient) SetPreference(id ids.ID) error
  • func (vm *VMClient) SetProcess(proc *plugin.Client)
  • func (vm *VMClient) Shutdown() error
• type VMServer
  • func NewServer(vm block.ChainVM, broker *plugin.GRPCBroker) *VMServer
  • func (vm *VMServer) BlockAccept(_ context.Context, req *vmproto.BlockAcceptRequest) (*vmproto.BlockAcceptResponse, error)
  • func (vm *VMServer) BlockReject(_ context.Context, req *vmproto.BlockRejectRequest) (*vmproto.BlockRejectResponse, error)
  • func (vm *VMServer) BlockVerify(_ context.Context, req *vmproto.BlockVerifyRequest) (*vmproto.BlockVerifyResponse, error)
  • func (vm *VMServer) Bootstrapped(context.Context, *vmproto.BootstrappedRequest) (*vmproto.BootstrappedResponse, error)
  • func (vm *VMServer) Bootstrapping(context.Context, *vmproto.BootstrappingRequest) (*vmproto.BootstrappingResponse, error)
  • func (vm *VMServer) BuildBlock(_ context.Context, _ *vmproto.BuildBlockRequest) (*vmproto.BuildBlockResponse, error)
  • func (vm *VMServer) CreateHandlers(_ context.Context, req *vmproto.CreateHandlersRequest) (*vmproto.CreateHandlersResponse, error)
  • func (vm *VMServer) GetBlock(_ context.Context, req *vmproto.GetBlockRequest) (*vmproto.GetBlockResponse, error)
  • func (vm *VMServer) Health(_ context.Context, req *vmproto.HealthRequest) (*vmproto.HealthResponse, error)
  • func (vm *VMServer) Initialize(_ context.Context, req *vmproto.InitializeRequest) (*vmproto.InitializeResponse, error)
  • func (vm *VMServer) ParseBlock(_ context.Context, req *vmproto.ParseBlockRequest) (*vmproto.ParseBlockResponse, error)
  • func (vm *VMServer) SetPreference(_ context.Context, req *vmproto.SetPreferenceRequest) (*vmproto.SetPreferenceResponse, error)
  • func (vm *VMServer) Shutdown(context.Context, *vmproto.ShutdownRequest) (*vmproto.ShutdownResponse, error)

Variables

var Handshake = plugin.HandshakeConfig{
	ProtocolVersion:  1,
	MagicCookieKey:   "VM_PLUGIN",
	MagicCookieValue: "dynamic",
}

Handshake is a common handshake that is shared by plugin and host.

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

PluginMap is the map of plugins we can dispense.

Types

type BlockClient

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

BlockClient is an implementation of Block that talks over RPC.

func (*BlockClient) Accept

func (b *BlockClient) Accept() error

func (*BlockClient) Bytes

func (b *BlockClient) Bytes() []byte

func (*BlockClient) Height

func (b *BlockClient) Height() uint64

func (*BlockClient) ID

func (b *BlockClient) ID() ids.ID

func (*BlockClient) Parent

func (b *BlockClient) Parent() snowman.Block

func (*BlockClient) Reject

func (b *BlockClient) Reject() error

func (*BlockClient) Status

func (b *BlockClient) Status() choices.Status

func (*BlockClient) Verify

func (b *BlockClient) Verify() error

type Factory

type Factory struct {
	Path   string
	Config string
}

Factory ...

func (*Factory) New

func (f *Factory) New(ctx *snow.Context) (interface{}, error)

New ...

type Plugin

type Plugin struct {
	plugin.NetRPCUnsupportedPlugin
	// contains filtered or unexported fields
}

Plugin is the implementation of plugin.Plugin so we can serve/consume this. We also implement GRPCPlugin so that this plugin can be served over gRPC.

func New

func New(vm block.ChainVM) *Plugin

New creates a new plugin from the provided VM

func (*Plugin) GRPCClient

func (p *Plugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

GRPCClient returns a new GRPC client

func (*Plugin) GRPCServer

func (p *Plugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

GRPCServer registers a new GRPC server.

type VMClient

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

VMClient is an implementation of VM that talks over RPC.

func NewClient

func NewClient(client vmproto.VMClient, broker *plugin.GRPCBroker) *VMClient

NewClient returns a VM connected to a remote VM

func (*VMClient) Bootstrapped

func (vm *VMClient) Bootstrapped() error

func (*VMClient) Bootstrapping

func (vm *VMClient) Bootstrapping() error

func (*VMClient) BuildBlock

func (vm *VMClient) BuildBlock() (snowman.Block, error)

func (*VMClient) CreateHandlers

func (vm *VMClient) CreateHandlers() (map[string]*common.HTTPHandler, error)

func (*VMClient) GetBlock

func (vm *VMClient) GetBlock(id ids.ID) (snowman.Block, error)

func (*VMClient) HealthCheck

func (vm *VMClient) HealthCheck() (interface{}, error)

func (*VMClient) Initialize

func (vm *VMClient) Initialize(
	ctx *snow.Context,
	db database.Database,
	genesisBytes []byte,
	toEngine chan<- common.Message,
	fxs []*common.Fx,
) error

func (*VMClient) LastAccepted

func (vm *VMClient) LastAccepted() (ids.ID, error)

func (*VMClient) ParseBlock

func (vm *VMClient) ParseBlock(bytes []byte) (snowman.Block, error)

func (*VMClient) SetPreference

func (vm *VMClient) SetPreference(id ids.ID) error

func (*VMClient) SetProcess

func (vm *VMClient) SetProcess(proc *plugin.Client)

SetProcess gives ownership of the server process to the client.

func (*VMClient) Shutdown

func (vm *VMClient) Shutdown() error

type VMServer

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

VMServer is a VM that is managed over RPC.

func NewServer

func NewServer(vm block.ChainVM, broker *plugin.GRPCBroker) *VMServer

NewServer returns a vm instance connected to a remote vm instance

func (*VMServer) BlockAccept

func (vm *VMServer) BlockAccept(_ context.Context, req *vmproto.BlockAcceptRequest) (*vmproto.BlockAcceptResponse, error)

func (*VMServer) BlockReject

func (vm *VMServer) BlockReject(_ context.Context, req *vmproto.BlockRejectRequest) (*vmproto.BlockRejectResponse, error)

func (*VMServer) BlockVerify

func (vm *VMServer) BlockVerify(_ context.Context, req *vmproto.BlockVerifyRequest) (*vmproto.BlockVerifyResponse, error)

func (*VMServer) Bootstrapped

func (vm *VMServer) Bootstrapped(context.Context, *vmproto.BootstrappedRequest) (*vmproto.BootstrappedResponse, error)

func (*VMServer) Bootstrapping

func (vm *VMServer) Bootstrapping(context.Context, *vmproto.BootstrappingRequest) (*vmproto.BootstrappingResponse, error)

func (*VMServer) BuildBlock

func (vm *VMServer) BuildBlock(_ context.Context, _ *vmproto.BuildBlockRequest) (*vmproto.BuildBlockResponse, error)

func (*VMServer) CreateHandlers

func (vm *VMServer) CreateHandlers(_ context.Context, req *vmproto.CreateHandlersRequest) (*vmproto.CreateHandlersResponse, error)

func (*VMServer) GetBlock

func (vm *VMServer) GetBlock(_ context.Context, req *vmproto.GetBlockRequest) (*vmproto.GetBlockResponse, error)

func (*VMServer) Health

func (vm *VMServer) Health(_ context.Context, req *vmproto.HealthRequest) (*vmproto.HealthResponse, error)

func (*VMServer) Initialize

func (vm *VMServer) Initialize(_ context.Context, req *vmproto.InitializeRequest) (*vmproto.InitializeResponse, error)

func (*VMServer) ParseBlock

func (vm *VMServer) ParseBlock(_ context.Context, req *vmproto.ParseBlockRequest) (*vmproto.ParseBlockResponse, error)

func (*VMServer) SetPreference

func (vm *VMServer) SetPreference(_ context.Context, req *vmproto.SetPreferenceRequest) (*vmproto.SetPreferenceResponse, error)

func (*VMServer) Shutdown

func (vm *VMServer) Shutdown(context.Context, *vmproto.ShutdownRequest) (*vmproto.ShutdownResponse, error)