How to setup Faber/Alice for revocable credentials

[cvarjao]

The best way to get started quickly is by following the instructions for the "Alice Gets a Mobile Agent " demo on the Aries Cloud Agent Python (ACA-Py) repo specifically following the instructions for "Running Locally in Docker"

Required Dependencies:

• docker
• ngrok

Mac

Step 1. Clone the ACA-Py repo

Open a terminal, clone the ACA-Py repo and navigate to the /demo folder

git clone https://github.com/hyperledger/aries-cloudagent-python.git

cd aries-cloudagent-python/demo

Step 2. Setup and run ngrok

See the instructions here for how to do that. You'll want to do this in another terminal.

ngrok http 8020

Step 3. Setup and run an Indy Tails Server

Open another terminal, clone the Indy Tails Server repo, navigate to the /docker folder and run the commands to build and run the Indy Tails Server container

git clone https://github.com/bcgov/indy-tails-server.git

cd indy-tails-server/docker

./manage build

./manage start

See more instructions here for how to do this.

Step 4. Run the Faber demo

In the previous terminal where you had cloned ACA-Py. Run the Faber demo using the following command:

TAILS_NETWORK=docker_tails-server LEDGER_URL=http://test.bcovrin.vonx.io ./run_demo faber --aip 10 --revocation --events

It will take some time to have the demo completely up and running. In the meantime you will see a bunch of output in the console/terminal. When the demo is ready you will see a scannable QR code to connect to Faber from the Mobile Wallet. Once the QR code is scanned a connection is successfully established to your mobile wallet you will see an interactive output that looks like:

    (1) Issue Credential
    (2) Send Proof Request
    (2a) Send *Connectionless* Proof Request (requires a Mobile client)
    (3) Send Message
    (4) Create New Invitation
    (5) Revoke Credential
    (6) Publish Revocations
    (T) Toggle tracing on credential/proof exchange
    (X) Exit?                                                                                                                                                                                                                                                                                          
[1/2/3/4/5/6/T/X] 

Note: The options may change since the time of this writing.

Step 5. Try different operations:

See the instructions here for some of the operations you can perform between Faber and the Mobile Wallet such as: Issuing a Credential, Sending a Proof Request, etc.

Windows

Instructions should be largely the same as for Mac

Troubleshooting

A common error that occurs is the Faber demo is run without setting up an Indy Tails Server. In the event this happens you may see the following error output when running ACA-Py which is a good indicator the Indy Tails Server is not running:

Faber      | 2022-03-07 20:06:14,377 aries_cloudagent.core.event_bus ERROR Error occurred while processing event

EVENT: Response from POST /credential-definitions received: 
{
    "credential_definition_id": "5m6VHPrFtxZedfPKrWkY2e:3:CL:164163:faber.agent.degree_schema"
}
Faber      | Traceback (most recent call last):
Faber      |   File "/home/indy/aries_cloudagent/core/event_bus.py", line 120, in notify
Faber      |     await processor()
Faber      |   File "/home/indy/aries_cloudagent/revocation/routes.py", line 1264, in on_revocation_tails_file_event
Faber      |     f"Tails file for rev reg {revoc_reg_id} failed to upload: {reason}"
Faber      | aries_cloudagent.revocation.error.RevocationError: Tails file for rev reg 5m6VHPrFtxZedfPKrWkY2e:4:5m6VHPrFtxZedfPKrWkY2e:3:CL:164163:faber.agent.degree_schema:CL_ACCUM:2eab46dd-5fed-454f-a8f1-ce49640971e7 failed to upload: Exceeded maximum put attempts

Note: At the time of this writing, revocation notification messages are not currently supported in the Mobile Wallet.