A GO implementation for a BIP0352 Silent Payments Indexing Server. This backend was focused on serving the BlindBit light client suite with tweak data and other simplified data to spend and receive. The produced index matches other implementations.
The installation process is still very manual. Will be improved based on feedback and new findings. It is advised to look at the example blindbit.toml. As new config options appear they will be listed and explained there.
go build -o <path/to/new/binary/file> ./src
Create a config file blindbit.toml
in your data directory to run.
An example blindbit.toml is provided here.
The settings in regard to parallelization have to be made in accordance to the cores on the Full node and host machine.
Once the data directory is set up you can run it as following.
$ <path/to/new/binary/file> --datadir <path/to/datadir/with/blindbit.toml>
Note that the program will automatically default --datadir
to ~/.blindbit-oracle
if not set.
You still have to set up a config file in any case as the rpc users can't and should not be defaulted.
You can now also decide which index you want to run. This setting can be set in the config file (blindbit.toml).
No known issues.
GET("/block-height") // returns the height of the indexing server
GET("/tweaks/:blockheight?dustLimit=<sat_amount>") // returns tweak data (cut-through); optional parameter dustLimit can be omitted; filtering happens per request, so virtually any amount can be specified
GET("/tweak-index/:blockheight?dustLimit=<sat_amount>") // returns the full tweak index (no cut-through); optional parameter dustLimit can be omitted; filtering happens per request, so virtually any amount can be specified
GET("/spent-index/:blockheight") // returns the spent outpoints index (see https://github.com/setavenger/BIP0352-light-client-specification?tab=readme-ov-file#spent-utxos)
GET("/filter/spent/:blockheight") // returns a filter for shortened spent outpoint hashes (see https://github.com/setavenger/BIP0352-light-client-specification?tab=readme-ov-file#filters)
GET("/filter/new-utxos/:blockheight") // returns a custom taproot only filter of x-only pubkey which received funds
GET("/utxos/:blockheight") // UTXO data for that block (cut down to the essentials needed to spend)
This is roughly the space needed. Some changes were made to the indexing server but overall it should still be in this range.
709632 -> 834761
217M ./filters
2.7G ./utxos
16M ./headers-inv
12M ./headers
2.8G ./tweaks 33,679,543 tweaks
1.7G ./tweak-index 54,737,510 tweaks
7.4G .