Documentation
¶
Index ¶
- Variables
- type AuditLogger
- type AutoPprof
- type Core
- type Database
- type DatabaseBackup
- type DatabaseListener
- type DatabaseLock
- type DatabaseSecrets
- type Feature
- type FluxMonitor
- type Insecure
- type JobPipeline
- type JobPipelineHTTPRequest
- type Keeper
- type KeeperRegistry
- type Log
- type LogFile
- type LogLevel
- type MercuryCredentials
- type MercurySecrets
- type OCR
- type OCR2
- type P2P
- type P2PV1
- type P2PV2
- type Passwords
- type PrometheusSecrets
- type Pyroscope
- type PyroscopeSecrets
- type Secrets
- type Sentry
- type TelemetryIngress
- type TelemetryIngressEndpoint
- type ThresholdKeyShareSecrets
- type Tracing
- type WebServer
- type WebServerMFA
- type WebServerRateLimit
- type WebServerTLS
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrUnsupported = errors.New("unsupported with config v2")
Functions ¶
This section is empty.
Types ¶
type AuditLogger ¶
type AuditLogger struct {
Enabled *bool
ForwardToUrl *models.URL
JsonWrapperKey *string
Headers *[]models.ServiceHeader
}
func (*AuditLogger) SetFrom ¶
func (p *AuditLogger) SetFrom(f *AuditLogger)
type AutoPprof ¶
type AutoPprof struct {
Enabled *bool
ProfileRoot *string
PollInterval *models.Duration
GatherDuration *models.Duration
GatherTraceDuration *models.Duration
MaxProfileSize *utils.FileSize
CPUProfileRate *int64 // runtime.SetCPUProfileRate
MemProfileRate *int64 // runtime.MemProfileRate
BlockProfileRate *int64 // runtime.SetBlockProfileRate
MutexProfileFraction *int64 // runtime.SetMutexProfileFraction
MemThreshold *utils.FileSize
GoroutineThreshold *int64
}
type Core ¶
type Core struct {
// General/misc
AppID uuid.UUID `toml:"-"` // random or test
InsecureFastScrypt *bool
RootDir *string
ShutdownGracePeriod *models.Duration
Feature Feature `toml:",omitempty"`
Database Database `toml:",omitempty"`
TelemetryIngress TelemetryIngress `toml:",omitempty"`
AuditLogger AuditLogger `toml:",omitempty"`
Log Log `toml:",omitempty"`
WebServer WebServer `toml:",omitempty"`
JobPipeline JobPipeline `toml:",omitempty"`
FluxMonitor FluxMonitor `toml:",omitempty"`
OCR2 OCR2 `toml:",omitempty"`
OCR OCR `toml:",omitempty"`
P2P P2P `toml:",omitempty"`
Keeper Keeper `toml:",omitempty"`
AutoPprof AutoPprof `toml:",omitempty"`
Pyroscope Pyroscope `toml:",omitempty"`
Sentry Sentry `toml:",omitempty"`
Insecure Insecure `toml:",omitempty"`
Tracing Tracing `toml:",omitempty"`
}
Core holds the core configuration. See chainlink.Config for more information.
func (*Core) SetFrom ¶
SetFrom updates c with any non-nil values from f. (currently TOML field only!)
func (*Core) ValidateConfig ¶
type Database ¶
type Database struct {
DefaultIdleInTxSessionTimeout *models.Duration
DefaultLockTimeout *models.Duration
DefaultQueryTimeout *models.Duration
Dialect dialects.DialectName `toml:"-"`
LogQueries *bool
MaxIdleConns *int64
MaxOpenConns *int64
MigrateOnStartup *bool
Backup DatabaseBackup `toml:",omitempty"`
Listener DatabaseListener `toml:",omitempty"`
Lock DatabaseLock `toml:",omitempty"`
}
type DatabaseBackup ¶
type DatabaseBackup struct {
Dir *string
Frequency *models.Duration
Mode *config.DatabaseBackupMode
OnVersionUpgrade *bool
}
DatabaseBackup
Note: url is stored in Secrets.DatabaseBackupURL
type DatabaseListener ¶
type DatabaseLock ¶
type DatabaseLock struct {
Enabled *bool
LeaseDuration *models.Duration
LeaseRefreshInterval *models.Duration
}
func (*DatabaseLock) Mode ¶
func (l *DatabaseLock) Mode() string
func (*DatabaseLock) ValidateConfig ¶
func (l *DatabaseLock) ValidateConfig() (err error)
type DatabaseSecrets ¶
type DatabaseSecrets struct {
URL *models.SecretURL
BackupURL *models.SecretURL
AllowSimplePasswords *bool
}
func (*DatabaseSecrets) SetFrom ¶
func (d *DatabaseSecrets) SetFrom(f *DatabaseSecrets) (err error)
func (*DatabaseSecrets) ValidateConfig ¶
func (d *DatabaseSecrets) ValidateConfig() (err error)
type FluxMonitor ¶
type Insecure ¶
type Insecure struct {
DevWebServer *bool
OCRDevelopmentMode *bool
InfiniteDepthQueries *bool
DisableRateLimiting *bool
}
func (*Insecure) ValidateConfig ¶
type JobPipeline ¶
type JobPipelineHTTPRequest ¶
type KeeperRegistry ¶
type LogLevel ¶
LogLevel replaces dpanic with crit/CRIT
func (LogLevel) CapitalString ¶
func (LogLevel) MarshalText ¶
func (*LogLevel) UnmarshalText ¶
type MercuryCredentials ¶
type MercuryCredentials struct {
// LegacyURL is the legacy base URL for mercury v0.2 API
LegacyURL *models.SecretURL
// URL is the base URL for mercury v0.3 API
URL *models.SecretURL
// Username is the user id for mercury credential
Username *models.Secret
// Password is the user secret key for mercury credential
Password *models.Secret
}
type MercurySecrets ¶
type MercurySecrets struct {
Credentials map[string]MercuryCredentials
}
func (*MercurySecrets) SetFrom ¶
func (m *MercurySecrets) SetFrom(f *MercurySecrets) (err error)
func (*MercurySecrets) ValidateConfig ¶
func (m *MercurySecrets) ValidateConfig() (err error)
type OCR ¶
type OCR struct {
Enabled *bool
ObservationTimeout *models.Duration
BlockchainTimeout *models.Duration
ContractPollInterval *models.Duration
ContractSubscribeInterval *models.Duration
DefaultTransactionQueueDepth *uint32
// Optional
KeyBundleID *models.Sha256Hash
SimulateTransactions *bool
TransmitterAddress *ethkey.EIP55Address
CaptureEATelemetry *bool
TraceLogging *bool
}
type OCR2 ¶
type OCR2 struct {
Enabled *bool
ContractConfirmations *uint32
BlockchainTimeout *models.Duration
ContractPollInterval *models.Duration
ContractSubscribeInterval *models.Duration
ContractTransmitterTransmitTimeout *models.Duration
DatabaseTimeout *models.Duration
KeyBundleID *models.Sha256Hash
CaptureEATelemetry *bool
CaptureAutomationCustomTelemetry *bool
DefaultTransactionQueueDepth *uint32
SimulateTransactions *bool
TraceLogging *bool
}
type P2P ¶
type P2P struct {
IncomingMessageBufferSize *int64
OutgoingMessageBufferSize *int64
PeerID *p2pkey.PeerID
TraceLogging *bool
V1 P2PV1 `toml:",omitempty"`
V2 P2PV2 `toml:",omitempty"`
}
func (*P2P) NetworkStack ¶
func (p *P2P) NetworkStack() ocrnetworking.NetworkingStack
type P2PV1 ¶
type P2PV1 struct {
Enabled *bool
AnnounceIP *net.IP
AnnouncePort *uint16
BootstrapCheckInterval *models.Duration
DefaultBootstrapPeers *[]string
DHTAnnouncementCounterUserPrefix *uint32
DHTLookupInterval *int64
ListenIP *net.IP
ListenPort *uint16
NewStreamTimeout *models.Duration
PeerstoreWriteInterval *models.Duration
}
func (*P2PV1) ValidateConfig ¶
type P2PV2 ¶
type P2PV2 struct {
Enabled *bool
AnnounceAddresses *[]string
DefaultBootstrappers *[]ocrcommontypes.BootstrapperLocator
DeltaDial *models.Duration
DeltaReconcile *models.Duration
ListenAddresses *[]string
}
type Passwords ¶
func (*Passwords) ValidateConfig ¶
type PrometheusSecrets ¶
func (*PrometheusSecrets) SetFrom ¶
func (p *PrometheusSecrets) SetFrom(f *PrometheusSecrets) (err error)
type PyroscopeSecrets ¶
func (*PyroscopeSecrets) SetFrom ¶
func (p *PyroscopeSecrets) SetFrom(f *PyroscopeSecrets) (err error)
type Secrets ¶
type Secrets struct {
Database DatabaseSecrets `toml:",omitempty"`
Password Passwords `toml:",omitempty"`
Pyroscope PyroscopeSecrets `toml:",omitempty"`
Prometheus PrometheusSecrets `toml:",omitempty"`
Mercury MercurySecrets `toml:",omitempty"`
Threshold ThresholdKeyShareSecrets `toml:",omitempty"`
}
type TelemetryIngress ¶
type TelemetryIngress struct {
UniConn *bool
Logging *bool
BufferSize *uint16
MaxBatchSize *uint16
SendInterval *models.Duration
SendTimeout *models.Duration
UseBatchSend *bool
Endpoints []TelemetryIngressEndpoint `toml:",omitempty"`
URL *models.URL `toml:",omitempty"` // Deprecated: Use TelemetryIngressEndpoint.URL instead, this field will be removed in future versions
ServerPubKey *string `toml:",omitempty"` // Deprecated: Use TelemetryIngressEndpoint.ServerPubKey instead, this field will be removed in future versions
}
func (*TelemetryIngress) ValidateConfig ¶ added in v2.7.0
func (t *TelemetryIngress) ValidateConfig() (err error)
type TelemetryIngressEndpoint ¶ added in v2.7.0
type ThresholdKeyShareSecrets ¶
type ThresholdKeyShareSecrets struct {
}
func (*ThresholdKeyShareSecrets) SetFrom ¶
func (t *ThresholdKeyShareSecrets) SetFrom(f *ThresholdKeyShareSecrets) (err error)
type Tracing ¶ added in v2.7.0
type Tracing struct {
Enabled *bool
CollectorTarget *string
NodeID *string
SamplingRatio *float64
Attributes map[string]string `toml:",omitempty"`
}
func (*Tracing) ValidateConfig ¶ added in v2.7.0
type WebServer ¶
type WebServer struct {
AllowOrigins *string
BridgeResponseURL *models.URL
BridgeCacheTTL *models.Duration
HTTPWriteTimeout *models.Duration
HTTPPort *uint16
SecureCookies *bool
SessionTimeout *models.Duration
SessionReaperExpiration *models.Duration
HTTPMaxSize *utils.FileSize
StartTimeout *models.Duration
ListenIP *net.IP
MFA WebServerMFA `toml:",omitempty"`
RateLimit WebServerRateLimit `toml:",omitempty"`
TLS WebServerTLS `toml:",omitempty"`
}
type WebServerMFA ¶
type WebServerRateLimit ¶
Click to show internal directories.
Click to hide internal directories.