external

Documentation

Index

• Variables
• type NodeApiResolver
  • func NewNodeApiResolver(scQueryService SCQueryService, statusMetricsHandler StatusMetricsHandler) (*NodeApiResolver, error)
  • func (nar *NodeApiResolver) ExecuteSCQuery(query *process.SCQuery) (*vmcommon.VMOutput, error)
  • func (nar *NodeApiResolver) IsInterfaceNil() bool
  • func (nar *NodeApiResolver) StatusMetrics() StatusMetricsHandler
• type SCQueryService
• type StatusMetricsHandler

Variables

var ErrNilBlockChain = errors.New("nil block chain")

ErrNilBlockChain signals that an operation has been attempted to or with a nil blockchain

var ErrNilMarshalizer = errors.New("nil Marshalizer")

ErrNilMarshalizer signals that an operation has been attempted to or with a nil Marshalizer implementation

var ErrNilSCQueryService = errors.New("nil SC query service")

ErrNilSCQueryService signals that a nil SC query service has been provided

var ErrNilShardCoordinator = errors.New("nil shard coordinator")

ErrNilShardCoordinator signals that an operation has been attempted to or with a nil shard coordinator

var ErrNilStatusMetrics = errors.New("nil status metrics handler")

ErrNilStatusMetrics signals that a nil status metrics was provided

var ErrNilStore = errors.New("nil data storage service")

ErrNilStore signals that the provided storage service is nil

var ErrWrongTypeAssertion = errors.New("wrong type assertion")

ErrWrongTypeAssertion signals that a wrong type assertion occurred

Types

type NodeApiResolver

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

NodeApiResolver can resolve API requests

func NewNodeApiResolver

func NewNodeApiResolver(scQueryService SCQueryService, statusMetricsHandler StatusMetricsHandler) (*NodeApiResolver, error)

NewNodeApiResolver creates a new NodeApiResolver instance

func (*NodeApiResolver) ExecuteSCQuery

func (nar *NodeApiResolver) ExecuteSCQuery(query *process.SCQuery) (*vmcommon.VMOutput, error)

ExecuteSCQuery retrieves data stored in a SC account through a VM

func (*NodeApiResolver) IsInterfaceNil

func (nar *NodeApiResolver) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (*NodeApiResolver) StatusMetrics

func (nar *NodeApiResolver) StatusMetrics() StatusMetricsHandler

StatusMetrics returns an implementation of the StatusMetricsHandler interface

type SCQueryService

type SCQueryService interface {
	ExecuteQuery(query *process.SCQuery) (*vmcommon.VMOutput, error)
	IsInterfaceNil() bool
}

SCQueryService defines how data should be get from a SC account

type StatusMetricsHandler

type StatusMetricsHandler interface {
	StatusMetricsMap() (map[string]interface{}, error)
	IsInterfaceNil() bool
}

StatusMetricsHandler is the interface that defines what a node details handler/provider should do