evm

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
  • func NewActiveUpkeepList() ActiveUpkeepList
• type AutomationServices
  • func New(addr common.Address, client evm.Chain, mc *models.MercuryCredentials, ...) (AutomationServices, error)
• type BlockSubscriber
  • func NewBlockSubscriber(hb httypes.HeadBroadcaster, lp logpoller.LogPoller, finalityDepth uint32, ...) *BlockSubscriber
  • func (bs *BlockSubscriber) Close() error
  • func (bs *BlockSubscriber) Start(ctx context.Context) error
  • func (bs *BlockSubscriber) Subscribe() (int, chan ocr2keepers.BlockHistory, error)
  • func (bs *BlockSubscriber) Unsubscribe(subId int) error
• type EvmRegistry
  • func NewEvmRegistry(lggr logger.Logger, addr common.Address, client evm.Chain, ...) *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

Variables

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
)

var (
	BlockSubscriberServiceName = "BlockSubscriber"
)

Functions

func NewOnchainKeyringV3Wrapper

func NewOnchainKeyringV3Wrapper(keyring types.OnchainKeyring) *onchainKeyringV3Wrapper

func NewPayloadBuilder

func NewPayloadBuilder(activeUpkeepList ActiveUpkeepList, recoverer logprovider.LogRecoverer, lggr logger.Logger) *payloadBuilder

func NewUpkeepProvider

func NewUpkeepProvider(activeUpkeeps ActiveUpkeepList, bs *BlockSubscriber, lp logpoller.LogPoller) *upkeepProvider

func RegistryUpkeepFilterName

func RegistryUpkeepFilterName(addr common.Address) string

Types

type ActiveUpkeepList

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

func NewActiveUpkeepList() ActiveUpkeepList

NewActiveList creates a new ActiveList

type AutomationServices

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]
}

func New

func New(addr common.Address, client evm.Chain, mc *models.MercuryCredentials, keyring ocrtypes.OnchainKeyring, lggr logger.Logger, db *sqlx.DB, dbCfg pg.QConfig) (AutomationServices, error)

type BlockSubscriber

type BlockSubscriber struct {
	utils.StartStopOnce
	// contains filtered or unexported fields
}

func NewBlockSubscriber

func NewBlockSubscriber(hb httypes.HeadBroadcaster, lp logpoller.LogPoller, finalityDepth uint32, lggr logger.Logger) *BlockSubscriber

func (*BlockSubscriber) Close

func (bs *BlockSubscriber) Close() error

func (*BlockSubscriber) Start

func (bs *BlockSubscriber) Start(ctx context.Context) error

func (*BlockSubscriber) Subscribe

func (bs *BlockSubscriber) Subscribe() (int, chan ocr2keepers.BlockHistory, error)

func (*BlockSubscriber) Unsubscribe

func (bs *BlockSubscriber) Unsubscribe(subId int) error

type EvmRegistry

type EvmRegistry struct {
	utils.StartStopOnce
	// contains filtered or unexported fields
}

func NewEvmRegistry

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

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

func (*EvmRegistry) Start

func (r *EvmRegistry) Start(ctx context.Context) error

type HttpClient

type HttpClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type MercuryConfig

type MercuryConfig struct {
	// contains filtered or unexported fields
}

type MercuryData

type MercuryData struct {
	Index     int
	Error     error
	Retryable bool
	Bytes     [][]byte
	State     encoding.PipelineExecutionState
}

type MercuryV02Response

type MercuryV02Response struct {
	ChainlinkBlob string `json:"chainlinkBlob"`
}

MercuryV02Response represents a JSON structure used by Mercury v0.2

type MercuryV03Report

type MercuryV03Report struct {
	FeedID                string `json:"feedID"` // feed id in hex encoded
	ValidFromTimestamp    uint32 `json:"validFromTimestamp"`
	ObservationsTimestamp uint32 `json:"observationsTimestamp"`
	FullReport            string `json:"fullReport"` // the actual hex encoded mercury report of this feed, can be sent to verifier
}

type MercuryV03Response

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

type StreamsLookup struct {
	// contains filtered or unexported fields
}

type UpkeepPrivilegeConfig

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.