cleanup

Author: jayantk

target_chains/ethereum/contracts/contracts/entropy/Entropy.sol

@@ -317,7 +317,7 @@ abstract contract Entropy is IEntropy, EntropyState {
             requestWithCallbackAndGasLimit(
                 provider,
                 userRandomNumber,
-                _state.providers[provider].defaultGasLimit
+                0 // Passing 0 will assign the request the provider's default gas limit
             );
     }
 

target_chains/ethereum/entropy_sdk/solidity/EntropyErrors.sol

@@ -45,6 +45,4 @@ library EntropyErrors {
     error UpdateTooOld();
     // Not enough gas was provided to the function to execute the callback with the desired amount of gas.
     error InsufficientGas();
-    // An argument to the function call was invalid or out of the expected range.
-    error InvalidArgument();
 }

target_chains/ethereum/entropy_sdk/solidity/EntropyEvents.sol

@@ -51,11 +51,10 @@ interface EntropyEvents {
 
     event ProviderFeeUpdated(address provider, uint128 oldFee, uint128 newFee);
 
-    // TODO: uint32
     event ProviderDefaultGasLimitUpdated(
         address indexed provider,
-        uint64 oldDefaultGasLimit,
-        uint64 newDefaultGasLimit
+        uint32 oldDefaultGasLimit,
+        uint32 newDefaultGasLimit
     );
 
     event ProviderUriUpdated(address provider, bytes oldUri, bytes newUri);

target_chains/ethereum/entropy_sdk/solidity/EntropyStructs.sol

@@ -63,8 +63,9 @@ contract EntropyStructs {
         bool useBlockhash;
         // Status flag for requests with callbacks. See EntropyConstants for the possible values of this flag.
         uint8 callbackStatus;
-        // 2 bytes of space left in this struct.
-        // The gasLimit in units of 10k gas. (i.e., 2 = 20k gas)
+        // The gasLimit in units of 10k gas. (i.e., 2 = 20k gas). We're using units of 10k in order to fit this
+        // field into the remaining 2 bytes of this storage slot. The dynamic range here is 10k - ~65M, which should
+        // cover all real-world use cases.
         uint16 gasLimit10k;
     }
 }

target_chains/ethereum/entropy_sdk/solidity/IEntropy.sol

@@ -48,14 +48,30 @@ interface IEntropy is EntropyEvents {
     //
     // The address calling this function should be a contract that inherits from the IEntropyConsumer interface.
     // The `entropyCallback` method on that interface will receive a callback with the generated random number.
+    // `entropyCallback` will be run with the provider's default gas limit (see `getProviderInfo(provider).defaultGasLimit`).
+    // If your callback needs additional gas, please use `requestWithCallbackAndGasLimit`.
     //
-    // This method will revert unless the caller provides a sufficient fee (at least getFee(provider)) as msg.value.
+    // This method will revert unless the caller provides a sufficient fee (at least `getFee(provider)`) as msg.value.
     // Note that excess value is *not* refunded to the caller.
     function requestWithCallback(
         address provider,
         bytes32 userRandomNumber
     ) external payable returns (uint64 assignedSequenceNumber);
 
+    // Request a random number from `provider`, getting a callback with the result.
+    // The caller must specify a provider to fulfill the request -- `getDefaultProvider()` is a sane default --
+    // and a `userRandomNumber` to combine into the result. The method returns a sequence number which callers
+    // should save to correlate the request with the callback.
+    //
+    // The address calling this function should be a contract that inherits from the IEntropyConsumer interface.
+    // The `entropyCallback` method on that interface will receive a callback with the returned sequence number and
+    // the generated random number. `entropyCallback` will be run with the `gasLimit` provided to this function.
+    // The `gasLimit` will be rounded up to a multiple of 10k (e.g., 19000 -> 20000), and furthermore is lower bounded
+    // by the provider's configured default limit.
+    //
+    // This method will revert unless the caller provides a sufficient fee (at least `getFeeForGas(provider, gasLimit)`) as msg.value.
+    // Note that provider fees can change over time. Thus, callers of this method should explictly compute `getFeeForGas(provider, gasLimit)`
+    // prior to each invocation (as opposed to  hardcoding a value). Further note that excess value is *not* refunded to the caller.
     function requestWithCallbackAndGasLimit(
         address provider,
         bytes32 userRandomNumber,
@@ -104,8 +120,11 @@ interface IEntropy is EntropyEvents {
         uint64 sequenceNumber
     ) external view returns (EntropyStructs.Request memory req);
 
+    // Get the fee charged by provider for a request with the default gasLimit (`request` or `requestWithCallback`).
+    // If you are calling `requestWithCallbackAndGasLimit`, please use `getFeeForGas`.
     function getFee(address provider) external view returns (uint128 feeAmount);
 
+    // Get the fee charged by `provider` for a request with a specific `gasLimit` (`requestWithCallbackAndGasLimit`).
     function getFeeForGas(
         address provider,
         uint32 gasLimit

target_chains/ethereum/entropy_sdk/solidity/abis/EntropyErrors.json

@@ -24,11 +24,6 @@
     "name": "InsufficientGas",
     "type": "error"
   },
-  {
-    "inputs": [],
-    "name": "InvalidArgument",
-    "type": "error"
-  },
   {
     "inputs": [],
     "name": "InvalidRevealCall",

target_chains/ethereum/entropy_sdk/solidity/abis/EntropyEvents.json

@@ -108,15 +108,15 @@
       },
       {
         "indexed": false,
-        "internalType": "uint64",
+        "internalType": "uint32",
         "name": "oldDefaultGasLimit",
-        "type": "uint64"
+        "type": "uint32"
       },
       {
         "indexed": false,
-        "internalType": "uint64",
+        "internalType": "uint32",
         "name": "newDefaultGasLimit",
-        "type": "uint64"
+        "type": "uint32"
       }
     ],
     "name": "ProviderDefaultGasLimitUpdated",

target_chains/ethereum/entropy_sdk/solidity/abis/IEntropy.json

@@ -108,15 +108,15 @@
       },
       {
         "indexed": false,
-        "internalType": "uint64",
+        "internalType": "uint32",
         "name": "oldDefaultGasLimit",
-        "type": "uint64"
+        "type": "uint32"
       },
       {
         "indexed": false,
-        "internalType": "uint64",
+        "internalType": "uint32",
         "name": "newDefaultGasLimit",
-        "type": "uint64"
+        "type": "uint32"
       }
     ],
     "name": "ProviderDefaultGasLimitUpdated",