#include <offchain_worker.hpp>

Inheritance diagram for kagome::offchain::OffchainWorker:

Collaboration diagram for kagome::offchain::OffchainWorker:

Public Member Functions
virtual	~OffchainWorker ()=default

virtual outcome::result< void >	run ()=0

virtual bool	isValidator () const =0

virtual Result< Success, Failure >	submitTransaction (const primitives::Extrinsic &ext)=0

virtual Result< OpaqueNetworkState, Failure >	networkState ()=0

virtual Timestamp	timestamp ()=0

virtual void	sleepUntil (Timestamp)=0

virtual RandomSeed	randomSeed ()=0

virtual void	localStorageSet (StorageType storage_type, const common::BufferView &key, common::Buffer value)=0

virtual void	localStorageClear (StorageType storage_type, const common::BufferView &key)=0

virtual bool	localStorageCompareAndSet (StorageType storage_type, const common::BufferView &key, std::optional< common::BufferView > expected, common::Buffer value)=0

virtual outcome::result< common::Buffer >	localStorageGet (StorageType storage_type, const common::BufferView &key)=0

virtual Result< RequestId, Failure >	httpRequestStart (HttpMethod method, std::string_view uri, common::Buffer meta)=0

virtual Result< Success, Failure >	httpRequestAddHeader (RequestId id, std::string_view name, std::string_view value)=0

virtual Result< Success, HttpError >	httpRequestWriteBody (RequestId id, common::Buffer chunk, std::optional< Timestamp > deadline)=0

virtual std::vector< HttpStatus >	httpResponseWait (const std::vector< RequestId > &ids, std::optional< Timestamp > deadline)=0

virtual std::vector< std::pair< std::string, std::string > >	httpResponseHeaders (RequestId id)=0

virtual Result< uint32_t, HttpError >	httpResponseReadBody (RequestId id, common::Buffer &chunk, std::optional< Timestamp > deadline)=0

virtual void	setAuthorizedNodes (std::vector< libp2p::peer::PeerId > nodes, bool authorized_only)=0

Detailed Description

The offchain workers allow the execution of long-running and possibly non-deterministic tasks (e.g. web requests, encryption/decryption and signing of data, random number generation, CPU-intensive computations, enumeration/aggregation of on-chain data, etc.) which could otherwise require longer than the block execution time. Offchain workers have their own execution environment. This separation of concerns is to make sure that the block production is not impacted by the long-running tasks.

Definition at line 31 of file offchain_worker.hpp.

Constructor & Destructor Documentation

virtual kagome::offchain::OffchainWorker::~OffchainWorker ( )

virtualdefault

Member Function Documentation

virtual Result<Success, Failure> kagome::offchain::OffchainWorker::httpRequestAddHeader	(	RequestId	id,
		std::string_view	name,
		std::string_view	value
	)

pure virtual

Implemented in kagome::offchain::OffchainWorkerImpl.

virtual Result<RequestId, Failure> kagome::offchain::OffchainWorker::httpRequestStart	(	HttpMethod	method,
		std::string_view	uri,
		common::Buffer	meta
	)

pure virtual

Implemented in kagome::offchain::OffchainWorkerImpl.

virtual Result<Success, HttpError> kagome::offchain::OffchainWorker::httpRequestWriteBody	(	RequestId	id,
		common::Buffer	chunk,
		std::optional< Timestamp >	deadline
	)

pure virtual

Implemented in kagome::offchain::OffchainWorkerImpl.

virtual std::vector<std::pair<std::string, std::string> > kagome::offchain::OffchainWorker::httpResponseHeaders ( RequestId id )

pure virtual

Implemented in kagome::offchain::OffchainWorkerImpl.

virtual Result<uint32_t, HttpError> kagome::offchain::OffchainWorker::httpResponseReadBody	(	RequestId	id,
		common::Buffer &	chunk,
		std::optional< Timestamp >	deadline
	)

pure virtual

Implemented in kagome::offchain::OffchainWorkerImpl.

virtual std::vector<HttpStatus> kagome::offchain::OffchainWorker::httpResponseWait	(	const std::vector< RequestId > &	ids,
		std::optional< Timestamp >	deadline
	)

pure virtual

Implemented in kagome::offchain::OffchainWorkerImpl.

virtual bool kagome::offchain::OffchainWorker::isValidator ( ) const

pure virtual

Implemented in kagome::offchain::OffchainWorkerImpl.

virtual void kagome::offchain::OffchainWorker::localStorageClear	(	StorageType	storage_type,
		const common::BufferView &	key
	)

pure virtual

Implemented in kagome::offchain::OffchainWorkerImpl.

virtual bool kagome::offchain::OffchainWorker::localStorageCompareAndSet	(	StorageType	storage_type,
		const common::BufferView &	key,
		std::optional< common::BufferView >	expected,
		common::Buffer	value
	)