Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typos in the demo's README.md #1405

Merged
merged 1 commit into from
Sep 9, 2021
Merged

Typos in the demo's README.md #1405

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions demo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,13 +176,13 @@ When ready to test the credentials exchange protocols, go to the Faber prompt, e

You don't need to do anything with Alice's agent - her agent is implemented to automatically receive credentials and respond to proof requests.

Note there is an option "2a" to initiate a connectionless proof - you can execute this option but it woll only work end-to-end when [connecting to Faber from a mobile agent](AliceGetsAPhone.md).
Note there is an option "2a" to initiate a connectionless proof - you can execute this option but it will only work end-to-end when [connecting to Faber from a mobile agent](AliceGetsAPhone.md).

## Additional Options in the Alice/Faber demo

You can enable support for various aca-py features by providing additional command-line arguements when starting up `alice` or `faber`.
You can enable support for various ACA-Py features by providing additional command-line arguements when starting up `alice` or `faber`.

Note that when the controller starts up the agent, it prints out the aca-py startup command with *all* parameters - you can inspect this command to see what parameters are provided in each case. For more details on the parameters, just start aca-py with the `--help` parameter, for example:
Note that when the controller starts up the agent, it prints out the ACA-Py startup command with *all* parameters - you can inspect this command to see what parameters are provided in each case. For more details on the parameters, just start ACA-Py with the `--help` parameter, for example:

```
./scripts/run_docker start --help
Expand All @@ -200,7 +200,7 @@ Note that you don't specify this option with `alice` because it's only applicabl

You need to run a revocation registry in order to support revocation - the details are described in the [Alice gets a Phone](https://github.com/hyperledger/aries-cloudagent-python/blob/master/demo/AliceGetsAPhone.md#run-an-instance-of-indy-tails-server) demo instructions.

Faber will setup support for revocatiom automatically, and you will see an extra option in faber's menu to revoke a credential:
Faber will setup support for revocation automatically, and you will see an extra option in faber's menu to revoke a credential:

```
(1) Issue Credential
Expand Down Expand Up @@ -234,7 +234,7 @@ Note that you need to Publish the revocation information to the ledger. Once yo

### DID Exchange

You can enable DID Exchange using the `--did-exchange` parameter for the `alice` and `faber` demo's.
You can enable DID Exchange using the `--did-exchange` parameter for the `alice` and `faber` demos.

This will use the new DID Exchange protocol when establishing connections between the agents, rather than the older Connection protocol. There is no other affect on the operation of the agents.

Expand Down Expand Up @@ -283,7 +283,7 @@ Alice:
(X) Exit?
```

When you create a new wallet, you just need to provide the wallet name. (If you provide the name of an existing wallet then the controller will "activate" that wallet and make it the current wallet.)
When you create a new wallet, you just need to provide the wallet name. (If you provide the name of an existing wallet then the controller will "activate" that wallet and make it the current wallet.)

```
[1/2/3/4/W/T/X] w
Expand Down Expand Up @@ -329,10 +329,10 @@ Note that with multi-tenancy enabled:

- The "base" wallet will have access to this new "agency API" - the agent's admin key, if enabled, must be provided in a header
- "Base wallet" API calls are handled [here](https://github.com/hyperledger/aries-cloudagent-python/blob/244194e68330835e5e2e53cc6c2993899d2437fb/demo/runners/support/agent.py#L606)
- The "sub-wallets" will have access to the "normal" aca-py admin API - to identify the sub-wallet, a JWT token must be provided, this token is created upon creation of the new wallet (see: [this code here](https://github.com/hyperledger/aries-cloudagent-python/blob/master/demo/runners/support/agent.py#L378))
- The "sub-wallets" will have access to the "normal" ACA-Py admin API - to identify the sub-wallet, a JWT token must be provided, this token is created upon creation of the new wallet (see: [this code here](https://github.com/hyperledger/aries-cloudagent-python/blob/master/demo/runners/support/agent.py#L378))
- "Sub-wallet" API calls are handled [here](https://github.com/hyperledger/aries-cloudagent-python/blob/244194e68330835e5e2e53cc6c2993899d2437fb/demo/runners/support/agent.py#L632)

Documentation on aca-py's multi-tenancy support can be found [here](https://github.com/hyperledger/aries-cloudagent-python/blob/master/Multitenancy.md).
Documentation on ACA-Py's multi-tenancy support can be found [here](https://github.com/hyperledger/aries-cloudagent-python/blob/master/Multitenancy.md).

### Multi-tenancy *with Mediation*!!!

Expand Down