hydrant

build features

created 2 days ago :: modified 2 days ago :: 1.13 KB .md

Tools

download raw

hydrant has several optional compile-time features:

featuredefaultdescription
indexeryesmakes hydrant act as an indexer. incompatible with the relay feature.
indexer_streamyesenables the event stream for the indexer. requires indexer feature.
relaynomakes hydrant act as a relay. incompatible with the indexer feature.
backlinksnoenables the backlinks indexer and XRPC endpoints (blue.microcosm.links.*). requires indexer feature.
jetstreamnoenables the jetstream-compatible GET /subscribe websocket stream for indexer, ephemeral indexer, and relay builds. requires indexer_stream or relay. hydrant stores live-event metadata only; replay is bounded by normal event ttl in ephemeral/relay mode.
user-keyspacenoenables library API for creating keyspaces in the hydrant database. the API of the keyspace is exactly the same as the fjall version hydrant uses, no abstraction efforts are made.

to build with a specific feature:

cargo build --release --features backlinks