dingo

README

Dingo

Dingo

This is a work in progress and is currently under heavy development

Development / Building

This requires Go 1.22 or better is installed. You also need make.

# Build
make
# Run
./dingo

You can also run the code without building a binary, first

go run ./cmd/dingo/

Documentation

Index

• type Config
  • func NewConfig(opts ...ConfigOptionFunc) Config
• type ConfigOptionFunc
  • func WithCardanoNodeConfig(cardanoNodeConfig *cardano.CardanoNodeConfig) ConfigOptionFunc
  • func WithDatabasePath(dataDir string) ConfigOptionFunc
  • func WithIntersectPoints(points []ocommon.Point) ConfigOptionFunc
  • func WithIntersectTip(intersectTip bool) ConfigOptionFunc
  • func WithListeners(listeners ...ListenerConfig) ConfigOptionFunc
  • func WithLogger(logger *slog.Logger) ConfigOptionFunc
  • func WithNetwork(network string) ConfigOptionFunc
  • func WithNetworkMagic(networkMagic uint32) ConfigOptionFunc
  • func WithOutboundSourcePort(port int) ConfigOptionFunc
  • func WithPeerSharing(peerSharing bool) ConfigOptionFunc
  • func WithPrometheusRegistry(registry prometheus.Registerer) ConfigOptionFunc
  • func WithTopologyConfig(topologyConfig *topology.TopologyConfig) ConfigOptionFunc
  • func WithTracing(tracing bool) ConfigOptionFunc
  • func WithTracingStdout(stdout bool) ConfigOptionFunc
• type ListenerConfig
• type Node
  • func New(cfg Config) (*Node, error)
  • func (n *Node) Run() error
  • func (n *Node) Stop() error

Types

type Config

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

func NewConfig

func NewConfig(opts ...ConfigOptionFunc) Config

NewConfig creates a new dingo config with the specified options

type ConfigOptionFunc

type ConfigOptionFunc func(*Config)

ConfigOptionFunc is a type that represents functions that modify the Connection config

func WithCardanoNodeConfig

func WithCardanoNodeConfig(
	cardanoNodeConfig *cardano.CardanoNodeConfig,
) ConfigOptionFunc

WithCardanoNodeConfig specifies the CardanoNodeConfig object to use. This is mostly used for loading genesis config files referenced by the dingo config

func WithDatabasePath

func WithDatabasePath(dataDir string) ConfigOptionFunc

WithDatabasePath specifies the persistent data directory to use. The default is to store everything in memory

func WithIntersectPoints

func WithIntersectPoints(points []ocommon.Point) ConfigOptionFunc

WithIntersectPoints specifies intersect point(s) for the initial chainsync. The default is to start at chain genesis

func WithIntersectTip

func WithIntersectTip(intersectTip bool) ConfigOptionFunc

WithIntersectTip specifies whether to start the initial chainsync at the current tip. The default is to start at chain genesis

func WithListeners

func WithListeners(listeners ...ListenerConfig) ConfigOptionFunc

WithListeners specifies the listener config(s) to use

func WithLogger

func WithLogger(logger *slog.Logger) ConfigOptionFunc

WithLogger specifies the logger to use. This defaults to discarding log output

func WithNetwork

func WithNetwork(network string) ConfigOptionFunc

WithNetwork specifies the named network to operate on. This will automatically set the appropriate network magic value

func WithNetworkMagic

func WithNetworkMagic(networkMagic uint32) ConfigOptionFunc

WithNetworkMagic specifies the network magic value to use. This will override any named network specified

func WithOutboundSourcePort

func WithOutboundSourcePort(port int) ConfigOptionFunc

WithOutboundSourcePort specifies the source port to use for outbound connections. This defaults to dynamic source ports

func WithPeerSharing

func WithPeerSharing(peerSharing bool) ConfigOptionFunc

WithPeerSharing specifies whether to enable peer sharing. This is disabled by default

func WithPrometheusRegistry

func WithPrometheusRegistry(registry prometheus.Registerer) ConfigOptionFunc

WithPrometheusRegistry specifies a prometheus.Registerer instance to add metrics to. In most cases, prometheus.DefaultRegistry would be a good choice to get metrics working

func WithTopologyConfig

func WithTopologyConfig(
	topologyConfig *topology.TopologyConfig,
) ConfigOptionFunc

WithTopologyConfig specifies a topology.TopologyConfig to use for outbound peers

func WithTracing

func WithTracing(tracing bool) ConfigOptionFunc

WithTracing enables tracing. By default, spans are submitted to a HTTP(s) endpoint using OTLP. This can be configured using the OTEL_EXPORTER_OTLP_* env vars documented in the README for go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp

func WithTracingStdout

func WithTracingStdout(stdout bool) ConfigOptionFunc

WithTracingStdout enables tracing output to stdout. This also requires tracing to enabled separately. This is mostly useful for debugging

type ListenerConfig

type ListenerConfig = connmanager.ListenerConfig

type Node

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

func New

func New(cfg Config) (*Node, error)

func (*Node) Run

func (n *Node) Run() error

func (*Node) Stop

func (n *Node) Stop() error