LaconicNetwork/vega-frontend-monorepo
3
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity
e0bcfe7bbe
vega-frontend-monorepo/apps/explorer/README.md
Dexter Edwards 9e82935658
Chore/more docs (#331) 
* chore renable prettier md files

* remove duplicated information, add instructions on running formatting

* add more docs for other apps a libraries

* correct numbering

* Missing applications

* correction for serving

* more docs
2022-05-03 16:32:31 +01:00

3.4 KiB
Raw Blame History

Explorer

Features

  • Transactions - Showing all transactions and decoded individual transactions
  • Search - Search for block number or transaction hash
  • Blocks - A list of the blocks on our chain and the transactions within each block
  • Assets - List of all assets on the Vega chain
  • Genesis - The initial Genesis configuration the network was started with
  • Governance - Current and past governance proposals
  • Markets - The markets currently open and expired on the Vega network
  • Network Parameters - The current network parameters
  • Parties - Searching for a specific party and the details for that party
  • Validators - The validator information in Vega and Tendermint

Development

First copy the configuration of the application you are starting:

cp .env.[environment] .env.local

Starting the app:

yarn nx serve explorer

Configuration

Example configurations are provided here:

There are a few different configuration options offered for this app:

Flag Purpose
NX_CHAIN_EXPLORER_URL The URL of the chain explorer service for decoding transactions
NX_TENDERMINT_URL The Tendermint REST URL for the Vega consesus engine
NX_TENDERMINT_WEBSOCKET_URL The Tendermint Websocket URL for the Vega consensus engine
NX_VEGA_URL The GraphQl query endpoint of a Vega data node
NX_VEGA_ENV The name of the currently connected vega environment
NX_VEGA_REST The REST URL for the Vega Data Node
NX_EXPLORER_ASSETS Enable the assets page for the explorer
NX_EXPLORER_GENESIS Enable the genesis page for the explorer
NX_EXPLORER_GOVERNANCE Enable the governance page for the explorer
NX_EXPLORER_MARKETS Enable the markets page for the explorer
NX_EXPLORER_NETWORK_PARAMETERS Enable the network parameters page for the explorer
NX_EXPLORER_PARTIES Enable the parties page for the explorer
NX_EXPLORER_VALIDATORS Enable the validators page for the explorer

Testing

To run the minimal set of unit tests, run the following:

yarn nx test explorer

To run the UI automation tests with a mocked API, run:

yarn nx run explorer-e2e:e2e