| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792 |
- // SPDX-License-Identifier: Apache 2
- pragma solidity ^0.8.0;
- import "forge-std/Test.sol";
- import "@pythnetwork/entropy-sdk-solidity/EntropyStructs.sol";
- import "@pythnetwork/entropy-sdk-solidity/EntropyStructsV2.sol";
- import "@pythnetwork/entropy-sdk-solidity/EntropyEvents.sol";
- import "@pythnetwork/entropy-sdk-solidity/IEntropyConsumer.sol";
- 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 "@pythnetwork/entropy-sdk-solidity/EntropyStatusConstants.sol";
- // TODO
- // - fuzz test?
- contract EntropyTest is Test, EntropyTestUtils, EntropyEvents {
- ERC1967Proxy public proxy;
- EntropyUpgradable public random;
- uint128 pythFeeInWei = 7;
- address public provider1 = address(1);
- bytes32[] provider1Proofs;
- uint128 provider1FeeInWei = 8;
- uint64 provider1ChainLength = 1000;
- uint32 provider1MaxNumHashes = 500;
- bytes provider1Uri = bytes("https://foo.com");
- bytes provider1CommitmentMetadata = hex"0100";
- address public provider2 = address(2);
- bytes32[] provider2Proofs;
- uint128 provider2FeeInWei = 20;
- bytes provider2Uri = bytes("https://bar.com");
- address public user1 = address(3);
- address public user2 = address(4);
- address public unregisteredProvider = address(7);
- uint128 MAX_UINT128 = 2 ** 128 - 1;
- bytes32 ALL_ZEROS = bytes32(uint256(0));
- address public owner = address(8);
- address public admin = address(9);
- address public admin2 = address(10);
- 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(owner, admin, pythFeeInWei, provider1, false);
- bytes32[] memory hashChain1 = generateHashChain(
- provider1,
- 0,
- provider1ChainLength
- );
- provider1Proofs = hashChain1;
- vm.prank(provider1);
- random.register(
- provider1FeeInWei,
- provider1Proofs[0],
- provider1CommitmentMetadata,
- provider1ChainLength,
- provider1Uri
- );
- vm.prank(provider1);
- random.setMaxNumHashes(provider1MaxNumHashes);
- bytes32[] memory hashChain2 = generateHashChain(provider2, 0, 100);
- provider2Proofs = hashChain2;
- vm.prank(provider2);
- random.register(
- provider2FeeInWei,
- provider2Proofs[0],
- hex"0200",
- 100,
- provider2Uri
- );
- }
- // Test helper method for requesting a random value as user from provider.
- function request(
- address user,
- address provider,
- uint randomNumber,
- bool useBlockhash
- ) public returns (uint64 sequenceNumber) {
- sequenceNumber = requestWithFee(
- user,
- random.getFee(provider),
- provider,
- randomNumber,
- useBlockhash
- );
- }
- function requestWithFee(
- address user,
- uint fee,
- address provider,
- uint randomNumber,
- bool useBlockhash
- ) public returns (uint64 sequenceNumber) {
- vm.deal(user, fee);
- vm.startPrank(user);
- sequenceNumber = random.request{value: fee}(
- provider,
- random.constructUserCommitment(bytes32(randomNumber)),
- useBlockhash
- );
- vm.stopPrank();
- }
- function assertRequestReverts(
- uint fee,
- address provider,
- uint randomNumber,
- bool useBlockhash,
- bytes4 revertReason
- ) public {
- bytes32 userCommitment = random.constructUserCommitment(
- bytes32(uint256(randomNumber))
- );
- vm.deal(address(this), fee);
- vm.expectRevert(revertReason);
- random.request{value: fee}(provider, userCommitment, useBlockhash);
- }
- function assertRevealSucceeds(
- address user,
- address provider,
- uint64 sequenceNumber,
- uint userRandom,
- bytes32 providerRevelation,
- bytes32 hash
- ) public {
- vm.prank(user);
- bytes32 randomNumber = random.reveal(
- provider,
- sequenceNumber,
- bytes32(userRandom),
- providerRevelation
- );
- assertEq(
- randomNumber,
- random.combineRandomValues(
- bytes32(userRandom),
- providerRevelation,
- hash
- )
- );
- }
- function assertRevealReverts(
- address user,
- address provider,
- uint64 sequenceNumber,
- uint userRandom,
- bytes32 providerRevelation
- ) public {
- vm.startPrank(user);
- vm.expectRevert();
- random.reveal(
- provider,
- sequenceNumber,
- bytes32(uint256(userRandom)),
- providerRevelation
- );
- vm.stopPrank();
- }
- function assertInvariants() public {
- uint expectedBalance = random
- .getProviderInfo(provider1)
- .accruedFeesInWei +
- random.getProviderInfo(provider2).accruedFeesInWei +
- random.getAccruedPythFees();
- assertEq(address(random).balance, expectedBalance);
- EntropyStructsV2.ProviderInfo memory info1 = random.getProviderInfo(
- provider1
- );
- assert(
- info1.originalCommitmentSequenceNumber <=
- info1.currentCommitmentSequenceNumber
- );
- assert(info1.currentCommitmentSequenceNumber < info1.sequenceNumber);
- assert(info1.sequenceNumber <= info1.endSequenceNumber);
- EntropyStructsV2.ProviderInfo memory info2 = random.getProviderInfo(
- provider2
- );
- assert(
- info2.originalCommitmentSequenceNumber <=
- info2.currentCommitmentSequenceNumber
- );
- assert(info2.sequenceNumber > info2.currentCommitmentSequenceNumber);
- assert(info2.sequenceNumber <= info2.endSequenceNumber);
- }
- function testBasicFlow() public {
- vm.roll(17);
- uint64 sequenceNumber = request(user2, provider1, 42, false);
- assertEq(random.getRequest(provider1, sequenceNumber).blockNumber, 17);
- assertEq(
- random.getRequest(provider1, sequenceNumber).useBlockhash,
- false
- );
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- ALL_ZEROS
- );
- EntropyStructsV2.Request memory reqAfterReveal = random.getRequest(
- provider1,
- sequenceNumber
- );
- assertEq(reqAfterReveal.sequenceNumber, 0);
- // You can only reveal the random number once. This isn't a feature of the contract per se, but it is
- // the expected behavior.
- assertRevealReverts(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber]
- );
- }
- function testDefaultProvider() public {
- vm.roll(20);
- uint64 sequenceNumber = request(
- user2,
- random.getDefaultProvider(),
- 42,
- false
- );
- assertEq(random.getRequest(provider1, sequenceNumber).blockNumber, 20);
- assertEq(
- random.getRequest(provider1, sequenceNumber).useBlockhash,
- false
- );
- assertRevealReverts(
- user2,
- random.getDefaultProvider(),
- sequenceNumber,
- 42,
- provider2Proofs[sequenceNumber]
- );
- assertRevealSucceeds(
- user2,
- random.getDefaultProvider(),
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- ALL_ZEROS
- );
- }
- function testNoSuchProvider() public {
- assertRequestReverts(
- 10000000,
- unregisteredProvider,
- 42,
- false,
- EntropyErrors.NoSuchProvider.selector
- );
- }
- function testAuthorization() public {
- uint64 sequenceNumber = request(user2, provider1, 42, false);
- assertEq(random.getRequest(provider1, sequenceNumber).requester, user2);
- // user1 not authorized, must be user2.
- assertRevealReverts(
- user1,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber]
- );
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- ALL_ZEROS
- );
- }
- function testAdversarialReveal() public {
- uint64 sequenceNumber = request(user2, provider1, 42, false);
- // test revealing with the wrong hashes in the same chain
- for (uint256 i = 0; i < 10; i++) {
- if (i != sequenceNumber) {
- assertRevealReverts(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[i]
- );
- }
- }
- // test revealing with the wrong user revealed value.
- for (uint256 i = 0; i < 42; i++) {
- assertRevealReverts(
- user2,
- provider1,
- sequenceNumber,
- i,
- provider1Proofs[sequenceNumber]
- );
- }
- // test revealing sequence numbers that haven't been requested yet.
- for (uint64 i = sequenceNumber + 1; i < sequenceNumber + 3; i++) {
- assertRevealReverts(
- user2,
- provider1,
- i,
- 42,
- provider1Proofs[sequenceNumber]
- );
- assertRevealReverts(user2, provider1, i, 42, provider1Proofs[i]);
- }
- }
- function testConcurrentRequests() public {
- uint64 s1 = request(user1, provider1, 1, false);
- uint64 s2 = request(user2, provider1, 2, false);
- uint64 s3 = request(user1, provider1, 3, false);
- uint64 s4 = request(user1, provider1, 4, false);
- assertRevealSucceeds(
- user1,
- provider1,
- s3,
- 3,
- provider1Proofs[s3],
- ALL_ZEROS
- );
- assertInvariants();
- uint64 s5 = request(user1, provider1, 5, false);
- assertRevealSucceeds(
- user1,
- provider1,
- s4,
- 4,
- provider1Proofs[s4],
- ALL_ZEROS
- );
- assertInvariants();
- assertRevealSucceeds(
- user1,
- provider1,
- s1,
- 1,
- provider1Proofs[s1],
- ALL_ZEROS
- );
- assertInvariants();
- assertRevealSucceeds(
- user2,
- provider1,
- s2,
- 2,
- provider1Proofs[s2],
- ALL_ZEROS
- );
- assertInvariants();
- assertRevealSucceeds(
- user1,
- provider1,
- s5,
- 5,
- provider1Proofs[s5],
- ALL_ZEROS
- );
- assertInvariants();
- }
- function testBlockhash() public {
- vm.roll(1234);
- uint64 sequenceNumber = request(user2, provider1, 42, true);
- assertEq(
- random.getRequest(provider1, sequenceNumber).blockNumber,
- 1234
- );
- assertEq(
- random.getRequest(provider1, sequenceNumber).useBlockhash,
- true
- );
- vm.roll(1235);
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- blockhash(1234)
- );
- }
- function testNoCheckOnBlockNumberWhenNoBlockHashUsed() public {
- vm.roll(1234);
- uint64 sequenceNumber = request(user2, provider1, 42, false);
- vm.roll(1236);
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- ALL_ZEROS
- );
- vm.roll(1234);
- sequenceNumber = request(user2, provider1, 42, false);
- vm.roll(1234);
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- ALL_ZEROS
- );
- vm.roll(1234);
- sequenceNumber = request(user2, provider1, 42, false);
- vm.roll(1234 + 257);
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- ALL_ZEROS
- );
- }
- function testCheckOnBlockNumberWhenBlockHashUsed() public {
- vm.roll(1234);
- uint64 sequenceNumber = request(user2, provider1, 42, true);
- vm.roll(1234);
- assertRevealReverts(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber]
- );
- vm.roll(1234 + 257);
- assertRevealReverts(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber]
- );
- vm.roll(1235);
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- blockhash(1234)
- );
- }
- function testProviderCommitmentRotation() public {
- uint userRandom = 42;
- uint64 sequenceNumber1 = request(user2, provider1, userRandom, false);
- uint64 sequenceNumber2 = request(user2, provider1, userRandom, false);
- assertInvariants();
- uint64 newHashChainOffset = sequenceNumber2 + 1;
- bytes32[] memory newHashChain = generateHashChain(
- provider1,
- newHashChainOffset,
- 10
- );
- vm.prank(provider1);
- random.register(
- provider1FeeInWei,
- newHashChain[0],
- hex"0100",
- 10,
- provider1Uri
- );
- assertInvariants();
- EntropyStructsV2.ProviderInfo memory info1 = random.getProviderInfo(
- provider1
- );
- assertEq(info1.endSequenceNumber, newHashChainOffset + 10);
- uint64 sequenceNumber3 = request(user2, provider1, 42, false);
- // Rotating the provider key uses a sequence number
- assertEq(sequenceNumber3, sequenceNumber2 + 2);
- // Requests that were in-flight at the time of rotation use the commitment from the time of request
- for (uint256 i = 0; i < 10; i++) {
- assertRevealReverts(
- user2,
- provider1,
- sequenceNumber1,
- userRandom,
- newHashChain[i]
- );
- }
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber1,
- userRandom,
- provider1Proofs[sequenceNumber1],
- ALL_ZEROS
- );
- assertInvariants();
- // Requests after the rotation use the new commitment
- assertRevealReverts(
- user2,
- provider1,
- sequenceNumber3,
- userRandom,
- provider1Proofs[sequenceNumber3]
- );
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber3,
- userRandom,
- newHashChain[sequenceNumber3 - newHashChainOffset],
- ALL_ZEROS
- );
- assertInvariants();
- }
- function testOutOfRandomness() public {
- // Should be able to request chainLength - 1 random numbers successfully.
- for (uint64 i = 0; i < provider1ChainLength - 1; i++) {
- uint64 sequenceNumber = request(user2, provider1, 42, false);
- assertRevealSucceeds(
- user2,
- provider1,
- sequenceNumber,
- 42,
- provider1Proofs[sequenceNumber],
- ALL_ZEROS
- );
- }
- assertRequestReverts(
- random.getFee(provider1),
- provider1,
- provider1ChainLength - 1,
- false,
- EntropyErrors.OutOfRandomness.selector
- );
- }
- function testGetFee() public {
- assertEq(random.getFee(provider1), pythFeeInWei + provider1FeeInWei);
- assertEq(random.getFee(provider2), pythFeeInWei + provider2FeeInWei);
- // Requesting the fee for a nonexistent provider returns pythFeeInWei. This isn't necessarily desirable behavior,
- // but it's unlikely to cause a problem.
- assertEq(random.getFee(unregisteredProvider), pythFeeInWei);
- // Check that overflowing the fee arithmetic causes the transaction to revert.
- vm.prank(provider1);
- random.register(
- MAX_UINT128,
- provider1Proofs[0],
- hex"0100",
- 100,
- provider1Uri
- );
- vm.expectRevert();
- random.getFee(provider1);
- }
- function testOverflow() public {
- bytes32 userCommitment = random.constructUserCommitment(
- bytes32(uint256(42))
- );
- // msg.value overflows the uint128 fee variable
- uint fee = 2 ** 128;
- vm.deal(address(this), fee);
- vm.expectRevert("SafeCast: value doesn't fit in 128 bits");
- random.request{value: fee}(provider1, userCommitment, false);
- // block number is too large
- vm.roll(2 ** 96);
- vm.expectRevert("SafeCast: value doesn't fit in 64 bits");
- random.request{value: pythFeeInWei + provider1FeeInWei}(
- provider1,
- userCommitment,
- true
- );
- }
- function testFees() public {
- // Insufficient fees causes a revert
- assertRequestReverts(
- 0,
- provider1,
- 42,
- false,
- EntropyErrors.InsufficientFee.selector
- );
- assertRequestReverts(
- pythFeeInWei + provider1FeeInWei - 1,
- provider1,
- 42,
- false,
- EntropyErrors.InsufficientFee.selector
- );
- assertRequestReverts(
- 0,
- provider2,
- 42,
- false,
- EntropyErrors.InsufficientFee.selector
- );
- assertRequestReverts(
- pythFeeInWei + provider2FeeInWei - 1,
- provider2,
- 42,
- false,
- EntropyErrors.InsufficientFee.selector
- );
- // Accrue some fees for both providers
- for (uint i = 0; i < 3; i++) {
- request(user2, provider1, 42, false);
- }
- request(user2, provider2, 42, false);
- // this call overpays for the random number
- requestWithFee(
- user2,
- pythFeeInWei + provider2FeeInWei + 10000,
- provider2,
- 42,
- false
- );
- assertEq(
- random.getProviderInfo(provider1).accruedFeesInWei,
- provider1FeeInWei * 3
- );
- assertEq(
- random.getProviderInfo(provider2).accruedFeesInWei,
- provider2FeeInWei * 2
- );
- assertEq(random.getAccruedPythFees(), pythFeeInWei * 5 + 10000);
- assertInvariants();
- // Reregistering updates the required fees
- vm.prank(provider1);
- random.register(
- 12345,
- provider1Proofs[0],
- hex"0100",
- 100,
- provider1Uri
- );
- assertRequestReverts(
- pythFeeInWei + 12345 - 1,
- provider1,
- 42,
- false,
- EntropyErrors.InsufficientFee.selector
- );
- requestWithFee(user2, pythFeeInWei + 12345, provider1, 42, false);
- uint128 providerOneBalance = provider1FeeInWei * 3 + 12345;
- assertEq(
- random.getProviderInfo(provider1).accruedFeesInWei,
- providerOneBalance
- );
- assertInvariants();
- vm.prank(unregisteredProvider);
- vm.expectRevert();
- random.withdraw(1000);
- vm.prank(provider1);
- random.withdraw(1000);
- assertEq(
- random.getProviderInfo(provider1).accruedFeesInWei,
- providerOneBalance - 1000
- );
- assertInvariants();
- vm.prank(provider1);
- vm.expectRevert();
- random.withdraw(providerOneBalance);
- }
- function testGetProviderInfo() public {
- EntropyStructsV2.ProviderInfo memory providerInfo1 = random
- .getProviderInfo(provider1);
- // These two fields aren't used by the Entropy contract itself -- they're just convenient info to store
- // on-chain -- so they aren't tested in the other tests.
- assertEq(providerInfo1.uri, provider1Uri);
- assertEq(providerInfo1.commitmentMetadata, provider1CommitmentMetadata);
- }
- function testSetProviderFee() public {
- assertNotEq(random.getProviderInfo(provider1).feeInWei, 1);
- vm.prank(provider1);
- random.setProviderFee(1);
- assertEq(random.getProviderInfo(provider1).feeInWei, 1);
- }
- function testSetProviderFeeByUnregistered() public {
- vm.prank(unregisteredProvider);
- vm.expectRevert();
- random.setProviderFee(1);
- }
- function testSetProviderUri() public {
- bytes memory newUri = bytes("https://new.com");
- assertNotEq0(random.getProviderInfo(provider1).uri, newUri);
- vm.prank(provider1);
- random.setProviderUri(newUri);
- assertEq0(random.getProviderInfo(provider1).uri, newUri);
- }
- function testSetProviderUriByUnregistered() public {
- bytes memory newUri = bytes("https://new.com");
- vm.prank(unregisteredProvider);
- vm.expectRevert();
- random.setProviderUri(newUri);
- }
- function testRequestWithCallbackAndReveal() public {
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- EntropyStructsV2.ProviderInfo memory providerInfo = random
- .getProviderInfo(provider1);
- vm.roll(1234);
- vm.deal(user1, fee);
- vm.startPrank(user1);
- vm.expectEmit(false, false, false, true, address(random));
- emit RequestedWithCallback(
- provider1,
- user1,
- providerInfo.sequenceNumber,
- userRandomNumber,
- EntropyStructs.Request({
- provider: provider1,
- sequenceNumber: providerInfo.sequenceNumber,
- numHashes: SafeCast.toUint32(
- providerInfo.sequenceNumber -
- providerInfo.currentCommitmentSequenceNumber
- ),
- commitment: keccak256(
- bytes.concat(
- random.constructUserCommitment(userRandomNumber),
- providerInfo.currentCommitment
- )
- ),
- blockNumber: 1234,
- requester: user1,
- useBlockhash: false,
- isRequestWithCallback: true
- })
- );
- vm.roll(1234);
- uint64 assignedSequenceNumber = random.requestWithCallback{value: fee}(
- provider1,
- userRandomNumber
- );
- assertEq(
- random.getRequest(provider1, assignedSequenceNumber).requester,
- user1
- );
- assertEq(
- random.getRequest(provider1, assignedSequenceNumber).provider,
- provider1
- );
- vm.expectRevert(EntropyErrors.InvalidRevealCall.selector);
- random.reveal(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- vm.stopPrank();
- }
- function testRequestWithCallbackAndRevealWithCallbackByContract() public {
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- EntropyConsumer consumer = new EntropyConsumer(address(random), false);
- vm.deal(user1, fee);
- vm.prank(user1);
- uint64 assignedSequenceNumber = consumer.requestEntropy{value: fee}(
- userRandomNumber
- );
- EntropyStructsV2.Request memory req = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- vm.expectEmit(false, false, false, true, address(random));
- emit RevealedWithCallback(
- EntropyStructConverter.toV1Request(req),
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- 0
- )
- );
- vm.prank(user1);
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- assertEq(consumer.sequence(), assignedSequenceNumber);
- assertEq(consumer.provider(), provider1);
- assertEq(
- consumer.randomness(),
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- // No blockhash is being used in callback method. As it
- // is being depreceated. Passing 0 for it.
- 0
- )
- );
- EntropyStructsV2.Request memory reqAfterReveal = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- assertEq(reqAfterReveal.sequenceNumber, 0);
- }
- function testRequestWithCallbackAndRevealWithCallbackByEoa() public {
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- vm.deal(user1, fee);
- vm.prank(user1);
- uint64 assignedSequenceNumber = random.requestWithCallback{value: fee}(
- provider1,
- userRandomNumber
- );
- EntropyStructsV2.Request memory req = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- vm.expectEmit(false, false, false, true, address(random));
- emit RevealedWithCallback(
- EntropyStructConverter.toV1Request(req),
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- 0
- )
- );
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- EntropyStructsV2.Request memory reqAfterReveal = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- assertEq(reqAfterReveal.sequenceNumber, 0);
- }
- function testRequestAndRevealWithCallback() public {
- uint64 sequenceNumber = request(user2, provider1, 42, false);
- assertEq(random.getRequest(provider1, sequenceNumber).requester, user2);
- vm.expectRevert(EntropyErrors.InvalidRevealCall.selector);
- vm.prank(user2);
- random.revealWithCallback(
- provider1,
- sequenceNumber,
- bytes32(uint256(42)),
- provider1Proofs[sequenceNumber]
- );
- }
- function testRequestWithCallbackAndRevealWithCallbackFailing() public {
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- EntropyConsumer consumer = new EntropyConsumer(address(random), true);
- vm.deal(address(consumer), fee);
- vm.startPrank(address(consumer));
- uint64 assignedSequenceNumber = random.requestWithCallback{value: fee}(
- provider1,
- userRandomNumber
- );
- vm.expectRevert();
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- }
- function testRequestWithCallbackGasLimit() public {
- uint32 defaultGasLimit = 100000;
- vm.prank(provider1);
- random.setDefaultGasLimit(defaultGasLimit);
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- EntropyConsumer consumer = new EntropyConsumer(address(random), false);
- vm.deal(user1, fee);
- vm.prank(user1);
- uint64 assignedSequenceNumber = consumer.requestEntropy{value: fee}(
- userRandomNumber
- );
- EntropyStructsV2.Request memory req = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- // Verify the gas limit was set correctly
- assertEq(req.gasLimit10k, 10);
- vm.expectEmit(false, false, false, true, address(random));
- emit RevealedWithCallback(
- EntropyStructConverter.toV1Request(req),
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- 0
- )
- );
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- assertEq(consumer.sequence(), assignedSequenceNumber);
- assertEq(consumer.provider(), provider1);
- assertEq(
- consumer.randomness(),
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- 0
- )
- );
- EntropyStructsV2.Request memory reqAfterReveal = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- assertEq(reqAfterReveal.sequenceNumber, 0);
- }
- function testRequestWithRevertingCallback() public {
- uint32 defaultGasLimit = 100000;
- vm.prank(provider1);
- random.setDefaultGasLimit(defaultGasLimit);
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- EntropyConsumer consumer = new EntropyConsumer(address(random), true);
- vm.deal(user1, fee);
- vm.prank(user1);
- uint64 assignedSequenceNumber = consumer.requestEntropy{value: fee}(
- userRandomNumber
- );
- // On the first attempt, the transaction should succeed and emit CallbackFailed event.
- bytes memory revertReason = abi.encodeWithSelector(
- 0x08c379a0,
- "Callback failed"
- );
- vm.expectEmit(false, false, false, true, address(random));
- emit CallbackFailed(
- provider1,
- address(consumer),
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- 0
- ),
- revertReason
- );
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- // Verify request is still active after failure
- EntropyStructsV2.Request memory reqAfterFailure = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- assertEq(reqAfterFailure.sequenceNumber, assignedSequenceNumber);
- assertTrue(
- reqAfterFailure.callbackStatus ==
- EntropyStatusConstants.CALLBACK_FAILED
- );
- // On the second attempt, the transaction should directly revert
- vm.expectRevert();
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- // Again, request stays active after failure
- reqAfterFailure = random.getRequest(provider1, assignedSequenceNumber);
- assertEq(reqAfterFailure.sequenceNumber, assignedSequenceNumber);
- assertTrue(
- reqAfterFailure.callbackStatus ==
- EntropyStatusConstants.CALLBACK_FAILED
- );
- // If the callback starts succeeding, we can invoke it and it emits the usual RevealedWithCallback event.
- consumer.setReverts(false);
- vm.expectEmit(false, false, false, true, address(random));
- emit RevealedWithCallback(
- EntropyStructConverter.toV1Request(reqAfterFailure),
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- 0
- )
- );
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- // Verify request is cleared after successful reveal
- EntropyStructsV2.Request memory reqAfterReveal = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- assertEq(reqAfterReveal.sequenceNumber, 0);
- }
- function testRequestWithCallbackUsingTooMuchGas() public {
- uint32 defaultGasLimit = 100000;
- vm.prank(provider1);
- random.setDefaultGasLimit(defaultGasLimit);
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- EntropyConsumer consumer = new EntropyConsumer(address(random), false);
- // Consumer callback uses ~10% more gas than the provider's default
- consumer.setTargetGasUsage((defaultGasLimit * 110) / 100);
- vm.deal(user1, fee);
- vm.prank(user1);
- uint64 assignedSequenceNumber = consumer.requestEntropy{value: fee}(
- userRandomNumber
- );
- EntropyStructsV2.Request memory req = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- // Verify the gas limit was set correctly
- assertEq(req.gasLimit10k, 10);
- // The transaction reverts if the provider does not provide enough gas to forward
- // the gasLimit to the callback transaction.
- vm.expectRevert();
- random.revealWithCallback{gas: defaultGasLimit - 10000}(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- // If called with enough gas, the transaction should succeed, but the callback should fail because
- // it uses too much gas.
- vm.expectEmit(false, false, false, true, address(random));
- emit CallbackFailed(
- provider1,
- address(consumer),
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- 0
- ),
- // out-of-gas reverts have an empty bytes array as the return value.
- ""
- );
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- // Verify request is still active after failure
- EntropyStructsV2.Request memory reqAfterFailure = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- assertEq(reqAfterFailure.sequenceNumber, assignedSequenceNumber);
- assertEq(
- reqAfterFailure.callbackStatus,
- EntropyStatusConstants.CALLBACK_FAILED
- );
- // A subsequent attempt passing insufficient gas should also revert
- vm.expectRevert();
- random.revealWithCallback{gas: defaultGasLimit - 10000}(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- // Again, request stays active after failure
- reqAfterFailure = random.getRequest(provider1, assignedSequenceNumber);
- assertEq(reqAfterFailure.sequenceNumber, assignedSequenceNumber);
- assertEq(
- reqAfterFailure.callbackStatus,
- EntropyStatusConstants.CALLBACK_FAILED
- );
- // Calling without a gas limit should succeed
- vm.expectEmit(false, false, false, true, address(random));
- emit RevealedWithCallback(
- EntropyStructConverter.toV1Request(reqAfterFailure),
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber],
- 0
- )
- );
- random.revealWithCallback(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- // Verify request is cleared after successful reveal
- EntropyStructsV2.Request memory reqAfterReveal = random.getRequest(
- provider1,
- assignedSequenceNumber
- );
- assertEq(reqAfterReveal.sequenceNumber, 0);
- }
- // Test the corner case caused by the CALL opcode passing at most 63/64ths of the current gas
- // to the sub-call.
- function testRequestWithCallbackUsingTooMuchGas2() public {
- // With a 64M gas limit, we will pass ~63M gas to the callback (which is insufficient), but still
- // have ~1M gas to execute code within the revealWithCallback method, which should be enough to
- // run all of the logic subsequent to the excessivelySafeCall.
- uint32 defaultGasLimit = 64000000;
- vm.prank(provider1);
- random.setDefaultGasLimit(defaultGasLimit);
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- EntropyConsumer consumer = new EntropyConsumer(address(random), false);
- consumer.setTargetGasUsage(defaultGasLimit);
- vm.deal(user1, fee);
- vm.prank(user1);
- uint64 assignedSequenceNumber = consumer.requestEntropy{value: fee}(
- userRandomNumber
- );
- // The transaction reverts if the provider does not provide enough gas to forward
- // the gasLimit to the callback transaction.
- vm.expectRevert(EntropyErrors.InsufficientGas.selector);
- random.revealWithCallback{gas: defaultGasLimit - 10000}(
- provider1,
- assignedSequenceNumber,
- userRandomNumber,
- provider1Proofs[assignedSequenceNumber]
- );
- }
- function testLastRevealedTooOld() public {
- for (uint256 i = 0; i < provider1MaxNumHashes; i++) {
- request(user1, provider1, 42, false);
- }
- assertRequestReverts(
- random.getFee(provider1),
- provider1,
- 42,
- false,
- EntropyErrors.LastRevealedTooOld.selector
- );
- }
- function testAdvanceProviderCommitment(
- uint32 requestCount,
- uint32 updateSeqNumber
- ) public {
- vm.assume(requestCount < provider1MaxNumHashes);
- vm.assume(updateSeqNumber < requestCount);
- vm.assume(0 < updateSeqNumber);
- for (uint256 i = 0; i < requestCount; i++) {
- request(user1, provider1, 42, false);
- }
- assertInvariants();
- EntropyStructsV2.ProviderInfo memory info1 = random.getProviderInfo(
- provider1
- );
- assertEq(info1.currentCommitmentSequenceNumber, 0);
- assertEq(info1.sequenceNumber, requestCount + 1);
- random.advanceProviderCommitment(
- provider1,
- updateSeqNumber,
- provider1Proofs[updateSeqNumber]
- );
- info1 = random.getProviderInfo(provider1);
- assertEq(info1.currentCommitmentSequenceNumber, updateSeqNumber);
- assertEq(info1.currentCommitment, provider1Proofs[updateSeqNumber]);
- assertEq(info1.sequenceNumber, requestCount + 1);
- assertInvariants();
- }
- function testAdvanceProviderCommitmentTooOld(
- uint32 requestCount,
- uint32 updateSeqNumber
- ) public {
- vm.assume(requestCount < provider1MaxNumHashes);
- vm.assume(updateSeqNumber < requestCount);
- vm.assume(0 < updateSeqNumber);
- for (uint256 i = 0; i < requestCount; i++) {
- request(user1, provider1, 42, false);
- }
- assertRevealSucceeds(
- user1,
- provider1,
- requestCount,
- 42,
- provider1Proofs[requestCount],
- ALL_ZEROS
- );
- vm.expectRevert(EntropyErrors.UpdateTooOld.selector);
- random.advanceProviderCommitment(
- provider1,
- updateSeqNumber,
- provider1Proofs[updateSeqNumber]
- );
- }
- function testAdvanceProviderCommitmentIncorrectRevelation(
- uint32 seqNumber,
- uint32 mismatchedProofNumber
- ) public {
- vm.assume(seqNumber < provider1ChainLength);
- vm.assume(mismatchedProofNumber < provider1ChainLength);
- vm.assume(seqNumber != mismatchedProofNumber);
- vm.assume(seqNumber > 0);
- vm.expectRevert(EntropyErrors.IncorrectRevelation.selector);
- random.advanceProviderCommitment(
- provider1,
- seqNumber,
- provider1Proofs[mismatchedProofNumber]
- );
- }
- function testAdvanceProviderCommitmentUpdatesSequenceNumber(
- uint32 seqNumber
- ) public {
- vm.assume(seqNumber < provider1ChainLength);
- vm.assume(seqNumber > 0);
- random.advanceProviderCommitment(
- provider1,
- seqNumber,
- provider1Proofs[seqNumber]
- );
- EntropyStructsV2.ProviderInfo memory info1 = random.getProviderInfo(
- provider1
- );
- assertEq(info1.sequenceNumber, seqNumber + 1);
- }
- function testAdvanceProviderCommitmentHigherThanChainLength(
- uint32 seqNumber
- ) public {
- vm.assume(seqNumber >= provider1ChainLength);
- vm.expectRevert(EntropyErrors.AssertionFailure.selector);
- random.advanceProviderCommitment(
- provider1,
- seqNumber,
- provider1Proofs[0]
- );
- }
- function testSetMaxNumHashes(uint32 maxNumHashes) public {
- vm.prank(provider1);
- random.setMaxNumHashes(maxNumHashes);
- EntropyStructsV2.ProviderInfo memory info1 = random.getProviderInfo(
- provider1
- );
- assertEq(info1.maxNumHashes, maxNumHashes);
- }
- function testSetMaxNumHashesRevertIfNotFromProvider() public {
- vm.expectRevert(EntropyErrors.NoSuchProvider.selector);
- random.setMaxNumHashes(100);
- }
- function testZeroMaxNumHashesDisableChecks() public {
- for (uint256 i = 0; i < provider1MaxNumHashes; i++) {
- request(user1, provider1, 42, false);
- }
- assertRequestReverts(
- random.getFee(provider1),
- provider1,
- 42,
- false,
- EntropyErrors.LastRevealedTooOld.selector
- );
- vm.prank(provider1);
- random.setMaxNumHashes(0);
- request(user1, provider1, 42, false);
- }
- function testFeeManager() public {
- address manager = address(12);
- // Make sure there are some fees for provider1
- request(user1, provider1, 42, false);
- // Manager isn't authorized, so can't withdraw or set fee.
- vm.prank(manager);
- vm.expectRevert();
- random.withdrawAsFeeManager(provider1, provider1FeeInWei);
- vm.prank(manager);
- vm.expectRevert();
- random.setProviderFeeAsFeeManager(provider1, 1000);
- // You can't set a fee manager from an address that isn't a registered provider.
- vm.expectRevert();
- random.setFeeManager(address(manager));
- // Authorizing the fee manager as the provider enables withdrawing and setting fees.
- vm.prank(provider1);
- random.setFeeManager(address(manager));
- // Withdrawing decrements provider's accrued fees and sends balance to the fee manager.
- uint startingBalance = manager.balance;
- vm.prank(manager);
- random.withdrawAsFeeManager(provider1, provider1FeeInWei);
- assertEq(random.getProviderInfo(provider1).accruedFeesInWei, 0);
- assertEq(manager.balance, startingBalance + provider1FeeInWei);
- // Setting provider fee updates the fee in the ProviderInfo.
- vm.prank(manager);
- random.setProviderFeeAsFeeManager(provider1, 10101);
- assertEq(random.getProviderInfo(provider1).feeInWei, 10101);
- // Authorizing a different manager depermissions the previous one.
- address manager2 = address(13);
- vm.prank(provider1);
- random.setFeeManager(address(manager2));
- vm.prank(manager);
- vm.expectRevert();
- random.withdrawAsFeeManager(provider1, provider1FeeInWei);
- vm.prank(manager);
- vm.expectRevert();
- random.setProviderFeeAsFeeManager(provider1, 1000);
- }
- function testSetDefaultGasLimit() public {
- uint32 newGasLimit = 100000;
- vm.prank(provider1);
- vm.expectEmit(false, false, false, true, address(random));
- emit ProviderDefaultGasLimitUpdated(provider1, 0, newGasLimit);
- random.setDefaultGasLimit(newGasLimit);
- EntropyStructsV2.ProviderInfo memory info = random.getProviderInfo(
- provider1
- );
- assertEq(info.defaultGasLimit, newGasLimit);
- // Can reset back to 0.
- vm.prank(provider1);
- random.setDefaultGasLimit(0);
- info = random.getProviderInfo(provider1);
- assertEq(info.defaultGasLimit, 0);
- // Can set to maximum value.
- uint32 maxLimit = random.MAX_GAS_LIMIT();
- vm.prank(provider1);
- random.setDefaultGasLimit(maxLimit);
- info = random.getProviderInfo(provider1);
- assertEq(info.defaultGasLimit, random.MAX_GAS_LIMIT());
- // Reverts if max value is exceeded
- uint32 exceedsGasLimit = random.MAX_GAS_LIMIT() + 1;
- vm.prank(provider1);
- vm.expectRevert(EntropyErrors.MaxGasLimitExceeded.selector);
- random.setDefaultGasLimit(exceedsGasLimit);
- }
- function testSetDefaultGasLimitRevertIfNotFromProvider() public {
- vm.expectRevert(EntropyErrors.NoSuchProvider.selector);
- random.setDefaultGasLimit(100000);
- }
- function testRequestWithCallbackUsesDefaultGasLimit() public {
- uint32 defaultGasLimit = 100000;
- vm.prank(provider1);
- random.setDefaultGasLimit(defaultGasLimit);
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFee(provider1);
- vm.deal(user1, fee);
- vm.prank(user1);
- uint64 sequenceNumber = random.requestWithCallback{value: fee}(
- provider1,
- userRandomNumber
- );
- EntropyStructsV2.Request memory req = random.getRequest(
- provider1,
- sequenceNumber
- );
- assertEq(req.gasLimit10k, 10);
- }
- function testGasLimitsAndFeeRounding() public {
- vm.prank(provider1);
- random.setDefaultGasLimit(20000);
- vm.prank(provider1);
- random.setProviderFee(1);
- // Test exact multiples of 10,000
- assertGasLimitAndFee(0, 2, 1);
- assertGasLimitAndFee(10000, 2, 1);
- assertGasLimitAndFee(20000, 2, 1);
- assertGasLimitAndFee(100000, 10, 5);
- // Test values just below multiples of 10,000
- assertGasLimitAndFee(9999, 2, 1);
- assertGasLimitAndFee(19999, 2, 1);
- assertGasLimitAndFee(39999, 4, 2);
- assertGasLimitAndFee(99999, 10, 5);
- // Test values just above multiples of 10,000
- assertGasLimitAndFee(10001, 2, 1);
- assertGasLimitAndFee(20001, 3, 1);
- assertGasLimitAndFee(100001, 11, 5);
- assertGasLimitAndFee(110001, 12, 6);
- // Test middle values
- assertGasLimitAndFee(5000, 2, 1);
- assertGasLimitAndFee(15000, 2, 1);
- assertGasLimitAndFee(25000, 3, 1);
- // Test maximum value
- assertGasLimitAndFee(
- uint32(type(uint16).max) * 10000,
- type(uint16).max,
- uint128(type(uint16).max) / 2
- );
- // Test larger than max value reverts with expected error
- uint32 exceedsGasLimit = uint32(type(uint16).max) * 10000 + 1;
- vm.expectRevert(EntropyErrors.MaxGasLimitExceeded.selector);
- random.getFeeForGas(provider1, exceedsGasLimit);
- vm.expectRevert(EntropyErrors.MaxGasLimitExceeded.selector);
- random.requestWithCallbackAndGasLimit{value: 10000000000000}(
- provider1,
- bytes32(uint(42)),
- exceedsGasLimit
- );
- // A provider with a 0 gas limit is opted-out of the failure state flow, indicated by
- // a 0 gas limit on all requests.
- vm.prank(provider1);
- random.setDefaultGasLimit(0);
- assertGasLimitAndFee(0, 0, 1);
- assertGasLimitAndFee(10000, 0, 1);
- assertGasLimitAndFee(20000, 0, 1);
- assertGasLimitAndFee(100000, 0, 1);
- }
- // Helper method to create a request with a specific gas limit and check the gasLimit10k / provider fees
- function assertGasLimitAndFee(
- uint32 gasLimit,
- uint16 expectedGasLimit10k,
- uint128 expectedProviderFee
- ) internal {
- // Create a request with callback
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFeeForGas(provider1, gasLimit);
- assertEq(fee - random.getPythFee(), expectedProviderFee);
- // Passing 1 wei less than the expected fee causes a revert.
- vm.deal(user1, fee);
- vm.prank(user1);
- vm.expectRevert(EntropyErrors.InsufficientFee.selector);
- random.requestWithCallbackAndGasLimit{value: fee - 1}(
- provider1,
- userRandomNumber,
- gasLimit
- );
- uint128 startingAccruedProviderFee = random
- .getProviderInfo(provider1)
- .accruedFeesInWei;
- vm.prank(user1);
- uint64 sequenceNumber = random.requestWithCallbackAndGasLimit{
- value: fee
- }(provider1, userRandomNumber, gasLimit);
- assertEq(
- random.getProviderInfo(provider1).accruedFeesInWei -
- startingAccruedProviderFee,
- expectedProviderFee
- );
- // Check the gasLimit10k field in the request
- EntropyStructsV2.Request memory req = random.getRequest(
- provider1,
- sequenceNumber
- );
- assertEq(req.gasLimit10k, expectedGasLimit10k);
- }
- function testCallbackProvidedGas() public {
- vm.prank(provider1);
- random.setDefaultGasLimit(200000);
- assertCallbackResult(0, 190000, true);
- assertCallbackResult(0, 210000, false);
- assertCallbackResult(300000, 290000, true);
- assertCallbackResult(300000, 310000, false);
- // A provider that hasn't upgraded to the callback failure flow
- // can never cause a callback to fail because it runs out of gas.
- vm.prank(provider1);
- random.setDefaultGasLimit(0);
- assertCallbackResult(0, 190000, true);
- assertCallbackResult(0, 210000, true);
- assertCallbackResult(300000, 290000, true);
- assertCallbackResult(300000, 310000, true);
- }
- // Helper method to assert whether a request with a specific gas limit / a callback with a specific gas cost
- // should be successful or not.
- function assertCallbackResult(
- uint32 gasLimit,
- uint32 callbackGasUsage,
- bool expectSuccess
- ) internal {
- // Create a request with callback
- bytes32 userRandomNumber = bytes32(uint(42));
- uint fee = random.getFeeForGas(provider1, gasLimit);
- vm.deal(user1, fee);
- vm.prank(user1);
- EntropyConsumer consumer = new EntropyConsumer(address(random), false);
- uint64 sequenceNumber = consumer.requestEntropyWithGasLimit{value: fee}(
- userRandomNumber,
- gasLimit
- );
- consumer.setTargetGasUsage(callbackGasUsage);
- EntropyStructsV2.Request memory req = random.getRequest(
- provider1,
- sequenceNumber
- );
- if (!expectSuccess) {
- vm.expectEmit(false, false, false, true, address(random));
- emit CallbackFailed(
- provider1,
- address(consumer),
- sequenceNumber,
- userRandomNumber,
- provider1Proofs[sequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[sequenceNumber],
- 0
- ),
- // out-of-gas reverts have an empty bytes array as the return value.
- ""
- );
- random.revealWithCallback(
- provider1,
- sequenceNumber,
- userRandomNumber,
- provider1Proofs[sequenceNumber]
- );
- // Verify request is still active after failure
- EntropyStructsV2.Request memory reqAfterFailure = random.getRequest(
- provider1,
- sequenceNumber
- );
- assertEq(reqAfterFailure.sequenceNumber, sequenceNumber);
- assertEq(
- reqAfterFailure.callbackStatus,
- EntropyStatusConstants.CALLBACK_FAILED
- );
- } else {
- vm.expectEmit(false, false, false, true, address(random));
- emit RevealedWithCallback(
- EntropyStructConverter.toV1Request(req),
- userRandomNumber,
- provider1Proofs[sequenceNumber],
- random.combineRandomValues(
- userRandomNumber,
- provider1Proofs[sequenceNumber],
- 0
- )
- );
- random.revealWithCallback(
- provider1,
- sequenceNumber,
- userRandomNumber,
- provider1Proofs[sequenceNumber]
- );
- // Verify request is cleared after successful callback
- EntropyStructsV2.Request memory reqAfterSuccess = random.getRequest(
- provider1,
- sequenceNumber
- );
- assertEq(reqAfterSuccess.sequenceNumber, 0);
- }
- }
- }
- 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");
- }
- }
- }
|