Skip to content

Latest commit

 

History

History
153 lines (118 loc) · 5.6 KB

README.md

File metadata and controls

153 lines (118 loc) · 5.6 KB
Raw

Oasis Explorer

CI build status CI test status CI lint status Release status Renovate enabled

Official explorer for the Oasis Network.

The official deployment of Oasis Explorer lives at https://explorer.oasis.io.

Development deploy is available at https://explorer.dev.oasis.io.

Features

  • Transaction History: Allows you to view the complete transaction history of a specific blockchain* address.
  • Block Contents: Enables you to examine the contents of individual blocks. This includes information like the transactions in the block, the total block size, and the block's hash data.
  • Transaction Verification: Lets you verify the status of a transaction. You can confirm whether a transaction has been validated by the network and included in a block.
  • Blockchain Statistics: Provides overall statistics regarding the blockchain* such as the total number of transactions, and the number of blocks already created.
  • Address Balance: Enables you to see the balance of any blockchain* address.
  • Network Nodes: Provides information about the nodes in the blockchain* network.
  • Search engine: Enables you to lookup tokens, addresses, names, blocks and transactions;
  • Non-Fungible Tokens (NFTs): Provides information about NFT ownership, metadata, transactions history and minting information. ( See more...)
  • Contract Reading and Writing (upcoming): Can read contract details and record new contract interactions.

*blockchain: ParaTime layer/s or Consensus

Getting started

Installing and running Oasis Explorer

You can quickly get started with the following commands:

yarn
yarn start

Then go to http://localhost:1234 to access the app.

Code style

This repository uses prettier as a code formatter and eslint for JavaScript/TypeScript linting.

It also lints git commits with gitlint and Markdown files with markdownlint.

You can use the following commands to run various linters:

# Lint JavaScript/TypeScript files across the whole repository.
yarn lint
# Fix JavaScript/TypeScript linting issues that were found.
yarn lint:fix

# Lint git commits.
yarn lint-git

# Lint Markdown files.
yarn lint-docs

Git Commit Messages

A quick summary:

  • Separate subject from body with a blank line.
  • Limit the subject line to 72 characters.
  • Capitalize the subject line.
  • Do not end the subject line with a period.
  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move component to..." not "Moves component to...").
  • Wrap the body at 80 characters.
  • Use the body to explain what and why vs. how.

A detailed post on Git commit messages: How To Write a Git Commit Message.

Oasis Nexus API

Deployed version is at https://nexus.oasis.io/v1/ with OpenAPI HTML and YAML specs.

Bleeding-edge API version

OpenAPI spec for the bleeding-edge version.

To quickly run latest emerald nexus locally without running a node, replace following lines with:

analysis:
  analyzers:
    - name: emerald_main_damask
      chain_id: oasis-3
      rpc: grpc.oasis.io:443
      chaincontext: b11b369e0da5bb230b220127f5e7b242d385ef8c6f54906243f30af63c815535
      # Use the latest round from oasisscan (easier than gRPC)
      # https://www.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000e2eaa99fc008f87f/roundList
      to: <latest round>
      from: <latest round - 500>

and run

make docker
make start-docker-e2e
# TODO: this needs to be updated with REACT_APP_TESTNET_API too
REACT_APP_API=http://localhost:8008/v1/ yarn start