Versions Compared

Old Version 5

changes.mady.by.user Timo Glastra

Saved on

compared with

New Version 6

changes.mady.by.user Ian Costanzo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Stephen Curran – Cloud Compass Computing, Inc., ACA-Py Maintainer, Aries RFC Maintainer
  • Daniel Hardman - SICPA, Aries RFC Maintainer
  • Timo Glastra - Animo Solutions, Aries Framework JavaScript Maintainer, ACA-Py Contributor
  • Ian Costanzo - Anon Solutions, Indy SDK Contributor, ACA-Py Contributor, AATH Contributor

Project Structure

There are four key types of open source elements in the Hyperledger Aries project, as outlined below.

...

  • Legal

    • All code has been made available under the Apache License and is free of incompatible dependencies

      • Response: All Hyperledger Aries frameworks are Apache 2.0 Licenses.

    • Project name has been checked for trademark issues

      • Response: Checking was done at proposal time, and changes made accordingly. TO BE CONFIRMED.

  • Community support

    • The project must have an active and diverse set of contributing members representing various constituencies

      • Response: From the Aries Activity Dashboard, in the last 6 months, 9 different organizations made substantial contributions (by commit), with another 10% of the 1,493 commits coming from "Other" and "Unknown" organizations. 
      • Response: The Aries WG calls continue to draw a good crowd, remain at 1.5 hours per week, with each meeting filled with discussion from start to finish.
      • Response: There are many, many non-contributing organizations building on Aries protocols and open source projects.

    • 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)

      • Response: There is a solid base and a growing number of organizations involved in Aries development. 

    • Release plans are developed and executed in public by the community.

      • Response: The ongoing work in the Aries Working Group calls, in the Aries RFC, in the implemented AIP 1.0, and in the upcoming AIP 2.0 target demonstrates the release plans that have been made, executed and continue to be defined for 2021 and beyond. 

  • Sufficient test coverage
    The project must include a comprehensive unit and integration test suite and document its coverage. Additional performance and scale test capability is desirable.

    • Response: Aries Cloud Agent Python currently has (per a recent commit CI run) 2437 unit tests and coverage hovering around 99%. As well, Aries Agent Test Harness runs on demand and daily against main to run RFC protocol level test cases that cover all of AIP 1.0.
    • Response: The BC Gov team has a scalable infrastructure (built on Kubernetes) using multiple ACA-Py instances to issues millions of verifiable credentials in as short a time as possible. The most recent execution of that test demonstrated sustained performance of 1200/credentials per minute. The full test has not been run since new shared components (such as Aries Askar) have been available, but preliminary results suggest that the sustained performance will improve.
    • Response: Aries Framework Go has 89% unit test coverage (as reported by codecov) and additionally a suite of integration/bdd tests. AFG also includes tests against specification test suites (currently Verifiable Credential Data Model): Aries Framework Go Test Reports.

  • Sufficient user documentation
    The project must including enough documentation for anyone to test or deploy any of the modules.

    • Response: Aries Cloud Agent Python has sufficient documentation and documented demonstration scenarios that developers can have running code in a matter of minutes at the command line and API level. Demonstrations can be run using docker in the browser (using Play-With-Docker) to include ACA-Py to ACA-Py tests and tests using 3rd-party Aries mobile wallets downloaded from The App Store and Google Play.
    • Response: The Linux Foundation edX course "Becoming an Aries Developer" provides a sound grounding in the Aries development.
    • Response: There are a number of example Aries apps available for demonstration from organizations like BC Gov, Trinsic, Evernym.

  • Alignment

    • Requirements fulfillment
      The project must document what requirements and use cases it addresses.

      • Response: The Aries RFCs repository, clearly documents the use case and protocols Aries addresses. As well, there are a number of resources on the Internet that describes at a full range of levels the goals of Trust over IP, Self-Sovereign Identity (SSI) and related uses of Aries Agents. The COVID-19 pandemic and the need for trust information about testing and vaccine has brought Aries use cases to the mainstream.

    • Architecture
      The project must document how it fits within the Hyperledger Architecture

      • Response: To be determined.

    • Compatibility with other Hyperledger projects
      Where applicable, the project should be compatible with other active projects.

      • Response: ACA-Py, Aries Framework .NET and several other frameworks integrate closely with Hyperledger Indy and Ursa. Aries Framework Go enables pluggable DID methods and has implemented integrated a DID method implementation that uses : Hyperledger Fabric as it's its public ledger. In theory, Aries is agnostic to the ledger (other mechanism) on which is stored the necessary DIDs and cryptographic material to support verifiable credential exchange.

    • Release numbering: the project should use the Hyperledger standard release taxonomy, once that is agreed upon.

      • Response: All major Aries frameworks use semvar versioning schemes, with a long history of appropriately numbered releases. For example, Aries Cloud Agent Python had 11 releases in calendar 2020 and has had 5 minor releases since launch.
      • Response: The achievement and demonstration of AIP 1.0 conformance by multiple implementers was (in retrospect) sufficient to be declared "1.0".

    • Project must make a release, even a “developer preview”, before graduation.

      • Response: Each Aries framework will consider this and decide on how to transition to release 1.0.0.

  • Infrastructure

    • Gerrit or Github repo has been created

      • Done.

    • Mailing lists have been created and are archived

      • Done and active.

    • Other communication means used, such as slack channels, are set up

      • Done and extremely active.

    • Project is set up with Continuous Integration

      • Response: The major Aries frameworks all have full CI/CD and generate 

    • 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, etc)

      • Response: Most of the repolinter information is there for ACA-Py. Updates to ensure everything is there.

  • 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.

    • Response: ACA-Py has a full CI/CD implementation. Will verify that it meets the needs.

...