Inscription Indexer

This project is an indexer for Bitcoin inscriptions, such as Ordinals, Satributes, and Runes. It uses Bitcoin Core's ZMQ notifications to get instant updates on new blocks and provides an API to query spendable UTXOs for a given wallet address.

Project Structure

inscription-indexer/
├── data/
├── src/
│   ├── indexer.js
│   ├── utxoController.js
├── .env
├── Dockerfile
├── docker-compose.yml
├── package.json
├── README.md

Setup

1. Clone the repository:

   git clone https://github.com/switch-900/inscription-indexer.git
   cd inscription-indexer

2. Create a .env file with your Bitcoin RPC credentials:

   BITCOIN_RPC_USER=your_rpc_user
   BITCOIN_RPC_PASSWORD=your_rpc_password

3. Build and start the Docker containers:

   docker-compose up -d --build

API

Get Spendable UTXOs

Endpoint: GET /api/spendable-utxos/:address

Example:

curl http://localhost:3000/api/spendable-utxos/your_wallet_address

License

This project is licensed under the MIT License.