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 Protocols() []protocol.ID
• func Run(ctx context.Context, conf Config) (err error)
• type Config
• type TestConfig

Functions

func Protocols

func Protocols() []protocol.ID

Protocols returns the list of supported Protocols in order of precedence.

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
	NoVerify                bool
	PrivKeyFile             string
	MonitoringAddr          string
	ValidatorAPIAddr        string
	BeaconNodeAddrs         []string
	JaegerAddr              string
	JaegerService           string
	SimnetBMock             bool
	SimnetVMock             bool
	SimnetValidatorKeysDir  string
	SyntheticBlockProposals bool
	BuilderAPI              bool

	TestConfig TestConfig
}

type TestConfig

type TestConfig struct {
	p2p.TestPingConfig

	// 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
	// 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
	// BuilderRegistration provides a channel for tests to trigger builder registration by the validator mock,
	BuilderRegistration <-chan *eth2api.VersionedValidatorRegistration
	// PrioritiseCallback is called with priority protocol results.
	PrioritiseCallback func(context.Context, core.Duty, []priority.TopicResult) error
	// TCPNodeCallback provides test logic access to the libp2p host.
	TCPNodeCallback func(host.Host)
	// LibP2POpts provide test specific libp2p options.
	LibP2POpts []libp2p.Option
}

TestConfig defines additional test-only config.