functions

Documentation

Index

• Constants
• func CheckStateTransition(prev RequestState, next RequestState) error
• func NewFunctionsConnectorHandler(signerKey *ecdsa.PrivateKey, lggr logger.Logger) *functionsConnectorHandler
• type ErrType
  • func (e ErrType) String() string
• type ExternalAdapterClient
  • func NewExternalAdapterClient(adapterURL url.URL, maxResponseBytes int64) ExternalAdapterClient
• type FunctionsListener
  • func NewFunctionsListener(oracle *ocr2dr_oracle.OCR2DROracle, job job.Job, ...) *FunctionsListener
  • func (l *FunctionsListener) Close() error
  • func (l *FunctionsListener) HandleLog(lb log.Broadcast)
  • func (l *FunctionsListener) JobID() int32
  • func (l *FunctionsListener) Start(context.Context) error
• type ORM
  • func NewORM(db *sqlx.DB, lggr logger.Logger, cfg pg.QConfig, ...) ORM
• type Request
• type RequestID
  • func (r *RequestID) Scan(value interface{}) error
  • func (r RequestID) String() string
  • func (r RequestID) Value() (driver.Value, error)
• type RequestState
  • func (s RequestState) String() string

Constants

const (
	DefaultPruneMaxStoredRequests uint32 = 20_000
	DefaultPruneCheckFrequencySec uint32 = 60 * 10
	DefaultPruneBatchSize         uint32 = 500
)

const RequestIDLength int = 32

Functions

func CheckStateTransition

func CheckStateTransition(prev RequestState, next RequestState) error

* +-----------+ * +----+IN_PROGRESS+----------------+ * | +-----+-----+ | * | | | * | v v * | +------------+ +---------+ * | |RESULT_READY+---------->|TIMED_OUT| * | +------+-----+ +---------+ * | | ^ * | v | * | +---------+ | * +---->|FINALIZED|-----------------+ * +---------+ * * \ / * | * v * +---------+ * |CONFIRMED| * +---------+

func NewFunctionsConnectorHandler

func NewFunctionsConnectorHandler(signerKey *ecdsa.PrivateKey, lggr logger.Logger) *functionsConnectorHandler

Types

type ErrType

type ErrType int8

const (
	NONE ErrType = iota
	// caused by internal infra problems, potentially retryable
	INTERNAL_ERROR
	// caused by user's code (exception, crash, timeout, ...)
	USER_ERROR
)

func (ErrType) String

func (e ErrType) String() string

type ExternalAdapterClient

type ExternalAdapterClient interface {
	RunComputation(
		ctx context.Context,
		requestId string,
		jobName string,
		subscriptionOwner string,
		subscriptionId uint64,
		nodeProvidedSecrets string,
		jsonData json.RawMessage,
	) (userResult, userError []byte, domains []string, err error)

	FetchEncryptedSecrets(ctx context.Context, encryptedSecretsUrls []byte, requestId string, jobName string) (encryptedSecrets, userError []byte, err error)
}

ExternalAdapterClient supports two endpoints:

1. Request (aka "lambda") for executing Functions requests via RunComputation()
2. Secrets (aka "fetcher") for fetching offchain secrets via FetchEncryptedSecrets()

Both endpoints share the same response format. All methods are thread-safe.

func NewExternalAdapterClient

func NewExternalAdapterClient(adapterURL url.URL, maxResponseBytes int64) ExternalAdapterClient

type FunctionsListener

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

func NewFunctionsListener

func NewFunctionsListener(oracle *ocr2dr_oracle.OCR2DROracle, job job.Job, eaClient ExternalAdapterClient, pluginORM ORM, pluginConfig config.PluginConfig, logBroadcaster log.Broadcaster, lggr logger.Logger, mailMon *utils.MailboxMonitor, urlsMonEndpoint commontypes.MonitoringEndpoint) *FunctionsListener

func (*FunctionsListener) Close

func (l *FunctionsListener) Close() error

Close complies with job.Service

func (*FunctionsListener) HandleLog

func (l *FunctionsListener) HandleLog(lb log.Broadcast)

HandleLog implements log.Listener

func (*FunctionsListener) JobID

func (l *FunctionsListener) JobID() int32

JobID() complies with log.Listener

func (*FunctionsListener) Start

func (l *FunctionsListener) Start(context.Context) error

Start complies with job.Service

type ORM

type ORM interface {
	CreateRequest(requestID RequestID, receivedAt time.Time, requestTxHash *common.Hash, qopts ...pg.QOpt) error

	SetResult(requestID RequestID, runID int64, computationResult []byte, readyAt time.Time, qopts ...pg.QOpt) error
	SetError(requestID RequestID, runID int64, errorType ErrType, computationError []byte, readyAt time.Time, readyForProcessing bool, qopts ...pg.QOpt) error
	SetFinalized(requestID RequestID, reportedResult []byte, reportedError []byte, qopts ...pg.QOpt) error
	SetConfirmed(requestID RequestID, qopts ...pg.QOpt) error

	TimeoutExpiredResults(cutoff time.Time, limit uint32, qopts ...pg.QOpt) ([]RequestID, error)

	FindOldestEntriesByState(state RequestState, limit uint32, qopts ...pg.QOpt) ([]Request, error)
	FindById(requestID RequestID, qopts ...pg.QOpt) (*Request, error)

	PruneOldestRequests(maxRequestsInDB uint32, batchSize uint32, qopts ...pg.QOpt) (total uint32, pruned uint32, err error)
}

func NewORM

func NewORM(db *sqlx.DB, lggr logger.Logger, cfg pg.QConfig, contractAddress common.Address) ORM

type Request

type Request struct {
	RequestID         RequestID
	RunID             *int64
	ReceivedAt        time.Time
	RequestTxHash     *common.Hash
	State             RequestState
	ResultReadyAt     *time.Time
	Result            []byte
	ErrorType         *ErrType
	Error             []byte
	TransmittedResult []byte
	TransmittedError  []byte
}

type RequestID

type RequestID [RequestIDLength]byte

func (*RequestID) Scan

func (r *RequestID) Scan(value interface{}) error

func (RequestID) String

func (r RequestID) String() string

func (RequestID) Value

func (r RequestID) Value() (driver.Value, error)

type RequestState

type RequestState int8

const (
	// IN_PROGRESS is the initial state of a request, set right after receiving it in an on-chain event.
	IN_PROGRESS RequestState = iota

	// RESULT_READY means that computation has finished executing (with either success or user error).
	// OCR2 reporting includes only requests in RESULT_READY state (for Query and Observation phases).
	RESULT_READY

	// TIMED_OUT request has been waiting to get confirmed on chain for too long.
	// It won't be included in OCR2 reporting rounds any more.
	TIMED_OUT

	// FINALIZED request is a part of a report produced by OCR2 and has now entered the transmission protocol
	// (i.e. passed through ShouldAcceptFinalizedReport()).
	FINALIZED

	// CONFIRMED state indicates that we received an on-chain confirmation event
	// (with or without this node's participation in an earlier OCR round).
	// We can transition here at any time (full fan-in) and cannot transition out (empty fan-out).
	// This is a desired and expected final state for every request.
	CONFIRMED
)

func (RequestState) String

func (s RequestState) String() string