config

Documentation

Index

• Variables
• func FriendlyNumber[N constraints.Integer | *big.Int](n N) string
• type AppConfig
• type AuditLogger
• type AutoPprof
• type Backup
• type ChainType
  • func (c ChainType) IsL2() bool
  • func (c ChainType) IsValid() bool
• type Database
• type DatabaseBackupMode
• type Feature
• type File
• type FluxMonitor
• type Insecure
• type JobPipeline
• type Keeper
• type Listener
• type Lock
• type Log
• type LogfFn
• type MFA
• type Mercury
• type OCR
• type OCR2
• type P2P
• type Password
• type Prometheus
• type Pyroscope
• type RateLimit
• type Registry
• type Sentry
• type TLS
• type TelemetryIngress
• type TelemetryIngressEndpoint
• type Threshold
• type Tracing
• type V1
• type V2
• type WebServer

Variables

var (
	ErrEnvUnset = errors.New("env var unset")
)

nolint

var ErrInvalidChainType = fmt.Errorf("must be one of %s or omitted", strings.Join([]string{
	string(ChainArbitrum), string(ChainMetis), string(ChainXDai), string(ChainOptimismBedrock), string(ChainCelo),
	string(ChainZkSync)}, ", "))

Functions

func FriendlyNumber

func FriendlyNumber[N constraints.Integer | *big.Int](n N) string

FriendlyNumber returns a string printing the integer or big.Int in both decimal and hexadecimal formats.

Types

type AppConfig

type AppConfig interface {
	AppID() uuid.UUID
	RootDir() string
	ShutdownGracePeriod() time.Duration
	InsecureFastScrypt() bool
	EVMEnabled() bool
	EVMRPCEnabled() bool
	CosmosEnabled() bool
	SolanaEnabled() bool
	StarkNetEnabled() bool

	Validate() error
	ValidateDB() error
	LogConfiguration(log, warn LogfFn)
	SetLogLevel(lvl zapcore.Level) error
	SetLogSQL(logSQL bool)
	SetPasswords(keystore, vrf *string)

	AuditLogger() AuditLogger
	AutoPprof() AutoPprof
	Database() Database
	Feature() Feature
	FluxMonitor() FluxMonitor
	Insecure() Insecure
	JobPipeline() JobPipeline
	Keeper() Keeper
	Log() Log
	Mercury() Mercury
	OCR() OCR
	OCR2() OCR2
	P2P() P2P
	Password() Password
	Prometheus() Prometheus
	Pyroscope() Pyroscope
	Sentry() Sentry
	TelemetryIngress() TelemetryIngress
	Threshold() Threshold
	WebServer() WebServer
	Tracing() Tracing
}

type AuditLogger

type AuditLogger interface {
	Enabled() bool
	ForwardToUrl() (models.URL, error)
	Environment() string
	JsonWrapperKey() string
	Headers() (models.ServiceHeaders, error)
}

type AutoPprof

type AutoPprof interface {
	BlockProfileRate() int
	CPUProfileRate() int
	Enabled() bool
	GatherDuration() models.Duration
	GatherTraceDuration() models.Duration
	GoroutineThreshold() int
	MaxProfileSize() utils.FileSize
	MemProfileRate() int
	MemThreshold() utils.FileSize
	MutexProfileFraction() int
	PollInterval() models.Duration
	ProfileRoot() string
}

type Backup

type Backup interface {
	Dir() string
	Frequency() time.Duration
	Mode() DatabaseBackupMode
	OnVersionUpgrade() bool
	URL() *url.URL
}

type ChainType

type ChainType string

ChainType denotes the chain or network to work with

const (
	ChainArbitrum        ChainType = "arbitrum"
	ChainMetis           ChainType = "metis"
	ChainOptimismBedrock ChainType = "optimismBedrock"
	ChainXDai            ChainType = "xdai"
	ChainCelo            ChainType = "celo"
	ChainZkSync          ChainType = "zksync"
)

nolint

func (ChainType) IsL2

func (c ChainType) IsL2() bool

IsL2 returns true if this chain is a Layer 2 chain. Notably:

• the block numbers used for log searching are different from calling block.number
• gas bumping is not supported, since there is no tx mempool

func (ChainType) IsValid

func (c ChainType) IsValid() bool

IsValid returns true if the ChainType value is known or empty.

type Database

type Database interface {
	Backup() Backup
	Listener() Listener
	Lock() Lock

	DefaultIdleInTxSessionTimeout() time.Duration
	DefaultLockTimeout() time.Duration
	DefaultQueryTimeout() time.Duration
	Dialect() dialects.DialectName
	LogSQL() bool
	MaxIdleConns() int
	MaxOpenConns() int
	MigrateDatabase() bool
	URL() url.URL
}

type DatabaseBackupMode

type DatabaseBackupMode string

var (
	DatabaseBackupModeNone DatabaseBackupMode = "none"
	DatabaseBackupModeLite DatabaseBackupMode = "lite"
	DatabaseBackupModeFull DatabaseBackupMode = "full"
)

type Feature

type Feature interface {
	FeedsManager() bool
	UICSAKeys() bool
	LogPoller() bool
}

type File

type File interface {
	Dir() string
	MaxSize() utils.FileSize
	MaxAgeDays() int64
	MaxBackups() int64
}

type FluxMonitor

type FluxMonitor interface {
	DefaultTransactionQueueDepth() uint32
	SimulateTransactions() bool
}

type Insecure

type Insecure interface {
	DevWebServer() bool
	OCRDevelopmentMode() bool
	DisableRateLimiting() bool
	InfiniteDepthQueries() bool
}

type JobPipeline

type JobPipeline interface {
	DefaultHTTPLimit() int64
	DefaultHTTPTimeout() models.Duration
	MaxRunDuration() time.Duration
	MaxSuccessfulRuns() uint64
	ReaperInterval() time.Duration
	ReaperThreshold() time.Duration
	ResultWriteQueueDepth() uint64
	ExternalInitiatorsEnabled() bool
}

type Keeper

type Keeper interface {
	DefaultTransactionQueueDepth() uint32
	GasPriceBufferPercent() uint16
	GasTipCapBufferPercent() uint16
	BaseFeeBufferPercent() uint16
	MaxGracePeriod() int64
	TurnLookBack() int64
	Registry() Registry
}

type Listener

type Listener interface {
	MaxReconnectDuration() time.Duration
	MinReconnectInterval() time.Duration
	FallbackPollInterval() time.Duration
}

type Lock

type Lock interface {
	LockingMode() string
	LeaseDuration() time.Duration
	LeaseRefreshInterval() time.Duration
}

type Log

type Log interface {
	DefaultLevel() zapcore.Level
	JSONConsole() bool
	Level() zapcore.Level
	UnixTimestamps() bool

	File() File
}

type LogfFn

type LogfFn func(string, ...any)

type MFA

type MFA interface {
	RPID() string
	RPOrigin() string
}

type Mercury

type Mercury interface {
	Credentials(credName string) *ocr2models.MercuryCredentials
}

type OCR

type OCR interface {
	Enabled() bool
	// OCR1 config, can override in jobs, only ethereum.
	BlockchainTimeout() time.Duration
	ContractPollInterval() time.Duration
	ContractSubscribeInterval() time.Duration
	KeyBundleID() (string, error)
	ObservationTimeout() time.Duration
	SimulateTransactions() bool
	TransmitterAddress() (ethkey.EIP55Address, error) // OCR2 can support non-evm changes
	// OCR1 config, cannot override in jobs
	TraceLogging() bool
	DefaultTransactionQueueDepth() uint32
	CaptureEATelemetry() bool
}

OCR is a subset of global config relevant to OCR v1.

type OCR2

type OCR2 interface {
	Enabled() bool
	// OCR2 config, can override in jobs, all chains
	ContractConfirmations() uint16
	ContractTransmitterTransmitTimeout() time.Duration
	BlockchainTimeout() time.Duration
	DatabaseTimeout() time.Duration
	ContractPollInterval() time.Duration
	ContractSubscribeInterval() time.Duration
	KeyBundleID() (string, error)
	// OCR2 config, cannot override in jobs
	TraceLogging() bool
	CaptureEATelemetry() bool
	DefaultTransactionQueueDepth() uint32
	SimulateTransactions() bool
	CaptureAutomationCustomTelemetry() bool
}

OCR2 is a subset of global config relevant to OCR v2.

type P2P

type P2P interface {
	V2() V2
	V1() V1
	NetworkStack() (n ocrnetworking.NetworkingStack)
	PeerID() p2pkey.PeerID
	IncomingMessageBufferSize() int
	OutgoingMessageBufferSize() int
	TraceLogging() bool
	Enabled() bool
}

type Password

type Password interface {
	Keystore() string
	VRF() string
}

type Prometheus

type Prometheus interface {
	AuthToken() string
}

type Pyroscope

type Pyroscope interface {
	AuthToken() string
	ServerAddress() string
	Environment() string
}

type RateLimit

type RateLimit interface {
	Authenticated() int64
	AuthenticatedPeriod() time.Duration
	Unauthenticated() int64
	UnauthenticatedPeriod() time.Duration
}

type Registry

type Registry interface {
	CheckGasOverhead() uint32
	PerformGasOverhead() uint32
	MaxPerformDataSize() uint32
	SyncInterval() time.Duration
	SyncUpkeepQueueSize() uint32
}

type Sentry

type Sentry interface {
	DSN() string
	Debug() bool
	Environment() string
	Release() string
}

type TLS

type TLS interface {
	Dir() string
	Host() string
	ForceRedirect() bool
	CertFile() string
	KeyFile() string
	HTTPSPort() uint16
	ListenIP() net.IP
}

type TelemetryIngress

type TelemetryIngress interface {
	Logging() bool
	UniConn() bool
	BufferSize() uint
	MaxBatchSize() uint
	SendInterval() time.Duration
	SendTimeout() time.Duration
	UseBatchSend() bool
	Endpoints() []TelemetryIngressEndpoint

	ServerPubKey() string // Deprecated: Use TelemetryIngressEndpoint.ServerPubKey instead, this field will be removed in future versions
	URL() *url.URL        // Deprecated: Use TelemetryIngressEndpoint.URL instead, this field will be removed in future versions
}

type TelemetryIngressEndpoint

type TelemetryIngressEndpoint interface {
	Network() string
	ChainID() string
	ServerPubKey() string
	URL() *url.URL
}

type Threshold

type Threshold interface {
	ThresholdKeyShare() string
}

type Tracing

type Tracing interface {
	Enabled() bool
	CollectorTarget() string
	NodeID() string
	Attributes() map[string]string
	SamplingRatio() float64
}

type V1

type V1 interface {
	Enabled() bool
	AnnounceIP() net.IP
	AnnouncePort() uint16
	DefaultBootstrapPeers() ([]string, error)
	DHTAnnouncementCounterUserPrefix() uint32
	ListenIP() net.IP
	ListenPort() uint16
	NewStreamTimeout() time.Duration
	BootstrapCheckInterval() time.Duration
	DHTLookupInterval() int
	PeerstoreWriteInterval() time.Duration
}

type V2

type V2 interface {
	Enabled() bool
	AnnounceAddresses() []string
	DefaultBootstrappers() (locators []ocrcommontypes.BootstrapperLocator)
	DeltaDial() models.Duration
	DeltaReconcile() models.Duration
	ListenAddresses() []string
}

type WebServer

type WebServer interface {
	AllowOrigins() string
	BridgeCacheTTL() time.Duration
	BridgeResponseURL() *url.URL
	HTTPMaxSize() int64
	StartTimeout() time.Duration
	HTTPWriteTimeout() time.Duration
	HTTPPort() uint16
	SessionReaperExpiration() models.Duration
	SecureCookies() bool
	SessionOptions() sessions.Options
	SessionTimeout() models.Duration
	ListenIP() net.IP

	TLS() TLS
	RateLimit() RateLimit
	MFA() MFA
}