From ecf8a1b9a08312cd44171082c7ab2b826509af53 Mon Sep 17 00:00:00 2001 From: Gas One Cent <86567384+gas1cent@users.noreply.github.com> Date: Tue, 21 Nov 2023 21:54:45 +0400 Subject: [PATCH] docs: update `PrivateERC20ResolutionModule` docs --- .../resolution/private_erc20_resolution_module.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/src/content/modules/resolution/private_erc20_resolution_module.md b/docs/src/content/modules/resolution/private_erc20_resolution_module.md index d644343e..73bad37a 100644 --- a/docs/src/content/modules/resolution/private_erc20_resolution_module.md +++ b/docs/src/content/modules/resolution/private_erc20_resolution_module.md @@ -10,12 +10,12 @@ The `PrivateERC20ResolutionModule` is a contract that allows users to vote on a ### Key methods -- `decodeRequestData(bytes calldata _data)`: Returns the decoded data for a request. -- `startResolution(bytes32 _disputeId)`: Starts the committing phase for a dispute. -- `commitVote(bytes32 _requestId, bytes32 _disputeId, bytes32 _commitment)`: Stores a commitment for a vote cast by a voter. -- `revealVote(bytes32 _requestId, bytes32 _disputeId, uint256 _numberOfVotes, bytes32 _salt)`: Reveals a vote cast by a voter. -- `resolveDispute(bytes32 _disputeId)`: Resolves a dispute by tallying the votes and executing the winning outcome. -- `computeCommitment(bytes32 _disputeId, uint256 _numberOfVotes, bytes32 _salt)`: Computes a valid commitment for the revealing phase. +- `decodeRequestData`: Returns the decoded data for a request. +- `startResolution`: Starts the committing phase for a dispute. +- `commitVote`: Stores a commitment for a vote cast by a voter. +- `revealVote`: Reveals a vote cast by a voter. +- `resolveDispute`: Resolves a dispute by tallying the votes and executing the winning outcome. +- `computeCommitment`: Computes a valid commitment for the revealing phase. ### Request Parameters @@ -36,4 +36,3 @@ The `PrivateERC20ResolutionModule` is a contract that allows users to vote on a - It is implied that the voters are incentivized to vote either because they're the governing entity of the ERC20 and have a stake in the outcome of the dispute or because they expect to be rewarded by such an entity. - The `commitVote` function allows committing multiple times and overwriting a previous commitment. - The `revealVote` function requires the user to have previously approved the module to transfer the tokens. -