Documentation
¶
Index ¶
- Constants
- Variables
- func CheckStateTransition(prev RequestState, next RequestState) error
- func NewFunctionsConnectorHandler(nodeAddress string, signerKey *ecdsa.PrivateKey, storage s4.Storage, ...) (*functionsConnectorHandler, error)
- func VerifyRequestSignature(subscriptionOwner common.Address, requestData *RequestData) error
- type AggregationMethod
- type BridgeAccessor
- type DONHostedSecrets
- type ErrType
- type ExternalAdapterClient
- type FunctionsListener
- type ORM
- type Request
- type RequestData
- type RequestFlags
- type RequestID
- type RequestState
- type SignedRequestData
Constants ¶
const ( DefaultPruneMaxStoredRequests uint32 = 20_000 DefaultPruneCheckFrequencySec uint32 = 60 * 10 DefaultPruneBatchSize uint32 = 500 FlagCBORMaxSize uint32 = 1 FlagSecretsMaxSize uint32 = 2 )
const ( LocationInline = 0 LocationRemote = 1 LocationDONHosted = 2 LanguageJavaScript = 0 )
const RequestIDLength int = 32
Variables ¶
var ErrDuplicateRequestID = errors.New("Functions ORM: duplicate request ID")
Functions ¶
func CheckStateTransition ¶
func CheckStateTransition(prev RequestState, next RequestState) error
* +-----------+ * +----+IN_PROGRESS+----------------+ * | +-----+-----+ | * | | | * | v v * | +------------+ +---------+ * | |RESULT_READY+---------->|TIMED_OUT| * | +------+-----+ +---------+ * | | ^ * | v | * | +---------+ | * +---->|FINALIZED|-----------------+ * +---------+ * * \ / * | * v * +---------+ * |CONFIRMED| * +---------+
func NewFunctionsConnectorHandler ¶ added in v2.3.0
func NewFunctionsConnectorHandler(nodeAddress string, signerKey *ecdsa.PrivateKey, storage s4.Storage, allowlist functions.OnchainAllowlist, rateLimiter *hc.RateLimiter, subscriptions functions.OnchainSubscriptions, minimumBalance assets.Link, lggr logger.Logger) (*functionsConnectorHandler, error)
func VerifyRequestSignature ¶ added in v2.5.0
func VerifyRequestSignature(subscriptionOwner common.Address, requestData *RequestData) error
Types ¶
type AggregationMethod ¶ added in v2.4.0
type AggregationMethod int8
type BridgeAccessor ¶ added in v2.3.0
type BridgeAccessor interface {
NewExternalAdapterClient() (ExternalAdapterClient, error)
}
func NewBridgeAccessor ¶ added in v2.3.0
func NewBridgeAccessor(bridgeORM bridges.ORM, bridgeName string, maxResponseBytes int64) BridgeAccessor
type DONHostedSecrets ¶ added in v2.4.0
type ExternalAdapterClient ¶ added in v2.3.0
type ExternalAdapterClient interface { RunComputation( ctx context.Context, requestId string, jobName string, subscriptionOwner string, subscriptionId uint64, flags RequestFlags, nodeProvidedSecrets string, requestData *RequestData, ) (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:
- Request (aka "lambda") for executing Functions requests via RunComputation()
- Secrets (aka "fetcher") for fetching offchain secrets via FetchEncryptedSecrets()
Both endpoints share the same response format. All methods are thread-safe.
func NewExternalAdapterClient ¶ added in v2.3.0
func NewExternalAdapterClient(adapterURL url.URL, maxResponseBytes int64) ExternalAdapterClient
type FunctionsListener ¶
type FunctionsListener struct { utils.StartStopOnce // contains filtered or unexported fields }
func NewFunctionsListener ¶
func NewFunctionsListener( job job.Job, client client.Client, contractAddressHex string, bridgeAccessor BridgeAccessor, pluginORM ORM, pluginConfig config.PluginConfig, s4Storage s4.Storage, logBroadcaster log.Broadcaster, lggr logger.Logger, mailMon *utils.MailboxMonitor, urlsMonEndpoint commontypes.MonitoringEndpoint, decryptor threshold.Decryptor, logPollerWrapper evmrelayTypes.LogPollerWrapper, ) *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
type ORM ¶
type ORM interface { CreateRequest(request *Request, qopts ...pg.QOpt) error SetResult(requestID RequestID, computationResult []byte, readyAt time.Time, qopts ...pg.QOpt) error SetError(requestID RequestID, 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) }
type Request ¶
type Request struct { RequestID RequestID ReceivedAt time.Time RequestTxHash *common.Hash State RequestState ResultReadyAt *time.Time Result []byte ErrorType *ErrType Error []byte TransmittedResult []byte TransmittedError []byte Flags []byte AggregationMethod *AggregationMethod CallbackGasLimit *uint32 CoordinatorContractAddress *common.Address OnchainMetadata []byte ProcessingMetadata []byte }
type RequestData ¶ added in v2.3.0
type RequestData struct { Source string `json:"source" cbor:"source"` Language int `json:"language" cbor:"language"` CodeLocation int `json:"codeLocation" cbor:"codeLocation"` Secrets []byte `json:"secrets" cbor:"secrets"` SecretsLocation int `json:"secretsLocation" cbor:"secretsLocation"` RequestSignature []byte `json:"requestSignature,omitempty" cbor:"requestSignature"` Args []string `json:"args,omitempty" cbor:"args"` BytesArgs [][]byte `json:"bytesArgs,omitempty" cbor:"bytesArgs"` }
type RequestFlags ¶ added in v2.5.0
type RequestFlags [32]byte
type RequestID ¶
type RequestID [RequestIDLength]byte
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