Skip to content

Commit

Permalink
Merge pull request #376 from swcurran/demo-instructions
Browse files Browse the repository at this point in the history
Tweaked instructions to separate messaging and exchanging credentials
  • Loading branch information
swcurran authored Feb 18, 2020
2 parents 90e5afb + 11c6d6c commit b676b08
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ There are several demos available for ACA-Py mostly (but not only) aimed at deve
- [Optional: Run a von-network ledger browser](#optional-run-a-von-network-ledger-browser)
- [Run the Alice and Faber Controllers/Agents](#run-the-alice-and-faber-controllersagents)
- [Follow The Script](#follow-the-script)
- [Exchanging Messages](#exchanging-messages)
- [Issuing and Proving Credentials](#issuing-and-proving-credentials)
- [Learning about the Alice/Faber code](#learning-about-the-alicefaber-code)
- [OpenAPI (Swagger) Demo](#openapi-swagger-demo)
- [Performance Demo](#performance-demo)
Expand Down Expand Up @@ -157,8 +159,12 @@ Alice:
x = Exit - stop and exit
```

#### Exchanging Messages

Feel free to use the "3" option to send messages back and forth between the agents. Fun, eh? Those are secure, end-to-end encrypted messages.

#### Issuing and Proving Credentials

When ready to test the credentials exchange protocols, go to the Faber prompt, enter "1" to send a credential, and then "2" to request a proof.

You don't need to do anything with Alice's agent - her agent is implemented to automatically receive credentials and respond to proof requests.
Expand All @@ -167,7 +173,7 @@ You don't need to do anything with Alice's agent - her agent is implemented to a

These Alice and Faber scripts (in the `demo/runners` folder) implement the controller and run the agent as a sub-process (see the documentation for `aca-py`). The controller publishes a REST service to receive web hook callbacks from their agent. Note that this architecture, running the agent as a sub-process, is a variation on the documented architecture of running the controller and agent as separate processes/containers.

The controllers for this demo can be found in the [alice.py](runners/alice.py) and [faber.py](runners/faber.py) files. You can watch [this video](https://zoom.us/recording/share/hfGCVMRsYWQcObOUjTQBd1vRxSH3sldO4QbEjWYjiS6wIumekTziMw) to get a start in understanding what is going on (and where) in the controllers.
The controllers for this demo can be found in the [alice.py](runners/alice.py) and [faber.py](runners/faber.py) files. Alice and Faber are instances of the agent class found in [agent.py](runners/support/agent.py).

## OpenAPI (Swagger) Demo

Expand Down

0 comments on commit b676b08

Please sign in to comment.