pyth-network_pyth-crosschain/target_chains/ethereum/contracts/test/EntropyGasBenchmark.t.sol

// SPDX-License-Identifier: Apache 2

pragma solidity ^0.8.0;

import "forge-std/Test.sol";
import "@pythnetwork/entropy-sdk-solidity/EntropyStructs.sol";
import "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";

import "./utils/EntropyTestUtils.t.sol";
import "../contracts/entropy/EntropyUpgradable.sol";

// TODO
// - what's the impact of # of in-flight requests on gas usage? More requests => more hashes to
//   verify the provider's value.
contract EntropyGasBenchmark is Test, EntropyTestUtils {
    ERC1967Proxy public proxy;
    EntropyUpgradable public random;

    uint128 pythFeeInWei = 7;

    address public provider1 = address(1);
    bytes32[] provider1Proofs;
    uint128 provider1FeeInWei = 8;
    uint64 provider1ChainLength = 100;

    address public user1 = address(3);

    function setUp() public {
        EntropyUpgradable _random = new EntropyUpgradable();
        // deploy proxy contract and point it to implementation
        proxy = new ERC1967Proxy(address(_random), "");
        // wrap in ABI to support easier calls
        random = EntropyUpgradable(address(proxy));

        random.initialize(
            address(4),
            address(5),
            pythFeeInWei,
            provider1,
            false
        );

        bytes32[] memory hashChain1 = generateHashChain(
            provider1,
            0,
            provider1ChainLength
        );
        provider1Proofs = hashChain1;
        vm.prank(provider1);
        random.register(
            provider1FeeInWei,
            provider1Proofs[0],
            hex"0100",
            provider1ChainLength,
            ""
        );

        // Register twice so the commitment sequence number is nonzero. Zero values can be misleading
        // when gas benchmarking.
        vm.prank(provider1);
        random.register(
            provider1FeeInWei,
            provider1Proofs[0],
            hex"0100",
            provider1ChainLength,
            ""
        );

        assert(
            random.getProviderInfo(provider1).currentCommitmentSequenceNumber !=
                0
        );
    }

    // Test helper method for requesting a random value as user from provider.
    function requestHelper(
        address user,
        uint randomNumber,
        bool useBlockhash
    ) public returns (uint64 sequenceNumber) {
        uint fee = random.getFee(provider1);
        vm.deal(user, fee);
        vm.prank(user);
        sequenceNumber = random.request{value: fee}(
            provider1,
            random.constructUserCommitment(bytes32(randomNumber)),
            useBlockhash
        );
    }

    function revealHelper(
        uint64 sequenceNumber,
        uint userRandom
    ) public returns (bytes32 randomNumber) {
        randomNumber = random.reveal(
            provider1,
            sequenceNumber,
            bytes32(userRandom),
            provider1Proofs[
                sequenceNumber -
                    random
                        .getProviderInfo(provider1)
                        .originalCommitmentSequenceNumber
            ]
        );
    }

    function testBasicFlow() public {
        uint userRandom = 42;
        vm.roll(10);
        uint64 sequenceNumber = requestHelper(user1, userRandom, true);
        vm.roll(12);
        revealHelper(sequenceNumber, userRandom);
    }
}