cityofzion / dora Goto Github PK

HTML 0.39% CSS 17.16% TypeScript 69.22% JavaScript 0.13% SCSS 13.10%

react typescript redux-thunk blockchain-explorer blockchain neo

dora's Introduction

dora

React / TypeScript based block explorer for the NEO blockchain

dora is built on top of a new cross chain backend service, documentation for which can be found here and should be referenced for all contributors and future development.

Local development

npm run start Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Generating static documentation

Static documentation automatically gets parsed and generated on the client side based on the contents of /src/documentation/api.yaml in the develop branch built on top of swagger-ui-dist

Deployment to Develop and Production Environments

Merges made to the develop branch will automatically build and deploy to https://dora-dev.coz.io/ while updates to master will deploy https://dora.coz.io/

dora's People

Contributors

Stargazers

Watchers

Forkers

praneybehl michael-siek picarodias zidious uudens hecate2 switcheo vincentgeneste habibkarim

dora's Issues

Potential block "time" issue

It appears as though there are repeated block times on the details page =

"It shows 05:07:00 for me for blocks 4,541,483 through 4,541,492"

Detailed Designs for Chain Agnostic Navigation

This issue covers creation of detailed designs for chain agnostic seach.

Transactions list page

NOTE: the "filtering components" encapsulated in a separate issue => #13

endpoint to provide token balance history for an address

task to implement the historical token balance information for an address relates to #36

[foundational] Set up react router

placeholder for work involved with setting up client side routing

[data visualization] Address balance over the last thirty days

API Documentation publishing(Neo2)

This task covers the public presentation of the api documentation for the Neo2 endpoints.

[Feat] Component Dockerization

This feature dockerizes the necessary components to deploy a neoscan instance.

api documentation static site

This issue covers the building of a static site for rendering the api yaml file.

Relates to #45

Dora v0.3.0

Kanban: https://github.com/CityOfZion/neoscan-2/projects/3

Focus of this release will be to incorporate Neo3 functionality into the explorer

Neoscan Marketing Release Discussion

This product will be the first encounter with the new branding. It would be good to have a banner at the very least. We should also consider an article describing the core feature. I also believe we will need some explanation for the change to neoscan.

@deanragnarok do you have any thoughts?

[foundational] add font family to application

Blocked by not having sketch assets... Will add to source control once I get those

Dashboard contract invocations panel

Block details page

Block Sync Discussion

@hal0x2328 is working on chain sync checkout; This discussion issue will be used to track the progress and debugging of that initiative.

dora v0.0.2

General Discussion issue for release
Kanban: https://github.com/CityOfZion/neoscan-2/projects/2

[Feat] Cross-Chain Support Views and "Helpers"

When adding cross chain support, there are a number of helpers that can be implemented to make exploration easier

Examples:

When searching for an address, if it resolves on multiple chains, display that to the user

[Feat] Neo3 API enhancements

This feature covers a review of the enhancements to the neo3 api as well as improvements to accommodate architectural changes made during the neo2 development process as well as changes made to the neo3 platform.

[Feat] dashboard invocation count 24 hours

Enhancements to Navigation to support chain agnosticism

Dashboard block list

endpoint to provide contract invocations over past 30 days

task covering implementation of an endpoint which produces the historical contract invocation data
relates to #34

Design embelishments to extend neo branding

I would like to use this issue to discuss some design embelishments which give the explorer a bit more of a Neo feel without diverging too much from our awesome branding. The neo team is currently discussing how to define a common feel within the ecosystem while allowing the communities to retain their distinct branding. I would prefer that we are the ones proposing changes instead of waiting for them to try to impose them.

@deanragnarok @comountainclimber

API Hosting

This task will cover the transition of the API to hosting on aws under the coz.io domain.

The planned path pattern is as follows:
dora.coz.io/api/v2/{{blockchain}}/{{network}}/{{method}}

Example:
dora.coz.io/api/v2/neo2/mainnet/get_invocation_stats

Indexer exits randomly with no error

During indexing of blocks using the DynamoDBPublisher plugin, neo-cli will randomly exit, usually after several hours of uptime. There are no error messages printed on STDOUT/STDERR and the exit code is zero. Trying to determine if it is a .NET/C# issue or a system resources issue.

enhancements to get_transfer_history endpoint to support filtering

adds filtering support to the get_transfer_history endpoint to support #13

Transactions list page filtering mechanics / UI elements

Dora should allow users to filter data. This filter should be present in the transaction list and in the search results.

The filter UI elements will differ depending on the page.

The filter on the search page:

The filter on the transaction list:

We also need to update the API to support this filtering. I (@lock9) don't think we need to add Neo Legacy specific filters (transaction type).

Wallet address details page

Contract details page

Report endpoint for timeseries data to present block transaction data

This issue will cover implementation of a reporting endpoint to provide data for #4

Common search component / redux logic

Not found page/components

Documentation pages

Wallet addresses page

[data visualization] Contract invocations over past 30 days

contract invocation data heat endpoint

This task covers implementation of an endpoint presenting contract invocation heat for #31

Dashboard transaction list

README.md

It would probably be better to have something other than the default create react app README.md for this repo:

Includes details on CI confguration
Details on eslint / prettier conventions
Explanation of "what it does"

Indexer contract count doesn't match db snapshot contract count

The contract counts between the indexer's memory and the LevelDB snapshot get further out of sync as block height increases. For example as of block 1536922, the snapshot has 2168 contracts stored and the indexer's in-memory contract array has 2189. It may be that the indexer is picking up and adding contracts where the deployment failed for some reason.

Home page interactive chart

This epic includes issues related to the home screen dashboard/chart.
There are 2 charts combined, using the same data. One is a bar chart (purple), containing range data (smaller / bigger blocks), and the other, is a line chart, with the average amount of transactions on those blocks. By default, each data point represents 10 blocks. This issue does not include the final touches on the design, like shadows or the gradient in the column, but other aspects should be 'identical' (purple rounded columns)

100 datapoints representing 10 blocks. The Y-axis is represented by a rounded column, which displays the smallest and bigger block sizes (transactions).
Example: If the smaller blocks contain 0 transactions, and the bigger 4, the column will start on 4 and end on the 0.

Additional features:

Tooltip: when hovering over the chart, it is possible to see the value represented by the column (smaller block, bigger block, average transactions in that interval, and the block interval that it is covering. Note: It is not possible to follow the design in details
Example (texts to be updated):

Block #923,232 - 242
Smaller block: '0' (empty block)
Biggest block: '20'
Average block size: 4.5

Zoom:
It is possible to change the zoom in the chart. This changes the number of blocks per data point. There are 3 zoom levels: 100 blocks per data point, 10 blocks per data point, and 3 blocks per data point. This will show data about the latest 100.000, 1000, and 300 blocks respectively.
The values at the axis and the title must be updated to match the new interval.

TPS Counter:
Below the chart there is an informative box that shows the total number of transactions in that interval, and the TPS (transactions per second). The TPS is calculated by dividing the sum of total transactions in the interval, by the seconds in the interval. If this value is not provided by the API, we can assume that each block takes 15 seconds to be formed.