{"id":24562539,"url":"https://github.com/veriblock/vbk-ri-btc-explorer","last_synced_at":"2025-04-19T17:42:37.135Z","repository":{"id":45333684,"uuid":"295798579","full_name":"VeriBlock/vbk-ri-btc-explorer","owner":"VeriBlock","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-28T17:01:33.000Z","size":9005,"stargazers_count":0,"open_issues_count":5,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T10:51:23.303Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VeriBlock.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-15T17:16:01.000Z","updated_at":"2021-12-20T12:42:22.000Z","dependencies_parsed_at":"2022-09-14T20:03:22.016Z","dependency_job_id":null,"html_url":"https://github.com/VeriBlock/vbk-ri-btc-explorer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VeriBlock%2Fvbk-ri-btc-explorer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VeriBlock%2Fvbk-ri-btc-explorer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VeriBlock%2Fvbk-ri-btc-explorer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VeriBlock%2Fvbk-ri-btc-explorer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VeriBlock","download_url":"https://codeload.github.com/VeriBlock/vbk-ri-btc-explorer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249751577,"owners_count":21320330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-23T09:16:11.688Z","updated_at":"2025-04-19T17:42:37.097Z","avatar_url":"https://github.com/VeriBlock.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BTC RPC Explorer\n\n[![npm version][npm-ver-img]][npm-ver-url] [![NPM downloads][npm-dl-img]][npm-dl-url]\n\n\nSimple, database-free Bitcoin blockchain explorer, via RPC. Built with Node.js, express, bootstrap-v4.\n\nThis tool is intended to be a simple, self-hosted explorer for the Bitcoin blockchain, driven by RPC calls to your own bitcoind node. This tool is easy to run but lacks features compared to database-backed explorers.\n\nWhatever reasons one might have for running a full node (trustlessness, technical curiosity, supporting the network, etc) it's helpful to appreciate the \"fullness\" of your node. With this explorer, you can not only explore the blockchain (in the traditional sense of the term \"explorer\"), but also explore the functional capabilities of your own node.\n\nLive demo available at: [https://explorer.btc21.org](https://explorer.btc21.org)\n\n# Features\n\n* Network Summary \"dashboard\"\n* View details of blocks, transactions, and addresses\n* Analysis tools for viewing stats on blocks, transactions, and miner activity\n* See the raw JSON content returned by bitcoind that's used to generate most pages\n* Search by transaction ID, block hash/height, and address\n* Optional transaction history for addresses by querying from ElectrumX, blockchain.com, blockchair.com, or blockcypher.com\n* Mempool summary, with fee, size, and age breakdowns\n* RPC command browser and terminal\n\n# Changelog / Release notes\n\nSee [CHANGELOG.md](/CHANGELOG.md).\n\n# Getting started\n\n## Prerequisites\n\n1. Install and run a full, archiving node - [instructions](https://bitcoin.org/en/full-node). Ensure that your bitcoin node has full transaction indexing enabled (`txindex=1`) and the RPC server enabled (`server=1`).\n2. Synchronize your node with the Bitcoin network (you *can* use this tool while your node is still sychronizing, but some pages may fail).\n3. Install a \"recent\" version of Node.js (8+ recommended).\n\n## Install / Run\n\nIf you're running on mainnet with the default datadir and port, the default configuration should *Just Work*. Otherwise, see the **Configuration** section below.\n\n#### Install via `npm`:\n\n```bash\nnpm install -g btc-rpc-explorer\nbtc-rpc-explorer\n```\n\n#### Run from source:\n\n1. `git clone git@github.com:janoside/btc-rpc-explorer.git`\n2. `npm install`\n3. `npm start`\n\n\nUsing either method (`npm install` or run from source), after startup open [http://127.0.0.1:3002/](http://127.0.0.1:3002/)\n\n\n## Configuration\n\nConfiguration options may be set via environment variables or CLI arguments.\n\n#### Configuration with environment variables\n\nTo configure with environment variables, you need to create one of the 2 following files and enter values in it:\n\n1. `~/.config/btc-rpc-explorer.env`\n2. `.env` in the working directory for btc-rpc-explorer\n\nIn either case, refer to [.env-sample](.env-sample) for a list of the options and formatting details.\n\n#### Configuration with CLI args\n\nFor configuring with CLI arguments, run `btc-rpc-explorer --help` for the full list of options. An example execution is:\n\n```bash\nbtc-rpc-explorer --port 8080 --bitcoind-port 18443 --bitcoind-cookie ~/.bitcoin/regtest/.cookie\n```\n\n#### Demo site settings\n\nTo match the features visible on the demo site at [https://explorer.btc21.org](https://explorer.btc21.org) you'll need to set the following non-default configuration values:\n\n    BTCEXP_DEMO=true \t\t# enables some demo/informational aspects of the site\n    BTCEXP_NO_RATES=false\t\t# enables querying of exchange rate data\n    BTCEXP_SLOW_DEVICE_MODE=false\t# enables resource-intensive tasks (UTXO set query, 24hr volume querying) that are inappropriate for \"slow\" devices\n\n\n\n## Run via Docker\n\n1. `docker build -t btc-rpc-explorer .`\n2. `docker run -p 3002:3002 -it btc-rpc-explorer`\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveriblock%2Fvbk-ri-btc-explorer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveriblock%2Fvbk-ri-btc-explorer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveriblock%2Fvbk-ri-btc-explorer/lists"}