eqcapital_robinhood_token_state

paulkullich

v0.1.0/7 downloads

Package ref

eqcapital-robinhood-token-state@v0.1.0

Download .spkg

Run package

CLI

Run map_token_state from the command line.

substreams run eqcapital-robinhood-token-state@v0.1.0 map_token_state -e robinhood

Authenticate by running substreams auth or directly on thegraph.market (see docs).

Modules

Execution graph

5 modules

mapMain

map_token_state

from #55234000

Output

sf.substreams.foundational_store.model.v2.SinkEntries

Inputs

map_progress store_token_birth store_token_rich

map

map_progress

from #55234000

Output

sf.substreams.v1.Clock

Inputs

sf.substreams.v1.Clock

map

map_token_logs

from #55234000

Output

eqcapital.substreams.v1.DexTape

Inputs

sf.ethereum.type.v2.Block map_progress

store

store_token_birth

from #55234000

Store value

int64

Update policy

set_if_not_exists

Inputs

map_token_logs map_progress

store

store_token_rich

from #55234000

Store value

int64

Update policy

set_if_not_exists

Inputs

map_token_logs map_progress store_token_birth

Protobuf

eqcapital.substreams.v1

DexTapemain

eqcapital.substreams.v1.DexTape

Each field contains the corresponding upstream evm.uniswap.vN.Events protobuf with selected event tags only. Decode using the pinned upstream descriptors; these are opaque event tapes, not new canonical contracts.

bytesv2 = 1

bytesv3 = 2

bytesv4 = 3

Show 42 dependencies

eqcapital.token_state.v1

TierProbe

eqcapital.token_state.v1.TierProbe

uint64block_number = 1

stringblock_hash = 2

TokenState[]states = 3

uint32unknown_tokens = 4

uint32selected_swap_count = 5

bytes[]selected_swap_payloads = 6

Lossless receipt log + transaction coordinates encoded as ReceiptLogEvidence. Full wallet/transaction coverage remains outside this bounded store probe.

TokenState

eqcapital.token_state.v1.TokenState

Engineering-only requested collection tier. Native coverage owns readiness.

stringtoken_key = 1

stringtoken_address = 2

stringpolicy_version = 3

uint64as_of_block = 4

stringas_of_block_hash = 5

uint64discovered_block = 6

uint64rich_from_block = 7

zero = no promotion observed

stringrequested_tier = 8

boolmodel_ready = 9

uint64valid_before_block = 10

exclusive expiry, required

stringreason = 11

uint64chain_id = 12

schema

ClickhouseIndexField

schema.ClickhouseIndexField

ClickhouseIndexField defines a secondary index for improved query performance. Secondary indexes help ClickHouse skip irrelevant data blocks during query execution.

stringname = 1

The name of the index (must be unique within the table)

stringfield_name = 2

The field name on which to create the index

IndexTypetype = 3

The type of index to create (e.g., minmax, bloom_filter, set)

uint32granularity = 4

The granularity parameter that controls index density (higher = less memory, lower precision)

Functionfunction = 5

Optional function to apply to the field value before indexing

ClickhouseOrderByField

schema.ClickhouseOrderByField

ClickhouseOrderByField defines a field used in the ClickHouse table ORDER BY clause. ORDER BY determines the physical storage order of data for optimal compression and query performance.

stringname = 1

The name of the field to include in the ORDER BY clause

booldescending = 2

Whether to sort this field in descending order (default is ascending)

Functionfunction = 3

Optional function to apply to the field value before ordering (e.g., toDate for timestamps)

ClickhousePartitionByField

schema.ClickhousePartitionByField

ClickhousePartitionByField defines a field used for ClickHouse table partitioning. Partitioning splits data into separate parts based on the specified field values.

stringname = 1

The name of the field to use for partitioning

Functionfunction = 2

Optional function to apply to the field value before partitioning (e.g., toYYYYMM for dates)

ClickhouseTableOptions

schema.ClickhouseTableOptions

ClickhouseTableOptions defines ClickHouse-specific table configuration options. These options are used to configure ClickHouse table engines and optimize query performance.

ClickhouseOrderByField[]order_by_fields = 1

Fields to use for the ORDER BY clause in ClickHouse table definition. ORDER BY determines the physical ordering of data on disk for better compression and query performance.

ClickhousePartitionByField[]partition_fields = 2

Fields to use for table partitioning in ClickHouse. Partitioning helps with query performance and data management by splitting data into logical parts.

ClickhouseIndexField[]index_fields = 4

Secondary indexes to create for improved query performance on specific columns. These are data skipping indexes that help ClickHouse skip irrelevant data blocks during queries.

Column

schema.Column

Column defines metadata for mapping a protobuf field to a database column. This message is used with the (field) extension on protobuf fields.

stringname = 1

Custom column name. If not specified, the field name is used.

stringforeign_key = 2

Foreign key reference to another table's column in the format "table.column". Used to establish referential integrity constraints in relational databases.

boolunique = 3

Whether this column should have a unique constraint. Ensures no duplicate values exist for this column.

boolprimary_key = 4

Whether this column is part of the primary key. Primary key columns are automatically non-null and unique.

StringConvertionconvertTo = 5

Specifies how to convert string fields to specific numeric types. Only applies to string fields that contain numeric data. Leave unset for no conversion (store as string).

boolinline = 6

Decimal128

schema.Decimal128

Decimal128 represents a 128-bit decimal type for string conversion. Used in StringConvertion to specify that a string field should be converted to Decimal128.

int32scale = 1

The number of digits after the decimal point for this decimal type.

Decimal256

schema.Decimal256

Decimal256 represents a 256-bit decimal type for string conversion. Used in StringConvertion to specify that a string field should be converted to Decimal256.

int32scale = 1

The number of digits after the decimal point for this decimal type.

Int128

schema.Int128

Int128 represents a 128-bit signed integer type for string conversion. Used in StringConvertion to specify that a string field should be converted to Int128.

No fields.

Int256

schema.Int256

Int256 represents a 256-bit signed integer type for string conversion. Used in StringConvertion to specify that a string field should be converted to Int256.

No fields.

StringConvertion

schema.StringConvertion

StringConvertion defines how string fields should be converted to specific numeric types. This is used when protobuf string fields contain numeric data that should be stored as native numeric types in the database for better performance and storage efficiency. Usage: Set this in Column.convertTo field to specify the target numeric type.

Int128int128 = 2oneof convertion

Convert string to 128-bit signed integer

UInt128uint128 = 3oneof convertion

Convert string to 128-bit unsigned integer

Int256int256 = 4oneof convertion

Convert string to 256-bit signed integer

UInt256uint256 = 6oneof convertion

Convert string to 256-bit unsigned integer

Decimal128decimal128 = 50oneof convertion

Convert string to 128-bit decimal with specified scale

Decimal256decimal256 = 51oneof convertion

Convert string to 256-bit decimal with specified scale

Table

schema.Table

Table defines metadata for mapping a protobuf message to a database table. This message is used with the (table) extension on protobuf messages.

stringname = 1

The name of the database table. If not specified, the message name is used.

stringchild_of = 2

Optional field to specify a parent table for establishing table relationships. Used for creating foreign key relationships in relational databases.

ClickhouseTableOptionsclickhouse_table_options = 200

ClickHouse-specific table options for configuring table engine parameters. Only applicable when using ClickHouse as the target database.

UInt128

schema.UInt128

UInt128 represents a 128-bit unsigned integer type for string conversion. Used in StringConvertion to specify that a string field should be converted to UInt128.

No fields.

UInt256

schema.UInt256

UInt256 represents a 256-bit unsigned integer type for string conversion. Used in StringConvertion to specify that a string field should be converted to UInt256.

No fields.

Functionenum

schema.Function

unset = 0

No function applied (use raw field value)

toYYYYMM = 1

Convert date/timestamp to YYYYMM format (useful for monthly partitioning)

toYYYYDD = 2

Convert date/timestamp to YYYYDD format (useful for daily partitioning)

toYear = 3

Extract year from date/timestamp (useful for yearly partitioning)

toMonth = 4

Extract month from date/timestamp (useful for monthly grouping)

toDate = 5

Convert timestamp to date (removes time component)

toStartOfMonth = 6

Convert date to first day of the month (useful for monthly aggregations)

IndexTypeenum

schema.IndexType

minmax = 0

MinMax index stores minimum and maximum values for each granule (fastest, least memory)

set = 1

Set index stores unique values for each granule (good for low cardinality fields)

ngrambf_v1 = 2

N-gram Bloom filter index for substring searches (good for text search)

tokenbf_v1 = 3

Token Bloom filter index for full-word searches (good for tokenized text)

bloom_filter = 4

Bloom filter index for equality checks (good for high cardinality fields)

sf.ethereum.type.v2

BlockRef

sf.ethereum.type.v2.BlockRef

byteshash = 1

uint64number = 2

BlockWithRefs

sf.ethereum.type.v2.BlockWithRefs

BlockWithRefs is a lightweight block, with traces and transactions purged from the block within, and only. It is used in transports to pass block data around.

stringid = 1

Blockblock = 2

TransactionRefstransaction_trace_refs = 3

boolirreversible = 4

BoolOptional

sf.ethereum.type.v2.BoolOptional

BoolOptional and BoolRequired are test messages used to verify the wire-encoding difference between optional bool (state: true / false / nil) and plain bool

boolstate = 1

BoolRequired

sf.ethereum.type.v2.BoolRequired

boolstate = 1

HeaderOnlyBlock

sf.ethereum.type.v2.HeaderOnlyBlock

HeaderOnlyBlock is used to optimally unpack the [Block] structure (note the corresponding message number for the header field) while consuming less memory, when only the header is desired.

WARN: this is a client-side optimization pattern and should be moved in the consuming code.

BlockHeaderheader = 5

TransactionRefs

sf.ethereum.type.v2.TransactionRefs

bytes[]hashes = 1

TransactionTraceWithBlockRef

sf.ethereum.type.v2.TransactionTraceWithBlockRef

TransactionTracetrace = 1

BlockRefblock_ref = 2

Reasonenum

sf.ethereum.type.v2.BalanceChange.Reason

REASON_UNKNOWN = 0

REASON_REWARD_MINE_UNCLE = 1

REASON_REWARD_MINE_UNCLE is a reward for mining an uncle block. Triggered when uncle blocks are processed during block finalization. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/consensus/ethash/consensus.go#L589

REASON_REWARD_MINE_BLOCK = 2

REASON_REWARD_MINE_BLOCK is a reward for mining a block. Triggered when the block miner receives their mining reward. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/consensus/ethash/consensus.go#L594

REASON_DAO_REFUND_CONTRACT = 3

REASON_DAO_REFUND_CONTRACT is ether sent to the DAO refund contract. Used during the DAO hard fork to move funds to the refund contract. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/consensus/misc/dao.go#L85

REASON_DAO_ADJUST_BALANCE = 4

REASON_DAO_ADJUST_BALANCE is ether taken from a DAO account to be moved to the refund contract. Used during the DAO hard fork to extract funds from DAO-related accounts. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/consensus/misc/dao.go#L86

REASON_TRANSFER = 5

REASON_TRANSFER is ether transferred via a call. This is a decrease for the sender and an increase for the recipient during value transfers. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/evm.go#L144 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/evm.go#L145

REASON_GENESIS_BALANCE = 6

REASON_GENESIS_BALANCE is ether allocated at the genesis block. Triggered when accounts are initialized with balances during genesis block creation. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/genesis.go#L154 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/genesis.go#L180

REASON_GAS_BUY = 7

REASON_GAS_BUY is spent to purchase gas for executing a transaction. The transaction sender's balance is decreased by gasLimit * gasPrice at transaction start. Note: This balance change persists even for failed transactions (see Block documentation). See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state_transition.go#L306

REASON_REWARD_TRANSACTION_FEE = 8

REASON_REWARD_TRANSACTION_FEE is the transaction tip increasing block builder's balance. The coinbase (block miner) receives the transaction fees as a reward. Note: This balance change persists even for failed transactions (see Block documentation). See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state_transition.go#L560

REASON_GAS_REFUND = 9

REASON_GAS_REFUND is ether returned for unused gas at the end of execution. Any unused gas from the transaction is refunded to the sender. Note: This balance change persists even for failed transactions (see Block documentation). See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state_transition.go#L658

REASON_TOUCH_ACCOUNT = 10

REASON_TOUCH_ACCOUNT is a transfer of zero value. It is only there to touch-create an account. Used to create an account without transferring value, often for contract interactions. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L442

REASON_SUICIDE_REFUND = 11

REASON_SUICIDE_REFUND is added to the recipient as indicated by a selfdestructing account. When a contract self-destructs, its remaining balance is sent to a designated recipient. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L890 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L910

REASON_CALL_BALANCE_OVERRIDE = 12

REASON_CALL_BALANCE_OVERRIDE represents a balance change due to call balance override. This is a Firehose-specific reason not directly mapped to Geth tracing reasons.

REASON_SUICIDE_WITHDRAW = 13

REASON_SUICIDE_WITHDRAW is deducted from a contract due to self-destruct. The self-destructing contract's balance is reduced to zero. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L909 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state/statedb_hooked.go#L230 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state/statedb_hooked.go#L256

REASON_REWARD_FEE_RESET = 14

REASON_REWARD_FEE_RESET represents a fee reset reward. This is a Firehose-specific reason not directly mapped to Geth tracing reasons.

REASON_BURN = 15

Used on chain(s) where some Ether burning happens This represents ether that is effectively burned when sent to a destroyed contract. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state/statedb_hooked.go#L288

REASON_WITHDRAWAL = 16

REASON_WITHDRAWAL is ether withdrawn from the beacon chain. Used for validator withdrawals from the Ethereum 2.0 beacon chain to the execution layer. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/consensus/beacon/consensus.go#L339

REASON_REWARD_BLOB_FEE = 17

Rewards for Blob processing on BNB chain added in Tycho hard-fork, refers to BNB documentation to check the timestamp at which it was activated.

REASON_INCREASE_MINT = 18

This reason is used only on Optimism chain for minting operations.

REASON_REVERT = 19

This reason is used only on Optimism chain for balance reverts.

REASON_MONAD_TX_POST_STATE = 20

This reason is used only on Monad chain. The Monad execution layer does not report the reason for a balance change, only the pre and post-execution state per account. Because of Monad's parallel execution model, there is always exactly one balance change per modified address per transaction, representing the state change. Consumers should not expect granular per-operation entries (i.e. GAS_BUY, TRANSFER, GAS_REFUND, REWARD_TRANSACTION_FEE) because of this.

DetailLevelenum

sf.ethereum.type.v2.Block.DetailLevel

DETAILLEVEL_EXTENDED = 0

DETAILLEVEL_BASE = 2

DETAILLEVEL_TRACE = 1; // TBD

CallTypeenum

sf.ethereum.type.v2.CallType

UNSPECIFIED = 0

CALL = 1

direct? what's the name for Call alone?

CALLCODE = 2

DELEGATE = 3

STATIC = 4

CREATE = 5

create2 ? any other form of calls?

Reasonenum

sf.ethereum.type.v2.GasChange.Reason

REASON_UNKNOWN = 0

REASON_CALL = 1

REASON_CALL is the amount of gas that will be charged for a 'CALL' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_CALL_CODE = 2

REASON_CALL_CODE is the amount of gas that will be charged for a 'CALLCODE' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_CALL_DATA_COPY = 3

REASON_CALL_DATA_COPY is the amount of gas that will be charged for a 'CALLDATACOPY' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_CODE_COPY = 4

REASON_CODE_COPY is the amount of gas that will be charged for a 'CODECOPY' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_CODE_STORAGE = 5

REASON_CODE_STORAGE is the amount of gas that will be charged for code storage. Triggered when storing contract code during contract creation. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L593

REASON_CONTRACT_CREATION = 6

REASON_CONTRACT_CREATION is the amount of gas that will be burned for a CREATE opcode. Triggered during contract creation via CREATE opcode, controlled by EIP150 rules. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L672

REASON_CONTRACT_CREATION2 = 7

REASON_CONTRACT_CREATION2 is the amount of gas that will be burned for a CREATE2 opcode. Triggered during contract creation via CREATE2 opcode, controlled by EIP150 rules. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L712

REASON_DELEGATE_CALL = 8

REASON_DELEGATE_CALL is the amount of gas that will be charged for a 'DELEGATECALL' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_EVENT_LOG = 9

REASON_EVENT_LOG is the amount of gas that will be charged for a 'LOG' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_EXT_CODE_COPY = 10

REASON_EXT_CODE_COPY is the amount of gas that will be charged for an 'EXTCODECOPY' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_FAILED_EXECUTION = 11

REASON_FAILED_EXECUTION is the burning of the remaining gas when the execution failed without a revert. Triggered when a call fails and all remaining gas is consumed. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L308 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L363 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L407 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L462 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L521 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L567

REASON_INTRINSIC_GAS = 12

REASON_INTRINSIC_GAS is the amount of gas charged for the intrinsic cost of the transaction. There is always exactly one of these per transaction, representing the base cost. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state_transition.go#L464

REASON_PRECOMPILED_CONTRACT = 13

REASON_PRECOMPILED_CONTRACT is the amount of gas charged for a precompiled contract execution. Triggered when calling precompiled contracts (addresses 0x01-0x09, etc.). See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/contracts.go#L271

REASON_REFUND_AFTER_EXECUTION = 14

REASON_REFUND_AFTER_EXECUTION is the amount of gas refunded to the caller after call execution. Triggered when gas is refunded after a successful call completes. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L688 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L724 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L764 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L797 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L826 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/instructions.go#L855

REASON_RETURN = 15

REASON_RETURN is the amount of gas that will be charged for a 'RETURN' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_RETURN_DATA_COPY = 16

REASON_RETURN_DATA_COPY is the amount of gas that will be charged for a 'RETURNDATACOPY' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_REVERT = 17

REASON_REVERT is the amount of gas that will be charged for a 'REVERT' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_SELF_DESTRUCT = 18

REASON_SELF_DESTRUCT is the amount of gas that will be charged for a 'SELFDESTRUCT' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_STATIC_CALL = 19

REASON_STATIC_CALL is the amount of gas that will be charged for a 'STATICCALL' opcode executed by the EVM. This is an opcode-related gas change mapped from Geth tracing via OnGasChange(gasCopy, gasCopy-cost, tracing.GasChangeCallOpCode). See: https://github.com/streamingfast/go-ethereum/blob/firehose-fh3.0/eth/tracers/firehose.go#L1247-L1264

REASON_STATE_COLD_ACCESS = 20

REASON_STATE_COLD_ACCESS is the amount of gas charged for a cold storage access as controlled by EIP2929 rules. Triggered when accessing storage slots or accounts that haven't been accessed in the current transaction. Added in Berlin fork (Geth 1.10+) See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/operations_acl.go#L167 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/operations_acl.go#L268 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/operations_acl.go#L283

REASON_TX_INITIAL_BALANCE = 21

REASON_TX_INITIAL_BALANCE is the initial gas balance for the transaction equal to the gasLimit. There is only one such gas change per transaction, representing the initial gas allocation. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state_transition.go#L300

REASON_TX_REFUNDS = 22

REASON_TX_REFUNDS is the sum of all refunds during transaction execution (e.g. storage slot clearing). This generates an increase in gas. There is only one such gas change per transaction. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state_transition.go#L648

REASON_TX_LEFT_OVER_RETURNED = 23

REASON_TX_LEFT_OVER_RETURNED is the amount of gas left over at transaction end that will be returned. This change will always be negative as we "drain" left over gas towards 0. If there was no gas left at the end of execution, no such event will be emitted. There is at most one per transaction. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state_transition.go#L661

REASON_CALL_INITIAL_BALANCE = 24

REASON_CALL_INITIAL_BALANCE is the initial gas balance for a call equal to the gasLimit of the call. There is only one such gas change per call. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L662

REASON_CALL_LEFT_OVER_RETURNED = 25

REASON_CALL_LEFT_OVER_RETURNED is the amount of gas left over that will be returned to the caller. This change will always be negative as we "drain" left over gas towards 0. If there was no gas left at the end of execution, no such event will be emitted. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L669

REASON_WITNESS_CONTRACT_INIT = 26

REASON_WITNESS_CONTRACT_INIT flags the event of adding to the witness during contract creation initialization. Used in stateless Ethereum (Verkle trees) for witness data collection. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L548

REASON_WITNESS_CONTRACT_CREATION = 27

REASON_WITNESS_CONTRACT_CREATION flags the event of adding to the witness during contract creation finalization. Used in stateless Ethereum (Verkle trees) for witness data collection. This is a Firehose-specific reason not directly mapped to current Geth tracing reasons.

REASON_WITNESS_CODE_CHUNK = 28

REASON_WITNESS_CODE_CHUNK flags the event of adding one or more contract code chunks to the witness. Used in stateless Ethereum (Verkle trees) for witness data collection. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L598 See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/interpreter.go#L179

REASON_WITNESS_CONTRACT_COLLISION_CHECK = 29

REASON_WITNESS_CONTRACT_COLLISION_CHECK flags the event of adding to the witness when checking for contract address collision. Used in stateless Ethereum (Verkle trees) for witness data collection. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/vm/evm.go#L500

REASON_TX_DATA_FLOOR = 30

REASON_TX_DATA_FLOOR is the amount of extra gas the transaction has to pay to reach the minimum gas requirement. This change will always be negative and represents additional gas cost for transaction data. See: https://github.com/ethereum/go-ethereum/blob/v1.16.4/core/state_transition.go#L538

Typeenum

sf.ethereum.type.v2.TransactionTrace.Type

TRX_TYPE_LEGACY = 0

All transactions that ever existed prior Berlin fork before EIP-2718 was implemented.

TRX_TYPE_ACCESS_LIST = 1

Transaction that specicy an access list of contract/storage_keys that is going to be used in this transaction.

Added in Berlin fork (EIP-2930).

TRX_TYPE_DYNAMIC_FEE = 2

Transaction that specifis an access list just like TRX_TYPE_ACCESS_LIST but in addition defines the max base gas gee and max priority gas fee to pay for this transaction. Transaction's of those type are executed against EIP-1559 rules which dictates a dynamic gas cost based on the congestion of the network.

TRX_TYPE_BLOB = 3

Transaction which contain a large amount of data that cannot be accessed by EVM execution, but whose commitment can be accessed. The format is intended to be fully compatible with the format that will be used in full sharding.

Transaction that defines an access list just like TRX_TYPE_ACCESS_LIST and enables dynamic fee just like TRX_TYPE_DYNAMIC_FEE but in addition defines the fields 'max_fee_per_data_gas' of type 'uint256' and the fields 'blob_versioned_hashes' which represents a list of hash outputs from 'kzg_to_versioned_hash'.

Activated in Cancun fork (EIP-4844)

TRX_TYPE_SET_CODE = 4

Transaction that sets code to an EOA (Externally Owned Accounts)

Activated in Prague (EIP-7702)

TRX_TYPE_ARBITRUM_DEPOSIT = 100

Arbitrum-specific transactions

TRX_TYPE_ARBITRUM_UNSIGNED = 101

TRX_TYPE_ARBITRUM_CONTRACT = 102

TRX_TYPE_ARBITRUM_RETRY = 104

TRX_TYPE_ARBITRUM_SUBMIT_RETRYABLE = 105

TRX_TYPE_ARBITRUM_INTERNAL = 106

TRX_TYPE_ARBITRUM_LEGACY = 120

TRX_TYPE_OPTIMISM_DEPOSIT = 126

OPTIMISM-specific transactions

TRX_TYPE_POLYGON_STATE_SYNC = 200

Polygon(bor)-specific

TransactionTraceStatusenum

sf.ethereum.type.v2.TransactionTraceStatus

UNKNOWN = 0

SUCCEEDED = 1

FAILED = 2

REVERTED = 3

sf.firehose.v2

BlockMetadata

sf.firehose.v2.BlockMetadata

uint64num = 1

Num is the block number of this response's block.

stringid = 2

ID is the block ID of this response's block. The ID actual representation is chain specific.

Antelope & Ethereum uses hex.
NEAR & Solana uses base58.

Refer to the chain documentation for more details.

uint64parent_num = 3

ParentNum is the block number of the parent of this response's block

stringparent_id = 4

ParentID is the block ID of the parent of this response's block. If this response is the genesis block, this field is empty.

The ID actual representation is chain specific.

Antelope & Ethereum uses hex.
NEAR & Solana uses base58.

Refer to the chain documentation for more details.

uint64lib_num = 5

LibNum is the block number of the last irreversible block (a.k.a last finalized block) at the time of this response' block. It determines the finality of the block.

Timestamptime = 6

Time is the time at which the block was produced.

InfoRequest

sf.firehose.v2.InfoRequest

No fields.

InfoResponse

sf.firehose.v2.InfoResponse

stringchain_name = 1

Canonical chain name from https://thegraph.com/docs/en/developing/supported-networks/ (ex: matic, mainnet ...)

string[]chain_name_aliases = 2

Alternate names for the chain.

uint64first_streamable_block_num = 3

First block that is served by this endpoint. This should usually be the genesis block, but some providers may have truncated history.

stringfirst_streamable_block_id = 4

InfoResponse.BlockIdEncodingblock_id_encoding = 5

This informs the client on how to decode the block_id field inside the "Clock" message as well as the first_streamable_block_id above.

string[]block_features = 10

features describes the blocks. Popular values for EVM chains include base, extended or hybrid.

Request

sf.firehose.v2.Request

int64start_block_num = 1

Controls where the stream of blocks will start.

The stream will start inclusively at the requested block num.

When not provided, starts at first streamable block of the chain. Not all chain starts at the same block number, so you might get an higher block than requested when using default value of 0.

Can be negative, will be resolved relative to the chain head block, assuming a chain at head block #100, then using -50 as the value will start at block #50. If it resolves before first streamable block of chain, we assume start of chain.

If start_cursor is given, this value is ignored and the stream instead starts immediately after the Block pointed by the opaque start_cursor value.

stringcursor = 2

Controls where the stream of blocks will start which will be immediately after the Block pointed by this opaque cursor.

Obtain this value from a previously received Response.cursor.

This value takes precedence over start_block_num.

uint64stop_block_num = 3

When non-zero, controls where the stream of blocks will stop.

The stream will close after that block has passed so the boundary is inclusive.

boolfinal_blocks_only = 4

With final_block_only, you only receive blocks with STEP_FINAL Default behavior will send blocks as STEP_NEW, with occasional STEP_UNDO

Any[]transforms = 10

Response

sf.firehose.v2.Response

Anyblock = 1

Chain specific block payload, ex:

sf.eosio.type.v1.Block
sf.ethereum.type.v1.Block
sf.near.type.v1.Block

ForkStepstep = 6

stringcursor = 10

BlockMetadatametadata = 12

Metadata about the block, added in some Firehose version, so consumer should be ready to handle the absence of this field.

SingleBlockRequest

sf.firehose.v2.SingleBlockRequest

SingleBlockRequest.BlockNumberblock_number = 3oneof reference

SingleBlockRequest.BlockHashAndNumberblock_hash_and_number = 4oneof reference

SingleBlockRequest.Cursorcursor = 5oneof reference

Any[]transforms = 6

BlockHashAndNumber

sf.firehose.v2.SingleBlockRequest.BlockHashAndNumber

Get the current block with specific hash and number

uint64num = 1

stringhash = 2

BlockNumber

sf.firehose.v2.SingleBlockRequest.BlockNumber

Get the current known canonical version of a block at with this number

uint64num = 1

Cursor

sf.firehose.v2.SingleBlockRequest.Cursor

Get the block that generated a specific cursor

stringcursor = 1

SingleBlockResponse

sf.firehose.v2.SingleBlockResponse

Anyblock = 1

BlockMetadatametadata = 2

Metadata about the block, added in some Firehose version, so consumer should be ready to handle the absence of this field.

ForkStepenum

sf.firehose.v2.ForkStep

STEP_UNSET = 0

STEP_NEW = 1

Incoming block

STEP_UNDO = 2

A reorg caused this specific block to be excluded from the chain

STEP_FINAL = 3

Block is now final and can be committed (finality is chain specific, see chain documentation for more details)

BlockIdEncodingenum

sf.firehose.v2.InfoResponse.BlockIdEncoding

BLOCK_ID_ENCODING_UNSET = 0

BLOCK_ID_ENCODING_HEX = 1

BLOCK_ID_ENCODING_0X_HEX = 2

BLOCK_ID_ENCODING_BASE58 = 3

BLOCK_ID_ENCODING_BASE64 = 4

BLOCK_ID_ENCODING_BASE64URL = 5