timelock

Documentation

Index

• func SetLiveStatus(status HealthStatus)
• func SetReadyStatus(status HealthStatus)
• func StartHTTPHealthServer(log *zap.SugaredLogger)
• func StartMetricsServer(log *zap.SugaredLogger)
• type HealthStatus
  • func GetLiveStatus() HealthStatus
  • func GetReadyStatus() HealthStatus
• type Scheduler
• type Worker
  • func NewTimelockWorker(nodeURL, timelockAddress, callProxyAddress, privateKey string, ...) (*Worker, error)
  • func (tw *Worker) Listen(ctx context.Context) error

Functions

func SetLiveStatus

func SetLiveStatus(status HealthStatus)

func SetReadyStatus

func SetReadyStatus(status HealthStatus)

func StartHTTPHealthServer

func StartHTTPHealthServer(log *zap.SugaredLogger)

Starts a http server, serving the healthz endpoint.

func StartMetricsServer

func StartMetricsServer(log *zap.SugaredLogger)

Types

type HealthStatus

type HealthStatus int

HealthStatus represents the health status enum.

const (
	HealthStatusOK HealthStatus = iota
	HealthStatusError
)

func GetLiveStatus

func GetLiveStatus() HealthStatus

func GetReadyStatus

func GetReadyStatus() HealthStatus

type Scheduler

type Scheduler interface {
	// contains filtered or unexported methods
}

type Worker

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

Worker represents a worker instance. address is an array of addresses as expected by ethereum.FilterQuery, but it's enforced only to one address in the logic.

func NewTimelockWorker

func NewTimelockWorker(
	nodeURL, timelockAddress, callProxyAddress, privateKey string, fromBlock *big.Int,
	pollPeriod int64, listenerPollPeriod int64, pollSize uint64, dryRun bool, logger *zap.SugaredLogger,
) (*Worker, error)

NewTimelockWorker initializes and returns a timelockWorker. It's a singleton, so further executions will retrieve the same timelockWorker.

func (*Worker) Listen

func (tw *Worker) Listen(ctx context.Context) error

Listen is the main function of a Timelock Worker. It handles the retrieval of old and new events, contexts and cancellations.