automation

type BlockHistory []BlockKey

type BlockKey struct {
	Number BlockNumber
	Hash   [32]byte
}

type BlockNumber uint64

type BlockSubscriber interface {
	// Subscribe provides an identifier integer, a new channel, and potentially an error
	Subscribe() (int, chan BlockHistory, error)
	// Unsubscribe requires an identifier integer and indicates the provided channel should be closed
	Unsubscribe(int) error
	Start(context.Context) error
	Close() error
}

type CheckResult struct {
	// zero if success, else indicates an error code
	PipelineExecutionState uint8
	// if PipelineExecutionState is non zero, then retryable indicates that the same
	// payload can be processed again in order to get a successful execution
	Retryable bool
	// Rest of these fields are only applicable if PipelineExecutionState is zero
	// Eligible indicates whether this result is eligible to be performed
	Eligible bool
	// If result is not eligible then the reason it failed. Should be 0 if eligible
	IneligibilityReason uint8
	// Upkeep is all the information that identifies the upkeep
	UpkeepID UpkeepIdentifier
	// Trigger is the event that triggered the upkeep to be checked
	Trigger Trigger
	// WorkID represents the unit of work for the check result
	// Exploratory: Make workID an internal field and an external WorkID() function which generates WID
	WorkID string
	// GasAllocated is the gas to provide an upkeep in a report
	GasAllocated uint64
	// PerformData is the raw data returned when simulating an upkeep perform
	PerformData []byte
	// FastGasWei is the fast gas price in wei when performing this upkeep
	FastGasWei *big.Int
	// Link to native ratio to be used when performing this upkeep
	LinkNative *big.Int
	// RetryInterval is the time interval after which the same payload can be retried.
	// This field is used is special cases (such as mercury lookup), where we want to
	// have a different retry interval than the default one (30s)
	// NOTE: this field is not encoded in JSON and is only used internally
	RetryInterval time.Duration
}

type ConditionalUpkeepProvider interface {
	GetActiveUpkeeps(context.Context) ([]UpkeepPayload, error)
}

type CoordinatedBlockProposal struct {
	// UpkeepID is the id of the proposed upkeep
	UpkeepID UpkeepIdentifier
	// Trigger represents the event that triggered the upkeep to be checked
	Trigger Trigger
	// WorkID represents the unit of work for the coordinated proposal
	WorkID string
}

type Encoder interface {
	Encode(...CheckResult) ([]byte, error)
	Extract([]byte) ([]ReportedUpkeep, error)
}

type EventProvider interface {
	services.Service
	GetLatestEvents(ctx context.Context) ([]TransmitEvent, error)
}

type LogEventProvider interface {
	GetLatestPayloads(context.Context) ([]UpkeepPayload, error)
	SetConfig(LogEventProviderConfig)
	Start(context.Context) error
	Close() error
}

type LogEventProviderConfig struct {
	BlockRate uint32
	LogLimit  uint32
}

type LogRecoverer interface {
	RecoverableProvider
	GetProposalData(context.Context, CoordinatedBlockProposal) ([]byte, error)

	Start(context.Context) error
	io.Closer
}

type LogTriggerExtension struct {
	// LogTxHash is the transaction hash of the log event
	TxHash [32]byte
	// Index is the index of the log event in the transaction
	Index uint32
	// BlockHash is the block hash in which the event occurred
	BlockHash [32]byte
	// BlockNumber is the block number in which the event occurred
	// NOTE: This field might be empty. If relying on this field check
	// it is non empty, if it's empty derive from BlockHash
	BlockNumber BlockNumber
}

type PayloadBuilder interface {
	// Can get payloads for a subset of proposals along with an error
	BuildPayloads(context.Context, ...CoordinatedBlockProposal) ([]UpkeepPayload, error)
}

type RecoverableProvider interface {
	GetRecoveryProposals(context.Context) ([]UpkeepPayload, error)
}

type Registry interface {
	CheckUpkeeps(ctx context.Context, keys ...UpkeepPayload) ([]CheckResult, error)
	Name() string
	Start(ctx context.Context) error
	Close() error
	HealthReport() map[string]error
}

type ReportedUpkeep struct {
	// UpkeepID id of the underlying upkeep
	UpkeepID UpkeepIdentifier
	// Trigger data for the upkeep
	Trigger Trigger
	// WorkID represents the unit of work for the reported upkeep
	WorkID string
}

type TransmitEvent struct {
	// Type describes the type of event
	Type TransmitEventType
	// TransmitBlock is the block height of the transmit event
	TransmitBlock BlockNumber
	// Confirmations is the block height behind latest
	Confirmations int64
	// TransactionHash is the hash for the transaction where the event originated
	TransactionHash [32]byte
	// UpkeepID uniquely identifies the upkeep in the registry
	UpkeepID UpkeepIdentifier
	// WorkID uniquely identifies the unit of work for the specified upkeep
	WorkID string
	// CheckBlock is the block value that the upkeep was originally checked at
	CheckBlock BlockNumber
}

type TransmitEventType int

type Trigger struct {
	// BlockNumber is the block number in which the trigger was checked
	BlockNumber BlockNumber
	// BlockHash is the block hash in which the trigger was checked
	BlockHash [32]byte
	// LogTriggerExtension is the extension for log triggers
	LogTriggerExtension *LogTriggerExtension
}

type UpkeepIdentifier [32]byte

type UpkeepPayload struct {
	// Upkeep is all the information that identifies the upkeep
	UpkeepID UpkeepIdentifier
	// Trigger is the event that triggered the upkeep to be checked
	Trigger Trigger
	// WorkID uniquely identifies the unit of work for the specified upkeep
	WorkID string
	// CheckData is the data used to check the upkeep
	CheckData []byte
}

type UpkeepState uint8

type UpkeepStateReader interface {
	SelectByWorkIDs(ctx context.Context, workIDs ...string) ([]UpkeepState, error)
}

type UpkeepStateStore interface {
	UpkeepStateUpdater
	UpkeepStateReader
	Start(context.Context) error
	io.Closer
}

type UpkeepStateUpdater interface {
	SetUpkeepState(context.Context, CheckResult, UpkeepState) error
}