keeper

Documentation

Index

• Variables
• func ValidatedKeeperSpec(tomlString string) (job.Job, error)
• type Delegate
  • func NewDelegate(db *gorm.DB, ethClient eth.Client, headBroadcaster *services.HeadBroadcaster, ...) *Delegate
  • func (d *Delegate) JobType() job.Type
  • func (d *Delegate) ServicesForSpec(spec job.Job) (services []job.Service, err error)
• type ORM
  • func NewORM(db *gorm.DB) ORM
  • func (korm ORM) BatchDeleteUpkeeps(ctx context.Context, registryID int32, upkeedIDs []int64) error
  • func (korm ORM) CreateEthTransactionForUpkeep(ctx context.Context, upkeep UpkeepRegistration, payload []byte) error
  • func (korm ORM) DeleteRegistryByJobID(ctx context.Context, jobID int32) error
  • func (korm ORM) EligibleUpkeeps(ctx context.Context, blockNumber int64) (upkeeps []UpkeepRegistration, _ error)
  • func (korm ORM) LowestUnsyncedID(ctx context.Context, reg Registry) (nextID int64, err error)
  • func (korm ORM) Registries(ctx context.Context) (registries []Registry, _ error)
  • func (korm ORM) UpsertRegistry(ctx context.Context, registry *Registry) error
  • func (korm ORM) UpsertUpkeep(ctx context.Context, registration *UpkeepRegistration) error
• type Registry
  • func NewRegistry(address models.EIP55Address, from models.EIP55Address, jobID int32) Registry
  • func (Registry) TableName() string
• type RegistrySynchronizer
  • func NewRegistrySynchronizer(job job.Job, contract *keeper_registry_wrapper.KeeperRegistry, db *gorm.DB, ...) *RegistrySynchronizer
  • func (rs *RegistrySynchronizer) Close() error
  • func (rs *RegistrySynchronizer) Start() error
• type UpkeepExecutor
  • func NewUpkeepExecutor(job job.Job, db *gorm.DB, ethClient eth.Client, ...) *UpkeepExecutor
  • func (executor *UpkeepExecutor) Close() error
  • func (executor *UpkeepExecutor) OnNewLongestChain(ctx context.Context, head models.Head)
  • func (executor *UpkeepExecutor) Start() error
• type UpkeepRegistration

Variables

var RegistryABI = eth.MustGetABI(keeper_registry_wrapper.KeeperRegistryABI)

Functions

func ValidatedKeeperSpec

func ValidatedKeeperSpec(tomlString string) (job.Job, error)

Types

type Delegate

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

func NewDelegate

func NewDelegate(db *gorm.DB, ethClient eth.Client, headBroadcaster *services.HeadBroadcaster, config *orm.Config) *Delegate

func (*Delegate) JobType

func (d *Delegate) JobType() job.Type

func (*Delegate) ServicesForSpec

func (d *Delegate) ServicesForSpec(spec job.Job) (services []job.Service, err error)

type ORM

type ORM struct {
	DB *gorm.DB
}

func NewORM

func NewORM(db *gorm.DB) ORM

func (ORM) BatchDeleteUpkeeps

func (korm ORM) BatchDeleteUpkeeps(ctx context.Context, registryID int32, upkeedIDs []int64) error

func (ORM) CreateEthTransactionForUpkeep

func (korm ORM) CreateEthTransactionForUpkeep(ctx context.Context, upkeep UpkeepRegistration, payload []byte) error

func (ORM) DeleteRegistryByJobID

func (korm ORM) DeleteRegistryByJobID(ctx context.Context, jobID int32) error

func (ORM) EligibleUpkeeps

func (korm ORM) EligibleUpkeeps(ctx context.Context, blockNumber int64) (upkeeps []UpkeepRegistration, _ error)

func (ORM) LowestUnsyncedID

func (korm ORM) LowestUnsyncedID(ctx context.Context, reg Registry) (nextID int64, err error)

LowestUnsyncedID returns the largest upkeepID + 1, indicating the expected next upkeepID to sync from the contract

func (ORM) Registries

func (korm ORM) Registries(ctx context.Context) (registries []Registry, _ error)

func (ORM) UpsertRegistry

func (korm ORM) UpsertRegistry(ctx context.Context, registry *Registry) error

func (ORM) UpsertUpkeep

func (korm ORM) UpsertUpkeep(ctx context.Context, registration *UpkeepRegistration) error

type Registry

type Registry struct {
	ID                int32 `gorm:"primary_key"`
	BlockCountPerTurn int32
	CheckGas          int32
	ContractAddress   models.EIP55Address
	FromAddress       models.EIP55Address
	JobID             int32
	KeeperIndex       int32
	NumKeepers        int32
}

func NewRegistry

func NewRegistry(address models.EIP55Address, from models.EIP55Address, jobID int32) Registry

func (Registry) TableName

func (Registry) TableName() string

type RegistrySynchronizer

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

func NewRegistrySynchronizer

func NewRegistrySynchronizer(
	job job.Job,
	contract *keeper_registry_wrapper.KeeperRegistry,
	db *gorm.DB,
	syncInterval time.Duration,
) *RegistrySynchronizer

func (*RegistrySynchronizer) Close

func (rs *RegistrySynchronizer) Close() error

func (*RegistrySynchronizer) Start

func (rs *RegistrySynchronizer) Start() error

type UpkeepExecutor

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

func NewUpkeepExecutor

func NewUpkeepExecutor(
	job job.Job,
	db *gorm.DB,
	ethClient eth.Client,
	headBroadcaster *services.HeadBroadcaster,
) *UpkeepExecutor

func (*UpkeepExecutor) Close

func (executor *UpkeepExecutor) Close() error

func (*UpkeepExecutor) OnNewLongestChain

func (executor *UpkeepExecutor) OnNewLongestChain(ctx context.Context, head models.Head)

func (*UpkeepExecutor) Start

func (executor *UpkeepExecutor) Start() error

type UpkeepRegistration

type UpkeepRegistration struct {
	ID                  int32 `gorm:"primary_key"`
	CheckData           []byte
	ExecuteGas          int32
	RegistryID          int32
	Registry            Registry
	UpkeepID            int64
	PositioningConstant int32
}

todo - upkeep