Lesson 9: Staging test is getting timeout error (Chainlink issue).

[sanjayojha]

As per the issue reported here. I am also getting same error, even for 500 sec timing. Attaching all the information

Console error log

fulfillRandomWords
        works with live Chainlink Keepers and Chainlink VRF, we get a random winner:
    Error: Timeout of 500000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (D:\coding-learning\solidityjsbypatrick\hardhat-smartcontract-lottery\test\staging\Raffle.staging.test.ts)

---

helper-network file

const networkConfig: networkConfigInfo = {
    4: {
        name: "rinkeby",
        vrfCoordinatorV2: "0x6168499c0cffcacd319c818142124b7a15e857ab",
        raffleEntranceFee: "10000000000000000", // 0.01 ETH
        gasLane: "0xd89b2bf150e3b9e13446986e571fb9cab24b13cea0a43ea20a6049a85cc807cc", //30 gwei
        subscriptionId: 7783,
        callBackGasLimit: "500000", // 500,000 gas
        keepersUpdateInterval: "30", // in seconds
    },
    .........
    ......
}

---

chain link VRF screenshot

Chainlink keeper screenshot

---

Staging Test file (TypeScript)

import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
import { assert, expect } from "chai";
import { BigNumber } from "ethers";
import { ethers, network } from "hardhat";
import { developmentChains } from "../../helper-hardhat-config";
import { Raffle } from "../../typechain-types";

//run onlu on test/main net
developmentChains.includes(network.name)
    ? describe.skip
    : describe("Raffle Staging Test", function () {
          let player: SignerWithAddress;
          let deployer: SignerWithAddress;
          let raffle: Raffle;
          let raffleEntranceFee: BigNumber;
          beforeEach(async () => {
              const accounts = await ethers.getSigners();
              deployer = accounts[0];
              player = accounts[1];
              raffle = await ethers.getContract("Raffle", deployer); //connecting account[0]/deployer with contract. We can use player account to using .connect(player)
              raffleEntranceFee = await raffle.getEnteranceFee();
          });
          describe("fulfillRandomWords", function () {
              it("works with live Chainlink Keepers and Chainlink VRF, we get a random winner", async () => {
                  //enter the raffle
                  console.log("Setting up test...");
                  const startingTimeStamp = await raffle.getLastTimeStamp();

                  console.log("Setting up Listener...");
                  await new Promise<void>(async (resolve, reject) => {
                      // setup listener before we enter the raffle. Just in case the blockchain moves REALLY fast
                      raffle.once("WinnerPicked", async () => {
                          console.log("WinnerPicked event fired!");
                          try {
                              // get data after the winner is picked and event is fired.
                              const recentWinner = await raffle.getRecentWinner();
                              const raffleState = await raffle.getRaffleState();
                              const endingTimeStamp = await raffle.getLastTimeStamp();
                              const winnerFinalBalance = await deployer.getBalance(); //here account[0]/deployer is the only entrant also. So he is the winner.
                              //start assertation
                              assert.equal(raffleState, 0);
                              assert.equal(recentWinner.toString(), deployer.address);
                              assert(endingTimeStamp > startingTimeStamp);
                              await expect(raffle.getPlayer(0)).to.be.reverted;
                              assert.equal(
                                  winnerFinalBalance.toString(),
                                  winnerStartingBalance.add(raffleEntranceFee).toString()
                              );
                              resolve();
                          } catch (e) {
                              console.log(e);
                              reject(e);
                          }
                      });

                      //Entering the raffle
                      console.log("Entering Raffle...");
                      const tx = await raffle.enterRaffle({ value: raffleEntranceFee });
                      await tx.wait(1);
                      const winnerStartingBalance = await deployer.getBalance(); //here account[0]/deployer is the only entrant also. So he is the winner.
                      // And this code Wont compelte untill our listener (above) has finished listening.
                      console.log("Ok, time to wait...");
                  });
              });
          });
      });

---

Raffle.sol file

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;

import "@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol";
import "@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol";
import "@chainlink/contracts/src/v0.8/KeeperCompatible.sol";

error Raffle__SendMoreToEnterRaffle();
error Raffle__RaffleIsNotOpen();
error Raffle__TransferFailed();
error Raffle__UpkeepNotNeeded(uint256 currentBalance, uint256 numPlayers, uint256 raffleState);

contract Raffle is VRFConsumerBaseV2, KeeperCompatibleInterface {
   
    enum RaffleState {
        Open,
        Calculating
    }
    
    uint256 private immutable i_enteranceFee;
    address payable[] private s_players;
    address private s_recentWinner;
    uint256 private s_lastTimeStamp;
    uint256 private immutable i_interval;
    RaffleState private s_raffleState;

    
    VRFCoordinatorV2Interface private immutable i_vrfCoordinator;
    bytes32 private immutable i_gasLane;
    uint64 private immutable i_subscriptionId;
    uint16 private constant REQUEST_CONFIRMATION = 3;
    uint32 private immutable i_callbackGasLimit;
    uint32 private constant NUM_WORDS = 1;

  
    event RaffleEnter(address indexed player);
    event RequestRafflewinner(uint256 indexed requestId);
    event WinnerPicked(address indexed winner);

    constructor(
        address vrfCoordinatorV2,
        uint64 subscriptionId,
        uint256 enteranceFee,
        bytes32 gasLane,
        uint32 callbackGasLimit,
        uint256 interval
    ) VRFConsumerBaseV2(vrfCoordinatorV2) {
        i_vrfCoordinator = VRFCoordinatorV2Interface(vrfCoordinatorV2);
        i_subscriptionId = subscriptionId;
        i_enteranceFee = enteranceFee;
        i_gasLane = gasLane;
        i_callbackGasLimit = callbackGasLimit;
        i_interval = interval;
        s_raffleState = RaffleState.Open;
        s_lastTimeStamp = block.timestamp;
    }

    // To enter into lottery
    function enterRaffle() public payable {
        if (msg.value < i_enteranceFee) {
            revert Raffle__SendMoreToEnterRaffle();
        }
        
        if (s_raffleState != RaffleState.Open) {
            revert Raffle__RaffleIsNotOpen();
        }
        s_players.push(payable(msg.sender));

       
        emit RaffleEnter(msg.sender);
    }

    
    function checkUpkeep(
        bytes memory /* checkData */
    )
        public
        view
        override
        returns (
            bool upkeepNeeded,
            bytes memory /* performData */
        )
    {
        bool isOpen = (RaffleState.Open == s_raffleState);
        bool timePassed = ((block.timestamp - s_lastTimeStamp) > i_interval);
        bool hasPlayers = (s_players.length > 0);
        bool hasBalance = (address(this).balance > 0);
        upkeepNeeded = (isOpen && timePassed && hasPlayers && hasBalance);
        return (upkeepNeeded, "");
    }

    
    function performUpkeep(
        bytes calldata /* performData */
    ) external override {
        (bool upkeepNeeded, ) = checkUpkeep("");

        if (!upkeepNeeded) {
            revert Raffle__UpkeepNotNeeded(
                address(this).balance,
                s_players.length,
                uint256(s_raffleState)
            );
        }
        s_raffleState = RaffleState.Calculating;
        uint256 requestId = i_vrfCoordinator.requestRandomWords(
            i_gasLane,
            i_subscriptionId,
            REQUEST_CONFIRMATION,
            i_callbackGasLimit,
            NUM_WORDS
        );
        emit RequestRafflewinner(requestId);
    }

    function fulfillRandomWords(
        uint256, /*requestId*/
        uint256[] memory randomWords
    ) internal override {
        
        uint256 indexOfWinner = randomWords[0] % s_players.length;
        address payable recentWinner = s_players[indexOfWinner];
        s_recentWinner = recentWinner;
        s_players = new address payable[](0);
        s_raffleState = RaffleState.Open;
        s_lastTimeStamp = block.timestamp;
       
        (bool success, ) = recentWinner.call{value: address(this).balance}("");
        if (!success) {
            revert Raffle__TransferFailed();
        }
        emit WinnerPicked(recentWinner);
    }

    //Rest of the getter function..
}

---

Contract address on rinkeby
0xdc6a50411fb987123bE0D048Cde60c66135e2FDe

[Vibesx]

Hy. Had the same issue and I solved it by setting my mocha.timeout to 300000 (300 seconds), in hardhat.config.js. You can even try with 200000 and try increasing it until you stop getting timed out.

[sanjayojha]

@Vibesx
I have already set it to 500000 (500 seconds).

[sanjayojha]

@PatrickAlphaC
I have debugged the code and it look like checkUpkeep is returning false.

 function checkUpkeep(bytes memory /* checkData */ )  public view override returns ( bool upkeepNeeded, bytes memory /* performData */ ) {
        bool isOpen = (RaffleState.Open == s_raffleState);
        bool timePassed = ((block.timestamp - s_lastTimeStamp) > i_interval); //this is returning false on staging test
        bool hasPlayers = (s_players.length > 0);
        bool hasBalance = (address(this).balance > 0);
        upkeepNeeded = (isOpen && timePassed && hasPlayers && hasBalance);
        return (upkeepNeeded, "");
 }

This line is returning false

bool timePassed = ((block.timestamp - s_lastTimeStamp) > i_interval); 

How we can further check or fix it? Do we need to do add interval manually in our staging code? as we did in unit test?

[PatrickAlphaC]

What happens when you deploy the contract with a shorter i_interval? Like 1 second? @sanjayojha

[sanjayojha]

Update:
Look like I was finally able to run the test. I guess we have to add await raffle.performUpkeep("0x"); in our promise method after entering the raffle.

console.log("Entering Raffle...");
const tx = await raffle.enterRaffle({ value: raffleEntranceFee });
await tx.wait(1);
winnerStartingBalance = await deployer.getBalance(); 
await raffle.performUpkeep("0x"); // add this line in your staging test

The reason for this could be the way we are defining the type of keeper Trigger. As suggested in another discussion, I used custom type

The await raffle.performUpkeep("0x"); line is missing from patrick's gitrepo Raffle.staging.test.ts .
May be he is using Time Interval based keeper in the tutorial?

[PatrickAlphaC]

You shouldn't need to call the performUpkeep yourself... So keepers haven't kicked off hm....

[sanjayojha]

Look like I am wrong in my above comment. We don't need await raffle.performUpkeep("0x"); in our staging test file. Since its keeper work to invoke it.

To me the error seems to be happening in performUpkeep method.

 function performUpkeep(
        bytes calldata /* performData */
    ) external override {
        (bool upkeepNeeded, ) = checkUpkeep(""); //This line is returning false.

        if (!upkeepNeeded) {
            revert Raffle__UpkeepNotNeeded(
                address(this).balance,
                s_players.length,
                uint256(s_raffleState)
            );
        }
        s_raffleState = RaffleState.Calculating;
        uint256 requestId = i_vrfCoordinator.requestRandomWords(
            i_gasLane,
            i_subscriptionId,
            REQUEST_CONFIRMATION,
            i_callbackGasLimit,
            NUM_WORDS
        );
        emit RequestRafflewinner(requestId);
    }

(bool upkeepNeeded, ) = checkUpkeep(""); is the main reason of failing. Its because when we call it from perfromUpkeep, it return false.

My possible explanation

Not sure but I think since chainlink call the checkUpkeep by default and then performUpkeep is called, but then performUpkeep call the checkUpkeep again and this result in false return. Which in turn throw error due to line revert Raffle__UpkeepNotNeeded( address(this).balance, s_players.length, uint256(s_raffleState) );

I just commented/removed the below part from the performUpkeep method and my staging test start working.

(bool upkeepNeeded, ) = checkUpkeep(""); 
        if (!upkeepNeeded) {
            revert Raffle__UpkeepNotNeeded(
                address(this).balance,
                s_players.length,
                uint256(s_raffleState)
            );
        }

[PatrickAlphaC]

So your upkeepNeeded is returning false...

        bool isOpen = (RaffleState.Open == s_raffleState);
        bool timePassed = ((block.timestamp - s_lastTimeStamp) > i_interval);
        bool hasPlayers = (s_players.length > 0);
        bool hasBalance = (address(this).balance > 0);
        upkeepNeeded = (isOpen && timePassed && hasPlayers && hasBalance);

That means one of these is false. You could use the hardhat console to find out which?

https://hardhat.org/guides/hardhat-console

[sanjayojha]

Yes, its returning false. And I think its bool timePassed = ((block.timestamp - s_lastTimeStamp) > i_interval);
But I will check with hardhat-console as you recommended, need to learn about it first.

[Aesthetyx]

Hi,

I was facing this issue yesterday so I took a look through all my code today, checked the following files against those on the github repo and did not notice any differences. Without making any changes to my code, I ran the staging test again and it worked. Perhaps you can try running the staging test again to see if it works.

Files that I checked against github repo:

1. helper-hardhat-config.js
2. hardhat.config.js
3. .env
4. Raffle.sol
5. 01-deploy-raffle.js
6. Raffle.staging.test.js

Not experienced with typescript but I took a look through your code and did not notice any significant differences between your code and mine. Only differences I observed was that your subscriptionId is not wrapped in " " and your filepath in the import statement for KeeperCompatible.sol in Raffle.sol is different from mine. Might be worth a check but I am not certain if these are causing the issue you are facing.

[sanjayojha]

@Aesthetyx
Thank you to help and put your thought. For me It didn't worked until i removed the calling of checkUpkeep() from the perfromUpkeep method.
For some reason, the checkUpkeep when called from performUpkeep is returning false.

Can you share your Raffle.sol source code?

[Aesthetyx]

Please find my Raffle.sol source code below. You can ignore the last getter function, I added it in to try to build on the unit tests but its still a work in progress

// SPDX-License-Identifier: MIT

pragma solidity ^0.8.7;

import "@chainlink/contracts/src/v0.8/VRFConsumerBaseV2.sol";
import "@chainlink/contracts/src/v0.8/interfaces/VRFCoordinatorV2Interface.sol";
import "@chainlink/contracts/src/v0.8/interfaces/KeeperCompatibleInterface.sol";

error Raffle__NotEnoughETHEntered();
error Raffle__TransferFailed();
error Raffle__NotOpen();
error Raffle__UpkeepNotNeeded(uint256 currentBalance, uint256 numPlayers, uint256 raffleState);

/** @title A sample Raffle Contract
 *  @author Aesthetyx
 *  @notice This contract is for creating an untamperable decentralised smart contract lottery
 *  @dev This implements Chainlink VRF v2 and Chainlink Keepers

 */
contract Raffle is VRFConsumerBaseV2, KeeperCompatibleInterface {
    /* Type declarations */
    enum RaffleState {
        OPEN,
        CALCULATING
    }

    /* State variables */
    address payable[] private s_players;
    uint256 private immutable i_entranceFee;
    VRFCoordinatorV2Interface private immutable i_vrfCoordinator;
    bytes32 private immutable i_gasLane;
    uint64 private immutable i_subscriptionId;
    uint16 private constant REQUEST_CONFIRMATIONS = 3;
    uint32 private immutable i_callbackGasLimit;
    uint32 private constant NUM_WORDS = 1;

    /* Lottery Variables */
    address private s_recentWinner;
    RaffleState private s_raffleState;
    uint256 private s_lastTimeStamp;
    uint256 private immutable i_interval;

    /* Events */
    event RaffleEnter(address indexed player);
    event RequestedRaffleWinner(uint256 indexed requestId);
    event WinnerPicked(address indexed winner);

    /* Functions */
    constructor(
        address vrfCoordinatorV2, // contract
        uint256 entranceFee,
        bytes32 gasLane,
        uint64 subscriptionId,
        uint32 callbackGasLimit,
        uint256 interval
    ) VRFConsumerBaseV2(vrfCoordinatorV2) {
        i_entranceFee = entranceFee;
        i_vrfCoordinator = VRFCoordinatorV2Interface(vrfCoordinatorV2);
        i_gasLane = gasLane;
        i_subscriptionId = subscriptionId;
        i_callbackGasLimit = callbackGasLimit;
        s_raffleState = RaffleState.OPEN;
        s_lastTimeStamp = block.timestamp;
        i_interval = interval;
    }

    function enterRaffle() public payable {
        if (msg.value < i_entranceFee) {
            revert Raffle__NotEnoughETHEntered();
        }
        if (s_raffleState != RaffleState.OPEN) {
            revert Raffle__NotOpen();
        }
        s_players.push(payable(msg.sender));
        emit RaffleEnter(msg.sender);
    }

    function performUpkeep(
        bytes calldata /*performData */
    ) external override {
        (bool upkeepNeeded, ) = checkUpkeep("");
        if (!upkeepNeeded) {
            revert Raffle__UpkeepNotNeeded(
                address(this).balance,
                s_players.length,
                uint256(s_raffleState)
            );
        }
        s_raffleState = RaffleState.CALCULATING;
        uint256 requestId = i_vrfCoordinator.requestRandomWords(
            i_gasLane,
            i_subscriptionId,
            REQUEST_CONFIRMATIONS,
            i_callbackGasLimit,
            NUM_WORDS
        );
        // the following statement is actually redundant since the requestRandomWords function in the VRFCoordinatorV2Mock actually already emits an event which contains the requestId as one of its paramters
        emit RequestedRaffleWinner(requestId);
    }

    /**
     * @dev This is the function that the Chainlink Keeper nodes call
     * they look for the `upkeepNeeded` to return true
     * the following should be true in order to return true:
     * 1. Our time interval should have passed
     * 2. The lottery should have at least 1 player, and have some ETH
     * 3. Our subscription is funded with LINK
     * 4. The lottery should be in an "open" state
     */
    function checkUpkeep(
        bytes memory /* checkData */
    )
        public
        override
        returns (
            bool upkeepNeeded,
            bytes memory /* performData */
        )
    {
        bool isOpen = (s_raffleState == RaffleState.OPEN);
        bool timePassed = ((block.timestamp - s_lastTimeStamp) > i_interval);
        bool hasPlayers = (s_players.length > 0);
        bool hasBalance = (address(this).balance > 0);
        upkeepNeeded = (isOpen && timePassed && hasPlayers && hasBalance);
    }

    function fulfillRandomWords(
        uint256, /* requestId */
        uint256[] memory randomWords
    ) internal override {
        uint256 indexOfRandomWinner = randomWords[0] % s_players.length;
        address payable recentWinner = s_players[indexOfRandomWinner];
        s_recentWinner = recentWinner;
        s_raffleState = RaffleState.OPEN;
        s_lastTimeStamp = block.timestamp;
        s_players = new address payable[](0);
        (bool success, ) = recentWinner.call{value: address(this).balance}("");
        if (!success) {
            revert Raffle__TransferFailed();
        }
        emit WinnerPicked(recentWinner);
    }

    /* View / Pure functions */
    function getEntranceFee() public view returns (uint256) {
        return i_entranceFee;
    }

    function getPlayer(uint256 _index) public view returns (address) {
        return s_players[_index];
    }

    function getRecentWinner() public view returns (address) {
        return s_recentWinner;
    }

    function getRaffleState() public view returns (RaffleState) {
        return s_raffleState;
    }

    function getNumWords() public pure returns (uint256) {
        return NUM_WORDS;
    }

    function getNumberOfPlayers() public view returns (uint256) {
        return s_players.length;
    }

    function getLatestTimeStamp() public view returns (uint256) {
        return s_lastTimeStamp;
    }

    function getRequestConfirmations() public pure returns (uint256) {
        return REQUEST_CONFIRMATIONS;
    }

    function getInterval() public view returns (uint256) {
        return i_interval;
    }

    function getVRFCoordinator() public view returns (VRFCoordinatorV2Interface) {
        return i_vrfCoordinator;
    }
}

[sanjayojha]

Thank you again. The only difference I can see that may be affecting our stage test is the missing return statement in your checkUpkeep method. Since your performUpkeep method is calling checkUpkeep but its not getting any return value therefore it may be passing.
Though I am not sure about it.

[Aesthetyx]

To my knowledge, since upkeepNeeded is specified in the returns portion of the checkUpkeep block, we do not need to include a return statement for the checkUpkeep function to return upkeepNeeded and an empty performData. You can check out Patrick's video at around time stamp 14:46:45 where he explains this bit.

In any case, I have included the return statement (shown below) into my checkUpkeep block and the staging test still works fine although it took a very long time to complete the try block in the raffle staging test.

    function checkUpkeep(
        bytes memory /* checkData */
    )
        public
        override
        returns (
            bool upkeepNeeded,
            bytes memory /* performData */
        )
    {
        bool isOpen = (s_raffleState == RaffleState.OPEN);
        bool timePassed = ((block.timestamp - s_lastTimeStamp) > i_interval);
        bool hasPlayers = (s_players.length > 0);
        bool hasBalance = (address(this).balance > 0);
        upkeepNeeded = (isOpen && timePassed && hasPlayers && hasBalance);
        return (upkeepNeeded, "0x");

Are the texts in your console.log statements in the raffle staging test showing in terminal or does it timeout without showing them? Because when I run the staging test, it shows all the texts (e.g., setting up test..., setting up listener...) and takes a really long time to complete after displaying WinnerPicked event fired! in terminal. If the statements are not appearing in terminal, there might be something else that is affecting your raffle staging test. Below is the text that is displayed in terminal after I ran the raffle staging test again with the updated checkUpkeep function.

  Raffle Staging Tests
    fulfillRandomWords
Setting up test...
Setting up listener...
Entering Raffle...
Ok, time to wait...
WinnerPicked event fired!
      ✓ works with live Chainlink Keepers and Chainlink VRF, we get a random winner (92288479 gas)

  1 passing (16m)

[sanjayojha]

  Raffle Staging Tests
    fulfillRandomWords
Setting up test...
Setting up listener...
Entering Raffle...
Ok, time to wait...
(here timeout error, because the WinnerPicked event don't fire)

^This is where my test stop and get timeout error.
When I remove following code from performUpkeep method it passes. This is clearly because upkeepNeeded returning false.

(bool upkeepNeeded, ) = checkUpkeep("");
      if (!upkeepNeeded) {
          revert Raffle__UpkeepNotNeeded(
              address(this).balance,
              s_players.length,
              uint256(s_raffleState)
          );
      }

[Avelous]

@sanjayojha what was your final solution? I'm having the same error

[sanjayojha]

I removed the following code from raffle.sol

(bool upkeepNeeded, ) = checkUpkeep("");
      if (!upkeepNeeded) {
          revert Raffle__UpkeepNotNeeded(
              address(this).balance,
              s_players.length,
              uint256(s_raffleState)
          );
      }

[chopperttt]

but how come this works in unit test?

[chopperttt]

I did this and it worked but i dont get why

[DorianDaSilva]

Having the same issue: #967

It seems it is not resolving the promise. I also tried to chain the promise with .catch(resolve, reject) but still no success.

vrf consumer shows up in etherscan with a bunch of transactions but keepers is not kicking in for some reason.

[alymurtazamemon]

@sanjayojha Hello, Can you show me the terminal where you run the command?

[sanjayojha]

I have moved to chapter 14 now. Error is timeout error as mentioned in my first post. For me the above mentioned solution works, so I am moving forward with the course.

[alymurtazamemon]

@sanjayojha Ok so mark that answer so others can see.

[Abhishek-465]

@alymurtazamemon @sanjayojha @PatrickAlphaC I have deleted the portion of the code as specified above still i am having timeout error. Can somebody please help me out.
Error: Timeout of 500000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves. (C:\Users\abhis\OneDrive\Documents\hardhat-smartcontract-lottery-fcc\test\staging\Raffle.staging.test.js)