Skip to content

NewCapital/TWIX-Explorer

Repository files navigation

TWIX Explorer v1.0.0 🌐

License

TWIX Explorer is a read-only web application to browse the content of the blockchain. The explorer supports searching for transactions, accounts, namespaces, tokens, and blocks information on a given network.


Features 💡

  • Explore recent block and transaction changes in real time.
  • View statistics such as block time differences, recommended fees multiplier, transaction per block and effective rental fees.
  • Easily search transactions, addresses, namespaces, tokens and blocks.
  • Browse block, transaction, account, namespace, token and node details.

Requirements 🧰

Node.js 8, 9 or 10 is required to run TWIX Explorer as a web application. It is recommended to install npm, the Node.js package manager. This can be done by executing the following command:

sudo apt install npm

Building instructions 🛠️

  1. Clone the project.
git clone https://github.com/NewCapital/TWIX-Explorer
  1. Navigate to the project folder.
cd TWIX-Explorer
  1. Install the dependencies. This may take a while.
npm install 
  1. Start the development server.
npm run dev 
  1. Visit http://localhost:8080/#/ in your browser.

Feature status 🖥️

Features currently working

  • Real-time display of recent blocks and transactions ✔️
  • Block information display ✔️
  • Transaction detail display ✔️
  • Account detail display ✔️
  • Namespace detial display ✔️
  • Token detail display ✔️
  • Block, transaction, account, token, namespace search ✔️
  • Statistics display (block time differences, transaction per block etc.) ✔️

Features currently not working

  • Nothing to report so far.

Main changes 🔧

  • Altered UI elements (header, footer, colors, text, icons) for a more appealing, consistent and coherent appearance.
  • Removed some irrelevant UI elements for less intrusive appearance.

Known issues ❗

  • Using the Grammarly extension for Google Chrome may cause unexpected behavior when double clicking certain UI elements (hyperlink items may become centered throughout the website).

Developer notes 🗒️

Architecture

  • /src/config: Handles the explorer configuration.
  • /src/infrastructure: Handles the API / SDK request from Symbol nodes.
  • /src/store: Handles the application logic with state management.
  • /src/views: Handles the UI of the explorer.

How to change the node list

The file /src/config/setup.json.mt contains the node list shown in the node selector dropdown.

  1. Edit peersApi.nodes array to set up the custom node list.
  2. Set peersApi.defaultNode property to the default node url.

About

SYMBOL-Based testnet explorer

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages