Oasis Explorer

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.

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.dev: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