Documentation
¶
Index ¶
- Variables
- func FriendlyBigInt(n *big.Int) string
- type AppConfig
- type AutoPprof
- type ChainType
- type Database
- type DatabaseBackupMode
- type Ethereum
- type Explorer
- type FeatureFlags
- type FluxMonitor
- type Insecure
- type JobPipeline
- type Keeper
- type Keystore
- type LogfFn
- type Logging
- type OCR1Config
- type OCR2Config
- type P2PDeprecated
- type P2PNetworking
- type P2PV1Networking
- type P2PV2Networking
- type Prometheus
- type Pyroscope
- type Secrets
- type Sentry
- type TelemetryIngress
- type Web
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrEnvUnset = errors.New("env var unset")
)
nolint
View Source
var ErrInvalidChainType = fmt.Errorf("must be one of %s or omitted", strings.Join([]string{ string(ChainArbitrum), string(ChainMetis), string(ChainOptimism), string(ChainXDai), string(ChainOptimismBedrock), }, ", "))
Functions ¶
func FriendlyBigInt ¶
FriendlyBigInt returns a string printing the integer in both decimal and hexadecimal formats.
Types ¶
type AppConfig ¶ added in v2.2.0
type AppConfig interface {
AppID() uuid.UUID
RootDir() string
ShutdownGracePeriod() time.Duration
Validate() error
ValidateDB() error
LogConfiguration(log LogfFn)
SetLogLevel(lvl zapcore.Level) error
SetLogSQL(logSQL bool)
LogSQL() bool
SetPasswords(keystore, vrf *string)
AutoPprof
Database
Ethereum
Explorer
FeatureFlags
FluxMonitor
Insecure
JobPipeline
Keeper
Keystore
Logging
OCR1Config
OCR2Config
P2PNetworking
P2PV1Networking
P2PV2Networking
Prometheus
Pyroscope
Secrets
Sentry
TelemetryIngress
Web
audit.Config
}
type AutoPprof ¶ added in v2.2.0
type AutoPprof interface {
AutoPprofBlockProfileRate() int
AutoPprofCPUProfileRate() int
AutoPprofGatherDuration() models.Duration
AutoPprofGatherTraceDuration() models.Duration
AutoPprofGoroutineThreshold() int
AutoPprofMaxProfileSize() utils.FileSize
AutoPprofMemProfileRate() int
AutoPprofMemThreshold() utils.FileSize
AutoPprofMutexProfileFraction() int
AutoPprofPollInterval() models.Duration
AutoPprofProfileRoot() string
}
type ChainType ¶
type ChainType string
ChainType denotes the chain or network to work with
const ( ChainArbitrum ChainType = "arbitrum" ChainMetis ChainType = "metis" ChainOptimism ChainType = "optimism" ChainOptimismBedrock ChainType = "optimismBedrock" ChainXDai ChainType = "xdai" )
nolint
type Database ¶ added in v2.2.0
type Database interface {
DatabaseBackupDir() string
DatabaseBackupFrequency() time.Duration
DatabaseBackupMode() DatabaseBackupMode
DatabaseBackupOnVersionUpgrade() bool
DatabaseBackupURL() *url.URL
DatabaseDefaultIdleInTxSessionTimeout() time.Duration
DatabaseDefaultLockTimeout() time.Duration
DatabaseDefaultQueryTimeout() time.Duration
DatabaseListenerMaxReconnectDuration() time.Duration
DatabaseListenerMinReconnectInterval() time.Duration
DatabaseLockingMode() string
DatabaseURL() url.URL
GetDatabaseDialectConfiguredOrDefault() dialects.DialectName
LeaseLockDuration() time.Duration
LeaseLockRefreshInterval() time.Duration
MigrateDatabase() bool
ORMMaxIdleConns() int
ORMMaxOpenConns() int
TriggerFallbackDBPollInterval() time.Duration
}
type DatabaseBackupMode ¶
type DatabaseBackupMode string
var ( DatabaseBackupModeNone DatabaseBackupMode = "none" DatabaseBackupModeLite DatabaseBackupMode = "lite" DatabaseBackupModeFull DatabaseBackupMode = "full" )
type FeatureFlags ¶
type FeatureFlags interface {
FeatureExternalInitiators() bool
FeatureFeedsManager() bool
FeatureOffchainReporting() bool
FeatureOffchainReporting2() bool
FeatureUICSAKeys() bool
FeatureLogPoller() bool
AutoPprofEnabled() bool
EVMEnabled() bool
EVMRPCEnabled() bool
P2PEnabled() bool
CosmosEnabled() bool
SolanaEnabled() bool
StarkNetEnabled() bool
}
FeatureFlags contains bools that toggle various features or chains TODO: document the new ones
type FluxMonitor ¶ added in v2.2.0
type JobPipeline ¶ added in v2.2.0
type Keeper ¶ added in v2.2.0
type Keeper interface {
KeeperDefaultTransactionQueueDepth() uint32
KeeperGasPriceBufferPercent() uint16
KeeperGasTipCapBufferPercent() uint16
KeeperBaseFeeBufferPercent() uint16
KeeperMaximumGracePeriod() int64
KeeperRegistryCheckGasOverhead() uint32
KeeperRegistryPerformGasOverhead() uint32
KeeperRegistryMaxPerformDataSize() uint32
KeeperRegistrySyncInterval() time.Duration
KeeperRegistrySyncUpkeepQueueSize() uint32
KeeperTurnLookBack() int64
}
type OCR1Config ¶
type OCR1Config interface {
// OCR1 config, can override in jobs, only ethereum.
OCRBlockchainTimeout() time.Duration
OCRContractPollInterval() time.Duration
OCRContractSubscribeInterval() time.Duration
OCRKeyBundleID() (string, error)
OCRObservationTimeout() time.Duration
OCRSimulateTransactions() bool
OCRTransmitterAddress() (ethkey.EIP55Address, error) // OCR2 can support non-evm changes
// OCR1 config, cannot override in jobs
OCRTraceLogging() bool
OCRDefaultTransactionQueueDepth() uint32
OCRCaptureEATelemetry() bool
}
OCR1Config is a subset of global config relevant to OCR v1.
type OCR2Config ¶
type OCR2Config interface {
// OCR2 config, can override in jobs, all chains
OCR2ContractConfirmations() uint16
OCR2ContractTransmitterTransmitTimeout() time.Duration
OCR2BlockchainTimeout() time.Duration
OCR2DatabaseTimeout() time.Duration
OCR2ContractPollInterval() time.Duration
OCR2ContractSubscribeInterval() time.Duration
OCR2KeyBundleID() (string, error)
// OCR2 config, cannot override in jobs
OCR2TraceLogging() bool
OCR2CaptureEATelemetry() bool
}
OCR2Config is a subset of global config relevant to OCR v2.
type P2PDeprecated ¶
type P2PDeprecated interface {
// contains filtered or unexported methods
}
type P2PNetworking ¶
type P2PNetworking interface {
P2PNetworkingStack() (n ocrnetworking.NetworkingStack)
P2PNetworkingStackRaw() string
P2PPeerID() p2pkey.PeerID
P2PPeerIDRaw() string
P2PIncomingMessageBufferSize() int
P2POutgoingMessageBufferSize() int
}
P2PNetworking is a subset of global config relevant to p2p networking.
type P2PV1Networking ¶
type P2PV1Networking interface {
P2PAnnounceIP() net.IP
P2PAnnouncePort() uint16
P2PBootstrapPeers() ([]string, error)
P2PDHTAnnouncementCounterUserPrefix() uint32
P2PListenIP() net.IP
P2PListenPort() uint16
P2PListenPortRaw() string
P2PNewStreamTimeout() time.Duration
P2PBootstrapCheckInterval() time.Duration
P2PDHTLookupInterval() int
P2PPeerstoreWriteInterval() time.Duration
}
P2PV1Networking is a subset of global config relevant to p2p v1 networking.
type P2PV2Networking ¶
type P2PV2Networking interface {
P2PV2AnnounceAddresses() []string
P2PV2Bootstrappers() (locators []ocrcommontypes.BootstrapperLocator)
P2PV2BootstrappersRaw() []string
P2PV2DeltaDial() models.Duration
P2PV2DeltaReconcile() models.Duration
P2PV2ListenAddresses() []string
}
P2PV2Networking is a subset of global config relevant to p2p v2 networking.
type Prometheus ¶ added in v2.2.0
type Prometheus interface {
PrometheusAuthToken() string
}
type Secrets ¶ added in v2.2.0
type Secrets interface {
MercuryCredentials(credName string) *ocr2models.MercuryCredentials
VRFPassword() string
}
type TelemetryIngress ¶ added in v2.2.0
type TelemetryIngress interface {
TelemetryIngressLogging() bool
TelemetryIngressUniConn() bool
TelemetryIngressServerPubKey() string
TelemetryIngressURL() *url.URL
TelemetryIngressBufferSize() uint
TelemetryIngressMaxBatchSize() uint
TelemetryIngressSendInterval() time.Duration
TelemetryIngressSendTimeout() time.Duration
TelemetryIngressUseBatchSend() bool
}
type Web ¶ added in v2.2.0
type Web interface {
AllowOrigins() string
AuthenticatedRateLimit() int64
AuthenticatedRateLimitPeriod() models.Duration
BridgeCacheTTL() time.Duration
BridgeResponseURL() *url.URL
CertFile() string
HTTPServerWriteTimeout() time.Duration
KeyFile() string
Port() uint16
RPID() string
RPOrigin() string
TLSCertPath() string
TLSDir() string
TLSHost() string
TLSKeyPath() string
TLSPort() uint16
TLSRedirect() bool
UnAuthenticatedRateLimit() int64
UnAuthenticatedRateLimitPeriod() models.Duration
ReaperExpiration() models.Duration
SecureCookies() bool
SessionOptions() sessions.Options
SessionTimeout() models.Duration
}
Source Files
¶
- app_config.go
- auto_pprof_config.go
- chaintype.go
- database_config.go
- ethereum_config.go
- explorer_config.go
- feature_flags.go
- flux_monitor_config.go
- insecure_config.go
- job_pipeline_config.go
- keeper_config.go
- keystore.go
- logging_config.go
- ocr1_config.go
- ocr2_config.go
- p2p_config.go
- p2p_v1_config.go
- p2p_v2_config.go
- presenters.go
- prometheus.go
- pyroscope_config.go
- secrets.go
- sentry_config.go
- telemetry_ingress_config.go
- web_config.go
Directories
¶
| Path | Synopsis |
|---|---|
|
docs/cmd/generate
command
Docs prints core node documentation and/or a list of errors.
|
Docs prints core node documentation and/or a list of errors. |
Click to show internal directories.
Click to hide internal directories.