Package Logo
ethereum_common
ethereum-common@v0.3.0
Total Downloads
1944
Published
5 months ago
Publisher
User Avatar streamingfast

Readme

common Ethereum substreams modules to extract events, calls, transactions with indexing

Use one of those optimized modules with a query string as a parameter:

  • filtered_events
  • filtered_calls
  • filtered_transactions
  • filtered_events_and_calls

The query string will be used for the blockfilter as well as the actual filtering of the events/calls/transactions

Documentation

Modules

Maps icon
Maps

map
all_events

963652a247fd23d0823dde62d21ae54c783b6073
map all_events (
blocksf.ethereum.type.v2.Block
)  -> sf.substreams.ethereum.v1.Events

all_events gives you all the events in a block (from successful transactions), with basic block hash/number/timestamp and transaction hash

substreams gui ethereum-common@v0.3.0 all_events

map
all_calls

ba4f8e82a1fdc3ffbf060bed89482619bdc2a771

all_calls gives you all the calls in a block (including internal calls), with basic block hash/number/timestamp and transaction hash

substreams gui ethereum-common@v0.3.0 all_calls

map
filtered_events

8fea38111c0a0111c18aa8a573a9d9a2369aa2f1
Default param : evt_sig:0x17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31

filtered_events reads from all_events and applies a filter on the event addresses and signatures. Supported operators are: logical or ||, logical and && and parenthesis: () Addresses to match must be written as 0x-prefixed hexadecimal, lowercase, prefixed by evt_addr: and signatures by evt_sig:. Example: (evt_addr:0x1234... || evt_addr:0x5678...) && evt_sig:0xdeadbeef...

substreams gui ethereum-common@v0.3.0 filtered_events

map
filtered_calls

d655efe9beb681bed30a0e9183823dcb98344762
Default param : call_method:0xa9059cbb && call_to:0xdac17f958d2ee523a2206206994597c13d831ec7

filtered_calls reads from all_calls and applies a filter on the called contract, the caller and the method 4-bytes signature Supported operators are: logical or ||, logical and && and parenthesis: () Addresses to match must be written as 0x-prefixed hexadecimal, lowercase, prefixed by call_to: or call_from:, methods by call_method:. Example: (call_to:0x1234... || call_from:0x1234...) && call_method:0xdeadbeef...

substreams gui ethereum-common@v0.3.0 filtered_calls

map
filtered_transactions

d6ccd50b8175be235cbf2f18c0ad7d2d41e913b6
map filtered_transactions (
paramsstring
)  -> sf.substreams.ethereum.v1.Transactions
Default param : evt_sig:0x17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31 || (call_method:0xa9059cbb && call_to:0xdac17f958d2ee523a2206206994597c13d831ec7)

filtered_transactions reads from ethereum blocks and applies a filter on the events (addresses and signatures) as well as calls (from, to and method). Supported operators are: logical or ||, logical and && and parenthesis: () Addresses and signatures to match must be written as 0x-prefixed hexadecimal, lowercase, prefixed by evt_addr:, evt_sig:, call_to:, call_from: or call_method:. Example: ((evt_addr:0x1234... || evt_addr:0x5678...) && evt_sig:0xdeadbeef...) || call_to:0x01010101...

substreams gui ethereum-common@v0.3.0 filtered_transactions

map
filtered_events_and_calls

a0c728ef58e8dc842dc3a0f234cfc18bc8b3a2c7
Default param : evt_sig:0x17307eab39ab6107e8899845ad3d59bd9653f200f220920489ca2b5937696c31 || (call_method:0xa9059cbb && call_to:0xdac17f958d2ee523a2206206994597c13d831ec7)

filtered_events_and_calls reads from all_calls and all_events, then applies a filter to extract the items that interest you, based on called contract, caller, call method, event address and event signature. Supported operators are: logical or ||, logical and && and parenthesis: () Addresses and signatures to match must be written as 0x-prefixed hexadecimal, lowercase, prefixed by evt_addr:, evt_sig:, call_to:, call_from: or call_method:. Example: evt_sig:0x9bb8f83800000000000000000000000000000000000000000000000000000000 || (call_method:0xa9059cbb && call_to:0xdac17f958d2ee523a2206206994597c13d831ec7)

substreams gui ethereum-common@v0.3.0 filtered_events_and_calls
Block Indexes icon
Block Indexes

blockIndex
index_events

87255243f80f5d4755cd826ec57bf70696a4d7b6

index_events sets the following keys on the block:

  • Event signatures evt_sig:0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef (signature in hex, prefixed by 0x)
  • Event address evt_addr:0x0123456789abcdef0123456789abcdef01234567 (address in hex, prefixed by 0x)
substreams gui ethereum-common@v0.3.0 index_events

blockIndex
index_calls

5d7204db974da4bb8cea5f7582f0d4a412332acd

index_calls sets the following keys on the block:

  • Call contract call_to:0x0123456789abcdef0123456789abcdef01234567 (contract address in hex, prefixed by 0x)
  • Caller call_from:0x0123456789abcdef0123456789abcdef01234567 (caller address in hex, prefixed by 0x)
  • Call method call_method:0x01234567 (4 bytes of method signature in hex, prefixed by 0x)
substreams gui ethereum-common@v0.3.0 index_calls

blockIndex
index_events_and_calls

9fecea473d8588a59ffe0fbdb8dd71f48de302b9

index_events_and_calls sets the following keys on the block:

  • Event signatures evt_sig:0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef (signature in hex, prefixed by 0x)
  • Event address evt_addr:0x0123456789abcdef0123456789abcdef01234567 (address in hex, prefixed by 0x)
  • Call contract call_to:0x0123456789abcdef0123456789abcdef01234567 (contract address in hex, prefixed by 0x)
  • Caller call_from:0x0123456789abcdef0123456789abcdef01234567 (caller address in hex, prefixed by 0x)
  • Call method call_method:0x01234567 (4 bytes of method signature in hex, prefixed by 0x)
substreams gui ethereum-common@v0.3.0 index_events_and_calls
Protobuf

Protobuf Docs Explorer

sf.ethereum.type.v2
sf.ethereum.substreams.v1