'OBE' (open-block-explorer)

Introduction

The Open Block Explorer (OBE) is the first OPEN SOURCE block explorer that is designed to support all EOSIO-based blockchains. This includes, amongst others, the following public and private chains: Telos, EOS, WAX, Ultra, Proton, UX and FIO.

Currently, the most-utilized Telos and EOSIO-based block explorers are feature-rich but closed source. This is problematic as it creates a central point of control (and failure), with no easy remedy, should those services be discontinued or otherwise restricted, essentially holding applications hostage that depend on those api endpoints for data and simultaneously abandoning users that rely on such services. This is the antithesis of decentralization. By developing an open-source explorer with an API utilizing an identical endpoint convention, anyone can clone and operate their own explorer and/or api without fear of losing service or access.

Because creating multiple versions of closed-source block explorers is a poor use of development resources for the EOSIO community, Telos has undertaken the task of developing an open-source, feature-rich block explorer that any EOSIO blockchain may deploy. The OBE-Project was kickstarted with resources of the Telos Core Developers (TCD) (Strategy/Architecture: Douglas Horn GoodBlock, Technical Design: Jesse Schulman CalEOS and Project Direction: Kersten Wirth) and further resources of the Telos Block Providers Persiantelos and nodenode (Lead by Rami James who is recognized for his UX/UI work for the EOS signer and wallet Scatter).

This project's aim is to contribute valuable code to the entire community. We are eager to accept useful pull requests, and welcome users and developers alike to submit feature requests and bug reports. While the first iterations are driven by the Telos Core Developers team, we are welcoming anybody who wishes to contribute and actively develop this open source solution for the EOSIO ecosystem!

Functional reference products

EOSIO based chains require specific components, of which various are historically managed within the various block explorers.

This includes following key features:

• Transaction log including extensive filter options
• Smart Contract verification
• Ressource management and staking (CPU, NET, RAM)
• REX staking / unstaking / savings
• Account power up
• Ressource trading (RAM)
• Multi-Signature (MSIG) setup and management
• Wallet functionality (non custodial), including transafer
• Permission and key managament (active / onwer)
• Chain and Block Provider (BP) statistics
• BP Voting and Governance
• Premium Name bids

Following, excelent products can be taken as reference points for further features:

• EOS Authority
• Blocks
• EOSX
• AJOR

Currently in development

Telos Mainnet: https://explorer.telos.net

Telos Testnet: https://explorer-test.telos.net

Installation

Install yarn package manager

Follow the installation instructions at: https://classic.yarnpkg.com/en/

Add Quasar CLI package

yarn global add @quasar/cli

Note regarding Node version from quasar docs

Do not use uneven versions of Node i.e. 13, 15, etc. These versions are not tested with Quasar and often cause issues due to their experimental nature. We highly recommend always using the LTS version of Node.

It is recommended to use Node version 14 if you experience issues running the application with other versions.

Using nvm: nvm use 14

Clone repo

git clone https://github.com/telosnetwork/open-block-explorer

Install the dependencies

cd open-block-explorer && yarn

Restore .env file & check that the correct endpoints are set

cp .env.example .env

Start the app in development mode (hot-code reloading, error reporting, etc.)

yarn dev

Run test suite

yarn test

Lint the files

yarn lint

Build the app for production

yarn build
cd dist/spa
quasar serve

app running at localhost:4000

Documentation

Configuring quasar.conf.js
Vue 2 documentation
Vue 3 documenation
Testing Quasar with Jest

Key Contributors