This repository contains resources for implementers and organizations interested in connecting with the Ayra Trust Network. These resources include specifications, guides, tools, sample code, and conformance tests to help you understand and implement the requirements for interacting with the Ayra ecosystem.
The following links should load a Swagger UI rendering of the TRQP and TRQP Ayra Profile:
- TRQP v2.0
- Swagger YAML - RESTful API specification describing the required endpoints for any TRQP-compliant registry in the network.
- Profile - Ayra Authority Verification Profile required to register into the Ayra Trust Network.
- Implementers Guide - Comprehensive guide for connecting to the Ayra Trust Network.
- Playground Guide - Instructions for setting up and using the testing playground environment.
- TRQP Alignment - Information about how the Ayra TRQP Profile aligns with and informs the TRQP efforts.
- Integration Playbook - creates an (early at time of writing) playbook/framework for systems integrators to consider as they bring new or existing systems of record online using the TRQP.
- EGF DID Creator - Python tool to create an Ayra Profile-aligned DID for an ecosystem.
- DID Peer Utils - Utility functions for DID generation and resolution.
The playground provides a working example environment with sample implementations:
- Sample Trust Registry - Go implementation of a Trust Registry compliant with the TRQP specification.
- Sample Verifier - Python implementation of a verifier that can query the Trust Registry.
- API Conformance Test - Tool for testing compliance of a Trust Registry endpoint with the TRQP specification.
- DID Conformance Test - Tool for checking conformance of the Ecosystem DID being registered. (TODO)
- Ayra Authority Verification Profile Conformance Test - Tool for checking that an ecosystem is compliant to register in the Ayra Trust Network. (TODO)
- Read the Ayra Authority Verification Profile to see understand the basic verification requirements.
- Read the Implementers Guide to understand the core concepts of how to interact with the Ayra Trust Network according to your ecosystem.
- Set up the Playground to experiment with the sample implementations.
- Use the Tools to create and manage DIDs for your ecosystem.
- Run the Tests to validate your implementation against the Ayra Trust Network requirements.
We welcome contributions to improve these resources. Please see CONTRIBUTING for details on how to contribute.