Event filtering in Blockchain / Solidity

Introduction

Event filtering helps you listen only to the important messages from the blockchain. It saves time and resources by ignoring unrelated events.

You want to track when a specific user receives tokens.

You need to monitor only failed transactions in a smart contract.

You want to update your app only when a certain item is sold.

You want to watch for events from a specific contract address.

You want to filter events by a date or block number range.

Syntax

Blockchain / Solidity

contractInstance.events.EventName({ filter: { key: value }, fromBlock: startBlock, toBlock: endBlock }, callback);

Use filter to specify which event data you want to listen to.

Use fromBlock and toBlock to limit the range of blocks checked.

Examples

This listens only to Transfer events where the sender is '0x123...'.

Blockchain / Solidity

contractInstance.events.Transfer({ filter: { from: '0x123...' } }, (error, event) => { console.log(event); });

This listens to Approval events from block 100 to the latest block.

Blockchain / Solidity

contractInstance.events.Approval({ fromBlock: 100, toBlock: 'latest' }, (error, event) => { console.log(event); });

This listens only to MyEvent events where the status is 'success'.

Blockchain / Solidity

contractInstance.events.MyEvent({ filter: { status: 'success' } }, (error, event) => { console.log(event); });

Sample Program

This program connects to the Ethereum mainnet and listens for Transfer events from a specific address only. It prints the event details when such an event happens.

Blockchain / Solidity

const Web3 = require('web3');
const web3 = new Web3('https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID');

const abi = [
  {
    "anonymous": false,
    "inputs": [
      {"indexed": true, "name": "from", "type": "address"},
      {"indexed": true, "name": "to", "type": "address"},
      {"indexed": false, "name": "value", "type": "uint256"}
    ],
    "name": "Transfer",
    "type": "event"
  }
];

const contractAddress = '0xYourTokenContractAddress';
const contractInstance = new web3.eth.Contract(abi, contractAddress);

// Listen only to Transfer events where 'from' is a specific address
contractInstance.events.Transfer({ filter: { from: '0x1234567890abcdef1234567890abcdef12345678' }, fromBlock: 'latest' })
.on('data', event => {
  console.log('Filtered Transfer event:', event.returnValues);
})
.on('error', console.error);

Important Notes

Event filtering reduces the amount of data your app processes, making it faster and cheaper.

Filters only work on indexed event parameters.

Always specify fromBlock to avoid missing events or scanning too many blocks.

Summary

Event filtering lets you listen only to events you care about.

Use filters on event parameters and block ranges to narrow down events.

This helps your app stay efficient and responsive.

Practice

1.

What is the main purpose of event filtering in blockchain applications?

easy

A. To encrypt blockchain data

B. To create new blockchain events

C. To mine new blocks faster

D. To listen only to specific events that match certain criteria

Solution

1. Step 1: Understand event filtering concept

   Event filtering allows you to listen only to events that match specific parameters or conditions.

2. Step 2: Identify the main purpose

   This helps reduce unnecessary data processing and improves app performance by focusing on relevant events.

3. Final Answer:

   To listen only to specific events that match certain criteria -> Option D

4. Quick Check:

   Event filtering = selective listening [OK]

Hint: Event filtering means listening only to events you want [OK]

Common Mistakes:

• Confusing event filtering with event creation
• Thinking event filtering speeds up mining
• Believing event filtering encrypts data

2.

Which of the following is the correct syntax to filter events by a parameter named user in a blockchain event listener?

contract.events.Transfer({ filter: { ??? } })

easy

A. { user: '0x123...' }

B. { 'user' }

C. [ user ]

D. user = '0x123...'

Solution

1. Step 1: Understand filter syntax

   Filters use an object with key-value pairs where keys are parameter names and values are filter values.

2. Step 2: Match correct syntax

   The correct syntax is an object with the parameter name as key and the desired value, like { user: '0x123...' }.

3. Final Answer:

   { user: '0x123...' } -> Option A

4. Quick Check:

   Filter = object with key-value pairs [OK]

Hint: Filters use {paramName: value} object syntax [OK]

Common Mistakes:

• Using array or string instead of object for filters
• Writing filter as assignment instead of object
• Omitting quotes around string values

3.

Given the following code snippet, what events will be received?

contract.events.Transfer({ filter: { from: '0xabc...' }, fromBlock: 100, toBlock: 200 })

Assuming events with from address '0xabc...' occurred at blocks 90, 150, and 210.

medium

A. Only event at block 150

B. Events at blocks 90, 150, and 210

C. Events at blocks 90 and 150

D. No events

Solution

1. Step 1: Analyze filter parameters

   The filter listens for events where 'from' equals '0xabc...'. The block range is from 100 to 200.

2. Step 2: Check event blocks against filter

   Events at blocks 90 and 210 are outside the block range, so only the event at block 150 matches both filter and block range.

3. Final Answer:

   Only event at block 150 -> Option A

4. Quick Check:

   Filter + block range = event at block 150 only [OK]

Hint: Events must match filter and block range [OK]

Common Mistakes:

• Ignoring block range and including all matching events
• Including events outside the block range
• Confusing filter parameter with block number

4.

Identify the error in this event filter code snippet:

contract.events.Approval({ filter: { owner: 0xabc123 }, fromBlock: 'latest' })

medium

A. Filter object should be an array

B. The filter value 0xabc123 should be a string

C. fromBlock cannot be 'latest'

D. The event name 'Approval' is incorrect

Solution

1. Step 1: Check filter parameter types

   Filter values must be strings for addresses, but 0xabc123 is missing quotes, so it's treated as a variable or number.

2. Step 2: Validate other parts

   The event name and fromBlock usage are valid; fromBlock can be 'latest'. Filter should be an object, not an array.

3. Final Answer:

   The filter value 0xabc123 should be a string -> Option B

4. Quick Check:

   Address filter values must be strings [OK]

Hint: Address filters need quotes around them [OK]

Common Mistakes:

• Omitting quotes around address strings
• Thinking fromBlock 'latest' is invalid
• Using array instead of object for filter

5.

You want to listen to Transfer events where the value is greater than 1000 tokens. Which approach correctly filters these events?

// Assume event signature: Transfer(address from, address to, uint256 value)

hard

A. Use filter: { value: '>1000' }

B. Use filter: { value: val => val > 1000 }

C. Filter events after receiving all by checking value > 1000 in code

D. Set fromBlock and toBlock to limit event range

Solution

1. Step 1: Understand filter limitations

   Event filters only support exact matches or arrays of values, not comparison operators like greater than.

2. Step 2: Choose correct approach

   To filter by value > 1000, you must receive events first and then check the value in your code logic.

3. Final Answer:

   Filter events after receiving all by checking value > 1000 in code -> Option C

4. Quick Check:

   Filters do exact matches; use code for range checks [OK]

Hint: Filters match exact values; use code for greater than checks [OK]

Common Mistakes:

• Trying to use comparison operators in filter
• Assuming string '>1000' works as filter
• Confusing block range with value filtering