Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 8 additions & 121 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
# Esplora Block Explorer
# Bitgesell Stream Block Explorer

[![build status](https://api.travis-ci.org/Blockstream/esplora.svg)](https://travis-ci.org/Blockstream/esplora)
[![docker release](https://img.shields.io/docker/pulls/blockstream/esplora.svg)](https://hub.docker.com/r/blockstream/esplora)
[![MIT license](https://img.shields.io/github/license/blockstream/esplora.svg)](https://github.com/blockstream/esplora/blob/master/LICENSE)
[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![IRC](https://img.shields.io/badge/chat-on%20freenode-brightgreen.svg)](https://webchat.freenode.net/?channels=bitcoin-explorers)
<a href="https://bglstream.bitgesell.dev">
<img width="100%" height="50%" src="./preview.png" alt="Bitgesell Explorer" />
</a>

Block explorer web interface based on the [esplora-electrs](https://github.com/Blockstream/electrs) HTTP API.
Block explorer web interface based on the [esplora-electrs](https://github.com/naftalimurgor/bgl-electrs) HTTP API.

Written as a single-page app in a reactive and functional style using
[rxjs](https://github.com/ReactiveX/rxjs) and [cycle.js](https://cycle.js.org/).

See live at [Blockstream.info](https://blockstream.info/).
See live at [bglstream.bitgesell.dev](https://bglstream.bitgesell.dev/).

API documentation [is available here](API.md).

Join the translation efforts on [Transifex](https://transifex.com/blockstream/esplora/).

![Esplora](https://raw.githubusercontent.com/Blockstream/esplora/master/flavors/blockstream/www/img/social-sharing.png)

## Features

Expand Down Expand Up @@ -46,7 +41,7 @@ Join the translation efforts on [Transifex](https://transifex.com/blockstream/es
To start a development server with live babel/browserify transpilation, run:

```bash
$ git clone https://github.com/Blockstream/esplora && cd esplora
$ git clone https://github.com/naftalimurgor/bgl-stream && cd bgl-stream
$ npm install
$ export API_URL=http://localhost:3000/ # or https://blockstream.info/api/ if you don't have a local API server
# (see more config options below)
Expand Down Expand Up @@ -152,7 +147,7 @@ docker build -t esplora -f contrib/Dockerfile .

Alternatively, you may use the pre-built [`blockstream/esplora` image](https://hub.docker.com/r/blockstream/esplora) from Docker Hub.

## How to run the explorer for Bitcoin mainnet
## How to run the explorer for Bitgesell mainnet

```bash
docker run -p 50001:50001 -p 8080:80 \
Expand All @@ -161,114 +156,6 @@ docker run -p 50001:50001 -p 8080:80 \
bash -c "/srv/explorer/run.sh bitcoin-mainnet explorer"
```

## How to run the explorer for Liquid mainnet

```bash
docker run -p 50001:50001 -p 8082:80 \
--volume $PWD/data_liquid_mainnet:/data \
--rm -i -t esplora \
bash -c "/srv/explorer/run.sh liquid-mainnet explorer"
```

## How to run the explorer for Bitcoin testnet3

```bash
docker run -p 50001:50001 -p 8084:80 \
--volume $PWD/data_bitcoin_testnet:/data \
--rm -i -t esplora \
bash -c "/srv/explorer/run.sh bitcoin-testnet explorer"
```

## How to run the explorer for Bitcoin testnet4

```
docker run -p 50001:50001 -p 8084:80 \
--volume $PWD/data_bitcoin_testnet4:/data \
--rm -i -t esplora \
bash -c "/srv/explorer/run.sh bitcoin-testnet4 explorer"
```

## How to run the explorer for Bitcoin signet

```bash
docker run -p 50001:50001 -p 8084:80 \
--volume $PWD/data_bitcoin_signet:/data \
--rm -i -t esplora \
bash -c "/srv/explorer/run.sh bitcoin-signet explorer"
```

## How to run the explorer for Liquid testnet

```bash
docker run -p 50001:50001 -p 8096:80 \
--volume $PWD/data_liquid_testnet:/data \
--rm -i -t esplora \
bash -c "/srv/explorer/run.sh liquid-testnet explorer"
```

## How to run the explorer for Liquid regtest

```bash
docker run -p 50001:50001 -p 8092:80 \
--volume $PWD/data_liquid_regtest:/data \
--rm -i -t esplora \
bash -c "/srv/explorer/run.sh liquid-regtest explorer"
```

## How to run the explorer for Bitcoin regtest

```bash
docker run -p 50001:50001 -p 8094:80 \
--volume $PWD/data_bitcoin_regtest:/data \
--rm -i -t esplora \
bash -c "/srv/explorer/run.sh bitcoin-regtest explorer"
```

## Regtest options

When run for Bitcoin regtest or Liquid regtest, the esplora container will
create a default wallet and mine 100 blocks internally. You can disable this behavior
by setting `NO_REGTEST_MINING=1`.

## Docker config options

Set `-e DEBUG=verbose` to enable more verbose logging.

Set `-e NO_PRECACHE=1` to disable pre-caching of statistics for "popular addresses",
which may take a long time and is not necessary for personal use.

Set `-e NO_ADDRESS_SEARCH=1` to disable the [by-prefix address search](https://github.com/Blockstream/esplora/blob/master/API.md#get-address-prefixprefix) index.

Set `-e ENABLE_LIGHTMODE=1` to enable [esplora-electrs's light mode](https://github.com/Blockstream/electrs/#light-mode).

Set `-e ONION_URL=http://xyz.onion` to enable the `Onion-Location` header.

## Pull tor directly from Docker Hub - `blockstream/tor:latest`

Run: `docker -d --name hidden_service blockstream/tor:latest tor -f /home/tor/torrc` (could add a `-v /extra/torrc:/home/tor/torrc`, if you have a custom torrc)

Example torrc:

```plaintext
DataDirectory /home/tor/tor
PidFile /var/run/tor/tor.pid

ControlSocket /var/run/tor/control GroupWritable RelaxDirModeCheck
ControlSocketsGroupWritable 1
SocksPort unix:/var/run/tor/socks WorldWritable
SocksPort 9050

CookieAuthentication 1
CookieAuthFileGroupReadable 1
CookieAuthFile /var/run/tor/control.authcookie

Log [handshake]debug [*]notice stderr

HiddenServiceDir /home/tor/tor/hidden_service_v3/
HiddenServiceVersion 3
HiddenServicePort 80 127.0.0.1:80
```

## License

MIT
2 changes: 1 addition & 1 deletion client/index.pug
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ head
meta(charset='utf-8')
title= pageTitle
meta(property='og:title', content=process.env.OG_TITLE || process.env.SITE_TITLE || 'Block explorer')
meta(name='description', content=process.env.SITE_DESC || 'Esplora Block Explorer')
meta(name='description', content=process.env.SITE_DESC || 'BlockStream Bitgesell Explorer')

if canon_url
link(rel="canonical", href=canon_url)
Expand Down
6 changes: 3 additions & 3 deletions client/src/const.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ export const addrTxsPerPage = 25
export const blocksPerPage = 10
export const maxMempoolTxs = 50

export const nativeAssetId = process.env.NATIVE_ASSET_ID || '6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d'
export const nativeAssetLabel = process.env.NATIVE_ASSET_LABEL || 'BTC'
export const nativeAssetName = process.env.NATIVE_ASSET_NAME || 'Bitcoin'
export const nativeAssetId = process.env.NATIVE_ASSET_ID || '6f0279e9ed041c3d710a9f57d0c02928416460c4b722ae3457a11eec381c526d'
export const nativeAssetLabel = process.env.NATIVE_ASSET_LABEL || 'BGL'
export const nativeAssetName = process.env.NATIVE_ASSET_NAME || 'Bitgesell'

// Elements only
export const assetTxsPerPage = 25
Expand Down
10 changes: 5 additions & 5 deletions flavors/bitcoin-mainnet/config.env
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#!/bin/bash

export SITE_TITLE='Bitcoin Explorer'
export HOME_TITLE='Bitcoin Explorer'
export NATIVE_ASSET_LABEL=BTC
export NATIVE_ASSET_NAME=Bitcoin
export MENU_ACTIVE='Bitcoin'
export SITE_TITLE='Bitgesell Explorer'
export HOME_TITLE='Bitgesell Explorer'
export NATIVE_ASSET_LABEL=BGL
export NATIVE_ASSET_NAME=Bitgesell
export MENU_ACTIVE='BGL'
export BASE_HREF=${BASE_HREF:-'/'}
Binary file added preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified www/img/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.