Endorser protocol configuration, automation and demo integration #1422

ianco · 2021-09-23T22:18:44Z

See issue #1238

This PR adds automation support for requesting, endorsing and writing transactions, and for executing the workflow of creating a cred def that supports revocation.

The next stage of work will re-factor the code to use the event bus and eliminate the code duplication (see https://hackmd.io/51flx8CVS1ypyOjEqVl1tg?view#Implementation-Details)

Signed-off-by: Ian Costanzo <[email protected]>

codecov-commenter · 2021-09-23T22:24:08Z

Codecov Report

Merging #1422 (d0cb97a) into main (9bea1d2) will decrease coverage by 0.73%.
The diff coverage is 28.61%.

@@            Coverage Diff             @@
##             main    #1422      +/-   ##
==========================================
- Coverage   95.30%   94.57%   -0.74%     
==========================================
  Files         483      483              
  Lines       29236    29518     +282     
==========================================
+ Hits        27864    27916      +52     
- Misses       1372     1602     +230

Signed-off-by: Ian Costanzo <[email protected]>

swcurran · 2021-10-01T14:49:17Z

I didn't find anything in testing this using alice/faber, but I couldn't figure out how to activate it in the demo. Do you have instructions?

We also need some tweaks to the run_demo help handling. I'm going to put in some suggestions in a separate issue.

ianco · 2021-10-01T14:56:45Z

I didn't find anything in testing this using alice/faber, but I couldn't figure out how to activate it in the demo. Do you have instructions?

The demo is in an "interim" state right now, endorser support is added but not fully added. The following is how it works now (sets up the endorser roles to allow manual testing using the swagger page) but not ultimately how I see the demo demonstrating endorsement ...

Run the following in 2 separate shells (make sure you are running von-network and the tails server first):

./run_demo faber --endorser-role endorser --revocation
./run_demo alice --endorser-role author --revocation

Copy the invitation from faber to alice to complete the connection.

Then in the alice shell, select option "D" and copy faber's DID to alice (it is the DID displayed on faber agent startup).

This starts up the aca-py agents with the endorser role set (via the new command-line args) and sets up the connection between the 2 agents with appropriate configuration.

Then, in the alice swagger page (http://localhost:8031) you can create a schema and cred def, and all the endorser steps will happen automatically. You don't need to specify a connection id or explicitly request endorsement (aca-py does it all automatically based on the startup args).

swcurran · 2021-10-01T15:12:27Z

Nice -- that worked.

I'm thinking we need to have a "von-network"-like Endorser so that we can start it when needed for testing. Perhaps it should be built into von-network? We should brainstorm a bit how to do that. We also need to have one that we can put into production, ahead of a BPA-based Endorser.

I think an "Endorser.md" file is needed for this to document how to use it both in real usage, and a section on how to use it in the demo. Seems like a fun thing to do on a Friday, no? :-). I'm thinking that should be done before merging.

I'm hoping you can demo this on Tuesday morning at the ACA-Pug meeting. Doable?

Signed-off-by: Ian Costanzo <[email protected]>

ianco · 2021-10-01T16:25:46Z

I think an "Endorser.md" file is needed for this to document how to use it both in real usage, and a section on how to use it in the demo. Seems like a fun thing to do on a Friday, no? :-). I'm thinking that should be done before merging.

I added some docs both for ACA-Py as well as the demo. These docs will need to be updated as the Endorser code is updated & re-factored.

swcurran · 2021-10-01T16:27:12Z

Endorser.md

@@ -0,0 +1,61 @@
+# Transaction Endorser Support
+
+Note that the ACA-Py transaciton support is in the process of code refactor and cleanup.  The following documents the current state, but is subject to change.


Do you anticipate the API (e.g. Admin API and Startup Parameters) changing, or are those more or less set?

I don't anticipate any API changes but can't guarantee we won't need any

Typo "transaction"

swcurran · 2021-10-01T17:09:18Z

Endorser.md

+
+Note that the ACA-Py transaciton support is in the process of code refactor and cleanup.  The following documents the current state, but is subject to change.
+
+ACA-Py supports an [Endorser Protocol](https://github.com/hyperledger/aries-rfcs/pull/586), that allows an un-privieged agent (an "Author") to request another agent (the "Endorser") to sign their transactions so they can write these transactions to the ledger.


Typo "un-privileged"

Should have a reference to this being an Indy feature/requirement.

swcurran · 2021-10-01T17:11:09Z

Endorser.md

+
+Since endorsement involves message exchange between two agents, these agents must establish and configure a connection before any endorsements can be provided or requested.
+
+Once the connection is established and `active`, the "role" (either Author or Endorser) is attached to the connection using the `/transactions/{conn_id}/set-endorser-role` endpoint.  For Authors, they must additionally configure the DID of the Endorser as this is required when the Author signs the transaction (prior to sending to the Endorser for endorsement) - this is done using the `/transactions/{conn_id}/set-endorser-info` endpoint.


I think it should be possible to have the DID specified on the command line.

Agree this is a command line parameter but not currently used (the auto-connection-setup support is still TBD)

swcurran

Approved -- but you might want to clean up the typos first. Or just merge.

ianco · 2021-10-01T17:15:29Z

Approved -- but you might want to clean up the typos first. Or just merge.

I'll include the doc updates/fixes in the next PR

ianco added 4 commits September 17, 2021 16:15

aca-py args for endorser protocol

45fa72d

Signed-off-by: Ian Costanzo <[email protected]>

Merge remote-tracking branch 'upstream/main' into endorser_protocol

2b34bec

Endorser params and automation; alice/faber integration WIP

841fac6

Signed-off-by: Ian Costanzo <[email protected]>

Fix black formatting

2c02dda

Signed-off-by: Ian Costanzo <[email protected]>

ianco added 9 commits September 24, 2021 11:56

Endorser automation of steps

74e105f

Signed-off-by: Ian Costanzo <[email protected]>

Update create cred def

ab9429f

Signed-off-by: Ian Costanzo <[email protected]>

Update revocation endpoints to check for author role

20ce402

Signed-off-by: Ian Costanzo <[email protected]>

Pass revocation params to alice demo

c915e7b

Signed-off-by: Ian Costanzo <[email protected]>

Add txn auto-request for revocation endpoints

8fd6739

Signed-off-by: Ian Costanzo <[email protected]>

Automate revocation steps for cred def setup

69be619

Signed-off-by: Ian Costanzo <[email protected]>

Merge remote-tracking branch 'upstream/main' into endorser_protocol

8392b63

Formatting fixes

29f90b9

Signed-off-by: Ian Costanzo <[email protected]>

Added an integration test for the autoated endorsement scenario

d0cb97a

Signed-off-by: Ian Costanzo <[email protected]>

ianco requested a review from andrewwhitehead September 30, 2021 22:29

ianco marked this pull request as ready for review September 30, 2021 22:29

Merge branch 'main' into endorser_protocol

9e1e1e0

ianco requested a review from swcurran September 30, 2021 23:03

Added endorser docs

bf4e70b

Signed-off-by: Ian Costanzo <[email protected]>

swcurran reviewed Oct 1, 2021

View reviewed changes

swcurran approved these changes Oct 1, 2021

View reviewed changes

ianco merged commit 33389d7 into openwallet-foundation:main Oct 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Endorser protocol configuration, automation and demo integration #1422

Endorser protocol configuration, automation and demo integration #1422

ianco commented Sep 23, 2021 •

edited

Loading

codecov-commenter commented Sep 23, 2021 •

edited

Loading

swcurran commented Oct 1, 2021

ianco commented Oct 1, 2021

swcurran commented Oct 1, 2021

ianco commented Oct 1, 2021

swcurran Oct 1, 2021

ianco Oct 1, 2021

swcurran Oct 1, 2021

swcurran Oct 1, 2021

swcurran Oct 1, 2021

swcurran Oct 1, 2021

ianco Oct 1, 2021

swcurran left a comment

ianco commented Oct 1, 2021

		@@ -0,0 +1,61 @@
		# Transaction Endorser Support

		Note that the ACA-Py transaciton support is in the process of code refactor and cleanup. The following documents the current state, but is subject to change.


		Note that the ACA-Py transaciton support is in the process of code refactor and cleanup. The following documents the current state, but is subject to change.

		ACA-Py supports an [Endorser Protocol](https://github.com/hyperledger/aries-rfcs/pull/586), that allows an un-privieged agent (an "Author") to request another agent (the "Endorser") to sign their transactions so they can write these transactions to the ledger.


		Since endorsement involves message exchange between two agents, these agents must establish and configure a connection before any endorsements can be provided or requested.

		Once the connection is established and `active`, the "role" (either Author or Endorser) is attached to the connection using the `/transactions/{conn_id}/set-endorser-role` endpoint. For Authors, they must additionally configure the DID of the Endorser as this is required when the Author signs the transaction (prior to sending to the Endorser for endorsement) - this is done using the `/transactions/{conn_id}/set-endorser-info` endpoint.

Endorser protocol configuration, automation and demo integration #1422

Endorser protocol configuration, automation and demo integration #1422

Conversation

ianco commented Sep 23, 2021 • edited Loading

codecov-commenter commented Sep 23, 2021 • edited Loading

Codecov Report

swcurran commented Oct 1, 2021

ianco commented Oct 1, 2021

swcurran commented Oct 1, 2021

ianco commented Oct 1, 2021

swcurran Oct 1, 2021

Choose a reason for hiding this comment

ianco Oct 1, 2021

Choose a reason for hiding this comment

swcurran Oct 1, 2021

Choose a reason for hiding this comment

swcurran Oct 1, 2021

Choose a reason for hiding this comment

swcurran Oct 1, 2021

Choose a reason for hiding this comment

swcurran Oct 1, 2021

Choose a reason for hiding this comment

ianco Oct 1, 2021

Choose a reason for hiding this comment

swcurran left a comment

Choose a reason for hiding this comment

ianco commented Oct 1, 2021

ianco commented Sep 23, 2021 •

edited

Loading

codecov-commenter commented Sep 23, 2021 •

edited

Loading