institutional_wallet_custody_evm

DanielShteinbok

v0.1.0/12 downloads

Package ref

institutional-wallet-custody-evm@v0.1.0

Download .spkg

Run package

CLI

Run custody_evm from the command line.

substreams run institutional-wallet-custody-evm@v0.1.0 custody_evm -e mainnet --start-block -1

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

README

institutional_wallet_custody_evm

Watchlist-filtered Ethereum custody security events composed from maintained transfer packages.

Overview

custody_evm emits block-scoped custody.v1.CustodyEvents for a dynamic list of protected EVM addresses. It normalizes native value and fee deltas, transaction initiation, ERC-20 transfers and approvals, ERC-721/ERC-1155 activity, and EIP-7702 authority changes. It is authorization-neutral: the consuming application supplies the watchlist and correlates the resulting independent chain evidence with its own authorization plane.

Modules

Module	Kind	Output	Description
`custody_evm`	map	`proto:custody.v1.CustodyEvents`	Filters configured addresses and normalizes composed EVM activity into custody security events.

Composition

The module composes four narrow, immutable Pinax package artifacts. Importing the primitives directly also avoids dragging unrelated database-sink schemas into this security stream:

Registry erc20-transfers v0.2.0, module map_events, for ERC-20 Transfer/Approval decoding.
Registry evm-native-transfers v0.2.0, module map_events, for native calls and fee metadata.
Pinax erc721 v0.4.0, module map_events, from commit 44f7809c027c64c8d725cfde7941249636ad6bd4.
Pinax erc1155 v0.5.0, module map_events, from the same pinned commit.

Raw sf.ethereum.type.v2.Block access supplies block identity, top-level transaction initiation and semantic context, fee-inclusive native net changes, and EIP-7702 authority changes. Those security facts are not exposed together by the imported transfer packages. ERC-20 events whose log identity is also decoded as ERC-721 are suppressed to avoid classifying NFTs as fungible tokens.

Prerequisites

Substreams CLI v1.22.0 or newer.
A The Graph Market data-plane credential created with substreams auth.

Parameters use this strict format:

chain_id=eip155:1;addresses=0x1111111111111111111111111111111111111111,0x2222222222222222222222222222222222222222

Quick Start

The following verified mainnet block contains native and ERC-20 activity for the configured public address:

substreams run institutional-wallet-custody-evm-v0.1.0.spkg custody_evm \
  --network mainnet -s 25968310 -t 25968311 -o jsonl \
  -p 'custody_evm=chain_id=eip155:1;addresses=0x28c6c06298d514db089934071355e5743bf21d60'

Build and pack from source:

substreams build
substreams pack substreams.yaml -o institutional-wallet-custody-evm-v0.1.0.spkg

Modules

Execution graph

5 modules

mapMain

custody_evm

Emits normalized custody events only for the configured protected addresses.

Output

custody.v1.CustodyEvents

Inputs

paramssf.ethereum.type.v2.Block erc20:map_events native:map_events erc721:map_events erc1155:map_events

Show 4 dependencies

map

erc1155:map_events

Output

erc1155.v1.Events

Inputs

sf.ethereum.type.v2.Block

map

erc20:map_events

ERC-20 & WETH Events

Output

erc20.transfers.v1.Events

Inputs

sf.ethereum.type.v2.Block

map

erc721:map_events

Output

evm.erc721.v1.Events

Inputs

sf.ethereum.type.v2.Block

map

native:map_events

Output

native.transfers.v1.Events

Inputs

sf.ethereum.type.v2.Block

Protobuf

erc20.transfers.v1

Eventsmain

erc20.transfers.v1.Events

Transaction[]transactions = 1

Approval

erc20.transfers.v1.Approval

bytesowner = 1

bytesspender = 2

stringvalue = 3

uint256

Deposit

erc20.transfers.v1.Deposit

WETH events

bytesdst = 1

stringwad = 2

uint256

Log

erc20.transfers.v1.Log

bytesaddress = 1

uint64ordinal = 2

bytes[]topics = 3

bytesdata = 4

Transfertransfer = 10oneof log

ERC-20 events

Approvalapproval = 11oneof log

Depositdeposit = 12oneof log

WETH events

Withdrawalwithdrawal = 13oneof log

Transaction

erc20.transfers.v1.Transaction

byteshash = 1

bytesfrom = 2

bytesto = 3

uint64nonce = 5

stringgas_price = 6

uint256

uint64gas_limit = 7

uint64gas_used = 8

stringvalue = 9

uint256

Log[]logs = 10

Transfer

erc20.transfers.v1.Transfer

ERC-20 events

bytesfrom = 1

bytesto = 2

stringamount = 3

uint256

Withdrawal

erc20.transfers.v1.Withdrawal

bytessrc = 1

stringwad = 2

uint256

native.transfers.v1

Eventsmain

native.transfers.v1.Events

BlockReward[]block_rewards = 1

Transaction[]transactions = 2

BlockReward

native.transfers.v1.BlockReward

bytesminer = 1

stringvalue = 2

uint256

Reasonreason = 3

Call

native.transfers.v1.Call

uint32index = 1

uint64begin_ordinal = 2

uint64end_ordinal = 3

bytescaller = 4

sender

bytesaddress = 5

recipient

stringvalue = 6

uint256

uint64gas_consumed = 7

uint64gas_limit = 8

uint32depth = 9

uint32parent_index = 10

Transaction

native.transfers.v1.Transaction

byteshash = 1

bytesfrom = 2

bytesto = 3

uint64nonce = 5

stringgas_price = 6

uint256

uint64gas_limit = 7

uint64gas_used = 8

stringvalue = 9

uint256

Call[]calls = 11

Reasonenum

native.transfers.v1.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.

evm.erc721.v1

Eventsmain

evm.erc721.v1.Events

Transfer[]transfers = 1

Approval[]approvals = 2

ApprovalForAll[]approvals_for_all = 3

Approval

evm.erc721.v1.Approval

bytestx_hash = 1

-- transaction --

bytescaller = 2

-- caller --

bytescontract = 3

-- log --

uint64ordinal = 4

log.ordinal

bytesowner = 10

-- event --

bytesapproved = 11

address

stringtoken_id = 12

uint256

ApprovalForAll

evm.erc721.v1.ApprovalForAll

bytestx_hash = 1

-- transaction --

bytescaller = 2

-- caller --

bytescontract = 3

-- log --

uint64ordinal = 4

log.ordinal

bytesowner = 10

-- event --

bytesoperator = 11

address

boolapproved = 12

true/false

Transfer

evm.erc721.v1.Transfer

bytestx_hash = 1

-- transaction --

bytescaller = 2

-- caller --

bytescontract = 3

-- log --

uint64ordinal = 4

log.ordinal

bytesfrom = 10

-- event --

bytesto = 11

The person that received the transfer.

stringtoken_id = 12

TokenID the identifier of the token for which the transfer is happening.

erc1155.v1

Eventsmain

erc1155.v1.Events

Transaction[]transactions = 1

ApprovalForAll

erc1155.v1.ApprovalForAll

bytesaccount = 10

address

bytesoperator = 11

address

boolapproved = 12

true/false

Log

erc1155.v1.Log

https://github.com/pinax-network/substreams-abis/blob/main/abi/evm/polymarket/CFTExchange.json

bytesaddress = 1

uint64ordinal = 2

bytes[]topics = 3

bytesdata = 4

TransferSingletransfer_single = 10oneof log

events

TransferBatchtransfer_batch = 11oneof log

ApprovalForAllapproval_for_all = 12oneof log

URIuri = 13oneof log

Transaction

erc1155.v1.Transaction

byteshash = 1

bytesfrom = 2

bytesto = 3

uint64nonce = 5

stringgas_price = 6

uint256

uint64gas_limit = 7

uint64gas_used = 8

stringvalue = 9

uint256

Log[]logs = 10

TransferBatch

erc1155.v1.TransferBatch

bytesoperator = 10

address

bytesfrom = 11

address

bytesto = 12

address

string[]ids = 13

uint256[]

string[]values = 14

uint256[]

TransferSingle

erc1155.v1.TransferSingle

bytesoperator = 10

address

bytesfrom = 11

address

bytesto = 12

address

stringid = 13

uint256

stringvalue = 14

uint256

URI

erc1155.v1.URI

ERC1155 Metadata https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol

stringvalue = 10

stringid = 11

uint256

custody.v1

CustodyEventsmain

custody.v1.CustodyEvents

One block-scoped output. Cursor and reorg metadata remain transport concerns.

uint64block_number = 1

stringblock_hash = 2

int64block_timestamp_seconds = 3

CustodyEvent[]events = 4

CustodyEvent

custody.v1.CustodyEvent

stringchain_id = 1

uint64block_number = 2

stringblock_hash = 3

stringtransaction_hash = 4

uint64ordinal = 5

stringprotected_address = 6

EventTypeevent_type = 7

stringcounterparty = 8

stringasset_type = 9

stringasset_contract = 10

stringtoken_id = 11

stringamount = 12

stringraw_context_hash = 13

TransactionContexttransaction = 14

TransactionContext

custody.v1.TransactionContext

stringfrom = 1

stringto = 2

stringvalue = 3

stringdata = 4

uint64nonce = 5

uint64gas_used = 6

stringeffective_gas_price = 7

stringstatus = 8

EventTypeenum

custody.v1.EventType

EVENT_TYPE_UNSPECIFIED = 0

TRANSACTION_INITIATED = 1

NATIVE_IN = 2

NATIVE_OUT = 3

FUNGIBLE_TOKEN_IN = 4

FUNGIBLE_TOKEN_OUT = 5

NFT_IN = 6

NFT_OUT = 7

TOKEN_APPROVAL = 8

OPERATOR_APPROVAL = 9

AUTHORITY_CHANGED = 10

Show 48 dependencies

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.substreams.v1

RpcCall

sf.ethereum.substreams.v1.RpcCall

bytesto_addr = 1

bytesdata = 2

RpcCalls

sf.ethereum.substreams.v1.RpcCalls

RpcCall[]calls = 1

RpcResponse

sf.ethereum.substreams.v1.RpcResponse

bytesraw = 1

boolfailed = 2

RpcResponses

sf.ethereum.substreams.v1.RpcResponses

RpcResponse[]responses = 1

sf.ethereum.transform.v1

CallToFilter

sf.ethereum.transform.v1.CallToFilter

bytes[]addresses = 1

bytes[]signatures = 2

CombinedFilter

sf.ethereum.transform.v1.CombinedFilter

LogFilter[]log_filters = 1

CallToFilter[]call_filters = 2

boolsend_all_block_headers = 3

HeaderOnly

sf.ethereum.transform.v1.HeaderOnly

No fields.

LogFilter

sf.ethereum.transform.v1.LogFilter

bytes[]addresses = 1

bytes[]event_signatures = 2

MultiCallToFilter

sf.ethereum.transform.v1.MultiCallToFilter

CallToFilter[]call_filters = 1

MultiLogFilter

sf.ethereum.transform.v1.MultiLogFilter

LogFilter[]log_filters = 1

sf.ethereum.type.v2

BlockRef

sf.ethereum.type.v2.BlockRef

byteshash = 1

uint64number = 2

BlockWithRefs

sf.ethereum.type.v2.BlockWithRefs

stringid = 1

Blockblock = 2

TransactionRefstransaction_trace_refs = 3

boolirreversible = 4

HeaderOnlyBlock

sf.ethereum.type.v2.HeaderOnlyBlock

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_BLOCK = 2

REASON_DAO_REFUND_CONTRACT = 3

REASON_DAO_ADJUST_BALANCE = 4

REASON_TRANSFER = 5

REASON_GENESIS_BALANCE = 6

REASON_GAS_BUY = 7

REASON_REWARD_TRANSACTION_FEE = 8

REASON_REWARD_FEE_RESET = 14

REASON_GAS_REFUND = 9

REASON_TOUCH_ACCOUNT = 10

REASON_SUICIDE_REFUND = 11

REASON_SUICIDE_WITHDRAW = 13

REASON_CALL_BALANCE_OVERRIDE = 12

REASON_BURN = 15

REASON_WITHDRAWAL = 16

REASON_REWARD_BLOB_FEE = 17

REASON_INCREASE_MINT = 18

REASON_REVERT = 19

DetailLevelenum

sf.ethereum.type.v2.Block.DetailLevel

DETAILLEVEL_EXTENDED = 0

DETAILLEVEL_BASE = 2

CallTypeenum

sf.ethereum.type.v2.CallType

UNSPECIFIED = 0

CALL = 1

CALLCODE = 2

DELEGATE = 3

STATIC = 4

CREATE = 5

Reasonenum

sf.ethereum.type.v2.GasChange.Reason

REASON_UNKNOWN = 0

REASON_CALL = 1

REASON_CALL_CODE = 2

REASON_CALL_DATA_COPY = 3

REASON_CODE_COPY = 4

REASON_CODE_STORAGE = 5

REASON_CONTRACT_CREATION = 6

REASON_CONTRACT_CREATION2 = 7

REASON_DELEGATE_CALL = 8

REASON_EVENT_LOG = 9

REASON_EXT_CODE_COPY = 10

REASON_FAILED_EXECUTION = 11

REASON_INTRINSIC_GAS = 12

REASON_PRECOMPILED_CONTRACT = 13

REASON_REFUND_AFTER_EXECUTION = 14

REASON_RETURN = 15

REASON_RETURN_DATA_COPY = 16

REASON_REVERT = 17

REASON_SELF_DESTRUCT = 18

REASON_STATIC_CALL = 19

REASON_STATE_COLD_ACCESS = 20

REASON_TX_INITIAL_BALANCE = 21

REASON_TX_REFUNDS = 22

REASON_TX_LEFT_OVER_RETURNED = 23

REASON_CALL_INITIAL_BALANCE = 24

REASON_CALL_LEFT_OVER_RETURNED = 25

REASON_WITNESS_CONTRACT_INIT = 26

REASON_WITNESS_CONTRACT_CREATION = 27

REASON_WITNESS_CODE_CHUNK = 28

REASON_WITNESS_CONTRACT_COLLISION_CHECK = 29

REASON_TX_DATA_FLOOR = 30

Typeenum

sf.ethereum.type.v2.TransactionTrace.Type

TRX_TYPE_LEGACY = 0

TRX_TYPE_ACCESS_LIST = 1

TRX_TYPE_DYNAMIC_FEE = 2

TRX_TYPE_BLOB = 3

TRX_TYPE_SET_CODE = 4

TRX_TYPE_ARBITRUM_DEPOSIT = 100

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

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