Documentation
¶
Index ¶
- Constants
- Variables
- func ChainIDInt64(cid string) (int64, error)
- func ChainTypeForID(chainID *big.Big) (chaintype.ChainType, bool)
- func GenerateDocs() (string, error)
- type AutoPurgeConfig
- type Automation
- type BalanceMonitor
- type BlockHistoryEstimator
- type Chain
- type ClientErrors
- type DAOracle
- type DAOracleType
- type EVMConfig
- type EVMConfigs
- func (cs EVMConfigs) Chains(ids ...string) (r []commontypes.ChainStatus, total int, err error)
- func (cs EVMConfigs) Enabled() bool
- func (cs EVMConfigs) Node(name string) (types.Node, error)
- func (cs EVMConfigs) NodeStatus(name string) (commontypes.NodeStatus, error)
- func (cs EVMConfigs) NodeStatuses(chainIDs ...string) (ns []commontypes.NodeStatus, err error)
- func (cs EVMConfigs) Nodes(chainID string) (ns []types.Node, err error)
- func (cs EVMConfigs) RPCEnabled() bool
- func (cs *EVMConfigs) SetFrom(fs *EVMConfigs) (err error)
- func (cs EVMConfigs) ValidateConfig() (err error)
- type EVMNodes
- type FeeHistoryEstimator
- type GasEstimator
- type GasLimitJobType
- type HasEVMConfigs
- type HeadTracker
- type KeySpecific
- type KeySpecificConfig
- type KeySpecificGasEstimator
- type Node
- type NodePool
- type OCR
- type OCR2
- type TransactionManagerV2Config
- type Transactions
- type Workflow
Constants ¶
View Source
const ( DAOracleOPStack = DAOracleType("opstack") DAOracleArbitrum = DAOracleType("arbitrum") DAOracleZKSync = DAOracleType("zksync") DAOracleCustomCalldata = DAOracleType("custom_calldata") )
View Source
const ENV_CUSTOM_DEFAULTS = "CL_CHAIN_DEFAULTS"
Variables ¶
View Source
var ( // DefaultIDs is the set of chain ids which have defaults. DefaultIDs []*big.Big )
View Source
var (
ErrNotFound = errors.New("not found")
)
Functions ¶
func ChainIDInt64 ¶
func GenerateDocs ¶
Types ¶
type AutoPurgeConfig ¶
type AutoPurgeConfig struct {
Enabled *bool
Threshold *uint32
MinAttempts *uint32
DetectionApiUrl *commonconfig.URL
}
type Automation ¶
type Automation struct {
GasLimit *uint32
}
type BalanceMonitor ¶
type BalanceMonitor struct {
Enabled *bool
}
type BlockHistoryEstimator ¶
type Chain ¶
type Chain struct {
AutoCreateKey *bool
BlockBackfillDepth *uint32
BlockBackfillSkip *bool
ChainType *chaintype.Config
FinalityDepth *uint32
SafeDepth *uint32
FinalityTagEnabled *bool
FlagsContractAddress *types.EIP55Address
LinkContractAddress *types.EIP55Address
LogBackfillBatchSize *uint32
LogPollInterval *commonconfig.Duration
LogKeepBlocksDepth *uint32
LogPrunePageSize *uint32
BackupLogPollerBlockDelay *uint64
MinIncomingConfirmations *uint32
MinContractPayment *commonassets.Link
NonceAutoSync *bool
NoNewHeadsThreshold *commonconfig.Duration
OperatorFactoryAddress *types.EIP55Address
LogBroadcasterEnabled *bool
RPCDefaultBatchSize *uint32
RPCBlockQueryDelay *uint16
FinalizedBlockOffset *uint32
NoNewFinalizedHeadsThreshold *commonconfig.Duration
Transactions Transactions `toml:",omitempty"`
BalanceMonitor BalanceMonitor `toml:",omitempty"`
GasEstimator GasEstimator `toml:",omitempty"`
HeadTracker HeadTracker `toml:",omitempty"`
KeySpecific KeySpecificConfig `toml:",omitempty"`
NodePool NodePool `toml:",omitempty"`
OCR OCR `toml:",omitempty"`
OCR2 OCR2 `toml:",omitempty"`
Workflow Workflow `toml:",omitempty"`
}
func Defaults ¶
Defaults returns a Chain based on the defaults for chainID and fields from with, applied in order so later Chains override earlier ones.
func DefaultsNamed ¶
DefaultsNamed returns the default Chain values, optionally for the given chainID, as well as a name if the chainID is known.
func (*Chain) ValidateConfig ¶
type ClientErrors ¶
type ClientErrors struct {
NonceTooLow *string `toml:",omitempty"`
NonceTooHigh *string `toml:",omitempty"`
ReplacementTransactionUnderpriced *string `toml:",omitempty"`
LimitReached *string `toml:",omitempty"`
TransactionAlreadyInMempool *string `toml:",omitempty"`
TerminallyUnderpriced *string `toml:",omitempty"`
InsufficientEth *string `toml:",omitempty"`
TxFeeExceedsCap *string `toml:",omitempty"`
L2FeeTooLow *string `toml:",omitempty"`
L2FeeTooHigh *string `toml:",omitempty"`
L2Full *string `toml:",omitempty"`
TransactionAlreadyMined *string `toml:",omitempty"`
Fatal *string `toml:",omitempty"`
TooManyResults *string `toml:",omitempty"`
MissingBlocks *string `toml:",omitempty"`
}
type DAOracle ¶
type DAOracle struct {
OracleType *DAOracleType
OracleAddress *types.EIP55Address
CustomGasPriceCalldata *string
}
func (*DAOracle) ValidateConfig ¶
type DAOracleType ¶
type DAOracleType string
func (DAOracleType) IsValid ¶
func (o DAOracleType) IsValid() bool
type EVMConfig ¶
func (*EVMConfig) ConfirmationTimeout ¶
func (*EVMConfig) TOMLString ¶
func (*EVMConfig) ValidateConfig ¶
type EVMConfigs ¶
type EVMConfigs []*EVMConfig
func (EVMConfigs) Chains ¶
func (cs EVMConfigs) Chains(ids ...string) (r []commontypes.ChainStatus, total int, err error)
func (EVMConfigs) Enabled ¶
func (cs EVMConfigs) Enabled() bool
func (EVMConfigs) NodeStatus ¶
func (cs EVMConfigs) NodeStatus(name string) (commontypes.NodeStatus, error)
func (EVMConfigs) NodeStatuses ¶
func (cs EVMConfigs) NodeStatuses(chainIDs ...string) (ns []commontypes.NodeStatus, err error)
func (EVMConfigs) RPCEnabled ¶
func (cs EVMConfigs) RPCEnabled() bool
func (*EVMConfigs) SetFrom ¶
func (cs *EVMConfigs) SetFrom(fs *EVMConfigs) (err error)
func (EVMConfigs) ValidateConfig ¶
func (cs EVMConfigs) ValidateConfig() (err error)
type FeeHistoryEstimator ¶
type FeeHistoryEstimator struct {
CacheTimeout *commonconfig.Duration
}
type GasEstimator ¶
type GasEstimator struct {
Mode *string
PriceDefault *assets.Wei
PriceMax *assets.Wei
PriceMin *assets.Wei
LimitDefault *uint64
LimitMax *uint64
LimitMultiplier *decimal.Decimal
LimitTransfer *uint64
LimitJobType GasLimitJobType `toml:",omitempty"`
EstimateLimit *bool
SenderAddress *types.EIP55Address `toml:",omitempty"`
BumpMin *assets.Wei
BumpPercent *uint16
BumpThreshold *uint32
BumpTxDepth *uint32
EIP1559DynamicFees *bool
FeeCapDefault *assets.Wei
TipCapDefault *assets.Wei
TipCapMin *assets.Wei
BlockHistory BlockHistoryEstimator `toml:",omitempty"`
FeeHistory FeeHistoryEstimator `toml:",omitempty"`
DAOracle DAOracle `toml:",omitempty"`
}
func (*GasEstimator) ValidateConfig ¶
func (e *GasEstimator) ValidateConfig() (err error)
type GasLimitJobType ¶
type HasEVMConfigs ¶
type HasEVMConfigs interface {
EVMConfigs() EVMConfigs
}
type HeadTracker ¶
type HeadTracker struct {
HistoryDepth *uint32
MaxBufferSize *uint32
SamplingInterval *commonconfig.Duration
MaxAllowedFinalityDepth *uint32
FinalityTagBypass *bool
PersistenceEnabled *bool
PersistenceBatchSize *int64
}
func (*HeadTracker) ValidateConfig ¶
func (t *HeadTracker) ValidateConfig() (err error)
type KeySpecific ¶
type KeySpecific struct {
Key *types.EIP55Address
GasEstimator KeySpecificGasEstimator `toml:",omitempty"`
}
type KeySpecificConfig ¶
type KeySpecificConfig []KeySpecific
func (KeySpecificConfig) ValidateConfig ¶
func (ks KeySpecificConfig) ValidateConfig() (err error)
type KeySpecificGasEstimator ¶
type Node ¶
type Node struct {
Name *string
WSURL *commonconfig.URL
HTTPURL *commonconfig.URL
// The HTTPURLExtraWrite is an undocumented config option used only for chains that require
// an additional URL in conjunction to the standard JSON-RPC URL
// Supports TRON (different write path)
HTTPURLExtraWrite *commonconfig.URL
SendOnly *bool
Order *int32
}
func (*Node) ValidateConfig ¶
type NodePool ¶
type NodePool struct {
PollFailureThreshold *uint32
PollInterval *commonconfig.Duration
SelectionMode *string
SyncThreshold *uint32
LeaseDuration *commonconfig.Duration
NodeIsSyncingEnabled *bool
FinalizedBlockPollInterval *commonconfig.Duration
Errors ClientErrors `toml:",omitempty"`
EnforceRepeatableRead *bool
DeathDeclarationDelay *commonconfig.Duration
NewHeadsPollInterval *commonconfig.Duration
VerifyChainID *bool
}
func (*NodePool) ValidateConfig ¶
type OCR ¶
type OCR struct {
ContractConfirmations *uint16
ContractTransmitterTransmitTimeout *commonconfig.Duration
DatabaseTimeout *commonconfig.Duration
DeltaCOverride *commonconfig.Duration
DeltaCJitterOverride *commonconfig.Duration
ObservationGracePeriod *commonconfig.Duration
}
type OCR2 ¶
type OCR2 struct {
Automation Automation `toml:",omitempty"`
}
type TransactionManagerV2Config ¶
type TransactionManagerV2Config struct {
Enabled *bool `toml:",omitempty"`
BlockTime *commonconfig.Duration `toml:",omitempty"`
CustomURL *commonconfig.URL `toml:",omitempty"`
DualBroadcast *bool `toml:",omitempty"`
}
func (*TransactionManagerV2Config) ValidateConfig ¶
func (t *TransactionManagerV2Config) ValidateConfig() (err error)
type Transactions ¶
type Transactions struct {
Enabled *bool
ForwardersEnabled *bool
MaxInFlight *uint32
MaxQueued *uint32
ReaperInterval *commonconfig.Duration
ReaperThreshold *commonconfig.Duration
ResendAfterThreshold *commonconfig.Duration
ConfirmationTimeout *commonconfig.Duration
AutoPurge AutoPurgeConfig `toml:",omitempty"`
TransactionManagerV2 TransactionManagerV2Config `toml:",omitempty"`
}
func (*Transactions) ValidateConfig ¶
func (c *Transactions) ValidateConfig() (err error)
type Workflow ¶
type Workflow struct {
FromAddress *types.EIP55Address `toml:",omitempty"`
ForwarderAddress *types.EIP55Address `toml:",omitempty"`
GasLimitDefault *uint64
TxAcceptanceState *commontypes.TransactionStatus
PollPeriod *commonconfig.Duration
AcceptanceTimeout *commonconfig.Duration
}
Click to show internal directories.
Click to hide internal directories.