Skip to content

Commit 1bdf837

Browse files
committed
docs: fix grammar and terminology in RewardsEligibilityOracle
- Change 'eligible period' to 'eligibility period' for consistency - Fix 'have confidence is being able' to 'have confidence in being able' - Fix 'have a good transparency' to 'have good transparency' - Change 'Reward Manager' to 'RewardsManager' for correct contract naming
1 parent 46f88dd commit 1bdf837

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

packages/issuance/contracts/eligibility/RewardsEligibilityOracle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,11 @@ For normal operations with reasonable eligibility periods (e.g., 14 days), index
155155

156156
In normal operation, the first condition is expected to be the only one that applies. The other two conditions provide fail-safes for oracle failures, or in extreme cases an operator override. For normal operational failure of oracles, the system gracefully degrades into a "allow all" mode. This mechanism is not perfect in that oracles could still be updating but allowing far fewer indexers than they should. However this is regarded as simple mechanism that is good enough to start with and provide a foundation for future improvements and decentralization.
157157

158-
While this simple model allows the criteria for providing good service to evolve over time (which is essential for the long-term health of the network), it captures sufficient information on-chain for indexers to be able to monitor their eligibility. This is important to ensure that even in the absence of other sources of information regarding observed indexer service, indexers have a good transparency about if they are being observed to be providing good service, and for how long their current approval is valid.
158+
While this simple model allows the criteria for providing good service to evolve over time (which is essential for the long-term health of the network), it captures sufficient information on-chain for indexers to be able to monitor their eligibility. This is important to ensure that even in the absence of other sources of information regarding observed indexer service, indexers have good transparency about if they are being observed to be providing good service, and for how long their current approval is valid.
159159

160160
It might initially seem safer to allow indexers by default unless an oracle explicitly denies an indexer. While that might seem safer from the perspective of the RewardsEligibilityOracle in isolation, in the absence of a more sophisticated voting system it would make the system vulnerable to a single bad oracle denying many indexers. The design of deny by default is better suited to allowing redundant oracles to be working in parallel, where only one needs to be successfully detecting indexers that are providing quality service, as well as eventually allowing different oracles to have different approval criteria and/or inputs. Therefore deny by default facilitates a more resilient and open oracle system that is less vulnerable to a single points of failure, and more open to increasing decentralization over time.
161161

162-
In general to be rewarded for providing service on The Graph, there is expected to be proof provided of good operation (such as for proof of indexing). While proof should be required to receive rewards, the system is designed for participants to have confidence is being able to adequately prove good operation (and in the case of oracles, be seen by at least one observer) that is sufficient to allow the indexer to receive rewards. The oracle model is in general far more suited to collecting evidence of good operation, from multiple independent observers, rather than any observer being able to establish that an indexer is not providing good service.
162+
In general to be rewarded for providing service on The Graph, there is expected to be proof provided of good operation (such as for proof of indexing). While proof should be required to receive rewards, the system is designed for participants to have confidence in being able to adequately prove good operation (and in the case of oracles, be seen by at least one observer) that is sufficient to allow the indexer to receive rewards. The oracle model is in general far more suited to collecting evidence of good operation, from multiple independent observers, rather than any observer being able to establish that an indexer is not providing good service.
163163

164164
## Operational Considerations
165165

@@ -295,7 +295,7 @@ The system is deployed with reasonable defaults but can be adjusted as required.
295295
### Normal Operation
296296

297297
1. Oracle nodes periodically call `renewIndexerEligibility()` to renew eligibility for indexers
298-
2. Reward Manager calls `isEligible()` to check indexer eligibility
298+
2. RewardsManager calls `isEligible()` to check indexer eligibility
299299
3. Operators adjust parameters as needed via configuration functions
300300
4. The operation of the system is monitored and adjusted as needed
301301

packages/issuance/contracts/eligibility/RewardsEligibilityOracle.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { BaseUpgradeable } from "../common/BaseUpgradeable.sol";
1414
* @notice This contract allows authorized oracles to mark indexers as eligible to receive rewards
1515
* with an expiration mechanism. Under normal configuration with reasonable eligibility periods, indexers
1616
* are denied by default until they are explicitly marked as eligible, and their eligibility expires after
17-
* a configurable eligible period. The contract also includes a global eligibility check toggle and an
17+
* a configurable eligibility period. The contract also includes a global eligibility check toggle and an
1818
* oracle update timeout mechanism.
1919
* @dev Note: If the eligibility period is set to an extremely large value that exceeds the current
2020
* block timestamp, all indexers (including those never registered) will be eligible.

0 commit comments

Comments
 (0)