uniswap-v4-substreams

StreamingFast

v0.1.0/3 downloads/Repository

Package ref

uniswap-v4-substreams@v0.1.0

Download .spkg

Run package

CLI

Run map_events from the command line.

substreams run uniswap-v4-substreams@v0.1.0 map_events -e base --start-block -1

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

README

Uniswap v4 Substreams (Base)

sg2ss conversion of Uniswap/v4-subgraph for Base.

Layer	Role
Substreams	Decode PoolManager + PositionManager events (address-gated)
ClickHouse	Event tables + HOL views (`api_pools`, `api_swaps`, …)
Hasura	GraphQL over public `api_*` views

No Substreams stores for Tier A+B — v4 pool events all come from a fixed PoolManager.

Source: streamingfast/substreams-chain-modules · dex/uniswap-v4-substreams

Showcase: substreams.dev/showcases/uniswap-v4

See DESIGN.md.

Contracts (Base)

Role	Address	startBlock
PoolManager	`0x498581fF718922c3f8e6A244956aF099B2652b2b`	25350988
PositionManager	`0x7C5f5A4bBd8fD63184577525326123B519429bDc`	25350993

Prerequisites

Install the Substreams CLI (includes substreams sink clickhouse — migration guide). Docker for the local ClickHouse + Hasura stack.

Build

From the monorepo root (workspace member):

cd substreams-chain-modules
cargo build -p uniswap_v4_substreams --release --target wasm32-unknown-unknown
# or:
cd dex/uniswap-v4-substreams && substreams build
# → uniswap-v4-substreams-v0.1.0.spkg

Get running

git clone https://github.com/streamingfast/substreams-chain-modules.git
cd substreams-chain-modules/dex/uniswap-v4-substreams

docker compose up -d                    # ClickHouse + Hasura + connector
# substreams auth                       # once

substreams sink clickhouse ./substreams.yaml \
  --dsn "clickhouse://default:SecureMe!@127.0.0.1:9000/uniswap_v4" \
  -s 25350988 \
  --network base \
  --batch-block-flush-interval 50 \
  --bytes-encoding hex \
  --cursor-file-path ./cursor.txt \
  --sink-info-folder ./ch-sink-info

# after event tables exist:
./scripts/apply_views.sh
./scripts/hasura_connect_clickhouse.sh

Then open the Console or hit GraphQL:

Service	URL
GraphQL	http://localhost:8080/v1/graphql · header `x-hasura-admin-secret: SecureMe!`
Console	http://localhost:8080/console
ClickHouse	http://127.0.0.1:8123 · DB `uniswap_v4`

curl -s http://localhost:8080/v1/graphql \
  -H 'content-type: application/json' \
  -H 'x-hasura-admin-secret: SecureMe!' \
  -d '{"query":"{ uniswap_v4_api_pools(limit: 5) { pool_id token0 token1 fee tick liquidity swap_count } }"}'

More examples: sql/hasura/examples.graphql

Hosted option: StreamingFast can host the sink against your warehouse — hosted sinks · Portal.

API views

View	Meaning
`api_pools`	Pool id HOL: tokens, fee, latest price/tick/liquidity
`api_swaps`	Swap events
`api_modify_liquidity`	Liquidity modifications
`api_positions`	Position NFT latest owner
`api_tokens`	Currency addresses seen (no symbol/decimals eth_call yet)

Out of core (for now)

USD volumes / Bundle pricing
Tick entities, day/hour aggregates as full subgraph parity
Hook factory extras (Arrakis/Euler)
Token metadata eth_call

Modules

Execution graph

1 modules

mapMain

map_events

from #25350988

Output

uniswap.v4.Events

Inputs

sf.ethereum.type.v2.Block

Protobuf

uniswap.v4

Eventsmain

uniswap.v4.Events

InitializeEvent[]initialize_events = 1

SwapEvent[]swap_events = 2

ModifyLiquidityEvent[]modify_liquidity_events = 3

PositionTransferEvent[]position_transfer_events = 4

PositionSubscriptionEvent[]position_subscription_events = 5

PositionUnsubscriptionEvent[]position_unsubscription_events = 6

InitializeEvent

uniswap.v4.InitializeEvent

stringid = 1

uint64block_number = 2

uint64block_timestamp = 3

stringtransaction_hash = 4

uint32log_index = 5

stringcontract = 6

stringevent_name = 7

stringpool_id = 8

stringcurrency0 = 9

stringcurrency1 = 10

stringfee = 11

stringtick_spacing = 12

stringhooks = 13

stringsqrt_price_x96 = 14

stringtick = 15

ModifyLiquidityEvent

uniswap.v4.ModifyLiquidityEvent

stringid = 1

uint64block_number = 2

uint64block_timestamp = 3

stringtransaction_hash = 4

uint32log_index = 5

stringcontract = 6

stringevent_name = 7

stringpool_id = 8

stringsender = 9

stringtick_lower = 10

stringtick_upper = 11

stringliquidity_delta = 12

stringsalt = 13

PositionSubscriptionEvent

uniswap.v4.PositionSubscriptionEvent

stringid = 1

uint64block_number = 2

uint64block_timestamp = 3

stringtransaction_hash = 4

uint32log_index = 5

stringcontract = 6

stringevent_name = 7

stringtoken_id = 8

stringsubscriber = 9

PositionTransferEvent

uniswap.v4.PositionTransferEvent

stringid = 1

uint64block_number = 2

uint64block_timestamp = 3

stringtransaction_hash = 4

uint32log_index = 5

stringcontract = 6

stringevent_name = 7

stringfrom_address = 8

stringto_address = 9

stringtoken_id = 10

PositionUnsubscriptionEvent

uniswap.v4.PositionUnsubscriptionEvent

stringid = 1

uint64block_number = 2

uint64block_timestamp = 3

stringtransaction_hash = 4

uint32log_index = 5

stringcontract = 6

stringevent_name = 7

stringtoken_id = 8

stringsubscriber = 9

SwapEvent

uniswap.v4.SwapEvent

stringid = 1

uint64block_number = 2

uint64block_timestamp = 3

stringtransaction_hash = 4

uint32log_index = 5

stringcontract = 6

stringevent_name = 7

stringpool_id = 8

stringsender = 9

stringamount0 = 10

stringamount1 = 11

stringsqrt_price_x96 = 12

stringliquidity = 13

stringtick = 14

stringfee = 15

Show 15 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)