Listening for Future Events

[hyndsite]

The closed issue here talks about how to obtain future events as @mrwillis previous example of getting only future events, does produce events from the past as well.

//provides events at least as far back as current block (which is not future)
const filter = contract.filters.MyEmittedEvent(arg1, arg2);
contract.on(filter, callback);

@ricmoo has pointed out a poll approach using queryFilter, but if we want to subscribe to events, and only get for future events, I don't see there is way to do that with contract.on() - is that correct? queryFilter is only going to allow for a polling approach as opposed to being notified on an emitted Solidity event.

The only way I have found for this to work, is to get the current block number getBlockNumber and check on every fired event that I am subscribed to contract.on(filter, callback)) and react to only block number above the current block number.

[zemse]

previous example of getting only future events does produce events from the past as well.

Do you mean the past events from the current block (the last mined block)?

The pooling mechanism in ethers.js considers block numbers up to currentBlockNumber - 1 as past (code reference), and hence when you create a listener using contract.on, you even get the events emitted in the current block.

This is generally not a problem when you have a chain continuously mining blocks in a short interval. But if you have a chain with a large block time or an environment like ganache, which mines a block only when a tx is received. To handle these situations, the logic you described is fine.

const startBlockNumber = await provider.getBlockNumber();

contract.on(filter, (...args) => {
  const event = args[args.length - 1];
  if(event.blockNumber <= startBlockNumber) return; // do not react to this event
  
  // further logic
})

[navneetgulati]

So shouldn't it consider currentBlockNumber as the past block too since if eventListener is attached on it, it is obvious that the eventListener will be looking for events in the next block? Or we should provide some string like "latest"(as is the case with Web3js) where it only listens to Future Events?

[zemse]

Actually "latest" means last block mined as in eth wiki ref.

Though I understand what you mean. But I think it depends on what you consider a confirmed block. All the blocks behind your confirmation block are in the past, while anything next to it is in the future. If you don't consider any confirmations, then it can be valid to consider the current block as past (in the case of PoA chains, or Ganache). In ethereum mainnet, most of the forked blocks have a depth of 1. So you can fairly say the block behind the current block is in the past but the current block is not necessarily past yet.

[ricmoo]

Yes, ethers considers the current block as part of "from now on". Often you want your process that is mining information to start with events from the current block. There are many use cases for the event emitter, and if the event listener is registered outside the context of a transaction, there is no distinction between starting at the current block or next block. And if you submit a transactions, that certainly won't be part of the current block, so in those cases it is handled implicitly.

You can either add a guard in your event handler (like your above example), or something like this might work for your purposes too:

provider.once("block", () => {
    provider.on(filter, (...args) => { ... });
});

Does that make sense?

[agrohs]

Does this work??

[zemse]

Did you try this and face any issues?

[ricmoo]

(moving to discussions)

[knivets]

I still have this issue. I'm running ethers.js 5.6.8 with HardHat environment. I'm building a basic ERC721 contract. When I register a listener, I receive all events that have been emitted from the contract from its creation. If I add this.provider.once('block', fn) then it won't fire with all events immediately, but it will after I send a transaction.

{blockNumber: 24, blockHash: '0x7c0565eadab74d898a33841aa4760ccb9edb68b7ddbe062916e17606d9308b4d', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 25, blockHash: '0x72ed1bef52f6b61b225a14681f5f98e528c25cdb7507e19c2af3f8da3baecac8', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 26, blockHash: '0xfc17e1098e475681a18d97e0efbee3730f92c5ba6a5a84afb5f64c3f87725aec', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 27, blockHash: '0x162b074ed932fdcb934cce2bf1b703f09d0d21248524515921ffb0d7d572b2ed', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 28, blockHash: '0xd915dc9925652ae717ec8760e4e58a378ee4902e90cb2d0e7eaf6356ce3f1e2a', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 29, blockHash: '0x2829269b1ab938e2c3bd0473cc52e978bf3d26a46d4d771e6a59daad0937d371', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 30, blockHash: '0x30a6ba0943dcaea69d7929c1cea7198332871de20e07a57a3310edd653f640f1', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 31, blockHash: '0xc87eab3ec3c3bc7c7d70dc494ce1e0c0e864fdff04da479bdb86cd85fbc15034', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 32, blockHash: '0x27820f4f96f49d24366291e87d6d0ca6a6c42a930efb82dcf0127bdc9d29c61d', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63 {blockNumber: 33, blockHash: '0xe0cc4906fc1b11b6cad87c255c7a59a94aa89b748bca26ffe38a20da94495523', transactionIndex: 0, removed: false, address: '0x0B306BF915C4d645ff596e518fAf3F9669b97016', …}
App.js:63

Here's the event code:

this.provider.once('block', (e) => {
      this.contract.on('Transfer', (from, to, val, event) => {
        console.log(event);
      }); 
    });

The event handler is registered once, so this is not the issue.

[knivets]

Basically there's no way to tell contract.on to only emit events that happened on the next block. What I'm experiencing is that ethers.js will just emit all past events for that contract once the contract.on('event', cb) is executed. Is this the expected behavior? @ricmoo

[lucianHymer]

Basically there's no way to tell contract.on to only emit events that happened on the next block. What I'm experiencing is that ethers.js will just emit all past events for that contract once the contract.on('event', cb) is executed. Is this the expected behavior? @ricmoo

I'm experiencing the same. contract.once is returning an old event as well

[knivets]

@lucianHymer I pushed a PR that fixes this issue #3094