Move Hyperledger Explorer from incubation to active status
Overview of Proposal
The Hyperledger Explorer community would like to apply for the project to be moved from incubation to active status. Below outlines an assessment of the requirements of graduating from incubation status to active status and how Hyperledger Explorer meets minimum requirement. We believe we believe the project is ready for active status because:
- Diversity of Community and Contributors: Hyperledger Explorer (aka Blockchain Explorer) since the proposal back in 2016 has been extensively used, and improved by feedbacks, and raised issues feedbacks, and raised issues from the community.
- The project has been maintained by various contributors durring this period, and continue to be. On average there are more than 250 unique GitHub cloners weekly, and more than 100K pulls from the docker hub Docker Hub.
- There are many companies already using Hyperledger Explorer in production worldwide industries like: financial, banking institutions, educational, government, science, etc, but due to their non-disclosure policy we cannot collect that information.
- Release 1.0-rc1 Occurred recently in November 2019.
- Hyperledger Explorer is a valuable tool for exploring a Hyperledger Fabric permissioned blockchain.
- Easily configurable to connect to any Hyperledger Fabric network.
- Designed to implementation, and support other blockchain platforms.
- Integrated with PostgreSQL to search, and filter historical data.
- The Hyperledger Explorer has been participated in multiple hackfests, meetups, and others.
- Hyperledger Explorer links:
The assessment against the requirements can be found below, and the CII Best Practices.
Category | Requirement | Hyperledger Explorer Community Response |
Legal | All code has been made available under the Apache License and is free of incompatible dependencies | done |
Project name has been checked for trademark issues | ||
DCO check | done | |
License check | Jira assigned BE-723 | |
Community Support | The project must have an active and diverse set of contributing members representing various constituencies | Hyperledger Explorer has an active community, |
The project is not highly dependent on any single contributor (there are at least 3 legally independent committers and there is no single company or entity that is vital to the success of the project) | DTCC is the main organization that is contributing to Hyperledger Explorer, and actively contributors from Fujitsu. Past contributing organizations: Altoros, American Express, Blockchain Tecnalia, and other contributors. | |
Release plans are developed and executed in public by the community. | The releases of Hyperledger Explorer have been in a public forum available on the GitHub, Docker Hub, and RocketChat. We do communicate using Rocket Chat, and Zoom meeting, as needed. | |
Test | Sufficient test coverage | See below. |
The project must include a comprehensive unit and integration test suite and document its coverage. Additional performance and scale test capability is desirable. | Currently there are comprehensive unit, integration and acceptance tests with Hyperledger Explorer that are triggered by Azure Pipeline on pull requests by contributors. Merges to master are reviewed by approvers, and prevented if there are failing tests. | |
Documentation | Sufficient user documentation | Hyperledger Explorer team maintains a blockchain-explorer.readthedocs.io, and README.md documentation. |
The project must include enough documentation for anyone to test or deploy any of the modules. | Done. See above. | |
Alignment | Requirements fulfillment | Hyperledger Explorer team maintains a Jira that provides details on requirements, use cases, and other expectations for the project created from the community feedback and reported issues. |
The project must document what requirements and use cases it addresses. | Hyperledger Explorer team maintains a robust Documentation site that provides details on requirements, use cases, and other expectations for the project. | |
The project must document how it fits within the Hyperledger Architecture | Hyperledger Explorer was designed based on initial proposal initial proposal, and enhanced since the beginning of the project by the community feedback and reported issues in Jira. | |
Compatibility with other Hyperledger projects | Hyperledger Explorer is a tool that can be connected to any Hyperledger Fabric blockchain network, also it is designed to implement any other blockchain platform. The are are some potential projects that can be added as part of the Explorer, like Hyperledger Iroha. | |
Where applicable, the project should be compatible with other active projects. | This is a work in progress that we are excited to continue to engage with the community on. | |
Alignment | Release numbering: the project should use the Hyperledger standard release taxonomy, once that is agreed upon. | Hyperledger Explorer uses the appropriate naming taxonomy. |
Project must make a release, even a “developer preview”, before graduation. | The past releases and the respective documentation for Hyperledger Explorer can be found here. | |
Infrastructure | Github repo has been created | |
Mailing lists have been created and are archived | ||
Other communication means used, such as slack channels, are set up | ||
Project is set up with Continuous Integration | ||
All information necessary for someone to join the community and be able to start contributing is duly documented (location of repo, list of maintainers, mailing lists addresses, slack channels if used, etc) following the Hyperledger Project standard practice (CONTRIBUTING.md, MAINTAINERS.txt, SECURITY.md, etc) | We currently have documentation in the current Docs and Wiki site referenced above. | |
CII Badge | A team seeking to graduate from incubation shall have started the CII Badge application and be nearly complete with incomplete badge requirements referenced in their graduation proposal. 100% of the applicable criteria for the CII Badge is a requirement for releasing a 1.0 of the project. That does not mean the project must have 100% of all criteria, just 100% of the applicable criteria. This is to allow for projects such as test harnesses, that have “N/A” answers for questions that don't offer that as an option. | |
Other Considerations | Sufficient real world use The project should be used in real applications and not just in demos. Because not all real applications may be discussed publicly, in such cases statements providing as much detail as possible should be made. Sufficient scalability The project must demonstrate sufficient scalability and document its scalability over various dimensions such as:
Minimum test code coverage expected, such as, for example:
| There are many companies already using Hyperledger Explorer in production worldwide industries like: financial, banking institutions, educational, government, science, etc, but due to their non-disclosure policy we cannot collect that information. Scalability - Hyperledger Explorer has performed several monitoring and benchmarking assessments of explorer. We have tested and created "How to configure with Prometheus, and Grafana" instructions. The main dashboard page of the Hyperledger Explorer had a detailed metrics panel on the blocks, and transactions per hour, and minutes. |
Formal Proposal(s)
Move Hyperledger Explorer from incubation to active status
Action Items
- Type your task here, using "@" to assign to a user and "//" to select a due date
Reviewed By
- Angelo de Caro
- Arnaud J LE HORS
- Christopher Ferris
- Dan Middleton
- Gari Singh
- Hart Montgomery
- Mark Wagner (Deactivated)
- Nathan George
- Swetha Repakula
- Tracy Kuhrt
- Troy Ronda