Documentation
¶
Index ¶
- Variables
- func Validate(cfg interface{}) (err error)
- type AutoPprof
- type Core
- type Database
- type DatabaseBackup
- type DatabaseListener
- type DatabaseLock
- type ErrEmpty
- type ErrInvalid
- type ErrMissing
- type Feature
- type FluxMonitor
- type JobPipeline
- type Keeper
- type Log
- type OCR
- type OCR2
- type P2P
- type P2PV1
- type P2PV2
- type Secrets
- type Sentry
- type TelemetryIngress
- type Validated
- type WebServer
- type WebServerMFA
- type WebServerRateLimit
- type WebServerTLS
Constants ¶
This section is empty.
Variables ¶
View Source
var (
CLDev = strings.ToLower(os.Getenv("CL_DEV")) == "true"
)
Functions ¶
Types ¶
type AutoPprof ¶
type AutoPprof struct {
Enabled *bool //TODO Disabled https://app.shortcut.com/chainlinklabs/story/33615/
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
ExplorerURL *models.URL
InsecureFastScrypt *bool
RootDir *string
ShutdownGracePeriod *models.Duration
Feature *Feature
Database *Database
TelemetryIngress *TelemetryIngress
Log *Log
WebServer *WebServer
JobPipeline *JobPipeline
FluxMonitor *FluxMonitor
OCR2 *OCR2
OCR *OCR
P2P *P2P
Keeper *Keeper
AutoPprof *AutoPprof
Sentry *Sentry
}
Core holds the core configuration. See chainlink.Config for more information.
type Database ¶
type Database struct {
DefaultIdleInTxSessionTimeout *models.Duration
DefaultLockTimeout *models.Duration
DefaultQueryTimeout *models.Duration
MigrateOnStartup *bool
ORMMaxIdleConns *int64
ORMMaxOpenConns *int64
Backup *DatabaseBackup
Listener *DatabaseListener
Lock *DatabaseLock
}
type DatabaseBackup ¶
type DatabaseListener ¶
type DatabaseLock ¶
type ErrInvalid ¶ added in v1.8.0
func (ErrInvalid) Error ¶ added in v1.8.0
func (e ErrInvalid) Error() string
type ErrMissing ¶ added in v1.8.0
func (ErrMissing) Error ¶ added in v1.8.0
func (e ErrMissing) Error() string
type FluxMonitor ¶
type JobPipeline ¶
type Keeper ¶
type Keeper struct {
DefaultTransactionQueueDepth *uint32
GasPriceBufferPercent *uint32
GasTipCapBufferPercent *uint32
BaseFeeBufferPercent *uint32
MaximumGracePeriod *int64
RegistryCheckGasOverhead *uint32
RegistryPerformGasOverhead *uint32
RegistrySyncInterval *models.Duration
RegistrySyncUpkeepQueueSize *uint32
TurnLookBack *int64
TurnFlagEnabled *bool
UpkeepCheckGasPriceEnabled *bool
}
type OCR ¶
type OCR struct {
Enabled *bool //TODO disabled https://app.shortcut.com/chainlinklabs/story/33615/
ObservationTimeout *models.Duration
BlockchainTimeout *models.Duration
ContractPollInterval *models.Duration
ContractSubscribeInterval *models.Duration
DefaultTransactionQueueDepth *uint32
// Optional
KeyBundleID *models.Sha256Hash
SimulateTransactions *bool
TransmitterAddress *ethkey.EIP55Address
}
type OCR2 ¶
type OCR2 struct {
Enabled *bool //TODO disabled https://app.shortcut.com/chainlinklabs/story/33615/
ContractConfirmations *uint32
BlockchainTimeout *models.Duration
ContractPollInterval *models.Duration
ContractSubscribeInterval *models.Duration
ContractTransmitterTransmitTimeout *models.Duration
DatabaseTimeout *models.Duration
KeyBundleID *models.Sha256Hash
}
type P2P ¶
type P2P struct {
// V1 and V2
IncomingMessageBufferSize *int64
OutgoingMessageBufferSize *int64
TraceLogging *bool
V1 *P2PV1
V2 *P2PV2
}
func (*P2P) NetworkStack ¶
func (p *P2P) NetworkStack() ocrnetworking.NetworkingStack
type P2PV1 ¶
type P2PV1 struct {
AnnounceIP *net.IP
AnnouncePort *uint16
BootstrapCheckInterval *models.Duration
DefaultBootstrapPeers *[]string
DHTAnnouncementCounterUserPrefix *uint32
DHTLookupInterval *int64
ListenIP *net.IP
ListenPort *uint16
NewStreamTimeout *models.Duration
PeerID *p2pkey.PeerID
PeerstoreWriteInterval *models.Duration
}
type P2PV2 ¶
type P2PV2 struct {
AnnounceAddresses *[]string
DefaultBootstrappers *[]ocrcommontypes.BootstrapperLocator
DeltaDial *models.Duration
DeltaReconcile *models.Duration
ListenAddresses *[]string
}
type Secrets ¶
type Secrets struct {
DatabaseURL *models.URL
DatabaseBackupURL *models.URL
ExplorerAccessKey *string
ExplorerSecret *string
KeystorePassword *string
VRFPassword *string
}
func (*Secrets) MarshalJSON ¶ added in v1.8.0
func (*Secrets) MarshalText ¶ added in v1.8.0
func (*Secrets) ValidateConfig ¶ added in v1.8.0
type TelemetryIngress ¶
type Validated ¶ added in v1.8.0
type Validated interface {
// ValidateConfig returns nil if the config is valid, otherwise an error describing why it is invalid.
//
// For implementations:
// - A nil receiver should return nil, freeing the caller to decide whether each case is required.
// - Use package multierr to accumulate all errors, rather than returning the first encountered.
ValidateConfig() error
}
Validated configurations impose constraints that must be checked.
type WebServer ¶
type WebServer struct {
AllowOrigins *string
BridgeResponseURL *models.URL
HTTPWriteTimeout *models.Duration
HTTPPort *uint16
SecureCookies *bool
SessionTimeout *models.Duration
SessionReaperExpiration *models.Duration
MFA *WebServerMFA
RateLimit *WebServerRateLimit
TLS *WebServerTLS
}
type WebServerMFA ¶
type WebServerRateLimit ¶
Click to show internal directories.
Click to hide internal directories.