refactor: renamed RNG into IRNG

Author: jaybuidl

contracts/src/arbitration/SortitionModule.sol

@@ -37,7 +37,7 @@ contract SortitionModule is SortitionModuleBase, UUPSProxiable, Initializable {
         KlerosCore _core,
         uint256 _minStakingTime,
         uint256 _maxDrawingTime,
-        RNG _rng
+        IRNG _rng
     ) external reinitializer(1) {
         super._initialize(_governor, _core, _minStakingTime, _maxDrawingTime, _rng);
     }

contracts/src/arbitration/SortitionModuleBase.sol

@@ -13,7 +13,7 @@ pragma solidity 0.8.24;
 import "./KlerosCore.sol";
 import "./interfaces/ISortitionModule.sol";
 import "./interfaces/IDisputeKit.sol";
-import "../rng/RNG.sol";
+import "../rng/IRNG.sol";
 import "../libraries/Constants.sol";
 
 /// @title SortitionModuleBase
@@ -64,7 +64,7 @@ abstract contract SortitionModuleBase is ISortitionModule {
     uint256 public maxDrawingTime; // The time after which the phase can be switched back to Staking.
     uint256 public lastPhaseChange; // The last time the phase was changed.
     uint256 public disputesWithoutJurors; // The number of disputes that have not finished drawing jurors.
-    RNG public rng; // The random number generator.
+    IRNG public rng; // The random number generator.
     uint256 public randomNumber; // Random number returned by RNG.
     uint256 public rngLookahead; // DEPRECATED
     uint256 public delayedStakeWriteIndex; // The index of the last `delayedStake` item that was written to the array. 0 index is skipped.
@@ -93,7 +93,7 @@ abstract contract SortitionModuleBase is ISortitionModule {
         KlerosCore _core,
         uint256 _minStakingTime,
         uint256 _maxDrawingTime,
-        RNG _rng
+        IRNG _rng
     ) internal {
         governor = _governor;
         core = _core;
@@ -136,7 +136,7 @@ abstract contract SortitionModuleBase is ISortitionModule {
 
     /// @dev Changes the `rng` storage variable.
     /// @param _rng The new random number generator.
-    function changeRandomNumberGenerator(RNG _rng) external onlyByGovernor {
+    function changeRandomNumberGenerator(IRNG _rng) external onlyByGovernor {
         rng = _rng;
         if (phase == Phase.generating) {
             rng.requestRandomness();

contracts/src/arbitration/SortitionModuleNeo.sol

@@ -47,7 +47,7 @@ contract SortitionModuleNeo is SortitionModuleBase, UUPSProxiable, Initializable
         KlerosCore _core,
         uint256 _minStakingTime,
         uint256 _maxDrawingTime,
-        RNG _rng,
+        IRNG _rng,
         uint256 _maxStakePerJuror,
         uint256 _maxTotalStaked
     ) external reinitializer(2) {

contracts/src/rng/BlockhashRNG.sol

@@ -2,15 +2,15 @@
 
 pragma solidity 0.8.24;
 
-import "./RNG.sol";
+import "./IRNG.sol";
 
 /// @title Random Number Generator using blockhash with fallback.
 /// @dev
 ///  Random Number Generator returning the blockhash with a fallback behaviour.
 ///  In case no one called it within the 256 blocks, it returns the previous blockhash.
 ///  This contract must be used when returning 0 is a worse failure mode than returning another blockhash.
 ///  Allows saving the random number for use in the future. It allows the contract to still access the blockhash even after 256 blocks.
-contract BlockHashRNG is RNG {
+contract BlockHashRNG is IRNG {
     uint256 public immutable lookahead; // Minimal block distance between requesting and obtaining a random number.
     uint256 public requestBlock; // Block number of the current request
     mapping(uint256 block => uint256 number) public randomNumbers; // randomNumbers[block] is the random number for this block, 0 otherwise.

contracts/src/rng/ChainlinkRNG.sol

@@ -5,11 +5,11 @@ pragma solidity 0.8.24;
 import {VRFConsumerBaseV2Plus, IVRFCoordinatorV2Plus} from "@chainlink/contracts/src/v0.8/vrf/dev/VRFConsumerBaseV2Plus.sol";
 import {VRFV2PlusClient} from "@chainlink/contracts/src/v0.8/vrf/dev/libraries/VRFV2PlusClient.sol";
 
-import "./RNG.sol";
+import "./IRNG.sol";
 
 /// @title Random Number Generator that uses Chainlink VRF v2.5
 /// https://blog.chain.link/introducing-vrf-v2-5/
-contract ChainlinkRNG is RNG, VRFConsumerBaseV2Plus {
+contract ChainlinkRNG is IRNG, VRFConsumerBaseV2Plus {
     // ************************************* //
     // *             Storage               * //
     // ************************************* //

contracts/src/rng/RNG.sol renamed to contracts/src/rng/IRNG.sol

@@ -2,7 +2,8 @@
 
 pragma solidity 0.8.24;
 
-interface RNG {
+/// @title Random Number Generator interface
+interface IRNG {
     /// @dev Request a random number.
     function requestRandomness() external;
 

contracts/src/rng/IncrementalNG.sol

@@ -5,9 +5,9 @@
 /// @dev A Random Number Generator which returns a number incremented by 1 each time. Useful as a fallback method.
 
 pragma solidity 0.8.24;
-import "./RNG.sol";
+import "./IRNG.sol";
 
-contract IncrementalNG is RNG {
+contract IncrementalNG is IRNG {
     uint256 public number;
 
     constructor(uint256 _start) {

contracts/src/rng/RNGWithFallback.sol

@@ -1,19 +1,19 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.24;
 
-import "./RNG.sol";
+import "./IRNG.sol";
 
 /// @title RNG with fallback mechanism
 /// @notice Uses multiple RNG implementations with automatic fallback if default RNG does not respond passed a timeout.
-contract RNGWithFallback is RNG {
+contract RNGWithFallback is IRNG {
     uint256 public constant DEFAULT_RNG = 0;
 
     // ************************************* //
     // *             Storage               * //
     // ************************************* //
 
     address public governor; // Governor address
-    RNG[] public rngs; // List of RNG implementations
+    IRNG[] public rngs; // List of RNG implementations
     uint256 public fallbackTimeout; // Number of blocks to wait before falling back to next RNG
     uint256 public requestBlock; // Block number of the current request
     uint256 public currentRngIndex; // Index of the current RNG
@@ -35,14 +35,14 @@ contract RNGWithFallback is RNG {
 
     /// @param _governor Governor address
     /// @param _fallbackTimeout Number of blocks to wait before falling back to next RNG
-    /// @param _initialRng The default RNG
-    constructor(address _governor, uint256 _fallbackTimeout, RNG _initialRng) {
-        require(address(_initialRng) != address(0), "Invalid default RNG");
+    /// @param _defaultRng The default RNG
+    constructor(address _governor, uint256 _fallbackTimeout, IRNG _defaultRng) {
+        require(address(_defaultRng) != address(0), "Invalid default RNG");
         require(_fallbackTimeout > 0, "Invalid fallback timeout");
 
         governor = _governor;
         fallbackTimeout = _fallbackTimeout;
-        rngs.push(_initialRng);
+        rngs.push(_defaultRng);
     }
 
     // ************************************* //
@@ -110,7 +110,7 @@ contract RNGWithFallback is RNG {
 
     /// @dev Change the default RNG
     /// @param _newDefaultRng Address of the new default RNG
-    function changeDefaultRng(RNG _newDefaultRng) external onlyByGovernor {
+    function changeDefaultRng(IRNG _newDefaultRng) external onlyByGovernor {
         require(address(_newDefaultRng) != address(0), "Invalid RNG");
         rngs[DEFAULT_RNG] = _newDefaultRng;
         emit RNGDefaultChanged(address(_newDefaultRng));
@@ -121,7 +121,7 @@ contract RNGWithFallback is RNG {
 
     /// @dev Add a new RNG fallback
     /// @param _newFallbackRng Address of the new RNG fallback
-    function addRngFallback(RNG _newFallbackRng) external onlyByGovernor {
+    function addRngFallback(IRNG _newFallbackRng) external onlyByGovernor {
         require(address(_newFallbackRng) != address(0), "Invalid RNG");
         rngs.push(_newFallbackRng);
         emit RNGFallbackAdded(address(_newFallbackRng));
@@ -136,7 +136,7 @@ contract RNGWithFallback is RNG {
             currentRngIndex = DEFAULT_RNG;
         }
 
-        RNG removedRng = rngs[rngs.length - 1];
+        IRNG removedRng = rngs[rngs.length - 1];
         rngs.pop();
         emit RNGFallbackRemoved(address(removedRng));
     }

contracts/src/rng/RandomizerRNG.sol

@@ -2,14 +2,14 @@
 
 pragma solidity 0.8.24;
 
-import "./RNG.sol";
+import "./IRNG.sol";
 import "./IRandomizer.sol";
 import "../proxy/UUPSProxiable.sol";
 import "../proxy/Initializable.sol";
 
 /// @title Random Number Generator that uses Randomizer.ai
 /// https://randomizer.ai/
-contract RandomizerRNG is RNG, UUPSProxiable, Initializable {
+contract RandomizerRNG is IRNG, UUPSProxiable, Initializable {
     // ************************************* //
     // *             Storage               * //
     // ************************************* //

cspell.json

@@ -34,6 +34,7 @@
     "IERC",
     "Initializable",
     "ipfs",
+    "IRNG",
     "kleros",
     "linguo",
     "Numberish",