@owstack/ows-explorer

OWS Explorer

A blockchain explorer web application service for the following:

• Bch Node using the Bch Explorer API.
• Btc Node using the Btc Explorer API.

Quick Start

Please see the guide at TBS for information about getting a block explorer running. This is only the front-end component of the block explorer, and is packaged together with all of the necessary components in the following:

• Bch
• Btc

Getting Started

To manually install all of the necessary components, you can run these commands:

npm install -g @owstack/btc-node
btcnode create mynode
cd mynode
btcnode install ows-explorer
btcnode start

Open a web browser to http://localhost:3001/explorer/

Development

To brand and build OWS Explorer locally:

$ npm run apply:ows-explorer

A watch task is also available:

$ npm run watch

Configuring nodes

By default, the explorerConfig in package.json is as follows. The explorer will connect to its own host for blockchain data.

  "explorerConfig": {
    "routePrefix": "explorer",
    "fullNodes": [
      {
        "url": "",
        "apiPrefix": "explorer-api"
      }
    ]
  }

To change these settings configure your OWS node (e.g., see ~./btc-node.json on your OWS node host). The following will connect the explorer to a remote node for blockchain data.

{
  "network": "livenet",
  "port": 3001,
  "services": [
    "ows-explorer",
    "web"
  ],
	"servicesConfig": {
    "ows-explorer": {
      "routePrefix": "explorer",
      "fullNodes": [
        {
          "url": "http://example.com:3001",
          "apiPrefix": "explorer-api"
        }
      ]
    }
	}
}

The explorer can connect to multiple nodes, each providing backend services for different blockchains.

{
  "network": "livenet",
  "port": 3001,
  "services": [
    "ows-explorer",
    "web"
  ],
	"servicesConfig": {
    "ows-explorer": {
      "routePrefix": "explorer",
      "fullNodes": [
        {
          "url": "http://btc.example.com:3001",
          "apiPrefix": "explorer-api"
        },
        {
          "url": "http://bcc.example.com:3001",
          "apiPrefix": "explorer-api"
        }
      ]
    }
	}
}

Multilanguage support

OWS Explorer uses angular-gettext for multilanguage support.

To enable a text to be translated, add the translate directive to html tags. See more details here. Then, run:

grunt compile

This action will create a template.pot file in po/ folder. You can open it with some PO editor (Poedit). Read this guide to learn how to edit/update/import PO files from a generated POT file. PO file will be generated inside po/ folder.

If you make new changes, simply run grunt compile again to generate a new .pot template and the angular javascript js/translations.js. Then (if use Poedit), open .po file and choose update from POT File from Catalog menu.

Finally changes your default language from www/src/js/config

gettextCatalog.currentLanguage = 'es';

This line will take a look at any *.po files inside po/ folder, e.g. po/es.po, po/nl.po. After any change do not forget to run grunt compile.

Note

For more details about the Explorer API configuration and end-points, go to Explorer API GitHub repository.

Contribute

Contributions and suggestions are welcomed at the OWS Explorer GitHub repository.

License

Code released under the MIT license.

Copyright 2017 Open Wallet Stack.