Skip to content
This repository has been archived by the owner on Mar 7, 2023. It is now read-only.

Commit

Permalink
Tweaks to match how things are currently setup
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Curran <swcurran@gmail.com>
  • Loading branch information
swcurran committed Feb 6, 2019
1 parent d6753ad commit ff7000b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 15 deletions.
2 changes: 1 addition & 1 deletion GettingStartedTutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ That's it, you should be good to go. Time to test.

With that, you should have a pretty good idea of how VON issuer/verifier agents are configured and deployed. See the [agent configuration documentation](von-x-agent/config/README.md) for more details about all of the elements of the YAML files.

If you discover any problems in completing this tutorial, please let us know either by submitting an issue to the source GitHub repo, or by updating the files or documentation and submitting a Pull Request. If you want to compare your config files with our version of the completed tutorial, look at files in the folder [von-x-agent/testdata/completed](von-x-agent/testdata/completed).
If you discover any problems in completing this tutorial, please let us know either by submitting an issue to the source GitHub repo, or by updating the files or documentation and submitting a Pull Request.

### Next Steps

Expand Down
19 changes: 5 additions & 14 deletions von-x-agent/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ This folder contains the files used to configure a VON Issuer/Verifier. If you a
- [File: settings.yml](#file-settingsyml)
- [File: routes.yml](#file-routesyml)
- [File: services.yml](#file-servicesyml)
- [The Config Files Generator](#the-config-files-generator)

## Summary: The Configuration Files

Expand All @@ -34,20 +33,16 @@ The following is a simple `schemas.yml` file with a single credential having a s
- name: my-permit.my-organization.ca
version: '1.0.2'
attributes:
corp_num:
label_en: Corporate Number
description_en: Corporate Number issued by the Registries
required: true
- corp_num
- legal_name
```
The following are notes about the example file above and `schemas.yml` files in general.
Pretty simple! The following are notes about the example file above and `schemas.yml` files in general.

- The entire `name` structure should be repeated for each type of Credential that is to be Issued by the Agent.
- The elements `name`, `version` and the `attributes` list (e.g. `corp_name` in the above example) correspond exactly to those same elements in a Hyperledger Indy schema. If the Indy schema structure evolves, the VON schema structure in this file will evolve to match.
- The entire `name` structure is repeated for each type of Credential that is to be Issued by the Agent.
- The elements `name`, `version` and the `attributes` list (e.g. `corp_name` in the above example) correspond exactly to those same elements in a Hyperledger Indy schema. If the Indy schema structure evolves, the VON schema structure in this file will likely evolve to match.
- The sub-elements within each `attribute` (`label_en`, etc.) are used in VON - they do not flow to the Hyperledger Indy schema.
- The "_en" fields are localized (in this case for English). You can pass additional fields with different suffixes for other languages (e.g. "_fr") to enable localized presentation in OrgBook.

A config file generator has been created that can be used to derive sections of the `services.yml` and `routes.yml` files from the `schemas.yml` file. That is done by adding some extra fields in this file (that are ignored by the VON Agent code). Those extra fields are documented in the section below on the config file generator.


On Agent startup, the Agent reads the `schemas.yml` file and looks in it's Wallet for the corresponding Credential Definitions and Schemata. If it does not find them, the Agent publishes them to the Ledger.
- **Note**: VON Agent currently assumes that the Agent itself will always publish the Schema to the Ledger. **TO DO** Confirm this.
Expand Down Expand Up @@ -340,7 +335,3 @@ proof_requests:
- The `schemas` is a list of Hyperledger Indy schema keys (DID of the creator of the schema, it's name and version) and an optional list of attributes to be included in the Proof Requests.
- While not currently supported, we expect to add support for zero knowledge proofs of specific claims - e.g. that a date is less than 5 years ago without revealing the date itself.
- If no attributes are provided, the proof request is still performed to prove that the necessary Credential is held without revealing the contents of the Credential.

## The Config Files Generator

To Do: Add this...

0 comments on commit ff7000b

Please sign in to comment.