models

Documentation

Index

• type ChainConnectionStatus
• type HealthCheck
• type HeuristicMethod
  • func StringToHeuristicMethod(s string) HeuristicMethod
• type Result
• type SessionRequestBody
  • func (irb *SessionRequestBody) Clone() *SessionRequestBody
  • func (irb *SessionRequestBody) MethodType() HeuristicMethod
• type SessionRequestParams
  • func (hrp *SessionRequestParams) AlertPolicy() *core.AlertPolicy
  • func (hrp *SessionRequestParams) AlertingDestType() core.AlertDestination
  • func (hrp *SessionRequestParams) GeneratePipelineConfig(pollInterval time.Duration, regType core.RegisterType) *core.PipelineConfig
  • func (hrp *SessionRequestParams) Heuristic() core.HeuristicType
  • func (hrp *SessionRequestParams) NetworkType() core.Network
  • func (hrp *SessionRequestParams) Params() *core.SessionParams
  • func (hrp *SessionRequestParams) PipelineType() core.PipelineType
  • func (hrp *SessionRequestParams) SessionConfig() *core.SessionConfig
• type SessionResponse
  • func NewSessionAcceptedResp(id core.SUUID) *SessionResponse
  • func NewSessionNoProcessResp() *SessionResponse
  • func NewSessionUnmarshalErrResp() *SessionResponse
• type SessionResponseStatus

Types

type ChainConnectionStatus

type ChainConnectionStatus struct {
	IsL1Healthy bool
	IsL2Healthy bool
}

ChainConnectionStatus ... Used to display health status of each node connection

type HealthCheck

type HealthCheck struct {
	Timestamp             time.Time
	Healthy               bool
	ChainConnectionStatus *ChainConnectionStatus
}

HealthCheck ... Returns health status of server

type HeuristicMethod

type HeuristicMethod int

HeuristicMethod ... Represents the heuristic operation method

const (
	Run HeuristicMethod = iota
	// NOTE - Update is not implemented yet
	Update
	// NOTE - Stop is not implemented yet
	Stop
)

func StringToHeuristicMethod

func StringToHeuristicMethod(s string) HeuristicMethod

type Result

type Result = map[string]string

Result ... Result of heuristic operation

type SessionRequestBody

type SessionRequestBody struct {
	Method string               `json:"method"`
	Params SessionRequestParams `json:"params"`
}

SessionRequestBody ... Request body for heuristic operation request

func (*SessionRequestBody) Clone

func (irb *SessionRequestBody) Clone() *SessionRequestBody

func (*SessionRequestBody) MethodType

func (irb *SessionRequestBody) MethodType() HeuristicMethod

MethodType ... Returns the heuristic method type

type SessionRequestParams

type SessionRequestParams struct {
	Network       string `json:"network"`
	PType         string `json:"pipeline_type"`
	HeuristicType string `json:"type"`

	StartHeight *big.Int `json:"start_height"`
	EndHeight   *big.Int `json:"end_height"`

	SessionParams  map[string]interface{} `json:"heuristic_params"`
	AlertingParams *core.AlertPolicy      `json:"alerting_params"`
}

SessionRequestParams ... Request params for heuristic operation

func (*SessionRequestParams) AlertPolicy

func (hrp *SessionRequestParams) AlertPolicy() *core.AlertPolicy

func (*SessionRequestParams) AlertingDestType

func (hrp *SessionRequestParams) AlertingDestType() core.AlertDestination

AlertingDestType ... Returns the alerting destination type

func (*SessionRequestParams) GeneratePipelineConfig

func (hrp *SessionRequestParams) GeneratePipelineConfig(pollInterval time.Duration,
	regType core.RegisterType) *core.PipelineConfig

GeneratePipelineConfig ... Generates a pipeline config using the request params

func (*SessionRequestParams) Heuristic

func (hrp *SessionRequestParams) Heuristic() core.HeuristicType

Heuristic ... Returns the heuristic type

func (*SessionRequestParams) NetworkType

func (hrp *SessionRequestParams) NetworkType() core.Network

NetworkType ... Returns the network type

func (*SessionRequestParams) Params

func (hrp *SessionRequestParams) Params() *core.SessionParams

Params ... Returns the heuristic session params

func (*SessionRequestParams) PipelineType

func (hrp *SessionRequestParams) PipelineType() core.PipelineType

PipelineType ... Returns the pipeline type

func (*SessionRequestParams) SessionConfig

func (hrp *SessionRequestParams) SessionConfig() *core.SessionConfig

SessionConfig ... Generates a session config using the request params

type SessionResponse

type SessionResponse struct {
	Code   int                   `json:"status_code"`
	Status SessionResponseStatus `json:"status"`

	Result Result `json:"result"`
	Error  string `json:"error"`
}

SessionResponse ... Response for heuristic operation request

func NewSessionAcceptedResp

func NewSessionAcceptedResp(id core.SUUID) *SessionResponse

NewSessionAcceptedResp ...Returns a heuristic response with status accepted

func NewSessionNoProcessResp

func NewSessionNoProcessResp() *SessionResponse

NewSessionNoProcessResp ... New internal processing response error

func NewSessionUnmarshalErrResp

func NewSessionUnmarshalErrResp() *SessionResponse

NewSessionUnmarshalErrResp ... New unmarshal error response construction

type SessionResponseStatus

type SessionResponseStatus string

SessionResponseStatus ... Represents the heuristic operation response status

const (
	OK    SessionResponseStatus = "OK"
	NotOK SessionResponseStatus = "NOTOK"
)