Skip to content

Commit eeeb314

Browse files
committed
fix: update comments
1 parent 26f1c7a commit eeeb314

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ import { IRewardsManager } from "../rewards/IRewardsManager.sol";
1212
* @dev Manages the availability of subgraphs by allowing oracles to vote on whether
1313
* a subgraph should be denied rewards or not. When enough oracles have voted to deny or
1414
* allow rewards for a subgraph, it calls the RewardsManager Contract to set the correct
15-
* state. The number of oracles and the execution threshold are set at deployment time.
16-
* Only governance can set the oracles.
15+
* state. The oracles and the execution threshold are set at deployment time.
16+
* Only governance can update the oracles and voteTimeLimit.
17+
* Governor can transfer ownership to a new governor.
1718
*/
1819
contract SubgraphAvailabilityManager is Governed {
1920
using SafeMathUpgradeable for uint256;
@@ -41,12 +42,12 @@ contract SubgraphAvailabilityManager is Governed {
4142
/// @notice Array of oracle addresses
4243
address[NUM_ORACLES] public oracles;
4344

44-
/// @notice Mapping of current nonce to subgraph deployment ID to oracle index to timestamp of last deny vote
45-
/// currentNonce => subgraphDeploymentId => oracleIndex => timestamp
45+
/// @notice Mapping of current nonce to subgraph deployment ID to an array of timestamps of last deny vote
46+
/// currentNonce => subgraphDeploymentId => timestamp[oracleIndex]
4647
mapping(uint256 => mapping(bytes32 => uint256[NUM_ORACLES])) public lastDenyVote;
4748

48-
/// @notice Mapping of current nonce to subgraph deployment ID to oracle index to timestamp of last allow vote
49-
/// currentNonce => subgraphDeploymentId => oracleIndex => timestamp
49+
/// @notice Mapping of current nonce to subgraph deployment ID to an array of timestamp of last allow vote
50+
/// currentNonce => subgraphDeploymentId => timestamp[oracleIndex]
5051
mapping(uint256 => mapping(bytes32 => uint256[NUM_ORACLES])) public lastAllowVote;
5152

5253
// -- Events --
@@ -87,6 +88,7 @@ contract SubgraphAvailabilityManager is Governed {
8788
* @param _rewardsManager Address of the RewardsManager contract
8889
* @param _executionThreshold Number of votes required to execute a deny or allow call to the RewardsManager
8990
* @param _voteTimeLimit Vote time limit in seconds
91+
* @param _oracles Array of oracle addresses, must be NUM_ORACLES in length.
9092
*/
9193
constructor(
9294
address _governor,

0 commit comments

Comments
 (0)