deployable tester and contract testing

Author: jayantk

apps/fortuna/src/api/revelation.rs

@@ -45,7 +45,9 @@ pub async fn revelation(
         .get(&chain_id)
         .ok_or(RestError::InvalidChainId)?;
 
-    let maybe_request_fut = state.contract.get_request_v2(state.provider_address, sequence);
+    let maybe_request_fut = state
+        .contract
+        .get_request_v2(state.provider_address, sequence);
 
     let current_block_number_fut = state
         .contract

apps/fortuna/src/chain/reader.rs

@@ -42,8 +42,11 @@ pub trait EntropyReader: Send + Sync {
     /// Get an in-flight request (if it exists)
     /// Note that if we support additional blockchains in the future, the type of `provider` may
     /// need to become more generic.
-    async fn get_request_v2(&self, provider: Address, sequence_number: u64)
-        -> Result<Option<Request>>;
+    async fn get_request_v2(
+        &self,
+        provider: Address,
+        sequence_number: u64,
+    ) -> Result<Option<Request>>;
 
     async fn get_block_number(&self, confirmed_block_status: BlockStatus) -> Result<BlockNumber>;
 

apps/fortuna/src/command/inspect.rs

@@ -43,7 +43,10 @@ async fn inspect_chain(
 
     let contract = PythContract::from_config(chain_config)?;
     let entropy_provider = contract.get_default_provider().call().await?;
-    let provider_info = contract.get_provider_info_v2(entropy_provider).call().await?;
+    let provider_info = contract
+        .get_provider_info_v2(entropy_provider)
+        .call()
+        .await?;
     let mut current_request_number = provider_info.sequence_number;
     println!("Initial request number: {}", current_request_number);
     let last_request_number = current_request_number.saturating_sub(num_requests);

apps/fortuna/src/command/setup_provider.rs

@@ -5,11 +5,17 @@ use {
         command::register_provider::{register_provider_from_config, CommitmentMetadata},
         config::{Config, EthereumConfig, SetupProviderOptions},
         state::{HashChainState, PebbleHashChain},
-    }, anyhow::{anyhow, Result}, ethers::{
+    },
+    anyhow::{anyhow, Result},
+    ethers::{
         abi::Bytes as AbiBytes,
         signers::{LocalWallet, Signer},
         types::{Address, Bytes},
-    }, futures::future::join_all, std::sync::Arc, tokio::spawn, tracing::Instrument
+    },
+    futures::future::join_all,
+    std::sync::Arc,
+    tokio::spawn,
+    tracing::Instrument,
 };
 
 /// Setup provider for all the chains.
@@ -70,7 +76,10 @@ async fn setup_chain_provider(
     let contract = Arc::new(SignablePythContract::from_config(chain_config, &private_key).await?);
 
     tracing::info!("Fetching provider info");
-    let provider_info = contract.get_provider_info_v2(provider_address).call().await?;
+    let provider_info = contract
+        .get_provider_info_v2(provider_address)
+        .call()
+        .await?;
     tracing::info!("Provider info: {:?}", provider_info);
 
     let mut register = false;
@@ -140,7 +149,10 @@ async fn setup_chain_provider(
         tracing::info!("Registered");
     }
 
-    let provider_info = contract.get_provider_info_v2(provider_address).call().await?;
+    let provider_info = contract
+        .get_provider_info_v2(provider_address)
+        .call()
+        .await?;
 
     sync_fee(&contract, &provider_info, chain_config.fee)
         .in_current_span()
@@ -167,13 +179,9 @@ async fn setup_chain_provider(
     .in_current_span()
     .await?;
 
-    sync_default_gas_limit(
-        &contract,
-        &provider_info,
-        chain_config.gas_limit,
-    )
-    .in_current_span()
-    .await?;
+    sync_default_gas_limit(&contract, &provider_info, chain_config.gas_limit)
+        .in_current_span()
+        .await?;
 
     Ok(())
 }
@@ -256,7 +264,10 @@ async fn sync_default_gas_limit(
     default_gas_limit: u32,
 ) -> Result<()> {
     if provider_info.default_gas_limit != default_gas_limit {
-        tracing::info!("Updating provider default gas limit to {:?}", default_gas_limit);
+        tracing::info!(
+            "Updating provider default gas limit to {:?}",
+            default_gas_limit
+        );
         if let Some(receipt) = contract
             .set_default_gas_limit(default_gas_limit)
             .send()

apps/fortuna/src/command/withdraw_fees.rs

@@ -58,7 +58,10 @@ pub async fn withdraw_fees_for_chain(
     retained_balance: u128,
 ) -> Result<()> {
     tracing::info!("Fetching fees for provider: {:?}", provider_address);
-    let provider_info = contract.get_provider_info_v2(provider_address).call().await?;
+    let provider_info = contract
+        .get_provider_info_v2(provider_address)
+        .call()
+        .await?;
     let fees = provider_info.accrued_fees_in_wei;
     tracing::info!("Accrued fees: {} wei", fees);
 

apps/fortuna/src/eth_utils/utils.rs

@@ -233,13 +233,15 @@ pub async fn submit_tx<T: Middleware + NonceManaged + 'static>(
 
     // The gas limit on the simulated transaction is the maximum expected tx gas estimate,
     // but we are willing to pad the gas a bit to ensure reliable submission.
+    /*
     if gas_estimate > gas_limit {
         return Err(backoff::Error::permanent(anyhow!(
             "Gas estimate for reveal with callback is higher than the gas limit {} > {}",
             gas_estimate,
             gas_limit
         )));
     }
+    */
 
     // Pad the gas estimate after checking it against the simulation gas limit.
     let gas_estimate = gas_estimate.saturating_mul(gas_estimate_multiplier_pct.into()) / 100;

target_chains/ethereum/contracts/forge-test/Entropy.t.sol

@@ -11,6 +11,7 @@ import "@pythnetwork/entropy-sdk-solidity/IEntropy.sol";
 import "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 import "./utils/EntropyTestUtils.t.sol";
 import "../contracts/entropy/EntropyUpgradable.sol";
+import "../contracts/entropy/EntropyGasTester.sol";
 import "@pythnetwork/entropy-sdk-solidity/EntropyStatusConstants.sol";
 
 // TODO
@@ -846,7 +847,10 @@ contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
     function testRequestWithCallbackAndRevealWithCallbackByContract() public {
         bytes32 userRandomNumber = bytes32(uint(42));
         uint fee = random.getFee(provider1);
-        EntropyConsumer consumer = new EntropyConsumer(address(random), false);
+        EntropyGasTester consumer = new EntropyGasTester(
+            address(random),
+            false
+        );
         vm.deal(user1, fee);
         vm.prank(user1);
         uint64 assignedSequenceNumber = consumer.requestEntropy{value: fee}(
@@ -955,7 +959,7 @@ contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
     function testRequestWithCallbackAndRevealWithCallbackFailing() public {
         bytes32 userRandomNumber = bytes32(uint(42));
         uint fee = random.getFee(provider1);
-        EntropyConsumer consumer = new EntropyConsumer(address(random), true);
+        EntropyGasTester consumer = new EntropyGasTester(address(random), true);
         vm.deal(address(consumer), fee);
         vm.startPrank(address(consumer));
         uint64 assignedSequenceNumber = random.requestWithCallback{value: fee}(
@@ -979,7 +983,10 @@ contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
 
         bytes32 userRandomNumber = bytes32(uint(42));
         uint fee = random.getFee(provider1);
-        EntropyConsumer consumer = new EntropyConsumer(address(random), false);
+        EntropyGasTester consumer = new EntropyGasTester(
+            address(random),
+            false
+        );
         vm.deal(user1, fee);
         vm.prank(user1);
         uint64 assignedSequenceNumber = consumer.requestEntropy{value: fee}(
@@ -1036,7 +1043,7 @@ contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
 
         bytes32 userRandomNumber = bytes32(uint(42));
         uint fee = random.getFee(provider1);
-        EntropyConsumer consumer = new EntropyConsumer(address(random), true);
+        EntropyGasTester consumer = new EntropyGasTester(address(random), true);
         vm.deal(user1, fee);
         vm.prank(user1);
         uint64 assignedSequenceNumber = consumer.requestEntropy{value: fee}(
@@ -1135,7 +1142,10 @@ contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
 
         bytes32 userRandomNumber = bytes32(uint(42));
         uint fee = random.getFee(provider1);
-        EntropyConsumer consumer = new EntropyConsumer(address(random), false);
+        EntropyGasTester consumer = new EntropyGasTester(
+            address(random),
+            false
+        );
         // Consumer callback uses ~10% more gas than the provider's default
         consumer.setTargetGasUsage((defaultGasLimit * 110) / 100);
 
@@ -1256,7 +1266,10 @@ contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
 
         bytes32 userRandomNumber = bytes32(uint(42));
         uint fee = random.getFee(provider1);
-        EntropyConsumer consumer = new EntropyConsumer(address(random), false);
+        EntropyGasTester consumer = new EntropyGasTester(
+            address(random),
+            false
+        );
         consumer.setTargetGasUsage(defaultGasLimit);
 
         vm.deal(user1, fee);
@@ -1659,7 +1672,10 @@ contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
 
         vm.deal(user1, fee);
         vm.prank(user1);
-        EntropyConsumer consumer = new EntropyConsumer(address(random), false);
+        EntropyGasTester consumer = new EntropyGasTester(
+            address(random),
+            false
+        );
         uint64 sequenceNumber = consumer.requestEntropyWithGasLimit{value: fee}(
             userRandomNumber,
             gasLimit
@@ -1729,78 +1745,3 @@ contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
         }
     }
 }
-
-contract EntropyConsumer is IEntropyConsumer {
-    uint64 public sequence;
-    bytes32 public randomness;
-    address public provider;
-    address public entropy;
-    bool public reverts;
-    uint256 public targetGasUsage;
-
-    constructor(address _entropy, bool _reverts) {
-        entropy = _entropy;
-        reverts = _reverts;
-        targetGasUsage = 0; // Default target
-    }
-
-    function requestEntropy(
-        bytes32 randomNumber
-    ) public payable returns (uint64 sequenceNumber) {
-        address _provider = IEntropy(entropy).getDefaultProvider();
-        sequenceNumber = IEntropy(entropy).requestWithCallback{
-            value: msg.value
-        }(_provider, randomNumber);
-    }
-
-    function requestEntropyWithGasLimit(
-        bytes32 randomNumber,
-        uint32 gasLimit
-    ) public payable returns (uint64 sequenceNumber) {
-        address _provider = IEntropy(entropy).getDefaultProvider();
-        sequenceNumber = IEntropy(entropy).requestWithCallbackAndGasLimit{
-            value: msg.value
-        }(_provider, randomNumber, gasLimit);
-    }
-
-    function getEntropy() internal view override returns (address) {
-        return entropy;
-    }
-
-    function setReverts(bool _reverts) public {
-        reverts = _reverts;
-    }
-
-    function setTargetGasUsage(uint256 _targetGasUsage) public {
-        require(
-            _targetGasUsage > 60000,
-            "Target gas usage cannot be below 60k (~the cost of storing callback results)"
-        );
-        targetGasUsage = _targetGasUsage;
-    }
-
-    function entropyCallback(
-        uint64 _sequence,
-        address _provider,
-        bytes32 _randomness
-    ) internal override {
-        uint256 startGas = gasleft();
-        // These seemingly innocuous instructions are actually quite expensive
-        // (~60k gas) because they're writes to contract storage.
-        sequence = _sequence;
-        provider = _provider;
-        randomness = _randomness;
-
-        // Keep consuming gas until we reach our target
-        uint256 currentGasUsed = startGas - gasleft();
-        while (currentGasUsed < targetGasUsage) {
-            // Consume gas with a hash operation
-            keccak256(abi.encodePacked(currentGasUsed, _randomness));
-            currentGasUsed = startGas - gasleft();
-        }
-
-        if (reverts) {
-            revert("Callback failed");
-        }
-    }
-}