📃WitnetRequest
Built out of non-parameterized data sources (i.e. Radon Retrievals) from the WitnetRequestFactory, or from parameterized WitnetRequestTemplate instances, WitnetRequest instances contain the RAD hash and bytecode of some Witnet-compliant data requests, as well as introspective metadata about its public data sources, off-chain computations, data filtering and reducing methods.
Did you know?
WitnetRequest addresses are counter-factual to the actual data sources, aggregate and tally filters and reducers they have been built with.
Meaning that if you try to build a WitnetRequest out of the same Radon Retrievals and Reducers as someone else did in the past, you will get exactly the same address. The underlying minimal-proxy contract would get constructed only once, of course. Building an already built WitnetRequest works, and requires less gas than building it for the first time.
Interfaces
^ Pure methods that neither write nor read from storage.
= View methods that read from immutable code storage.
:: View methods that read from storage.
+ Methods that may potentially alter storage.
$ Payable methods that may potentially alter storage.
[]! Methods that may revert under certain conditions.
IWitnetRequestFactoryAppliance
= class(): string
Returns the name of the contract that's actually implementing the ABI's specs() logic.
= factory(): WitnetRequestFactory
= specs(): bytes4
Returns the immutable ERC-165 id of the expected functionality as for the WitnetRequest ABI.
= witnet(): WitnetOracle
IWitnetRequest
:: bytecode():bytes
Returns the Witnet-compliant RAD bytecode for the data request (i.e. Radon Request) contained within this WitnetRequest.
:: radHash():bytes32
Returns the Witnet-compliant RAD hash of the data request (i.e. Radon Request) contained within this WitnetRequest.
:: getArgs():string[][]
:: getResultDataType():RadonDataTypes
Returns the expected data type produced by successful resolutions of the Witnet-compliant data request contained within this WitnetRequest.
:: getAggregateReducer():RadonReducer
Returns the filters and reducing function to be applied by witnessing nodes on the Witnet blockchain when aggregating data extracted from the public data sources (i.e. Radon Retrievals) as specified within this WitnetRequest.
:! getRetrievalByIndex(uint256):RRet.
Returns metadata concerning the data source specified by the given index.
:: getRetrievals():RadonRetrieval[]
Returns the array of one or more data sources (i.e. Radon Retrievals) that compose this WitnetRequest.
:: getTallyReducer():RadonReducer
Returns the slashing filters and reducing function to be applied to the values revealed by the witnessing nodes on the Witnet blockchain that contribute to solve the data request as specified within this WitnetRequest.
:: template():WitnetRequestTemplate
:: version():string
If built out of an upgradable factory, or template, returns the SemVer tag of the actual implementation version at the time when this WitnetRequest got built.
Structs
Witnet.RadonFilter
Struct defining the data filtering to be applied at either the Aggregate or Tally stages within the resolution of a data request within the Witnet blockchain.
opcode
Witnet.RadonFilterOpcodes
Filtering function.
cborArgs
bytes
CBOR-encoded array of filter parameters. Empty if no parameters are to be specified.
Witnet.RadonReducer
Struct defining the array of filters, if any, and reduce function to be applied at either the Aggregate or Tally stages within the resolution of a data request within the Witnet blockchain.
opcode
Witnet.RadonReducerOpcodes
Reducing function.
filters
Witnet.RadonFilter[]
Zero, one or more filters to be orderly applied to input dataset before actually executing the reduce function.
Witnet.RadonRequest
Struct containing the Retrieve-Attestation-Delivery parts of a Witnet-compliant Data Request Object.
retrieve
Witnet.RadonRetrieval[]
One or more public data sources (i.e. Radon Retrievals) out from where data will be retrieved by all witnessing nodes in the Witnet-blockchain attending the resolution of this data request.
aggregate
Witnet.RadonReducer
Filtering and reduce operations that will executed by every single witnessing node as to aggregate the data extracted from the request's data sources.
tally
Witnet.RadonReducer
Filtering and reduce operations that will be applied to the aggregated data revealed by each witnessing node. Witnessing nodes revealing data that gets ultimately filtered out, will get slashed.
Witnet.RadonRetrieval
Struct containing all parameters that fully describe the Radon Retrievals that can form part of Witnet-compliant Data Request Objects.
argsCount
uint8
Number of indexed parameters to be provided whenever this Radon Retrieval is to be included into a Radon Request.
method
Witnet.RadonRetrievalMethods
Immutable method to be used for retrieving data.
dataType
Witnet.RadonDataTypes
Deterministic data type that successful executions will return.
url
string
Request URL. Mandatory on HttpGet, HttpPost and HttpHead retrieving methods.
body
string
Request body. Optional on HttpGet and HttpPost retrieving methods.
headers
string[2][]
Request key/value headers. Optional on HttpGet and HttpPost retrieving methods.
radonScript
bytes
Optional CBOR-encoded Radon Script that will transform whatever value is returned from the source. Not supported on RNG retrievals.
Enums
Witnet.RadonDataTypes
Primitive data types that can be contained in successful results to Witnet data requests.
0x00
Any
CBOR-encoded value of undetermined type.
0x01
Array
An array of CBOR values.
0x02
Bool
A CBOR-encoded boolean value.
0x03
Bytes
A CBOR-encoded bytes buffer.
0x04
Integer
A CBOR-encoded integer value.
0x05
Float
A CBOR-encoded float value.
0x06
Map
A key/value map of CBOR values.
0x07
String
A CBOR-encoded string value.
Witnet.RadonFilterOpcodes
Dataset filtering methods currently supported on the Witnet blockchain.
0x05
StandardDeviation
Filters out all input items that deviates from the average more than a threshold. Requires a CBOR-encoded float as single but mandatory filter parameter. Works only with arrays of numbers (integers or floats) as input datasets.
0x08
Mode
Filters out all input items that diverge from the mode.
Witnet.RadonReducerOpcodes
Reducing functions currently supported on the Witnet blockchain.
0x02
Mode
Returns the mode value from the input dataset.
0x03
AverageMean
Returns the average mean from the input dataset. Works only with arrays of numbers as input datasets.
0x05
AverageMedian
Returns the median from the input dataset. Works only with arrays of numbers as input datasets.
0x07
StandardDeviation
Returns the standard deviation calculated out from the input dataset. Works only with arrays of numbers as input datasets.
0x0B
ConcatenateAndHash
Returns the SHA-256 hash of the concatenation of the input buffers. Works only with arrays of buffers as input datasets. Used mainly on RNG requests for mixing randomness produced by independent and randomly selected witnessing nodes.
Witnet.RadonRetrievalMethods
Possible data request methods that can be specified on a Radon Retrieval.
0x01
HttpGet
Data shall be retrieved from HTTP-GET requests.
0x02
RNG
Random seeds shall be independently produced by the witnessing nodes themselves.
0x03
HttpPost
Data shall be retrieved from HTTP-POST requests.
0x04
HttpHead
Data shall be retrieved from HTTP-HEAD requests.
Last updated