Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

common

package

Go to main page

Versions in this module

v1

v1.13.7

Jul 18, 2025

Changes in this version

+ var ErrTimeout = &AppError

+ func NewTimeoutScheduler(onTimeout func(), preemptionSignal <-chan struct{}) *timeoutScheduler

+ type AcceptedFrontierHandler interface

+ AcceptedFrontier func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containerID ids.ID) error

+ GetAcceptedFrontierFailed func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ func NewNoOpAcceptedFrontierHandler(log logging.Logger) AcceptedFrontierHandler

+ type AcceptedHandler interface

+ Accepted func(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) error

+ GetAcceptedFailed func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ func NewNoOpAcceptedHandler(log logging.Logger) AcceptedHandler

+ type AcceptedSender interface

+ SendAccepted func(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...)

+ SendGetAccepted func(ctx context.Context, nodeIDs set.Set[ids.NodeID], requestID uint32, ...)

+ type AcceptedStateSummaryHandler interface

+ AcceptedStateSummary func(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) error

+ GetAcceptedStateSummaryFailed func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ func NewNoOpAcceptedStateSummaryHandler(log logging.Logger) AcceptedStateSummaryHandler

+ type AcceptedStateSummarySender interface

+ SendAcceptedStateSummary func(ctx context.Context, nodeID ids.NodeID, requestID uint32, summaryIDs []ids.ID)

+ SendGetAcceptedStateSummary func(ctx context.Context, nodeIDs set.Set[ids.NodeID], requestID uint32, ...)

+ type AllGetsServer interface

+ type AncestorsHandler interface

+ Ancestors func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containers [][]byte) error

+ GetAncestorsFailed func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ func NewNoOpAncestorsHandler(log logging.Logger) AncestorsHandler

type AppError

+ func (a *AppError) Is(target error) bool

+ type AppGossipHandler interface

+ AppGossip func(ctx context.Context, nodeID ids.NodeID, msg []byte) error

+ type AppHandler interface

+ func NewNoOpAppHandler(log logging.Logger) AppHandler

+ type AppRequestHandler interface

+ AppRequest func(ctx context.Context, nodeID ids.NodeID, requestID uint32, deadline time.Time, ...) error

+ type AppResponseHandler interface

+ AppRequestFailed func(ctx context.Context, nodeID ids.NodeID, requestID uint32, appErr *AppError) error

+ AppResponse func(ctx context.Context, nodeID ids.NodeID, requestID uint32, response []byte) error

+ type AppSender interface

+ SendAppError func(ctx context.Context, nodeID ids.NodeID, requestID uint32, errorCode int32, ...) error

+ SendAppGossip func(ctx context.Context, config SendConfig, appGossipBytes []byte) error

+ SendAppRequest func(ctx context.Context, nodeIDs set.Set[ids.NodeID], requestID uint32, ...) error

+ SendAppResponse func(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) error

+ type BootstrapTracker interface

+ AllBootstrapped func() <-chan struct{}

+ Bootstrapped func(chainID ids.ID)

+ IsBootstrapped func() bool

+ type BootstrapableEngine interface

+ Clear func(ctx context.Context) error

+ func TraceBootstrapableEngine(bootstrapableEngine BootstrapableEngine, tracer trace.Tracer) BootstrapableEngine

+ type ChitsHandler interface

+ Chits func(ctx context.Context, nodeID ids.NodeID, requestID uint32, preferredID ids.ID, ...) error

+ QueryFailed func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ func NewNoOpChitsHandler(log logging.Logger) ChitsHandler

+ type Engine interface

+ Start func(ctx context.Context, startReqID uint32) error

+ func TraceEngine(engine Engine, tracer trace.Tracer) Engine

+ type FetchSender interface

+ SendAncestors func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containers [][]byte)

+ SendGet func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containerID ids.ID)

+ SendGetAncestors func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containerID ids.ID)

+ SendPut func(ctx context.Context, nodeID ids.NodeID, requestID uint32, container []byte)

+ type FrontierSender interface

+ SendAcceptedFrontier func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containerID ids.ID)

+ SendGetAcceptedFrontier func(ctx context.Context, nodeIDs set.Set[ids.NodeID], requestID uint32)

+ type Fx struct

+ Fx interface{}

+ ID ids.ID

+ type GetAcceptedFrontierHandler interface

+ GetAcceptedFrontier func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ type GetAcceptedHandler interface

+ GetAccepted func(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) error

+ type GetAcceptedStateSummaryHandler interface

+ GetAcceptedStateSummary func(ctx context.Context, nodeID ids.NodeID, requestID uint32, ...) error

+ type GetAncestorsHandler interface

+ GetAncestors func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containerID ids.ID) error

+ type GetHandler interface

+ Get func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containerID ids.ID) error

+ type GetStateSummaryFrontierHandler interface

+ GetStateSummaryFrontier func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ type Haltable interface

+ Halt func()

+ Halted func() bool

+ type Halter struct

+ func (h *Halter) Halt()

+ func (h *Halter) Halted() bool

+ type Handler interface

+ type InternalHandler interface

+ Gossip func(context.Context) error

+ Notify func(context.Context, Message) error

+ Shutdown func(context.Context) error

+ func NewNoOpInternalHandler(log logging.Logger) InternalHandler

+ type Message uint32

+ const PendingTxs

+ const StateSyncDone

+ func (msg Message) String() string

+ type NotificationForwarder struct

+ Engine Notifier

+ Log logging.Logger

+ Subscribe Subscription

+ func NewNotificationForwarder(engine Notifier, subscribe Subscription, log logging.Logger) *NotificationForwarder

+ func (nf *NotificationForwarder) CheckForEvent()

+ func (nf *NotificationForwarder) Close()

+ type Notifier interface

+ Notify func(context.Context, Message) error

+ type PreemptionSignal struct

+ func (ps *PreemptionSignal) Listen() <-chan struct{}

+ func (ps *PreemptionSignal) Preempt()

+ type PutHandler interface

+ GetFailed func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ Put func(ctx context.Context, nodeID ids.NodeID, requestID uint32, container []byte) error

+ func NewNoOpPutHandler(log logging.Logger) PutHandler

+ type QueryHandler interface

+ PullQuery func(ctx context.Context, nodeID ids.NodeID, requestID uint32, containerID ids.ID, ...) error

+ PushQuery func(ctx context.Context, nodeID ids.NodeID, requestID uint32, container []byte, ...) error

+ func NewNoOpQueryHandler(log logging.Logger) QueryHandler

+ type QuerySender interface

+ SendChits func(ctx context.Context, nodeID ids.NodeID, requestID uint32, preferredID ids.ID, ...)

+ SendPullQuery func(ctx context.Context, nodeIDs set.Set[ids.NodeID], requestID uint32, ...)

+ SendPushQuery func(ctx context.Context, nodeIDs set.Set[ids.NodeID], requestID uint32, ...)

+ type Request struct

+ NodeID ids.NodeID

+ RequestID uint32

+ func (r Request) MarshalText() ([]byte, error)

+ type SendConfig struct

+ NodeIDs set.Set[ids.NodeID]

+ NonValidators int

+ Peers int

+ Validators int

+ type Sender interface

+ type StateSummaryFrontierHandler interface

+ GetStateSummaryFrontierFailed func(ctx context.Context, nodeID ids.NodeID, requestID uint32) error

+ StateSummaryFrontier func(ctx context.Context, nodeID ids.NodeID, requestID uint32, summary []byte) error

+ func NewNoOpStateSummaryFrontierHandler(log logging.Logger) StateSummaryFrontierHandler

+ type StateSummarySender interface

+ SendGetStateSummaryFrontier func(ctx context.Context, nodeIDs set.Set[ids.NodeID], requestID uint32)

+ SendStateSummaryFrontier func(ctx context.Context, nodeID ids.NodeID, requestID uint32, summary []byte)

+ type StateSyncer interface

+ IsEnabled func(context.Context) (bool, error)

+ func TraceStateSyncer(stateSyncer StateSyncer, tracer trace.Tracer) StateSyncer

+ type Subscription func(ctx context.Context) (Message, error)

+ type TimeoutRegistrar interface

+ RegisterTimeout func(time.Duration)

+ type VM interface

+ CreateHandlers func(context.Context) (map[string]http.Handler, error)

+ Initialize func(ctx context.Context, chainCtx *snow.Context, db database.Database, ...) error

+ NewHTTPHandler func(ctx context.Context) (http.Handler, error)

+ SetState func(ctx context.Context, state snow.State) error

+ Shutdown func(context.Context) error

+ Version func(context.Context) (string, error)

+ WaitForEvent func(ctx context.Context) (Message, error)

v1.13.5-alpha

Aug 23, 2025

v1.13.4-lux.25

Aug 19, 2025

v1.13.4-lux.20

Aug 18, 2025

v1.11.14

Aug 18, 2025

Changes in this version

+ var ErrUndefined = &AppError

+ type AppError struct

+ Code int

+ Message string

+ func (e *AppError) Error() string

v0

v0.7.8-lux.11

Aug 18, 2025

v0.1.0-lux.17

Aug 17, 2025