Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oasisprotocol/explorer

Official explorer for the Oasis Network.
https://github.com/oasisprotocol/explorer

blockchain crypto explorer oasis official paratime rose web

Last synced: 1 day ago
JSON representation

Official explorer for the Oasis Network.

Awesome Lists containing this project

README 

        
# Oasis Explorer



[![CI build status][github-ci-build-badge]][github-ci-build-link]

[![CI test status][github-ci-test-badge]][github-ci-test-link]

[![CI lint status][github-ci-lint-badge]][github-ci-lint-link]

[![Release status][github-release-badge]][github-release-link]

[![Renovate enabled][github-renovate-badge]][github-renovate-link]



Official explorer for the Oasis Network.



The official deployment of Oasis Explorer lives at .



Development deploy is available at .



## 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...](./docs/NFTs.md))

- **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:



```shell

yarn

yarn start

```



Then go to  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:



```bash

# 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  with OpenAPI

[HTML][nexus-html-spec] and [YAML][nexus-yaml-spec] specs.



Bleeding-edge API version



OpenAPI spec for the [bleeding-edge version][nexus-bleeding-edge-spec].



To quickly run latest emerald nexus locally without running a node,

[replace following lines][replace-lines-to-run-latest-emerald] with:



```yaml

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: 

      from: 

```



and run



```sh

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

```



[prettier]: https://prettier.io/

[eslint]: https://github.com/eslint/eslint

[gitlint]: https://jorisroovers.com/gitlint/

[markdownlint]: https://github.com/DavidAnson/markdownlint

[How To Write a Git Commit Message]: https://chris.beams.io/posts/git-commit/

[github-ci-build-badge]: https://github.com/oasisprotocol/explorer/actions/workflows/ci-build.yml/badge.svg

[github-ci-build-link]: https://github.com/oasisprotocol/explorer/actions?query=workflow:ci-build+branch:master

[github-ci-test-badge]: https://github.com/oasisprotocol/explorer/actions/workflows/ci-test.yml/badge.svg

[github-ci-test-link]: https://github.com/oasisprotocol/explorer/actions?query=workflow:ci-test+branch:master

[github-ci-lint-badge]: https://github.com/oasisprotocol/explorer/actions/workflows/ci-lint.yml/badge.svg

[github-ci-lint-link]: https://github.com/oasisprotocol/explorer/actions?query=workflow:ci-lint+branch:master

[github-release-badge]: https://github.com/oasisprotocol/explorer/actions/workflows/release.yml/badge.svg

[github-release-link]: https://github.com/oasisprotocol/explorer/actions?query=workflow:release

[github-renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg

[github-renovate-link]: https://www.mend.io/renovate/

[nexus-html-spec]: https://nexus.oasis.io/v1/spec/v1.html

[nexus-yaml-spec]: https://nexus.oasis.io/v1/spec/v1.yaml

[nexus-bleeding-edge-spec]: https://github.com/oasisprotocol/nexus/blob/main/api/spec/v1.yaml

[replace-lines-to-run-latest-emerald]: https://github.com/oasisprotocol/nexus/blob/d48de37/tests/e2e/config/e2e-dev.yml#L1-L8