Skip to content

Commit

Permalink
docs: proofreading
Browse files Browse the repository at this point in the history
Co-authored-by: moebius <[email protected]>
  • Loading branch information
gas1cent and 0xmoebius authored Apr 10, 2024
1 parent 089db87 commit 8d26107
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/src/content/modules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Here you can find the list and the details of each module available in Prophet
You can notice that many modules follow the same structure. This is because they all inherit from the `IModule` interface which defines the common functions and modifiers that all modules should have.

- `moduleName` is required to properly show the module in Prophet UI.
- `RequestParameters` is what parameters are required for the request to be processed with the module.
- `decodeRequestData` decodes the ABI encoded parameters using the `RequestParameters` struct and returns them as a list. This is useful for both on-chain and off-chain parts.
- `RequestParameters` is which parameters are required for the request to be processed with the module.
- `decodeRequestData` decodes the ABI encoded parameters using the `RequestParameters` struct and returns them as a list. This is useful for both on-chain and off-chain components.

## Best Practices

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ The Bonded Response Module is a contract that allows users to propose a response

- **Early finalization**: It is possible for pre-dispute modules to atomically calculate the correct response on-chain, decide on the result of a dispute and finalize the request before its deadline.
- **Dispute window**: Prevents proposers from submitting a response 1 block before the deadline and finalizing it in the next block, leaving disputers no time to dispute the response.
- **Unutilized response**: A correct response that has not been used to finalize the request. Consider what happens when the first response to a request is disputed maliciously and someone send a second response with the same content. In that case if the second response isn't disputed and the first one comes back from the dispute and is accepted as the final response, the second proposer should be able to get their bond back.
- **Unutilized response**: A correct response that has not been used to finalize the request. Consider what happens when the first response to a request is disputed maliciously and someone sends a second response with the same content. In that case if the second response isn't disputed and the first one comes back from the dispute and is accepted as the final response, the second proposer should be able to get his bond back.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ interface IArbitratorModule is IResolutionModule {
* @notice Available status of the arbitration process
* @param Unknown The arbitration process has not started (default)
* @param Active The arbitration process is active
* @param ResolvedThe The arbitration process is finished
* @param Resolved The The arbitration process is finished
*/
enum ArbitrationStatus {
Unknown,
Expand Down

0 comments on commit 8d26107

Please sign in to comment.