NS-Indexer — NS-Protocol Indexer service in Rust
More information about the protocol can be found in the protocol documentation
Dependencies
- Bitcoin RPC server with
txindex
option enabled, don't need wallet. For example, run a regtest node:
- ScyllaDB as a database, run it in a docker container as development environment:
And then import the CQL schema https://github.com/ldclabs/ns-rs/tree/main/crates/ns-indexer/cql
Development
Run the indexer on local machine
Build:
Create .env
file from sample and edit it:
Run:
Build for production
Cross compile for linux:
Docker image
https://github.com/ldclabs/ns-rs/pkgs/container/ns-indexer
API Documentation
Here is the API documentation generated by Insomnia.
The mime type of the request and response in documentation is application/json
, but the real mime type is application/cbor
.