Skip to content

feat(p2p/sensor): add ClickHouse database backend #961

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
minhd-vu wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(p2p/sensor): add ClickHouse database backend #961

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a28f22a
feat(p2p/sensor): add ClickHouse database backend
minhd-vu Jul 17, 2026
c15f618
feat(p2p/sensor): store full block header in ClickHouse
minhd-vu Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions cmd/p2p/sensor/sensor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ type (
TrustedNodesFile string
ProjectID string
DatabaseID string
ClickHouseDSN string
SensorID string
MaxPeers int
MaxDatabaseConcurrency int
Expand Down Expand Up @@ -483,6 +484,21 @@ func newDatabase(ctx context.Context) (database.Database, error) {
ShouldWritePeers: inputSensorParams.ShouldWritePeers,
TTL: inputSensorParams.TTL,
}), nil
case "clickhouse":
return database.NewClickHouse(ctx, database.ClickHouseOptions{
DSN: inputSensorParams.ClickHouseDSN,
SensorID: inputSensorParams.SensorID,
ChainID: inputSensorParams.NetworkID,
MaxConcurrency: inputSensorParams.MaxDatabaseConcurrency,
ShouldWriteBlocks: inputSensorParams.ShouldWriteBlocks,
ShouldWriteBlockEvents: inputSensorParams.ShouldWriteBlockEvents,
ShouldWriteFirstBlockEvent: inputSensorParams.ShouldWriteFirstBlockEvent,
ShouldWriteTransactions: inputSensorParams.ShouldWriteTransactions,
ShouldWriteTransactionEvents: inputSensorParams.ShouldWriteTransactionEvents,
ShouldWriteFirstTransactionEvent: inputSensorParams.ShouldWriteFirstTransactionEvent,
ShouldWritePeers: inputSensorParams.ShouldWritePeers,
TTL: inputSensorParams.TTL,
}), nil
case "json":
return database.NewJSONDatabase(database.JSONDatabaseOptions{
SensorID: inputSensorParams.SensorID,
Expand All @@ -508,6 +524,8 @@ func init() {
flag.MarkFlagsRequired(SensorCmd, "network-id")
f.StringVarP(&inputSensorParams.ProjectID, "project-id", "p", "", "GCP project ID")
f.StringVarP(&inputSensorParams.DatabaseID, "database-id", "d", "", "datastore database ID")
f.StringVar(&inputSensorParams.ClickHouseDSN, "clickhouse-dsn", "",
"ClickHouse DSN, e.g. clickhouse://user:pass@host:9000/sensor (used with --database=clickhouse)")
f.StringVarP(&inputSensorParams.SensorID, "sensor-id", "s", "", "sensor ID when writing block/tx events")
flag.MarkFlagsRequired(SensorCmd, "sensor-id")
f.IntVarP(&inputSensorParams.MaxPeers, "max-peers", "m", 2000, "maximum number of peers to connect to")
Expand Down Expand Up @@ -564,6 +582,7 @@ will result in less chance of missing data but can significantly increase memory
f.StringVar(&inputSensorParams.Database, "database", "none",
`which database to persist data to, options are:
- datastore (GCP Datastore)
- clickhouse (ClickHouse, see --clickhouse-dsn)
- json (output to stdout)
- none (no persistence)`)
f.BoolVar(&inputSensorParams.NoDiscovery, "no-discovery", false, "disable P2P peer discovery")
Expand Down
26 changes: 17 additions & 9 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,25 @@ require (
require github.com/alecthomas/participle/v2 v2.1.4

require (
github.com/ClickHouse/ch-go v0.73.0 // indirect
github.com/ProjectZKM/Ziren/crates/go-runtime/zkvm_runtime v0.0.0-20251213223233-751f36331c62 // indirect
github.com/andybalholm/brotli v1.2.1 // indirect
github.com/chromedp/sysutil v1.1.0 // indirect
github.com/containerd/errdefs v1.0.0 // indirect
github.com/containerd/errdefs/pkg v0.3.0 // indirect
github.com/containerd/log v0.1.0 // indirect
github.com/crate-crypto/go-eth-kzg v1.5.0 // indirect
github.com/dgryski/go-farm v0.0.0-20200201041132-a6ae2369ad13 // indirect
github.com/distribution/reference v0.6.0 // indirect
github.com/docker/go-connections v0.4.0 // indirect
github.com/docker/go-connections v0.7.0 // indirect
github.com/docker/go-units v0.5.0 // indirect
github.com/emicklei/dot v1.6.2 // indirect
github.com/ethereum/c-kzg-4844/v2 v2.1.6 // indirect
github.com/ethereum/go-bigmodexpfix v0.0.0-20250911101455-f9e208c548ab // indirect
github.com/ferranbt/fastssz v0.1.4 // indirect
github.com/fjl/jsonw v0.1.0 // indirect
github.com/gdamore/encoding v1.0.1 // indirect
github.com/go-faster/city v1.0.1 // indirect
github.com/go-faster/errors v0.7.1 // indirect
github.com/go-json-experiment/json v0.0.0-20260214004413-d219187c3433 // indirect
github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
github.com/gobwas/httphead v0.1.0 // indirect
Expand All @@ -66,11 +69,15 @@ require (
github.com/morikuni/aec v1.0.0 // indirect
github.com/opencontainers/go-digest v1.0.0 // indirect
github.com/opencontainers/image-spec v1.1.1 // indirect
github.com/paulmach/orb v0.13.0 // indirect
github.com/pierrec/lz4/v4 v4.1.27 // indirect
github.com/pion/dtls/v3 v3.1.2 // indirect
github.com/pion/logging v0.2.4 // indirect
github.com/pion/stun/v3 v3.1.2 // indirect
github.com/pion/transport/v4 v4.0.1 // indirect
github.com/sagikazarmark/locafero v0.11.0 // indirect
github.com/segmentio/asm v1.2.1 // indirect
github.com/shopspring/decimal v1.4.0 // indirect
github.com/sourcegraph/conc v0.3.1-0.20240121214520-5f936abd7ae8 // indirect
github.com/spf13/afero v1.15.0 // indirect
github.com/spf13/cast v1.10.0 // indirect
Expand Down Expand Up @@ -119,7 +126,7 @@ require (
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/ipfs/go-cid v0.4.1 // indirect
github.com/jackpal/go-nat-pmp v1.0.2 // indirect
github.com/klauspost/compress v1.18.0 // indirect
github.com/klauspost/compress v1.18.6 // indirect
github.com/klauspost/cpuid/v2 v2.2.8 // indirect
github.com/kr/pretty v0.3.1 // indirect
github.com/kr/text v0.2.0 // indirect
Expand Down Expand Up @@ -148,8 +155,8 @@ require (
github.com/shirou/gopsutil v3.21.11+incompatible // indirect
github.com/spaolacci/murmur3 v1.1.0 // indirect
github.com/supranational/blst v0.3.16 // indirect
github.com/tklauser/go-sysconf v0.3.14 // indirect
github.com/tklauser/numcpus v0.9.0 // indirect
github.com/tklauser/go-sysconf v0.4.0 // indirect
github.com/tklauser/numcpus v0.12.0 // indirect
github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
go.opencensus.io v0.24.0 // indirect
Expand All @@ -169,6 +176,7 @@ require (
require (
cloud.google.com/go/kms v1.31.0
github.com/0xPolygon/cdk-contracts-tooling v0.0.1
github.com/ClickHouse/clickhouse-go/v2 v2.47.0
github.com/btcsuite/btcd/btcutil v1.2.0
github.com/chromedp/cdproto v0.0.0-20260321001828-e3e3800016bc
github.com/chromedp/chromedp v0.15.1
Expand Down Expand Up @@ -221,8 +229,8 @@ require (
github.com/yusufpapurcu/wmi v1.2.4 // indirect
go.etcd.io/bbolt v1.4.0-alpha.0.0.20240404170359-43604f3112c5 // indirect
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.67.0 // indirect
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.67.0 // indirect
go.opentelemetry.io/otel v1.43.0 // indirect
go.opentelemetry.io/otel/metric v1.43.0 // indirect
go.opentelemetry.io/otel/trace v1.43.0 // indirect
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.69.0 // indirect
go.opentelemetry.io/otel v1.44.0 // indirect
go.opentelemetry.io/otel/metric v1.44.0 // indirect
go.opentelemetry.io/otel/trace v1.44.0 // indirect
)
Loading
Loading