mirror of
https://github.com/luxfi/vm.git
synced 2026-10-30 15:13:40 +00:00
zeekay
cc4204d39b
Add all missing ZAP server handlers: WaitForEvent, BatchedParseBlock, GetAncestors, Connected, Disconnected, GetBlockIDAtHeight, NewHTTPHandler. Use persistent BadgerDB for plugin-local storage, add block caching to prevent timestamp drift during consensus, and refactor State type to canonical vm.State. Update dependencies.
100 lines
3.1 KiB
Go
100 lines
3.1 KiB
Go
// Copyright (C) 2019-2025, Lux Industries, Inc. All rights reserved.
|
|
// See the file LICENSE for licensing terms.
|
|
|
|
// Package base provides the common RPC infrastructure for all VM shapes.
|
|
// This includes the shared operations that all VMs support regardless of
|
|
// whether they are chain-based (linear blocks), DAG-based (vertices), or
|
|
// other shapes.
|
|
package base
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
|
|
"github.com/luxfi/ids"
|
|
"github.com/luxfi/vm"
|
|
)
|
|
|
|
// VM defines the common interface that all VM shapes must implement.
|
|
// This is the base layer shared by ChainVM, DAGVM, and other shapes.
|
|
type VM interface {
|
|
// Initialize initializes the VM with the provided context, database,
|
|
// and configuration. The interface{} types allow flexibility for
|
|
// shape-specific implementations.
|
|
Initialize(
|
|
ctx context.Context,
|
|
vmCtx interface{},
|
|
db interface{},
|
|
genesisBytes []byte,
|
|
upgradeBytes []byte,
|
|
configBytes []byte,
|
|
msgChan interface{},
|
|
fxs []interface{},
|
|
sender interface{},
|
|
) error
|
|
|
|
// Shutdown gracefully shuts down the VM
|
|
Shutdown(context.Context) error
|
|
|
|
// SetState sets the VM's operational state.
|
|
// State values are defined in github.com/luxfi/vm (vm.State).
|
|
SetState(context.Context, vm.State) error
|
|
|
|
// Version returns the VM's version string
|
|
Version(context.Context) (string, error)
|
|
|
|
// Connected is called when a node connects
|
|
Connected(ctx context.Context, nodeID ids.NodeID, version interface{}) error
|
|
|
|
// Disconnected is called when a node disconnects
|
|
Disconnected(ctx context.Context, nodeID ids.NodeID) error
|
|
|
|
// HealthCheck returns the VM's health status
|
|
HealthCheck(context.Context) (interface{}, error)
|
|
|
|
// LastAccepted returns the ID of the last accepted block/vertex
|
|
LastAccepted(context.Context) (ids.ID, error)
|
|
}
|
|
|
|
// State is the canonical VM lifecycle state from the root vm package.
|
|
// Kept as an alias for backward compatibility.
|
|
type State = vm.State
|
|
|
|
// HTTPHandler provides HTTP handler creation capability
|
|
type HTTPHandler interface {
|
|
// NewHTTPHandler creates a new HTTP handler for the VM's API
|
|
NewHTTPHandler(context.Context) (http.Handler, error)
|
|
}
|
|
|
|
// Gatherer provides metrics gathering capability
|
|
type Gatherer interface {
|
|
// Gather returns the VM's metrics
|
|
Gather() ([]*MetricFamily, error)
|
|
}
|
|
|
|
// MetricFamily represents a family of metrics (placeholder for actual type)
|
|
type MetricFamily struct {
|
|
Name string
|
|
Help string
|
|
Type string
|
|
Metrics []interface{}
|
|
}
|
|
|
|
// NetworkCallbacks provides network event callbacks
|
|
type NetworkCallbacks interface {
|
|
Connected(ctx context.Context, nodeID ids.NodeID, version interface{}) error
|
|
Disconnected(ctx context.Context, nodeID ids.NodeID) error
|
|
}
|
|
|
|
// AppHandler handles application-level messages (e.g., Warp messages)
|
|
type AppHandler interface {
|
|
// Request handles an application request
|
|
Request(ctx context.Context, nodeID ids.NodeID, requestID uint32, deadline interface{}, request []byte) ([]byte, error)
|
|
|
|
// Response handles an application response
|
|
Response(ctx context.Context, nodeID ids.NodeID, requestID uint32, response []byte) error
|
|
|
|
// Gossip handles an application gossip message
|
|
Gossip(ctx context.Context, nodeID ids.NodeID, msg []byte) error
|
|
}
|