Request

Introduction

All modules in the Prophet Framework are designed to handle specific parts of a request's lifecycle and the Request module is responsible for asking for the information and configuring a reward. This includes declaring the source for the response and running any necessary validations or actions specified in the createRequest function.

Prophet's Request modules:

• HTTPRequestModule to request data from a URL
• ContractCallRequestModule to request data from a smart contract
• SparseMerkleTreeRequestModule to request a verification of a Merkle tree

Creating a Request Module

Creating a Request module is as simple as following from the IRequestModule interface and implementing the necessary logic in the createRequest and finalizeRequest hooks, as well as any custom logic.

A good Request module should take care of the following:

• Defining the RequestParameters struct with the necessary configuration for requests, such as the data source and the reward
• Providing a way for the requester to withdraw the reward if no valid answer is proposed
• Securing the hooks with the onlyOracle modifier