Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: subgraph availability manager contract #882

Merged
merged 40 commits into from
Aug 21, 2024
Merged
Changes from 2 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
ad358fb
feat: subgraph availability manager contract
Maikol Nov 16, 2023
77e8dc3
feat: vote denied many
Maikol Nov 20, 2023
1805cd9
fix: pr feedback changes
Maikol Nov 24, 2023
f4942f2
fix: use natspec for state variables comments
Maikol Nov 27, 2023
fa9b153
fix: use currentNonce to refresh votes, init oracles with valid addre…
Maikol Nov 27, 2023
08e269f
fix: update functions docs
Maikol Nov 28, 2023
35f6392
fix: removed unnecessary code in tests
Maikol Nov 28, 2023
0896337
fix: typo, comments and changed maxOracles to be a constant
Maikol Dec 8, 2023
ad4baec
fix: change constant variable name to match style guide
Maikol Dec 11, 2023
a67ad20
chore: deploy to staging
Maikol Dec 21, 2023
ddbcc86
fix: emit oracle set event on init
Maikol Dec 21, 2023
48ffb3a
Merge remote-tracking branch 'origin/main' into mde/sam-contract
Maikol Jan 9, 2024
26f1c7a
fix: change mapping for an array to make storage cheaper
Maikol Jan 9, 2024
eeeb314
fix: update comments
Maikol Jan 10, 2024
1ad7935
fix: make currentNonce public
Maikol Jan 10, 2024
fbdf6af
fix: added input validation for executionThreshold (OZ L-01)
Maikol Feb 1, 2024
94e6d05
docs: added missing docstrings for events (OZ L-03)
Maikol Feb 1, 2024
9f9db2e
fix: change OracleVote event order (OZ N-01)
Maikol Feb 1, 2024
f2aa2fa
fix: gas optimization (OZ N-02)
Maikol Feb 1, 2024
a52066c
fix: clear vote for earlier rounds (OZ L-02)
Maikol Feb 2, 2024
1ce46f0
fix: change to if/else
Maikol Feb 2, 2024
ef35364
fix: remove setDeniedMany since it's unused (OZ N-03)
Maikol Feb 2, 2024
9562b28
Merge pull request #935 from graphprotocol/mde/pr935-fix-oz-l-01
Maikol Feb 20, 2024
fa9d0cb
Merge pull request #936 from graphprotocol/mde/pr936-fix-oz-l-03
Maikol Feb 20, 2024
0c547c4
Merge pull request #937 from graphprotocol/mde/pr937-fix-oz-n-01
Maikol Feb 20, 2024
0698989
Merge pull request #938 from graphprotocol/mde/pr938-fix-oz-n-02
Maikol Feb 20, 2024
374e387
Merge pull request #939 from graphprotocol/mde/pr939-fix-oz-l-02
Maikol Feb 20, 2024
58463a8
Merge pull request #940 from graphprotocol/mde/pr400-fix-ox-n-03
Maikol Feb 20, 2024
06885f3
Merge branch 'main' into mde/sam-contract
Maikol Mar 13, 2024
bcf6957
fix: indentation
Maikol Mar 13, 2024
4c01fc4
chore: deploy to arbitrum-sepolia and remove sepolia
Maikol Mar 12, 2024
87bb02d
fix: remove debugging log
Maikol Mar 12, 2024
b24377e
fix: e2e tests
Maikol Mar 13, 2024
09271fd
fix: building error
Maikol Mar 13, 2024
6428bda
fix: update deployment
Maikol May 1, 2024
b45b21f
fix: new deployment
Maikol May 2, 2024
152521b
chore: testnet deployment
Maikol May 30, 2024
113fe69
fix: testnet deployment
Maikol May 30, 2024
19faf45
chore: deploy SAM to arbitrum-one
Maikol Jun 20, 2024
7fe43b8
Merge pull request #961 from graphprotocol/mde/sam-contract-deployments
Maikol Jun 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -2,8 +2,6 @@

pragma solidity ^0.7.6;

import { SafeMathUpgradeable } from "@openzeppelin/contracts-upgradeable/math/SafeMathUpgradeable.sol";

import { Governed } from "../governance/Governed.sol";
import { IRewardsManager } from "../rewards/IRewardsManager.sol";

@@ -17,8 +15,6 @@
* Governor can transfer ownership to a new governor.
*/
contract SubgraphAvailabilityManager is Governed {
using SafeMathUpgradeable for uint256;

// -- Immutable --

/// @notice Number of oracles
@@ -81,9 +77,9 @@

// -- Modifiers --

modifier onlyOracle(uint256 _oracleIndex) {
require(_oracleIndex < NUM_ORACLES, "SAM: index out of bounds");
require(msg.sender == oracles[_oracleIndex], "SAM: caller must be oracle");

Check warning on line 82 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L80-L82

Added lines #L80 - L82 were not covered by tests
_;
}

@@ -106,14 +102,11 @@
) {
require(_governor != address(0), "SAM: governor must be set");
require(_rewardsManager != address(0), "SAM: rewardsManager must be set");
require(
_executionThreshold >= NUM_ORACLES.div(2).add(1),
"SAM: executionThreshold too low"
);
require(_executionThreshold >= (NUM_ORACLES / 2) + 1, "SAM: executionThreshold too low");
require(_executionThreshold <= NUM_ORACLES, "SAM: executionThreshold too high");

// Oracles should not be address zero
for (uint256 i = 0; i < _oracles.length; i++) {
for (uint256 i; i < _oracles.length; i++) {
address oracle = _oracles[i];
require(oracle != address(0), "SAM: oracle cannot be address zero");
oracles[i] = oracle;
@@ -133,10 +126,10 @@
* @dev Set the vote time limit. Refreshes all existing votes by incrementing the current nonce.
* @param _voteTimeLimit Vote time limit in seconds
*/
function setVoteTimeLimit(uint256 _voteTimeLimit) external onlyGovernor {
voteTimeLimit = _voteTimeLimit;

Check warning on line 130 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L129-L130

Added lines #L129 - L130 were not covered by tests
currentNonce++;
emit VoteTimeLimitSet(_voteTimeLimit);

Check warning on line 132 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L132

Added line #L132 was not covered by tests
}

/**
@@ -144,15 +137,15 @@
* @param _index Index of the oracle
* @param _oracle Address of the oracle
*/
function setOracle(uint256 _index, address _oracle) external onlyGovernor {
require(_index < NUM_ORACLES, "SAM: index out of bounds");
require(_oracle != address(0), "SAM: oracle cannot be address zero");

Check warning on line 142 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L140-L142

Added lines #L140 - L142 were not covered by tests

oracles[_index] = _oracle;

Check warning on line 144 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L144

Added line #L144 was not covered by tests
// Increment the current nonce to refresh all existing votes for subgraph deployment IDs
currentNonce++;

emit OracleSet(_index, _oracle);

Check warning on line 148 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L148

Added line #L148 was not covered by tests
}

/**
@@ -162,12 +155,12 @@
* @param _deny True to deny, false to allow
* @param _oracleIndex Index of the oracle voting
*/
function vote(

Check warning on line 158 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L158

Added line #L158 was not covered by tests
bytes32 _subgraphDeploymentID,
bool _deny,
uint256 _oracleIndex
) external onlyOracle(_oracleIndex) {
_vote(_subgraphDeploymentID, _deny, _oracleIndex);

Check warning on line 163 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L163

Added line #L163 was not covered by tests
}

/**
@@ -177,14 +170,14 @@
* @param _deny Array of booleans, true to deny, false to allow
* @param _oracleIndex Index of the oracle voting
*/
function voteMany(

Check warning on line 173 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L173

Added line #L173 was not covered by tests
bytes32[] calldata _subgraphDeploymentID,
bool[] calldata _deny,
uint256 _oracleIndex
) external onlyOracle(_oracleIndex) {
require(_subgraphDeploymentID.length == _deny.length, "!length");
for (uint256 i = 0; i < _subgraphDeploymentID.length; i++) {
for (uint256 i; i < _subgraphDeploymentID.length; i++) {
_vote(_subgraphDeploymentID[i], _deny[i], _oracleIndex);

Check warning on line 180 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L178-L180

Added lines #L178 - L180 were not covered by tests
}
}

@@ -197,24 +190,24 @@
* @param _deny True to deny, false to allow
* @param _oracleIndex Index of the oracle voting
*/
function _vote(

Check warning on line 193 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L193

Added line #L193 was not covered by tests
bytes32 _subgraphDeploymentID,
bool _deny,
uint256 _oracleIndex
) private {
uint256 timestamp = block.timestamp;

Check warning on line 198 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L198

Added line #L198 was not covered by tests

// corresponding votes based on _deny for a subgraph deployment
uint256[NUM_ORACLES] storage lastVoteForSubgraph = _deny

Check warning on line 201 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L201

Added line #L201 was not covered by tests
? lastDenyVote[currentNonce][_subgraphDeploymentID]
: lastAllowVote[currentNonce][_subgraphDeploymentID];
lastVoteForSubgraph[_oracleIndex] = timestamp;

Check warning on line 204 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L204

Added line #L204 was not covered by tests

emit OracleVote(_subgraphDeploymentID, _deny, _oracleIndex, timestamp);

Check warning on line 206 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L206

Added line #L206 was not covered by tests

// check if execution threshold is reached, if it is call the RewardsManager
if (checkVotes(_subgraphDeploymentID, _deny)) {
rewardsManager.setDenied(_subgraphDeploymentID, _deny);

Check warning on line 210 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L209-L210

Added lines #L209 - L210 were not covered by tests
}
}

@@ -225,29 +218,29 @@
* @param _deny True to deny, false to allow
* @return True if execution threshold is reached
*/
function checkVotes(bytes32 _subgraphDeploymentID, bool _deny) public view returns (bool) {
uint256 votes = 0;
uint256 votes;

Check warning on line 222 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L221-L222

Added lines #L221 - L222 were not covered by tests

// timeframe for a vote to be valid
uint256 voteTimeValidity = block.timestamp - voteTimeLimit;

Check warning on line 225 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L225

Added line #L225 was not covered by tests

// corresponding votes based on _deny for a subgraph deployment
uint256[NUM_ORACLES] storage lastVoteForSubgraph = _deny

Check warning on line 228 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L228

Added line #L228 was not covered by tests
? lastDenyVote[currentNonce][_subgraphDeploymentID]
: lastAllowVote[currentNonce][_subgraphDeploymentID];

for (uint256 i = 0; i < NUM_ORACLES; i++) {
for (uint256 i; i < NUM_ORACLES; i++) {

Check warning on line 232 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L232

Added line #L232 was not covered by tests
// check if vote is within the vote time limit
if (lastVoteForSubgraph[i] > voteTimeValidity) {

Check warning on line 234 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L234

Added line #L234 was not covered by tests
votes++;
}

// check if execution threshold is reached
if (votes == executionThreshold) {
return true;

Check warning on line 240 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L239-L240

Added lines #L239 - L240 were not covered by tests
}
}

return false;

Check warning on line 244 in packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol

Codecov / codecov/patch

packages/contracts/contracts/rewards/SubgraphAvailabilityManager.sol#L244

Added line #L244 was not covered by tests
}
}