Documentation
¶
Index ¶
- Variables
- func NewOnchainKeyringV3Wrapper(keyring types.OnchainKeyring) *onchainKeyringV3Wrapper
- func NewPayloadBuilder(activeUpkeepList ActiveUpkeepList, recoverer logprovider.LogRecoverer, ...) *payloadBuilder
- func NewUpkeepProvider(activeUpkeeps ActiveUpkeepList, bs *BlockSubscriber, lp logpoller.LogPoller) *upkeepProvider
- func RegistryUpkeepFilterName(addr common.Address) string
- type ActiveUpkeepList
- type AutomationServices
- type BlockSubscriber
- type EvmRegistry
- func (r *EvmRegistry) CheckUpkeeps(ctx context.Context, keys ...ocr2keepers.UpkeepPayload) ([]ocr2keepers.CheckResult, error)
- func (r *EvmRegistry) Close() error
- func (r *EvmRegistry) HealthReport() map[string]error
- func (r *EvmRegistry) Name() string
- func (r *EvmRegistry) Start(ctx context.Context) error
- type HttpClient
- type MercuryConfig
- type MercuryData
- type MercuryV02Response
- type MercuryV03Report
- type MercuryV03Response
- type Registry
- type StreamsLookup
- type UpkeepPrivilegeConfig
Constants ¶
This section is empty.
Variables ¶
View Source
var ( RegistryServiceName = "AutomationRegistry" ErrLogReadFailure = fmt.Errorf("failure reading logs") ErrHeadNotAvailable = fmt.Errorf("head not available") ErrInitializationFailure = fmt.Errorf("failed to initialize registry") ErrContextCancelled = fmt.Errorf("context was cancelled") ErrABINotParsable = fmt.Errorf("error parsing abi") ActiveUpkeepIDBatchSize int64 = 1000 )
View Source
var (
BlockSubscriberServiceName = "BlockSubscriber"
)
Functions ¶
func NewOnchainKeyringV3Wrapper ¶ added in v2.5.0
func NewOnchainKeyringV3Wrapper(keyring types.OnchainKeyring) *onchainKeyringV3Wrapper
func NewPayloadBuilder ¶ added in v2.5.0
func NewPayloadBuilder(activeUpkeepList ActiveUpkeepList, recoverer logprovider.LogRecoverer, lggr logger.Logger) *payloadBuilder
func NewUpkeepProvider ¶ added in v2.5.0
func NewUpkeepProvider(activeUpkeeps ActiveUpkeepList, bs *BlockSubscriber, lp logpoller.LogPoller) *upkeepProvider
func RegistryUpkeepFilterName ¶ added in v2.5.0
Types ¶
type ActiveUpkeepList ¶ added in v2.5.0
type ActiveUpkeepList interface {
// Reset resets the list to the given IDs
Reset(ids ...*big.Int)
// Add adds new entries to the list
Add(id ...*big.Int) int
// Remove removes entries from the list
Remove(id ...*big.Int) int
// View returns the list of IDs of the given type
View(...ocr2keepers.UpkeepType) []*big.Int
// IsActive returns true if the given ID is of an active upkeep
IsActive(id *big.Int) bool
Size() int
}
ActiveUpkeepList is a list to manage active upkeep IDs
func NewActiveUpkeepList ¶ added in v2.5.0
func NewActiveUpkeepList() ActiveUpkeepList
NewActiveList creates a new ActiveList
type AutomationServices ¶ added in v2.5.0
type AutomationServices interface {
Registry() *EvmRegistry
Encoder() ocr2keepers.Encoder
TransmitEventProvider() *transmit.EventProvider
BlockSubscriber() *BlockSubscriber
PayloadBuilder() ocr2keepers.PayloadBuilder
UpkeepStateStore() upkeepstate.UpkeepStateStore
LogEventProvider() logprovider.LogEventProvider
LogRecoverer() logprovider.LogRecoverer
UpkeepProvider() ocr2keepers.ConditionalUpkeepProvider
Keyring() ocr3types.OnchainKeyring[plugin.AutomationReportInfo]
}
type BlockSubscriber ¶ added in v2.4.0
type BlockSubscriber struct {
utils.StartStopOnce
// contains filtered or unexported fields
}
func NewBlockSubscriber ¶ added in v2.4.0
func NewBlockSubscriber(hb httypes.HeadBroadcaster, lp logpoller.LogPoller, finalityDepth uint32, lggr logger.Logger) *BlockSubscriber
func (*BlockSubscriber) Close ¶ added in v2.4.0
func (bs *BlockSubscriber) Close() error
func (*BlockSubscriber) Start ¶ added in v2.4.0
func (bs *BlockSubscriber) Start(ctx context.Context) error
func (*BlockSubscriber) Subscribe ¶ added in v2.4.0
func (bs *BlockSubscriber) Subscribe() (int, chan ocr2keepers.BlockHistory, error)
func (*BlockSubscriber) Unsubscribe ¶ added in v2.4.0
func (bs *BlockSubscriber) Unsubscribe(subId int) error
type EvmRegistry ¶
type EvmRegistry struct {
utils.StartStopOnce
// contains filtered or unexported fields
}
func NewEvmRegistry ¶ added in v2.5.0
func NewEvmRegistry( lggr logger.Logger, addr common.Address, client evm.Chain, streamsLookupCompatibleABI, keeperRegistryABI abi.ABI, registry *iregistry21.IKeeperRegistryMaster, mc *models.MercuryCredentials, al ActiveUpkeepList, logEventProvider logprovider.LogEventProvider, packer encoding.Packer, blockSub *BlockSubscriber, finalityDepth uint32, ) *EvmRegistry
func (*EvmRegistry) CheckUpkeeps ¶ added in v2.4.0
func (r *EvmRegistry) CheckUpkeeps(ctx context.Context, keys ...ocr2keepers.UpkeepPayload) ([]ocr2keepers.CheckResult, error)
func (*EvmRegistry) Close ¶
func (r *EvmRegistry) Close() error
func (*EvmRegistry) HealthReport ¶
func (r *EvmRegistry) HealthReport() map[string]error
func (*EvmRegistry) Name ¶
func (r *EvmRegistry) Name() string
type MercuryConfig ¶
type MercuryConfig struct {
// contains filtered or unexported fields
}
type MercuryData ¶ added in v2.5.0
type MercuryV02Response ¶ added in v2.5.0
type MercuryV02Response struct {
ChainlinkBlob string `json:"chainlinkBlob"`
}
MercuryV02Response represents a JSON structure used by Mercury v0.2
type MercuryV03Report ¶ added in v2.5.0
type MercuryV03Response ¶ added in v2.5.0
type MercuryV03Response struct {
Reports []MercuryV03Report `json:"reports"`
}
MercuryV03Response represents a JSON structure used by Mercury v0.3
type Registry ¶
type Registry interface {
GetUpkeep(opts *bind.CallOpts, id *big.Int) (encoding.UpkeepInfo, error)
GetState(opts *bind.CallOpts) (iregistry21.GetState, error)
GetActiveUpkeepIDs(opts *bind.CallOpts, startIndex *big.Int, maxCount *big.Int) ([]*big.Int, error)
GetUpkeepPrivilegeConfig(opts *bind.CallOpts, upkeepId *big.Int) ([]byte, error)
GetUpkeepTriggerConfig(opts *bind.CallOpts, upkeepId *big.Int) ([]byte, error)
CheckCallback(opts *bind.TransactOpts, id *big.Int, values [][]byte, extraData []byte) (*coreTypes.Transaction, error)
ParseLog(log coreTypes.Log) (generated.AbigenLog, error)
}
type StreamsLookup ¶ added in v2.6.0
type StreamsLookup struct {
// contains filtered or unexported fields
}
type UpkeepPrivilegeConfig ¶ added in v2.5.0
type UpkeepPrivilegeConfig struct {
MercuryEnabled bool `json:"mercuryEnabled"`
}
UpkeepPrivilegeConfig represents the administrative offchain config for each upkeep. It can be set by s_upkeepPrivilegeManager role on the registry. Upkeeps allowed to use Mercury server will have this set to true.
Source Files
¶
Click to show internal directories.
Click to hide internal directories.