Skip to content

Latest commit

 

History

History
120 lines (83 loc) · 3.18 KB

README.md

File metadata and controls

120 lines (83 loc) · 3.18 KB
Raw

The demo project in aries-cloudagent-python wasn't super helpful for me in understanding the relationship between the agent and the agent controller for the actual service. So, I put together this practice environment for my team and clients to use for educational and exercise purposes. Hopefully, this repository will be helpful to beginners, especially in the context of aca-py multitenancy.

setup guide

register an endorser DID

register an endorser DID with seed on https://test.bcovrin.vonx.io and remember that seed.

setup environment variables

Copy env.template to .env

cp env.template .env

Edit .env

vi .env

You need only two options to edit.

  • ISSUER_PUBLIC_DID_SEED='seed for a endorser that already registered above'
  • SCHEMA_VERSION='whatever you want in semver format but not registered on ledger yet'

build docker images

docker compose build

run base containers

docker compose up -d

run setup

Wait a few seconds for all containers is up

docker compose exec setup python3 setup.py

re-run containers to apply environment veriables

docker compose down
docker compose up -d

environment is ready now.

how to use

ports explained

  • port 8000 multi tenent agency itself
  • port 8001 multi tenant controller api service
  • port 8002 holder agent controller
  • port 8003 issuer agent controller
  • port 8004 verifier agent controller

issue credential

# this will issue a credential through oob with attachment.
# nomally, holder should be received oob invitation in other ways.
# for example, holder could receives oob invitation from qr code.
# anyway, this is a simple demonstration of the issuance flow.

# this api will receive and accept a oob invitation from issuer.
# credential offer is attached in that invitation.
# being process that invitation, holder receives a credential from issuer. 
curl http://localhost:8002/issue-credential/1
curl http://localhost:8002/credentials
curl http://localhost:8002/connections
curl http://localhost:8002/issue-credential/records
curl http://localhost:8002/present-proof/records

# in issuer side, there is a credential exchange record with no connection.
# this is because isser made a oob invitation without handshake_protocols.
curl http://localhost:8003/issue-credential/records
curl http://localhost:8003/connections

present proof

# this will present a proof through connection-less present proof

# this api will receive and accept a oob invitation from verifier.
# presentation request is attached in that invitation.
# holder build a proof of that request and send it to verifier.
curl http://localhost:8002/present-proof/1
curl http://localhost:8002/credentials
curl http://localhost:8002/connections
curl http://localhost:8002/issue-credential/records
curl http://localhost:8002/present-proof/records

# verifier has no connection because it was connection-less present proof
# while verifier got a present-proof record.
curl http://localhost:8004/present-proof/records
curl http://localhost:8004/connections

cleanup all

curl http://localhost:8002/all/clear
curl http://localhost:8003/all/clear
curl http://localhost:8004/all/clear