Aries Cloudagent plugins for the Universal Ledger Agent
This repository contains plugins to integrate Hyperledger Aries into the Universal Ledger Agent (ULA). The ULA is primarily meant for managing Self Sovereign Identity data. If you don't know what the ULA is check it out on the repository.
This repository uses Lerna to manage multiple NPM packages in one repository. To find usage information about one of the packages contained in this repository you should check the readme for that specific package. See the Packages entry in this file to see information about the packages in this repository.
Almost all packages in this repo use
@ula-aca/aries-cloudagent-interface. This packages provides an API to Aries Cloud Agent Python. This API is generated using the OpenAPI Schema (Swagger) from Aries Cloud Agent Python. However this schema is not representing the real API. A lot of types are not correct. Keep this in mind when using this package. Please open issues or pull requests with patches in the ula-aca/aries-cloudagent-interface-javascript repository when you find them.
All packages are placed in the packages/ directory.
| Package | Path | Description |
|---|---|---|
@ula-aca/connection |
./packages/connection |
Universal Ledger Agent plugin for creating and maintaining Aries Cloudagent connections with other agents |
@ula-aca/present-proof |
./packages/present-proof |
Universal Ledger Agent plugin for creating and receiving Aries Cloudagent Verifiable Presentations |
@ula-aca/schema |
./packages/schema |
Universal Ledger Agent plugin for creating and retrieving schemas from the ledger connected to Aries Cloudagent |
@ula-aca/ledger |
./packages/ledger |
Universal Ledger Agent plugin for performing ledger actions on the Aries Cloudagent |
@ula-aca/credential-definition |
./packages/credential-definition |
Universal Ledger Agent plugin for creating and retrieving credential definitions from the ledger connected to Aries Cloudagent |
@ula-aca/issue-credential |
./packages/issue-credential |
Universal Ledger Agent plugin for creating and receiving Aries Cloudagent Verifiable Credentials |
@ula-aca/wallet |
./packages/wallet |
Universal Ledger Agent plugin for managing the wallet in Aries Cloudagent |
@ula-aca/credential |
./packages/credential |
Universal Ledger Agent plugin for retrieving and removing Aries Cloudagent credentials issued to you |
@ula-aca/webhook-relay-event-router |
./packages/webhook-relay-event-router |
Universal Ledger Agent Plugin for receiving Aries Cloudagent Webhook Relay webhook events through a WebSocket connection |
@ula-aca/webhook-event-models |
./packages/webhook-event-models |
Helper package with base models for creating plugins that interact with Aries Cloudagent webhook events |
@ula-aca/core |
./packages/core |
Core module of ula-aca that contains code used by all plugins. Base plugin, error handling, etc... |
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
See CONTRIBUTING.md for more information.
- Set up VON Network
You need to run a Hyperledger Indy Node Network. The easiest way to do this is with the VON Network from BCGov.
See Running the Network Locally in the repo for up to date setup. Make sure Docker is installed and running.
git clone https://github.com/bcgov/von-network.git
cd von-network
./manage build
./manage start- Start Aries Cloud Agent with Webhook Relay
git clone https://github.com/ula-aca/ula-aca-plugins.git
cd ula-aca-plugins
docker-compose -f network-setup/docker-compose.yml up -d- Install NPM Dependencies
# inside ula-aca-plugins
yarn- Set up
.envfile
.env.example contains the correct setup for the docker-compose setup in the network-setup folder. .env will be automatically picked up by integration tests and examples.
cp .env.example .env| HOST | DESCRIPTION | |
|---|---|---|
| Faber | http://localhost:7002 | ACA-Py + Swagger UI |
| ws://localhost:7080/ws | Webhook Relay | |
| Alice | http://localhost:8002 | ACA-Py + Swagger UI |
| ws://localhost:8080/ws | Webhook Relay | |
| ACME | http://localhost:6002 | ACA-Py + Swagger UI |
| ws://localhost:6080/ws | Webhook Relay |
Besides unit testing with Mocha, the effectivity of all tests are also measured with the Stryker mutation testing framework.
Make sure the NPM dependencies are installed. VON Network, ACA-Py and .env setup are not needed for unit tests.
yarn test:unit
yarn test:strykerWe aim to achieve a coverage of 100%. Mocha test scores below 80% will fail the build. Stryker test scores do not have a threshold at the moment, but is planned to also fail below 80% in the future.
Integration tests are run against a real Aries Cloudagent. Make sure your environment is set up with Setting up Environment.
yarn test:integrationExamples are run against a real Aries Cloudagent. Make sure your environment is set up with Setting up Environment.
There are examples that demonstrate the working of a single plugin. These are available for ledger, schema, credential-definition, credential and wallet. Not all will work out of the box because previous interactions are needed.
You can run them with:
yarn example <ExampleName>
# e.g.
yarn example schema # works out of the boxThere is a full example available covering the Issuing and Holding and Proving between three parties. Faber College issues a college degree credential to Alice. Alice then proves to ACME Corp. that she possesses a college degree.
NOTE: The asciicasts are not in sync and sped up.
- Run Faber example and copy the created invitation
yarn example faber
- Run Alice example and paste copied invitation from Faber. After Alice connects with Faber and received a credential, Alice will create a new invitation. Copy this invitation.
yarn example alice
- Run ACME example and paste copied invitation from Alice. It should en with the event
START: Presentation received.
yarn example acme
This project was created in the context of a blockchain minor at the HU University of Applied Sciences Utrecht under guidance from Rabobank. The report Creating Hyperledger Aries Plugins for The Universal Ledger Agent describes why we chose to use Aries Cloud Agent - Python. You can read it here
apache-2.0 with a notice.
We discourage the use of this work in production environments as it is in active development and not mature enough.