app

Documentation

Overview

Package app provides the top app-level abstraction and entrypoint for a charon DVC instance. The sub-packages also provide app-level functionality.

Index

• func Run(ctx context.Context, conf Config) (err error)
• type Config
• type TestConfig

Functions

func Run

func Run(ctx context.Context, conf Config) (err error)

Run is the entrypoint for running a charon DVC instance. All processes and their dependencies are wired and added to the life cycle manager which handles starting and graceful shutdown.

Types

type Config

type Config struct {
	P2P              p2p.Config
	Log              log.Config
	Feature          featureset.Config
	LockFile         string
	DataDir          string
	MonitoringAddr   string
	ValidatorAPIAddr string
	BeaconNodeAddrs  []string
	JaegerAddr       string
	JaegerService    string
	SimnetBMock      bool
	SimnetVMock      bool
	BuilderAPI       bool

	TestConfig TestConfig
}

type TestConfig

type TestConfig struct {
	// Lock provides the lock explicitly, skips loading from disk.
	Lock *cluster.Lock
	// P2PKey provides the p2p privkey explicitly, skips loading from keystore on disk.
	P2PKey *ecdsa.PrivateKey
	// DisablePing disables the ping service.
	DisablePing bool
	// PingCallback is called when a ping was completed to a peer.
	PingCallback func(peer.ID)
	// ParSigExFunc provides an in-memory partial signature exchange.
	ParSigExFunc func() core.ParSigEx
	// LcastTransportFunc provides an in-memory leader cast transport.
	LcastTransportFunc func() leadercast.Transport
	// SimnetKeys provides private key shares for the simnet validatormock signer.
	SimnetKeys []*bls_sig.SecretKey
	// SimnetBMockOpts defines additional simnet beacon mock options.
	SimnetBMockOpts []beaconmock.Option
	// BroadcastCallback is called when a duty is completed and sent to the broadcast component.
	BroadcastCallback func(context.Context, core.Duty, core.PubKey, core.SignedData) error
	// DisablePromWrap disables wrapping prometheus metrics with cluster identifiers.
	DisablePromWrap bool
	// BuilderAPI enables the builder API opt-in feature
	BuilderAPI bool
}

TestConfig defines additional test-only config.