feat(did-comm) Support DIDComm Mediation #1095

codynhat · 2022-12-31T01:01:40Z

Initial part of #1051. Adds support for forwarding messages to mediators. I am submitting a draft PR here to make sure I am on the right track.

Still to do is handling forwarded messages and setting up the relationship between a user and mediator.

What issue is this PR fixing

closes #1051

What is being changed

A clear description of what this PR brings.

Quality

Check all that apply:

I want these changes to be integrated
I successfully ran yarn, yarn build, yarn test, yarn test:browser locally.
I allow my PR to be updated by the reviewers (to speed up the review process).
I added unit tests.
I added integration tests.
I did not add automated tests because _________, and I am aware that a PR without tests will likely get rejected.

codecov · 2022-12-31T01:17:54Z

Codecov Report

Base: 80.25% // Head: 84.65% // Increases project coverage by +4.40% 🎉

Coverage data is based on head (765489b) compared to base (125bf42).
Patch coverage: 81.03% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #1095      +/-   ##
==========================================
+ Coverage   80.25%   84.65%   +4.40%     
==========================================
  Files         118      145      +27     
  Lines        4056    14800   +10744     
  Branches      875     1548     +673     
==========================================
+ Hits         3255    12529    +9274     
- Misses        798     2271    +1473     
+ Partials        3        0       -3

Impacted Files	Coverage Δ
packages/core-types/src/agent.ts	`0.00% <0.00%> (ø)`
packages/core-types/src/coreEvents.ts	`0.00% <ø> (ø)`
packages/core-types/src/index.ts	`0.00% <0.00%> (ø)`
...s/credential-ld/src/module-types/jsonld/index.d.ts	`0.00% <0.00%> (ø)`
packages/data-store-json/src/types.ts	`0.00% <0.00%> (ø)`
packages/did-provider-ion/src/functions.ts	`95.68% <ø> (ø)`
packages/did-provider-ion/src/index.ts	`100.00% <ø> (ø)`
packages/did-provider-ion/src/ion-did-provider.ts	`85.21% <ø> (ø)`
packages/did-provider-ion/src/ion-did-resolver.ts	`82.35% <ø> (ø)`
packages/did-provider-ion/src/ion-signer.ts	`91.48% <ø> (ø)`
... and 215 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

nickreynolds · 2023-01-04T15:33:12Z

packages/did-comm/src/didcomm.ts

+      ],
+    }
+
+    context.agent.emit('DIDCommV2Message-forwarded', {


we want to emit this message at some point, but probably not here, since this is just the message wrapping. this event shouldn't get emitted until after the message is actually forwarded.

What about if the event was DIDCommV2Message-wrappedForward? In the case of their being more than one mediator, multiple messages would be wrapped but only one would be forwarded. Should this emit one message per wrap? Or only one message for the single forward?

nickreynolds · 2023-01-04T15:34:16Z

packages/did-comm/src/didcomm.ts

+    // 2. Pack message for routingKey with anoncrypt
+    if (shouldUseSpecificKid) {
+      return this.packDIDCommMessageJWE(
+        { message: forwardMessage, packing: 'anoncrypt', options: { recipientKids: [routingKey] } },


does the forward protocol assume anoncrypt?

I don't see anywhere in the spec where this is mentioned explicitly. The example does not have a from field, meaning anoncrypt is used. https://identity.foundation/didcomm-messaging/spec/#messages

This seems to mean either could be used?

codynhat · 2023-01-11T17:50:58Z

@nickreynolds This is ready for review. Here is a summary:

Three DIDComm protocols (Pickup, Mediator Coordinator, Routing) were added under protocols in the didcomm package, similar to Trust Ping
Routing Protocol
- Handles a mediator receiving forward messages and saving one message for each kid
Mediator Coordinator Protocol
- Handles a mediator receiving mediate-request and currently grants mediation to anyone who requests it
- Handles a receiver receiving mediate-grant and mediate-deny and updates the DID doc service endpoint accordingly
Pickup Protocol
- Handles a mediator receiving a status-request message, currently responding with the required message_count
- Handles a mediator receiving a delivery-request and responding with a delivery
- Handles a mediator receiving a messages-received message and deleting messages
- Handles a recipient receiving a delivery request and handling all messages in a batch
Also adds return_route functionality to the HTTP transport
Also adds wrapping of messages in a forward when sent to a DID with a mediator in their DID doc

nickreynolds · 2023-01-12T02:01:03Z

At first glance, this looks amazing. Thank you so much @codynhat !

This one might take a little while to fully review (and we're trying to finish up the ESM upgrade before merging in any other big features so might go unmerged even after it's approved) but thanks!

codynhat · 2023-01-12T18:05:44Z

Sounds good!

nickreynolds · 2023-01-25T19:20:38Z

packages/data-store-json/src/data-store-json.ts

@@ -137,6 +138,18 @@ export class DataStoreJson implements IAgentPlugin {
    }
  }

+  async dataStoreDeleteMessage(args: IDataStoreDeleteMessageArgs): Promise<boolean> {


@mirceanis I see that you originally removed this function, can you review this file's changes?

There were some unpleasant consequences when deleting stuff because of some typeorm misconfiguration in our entities, causing a cascade effect and deleting more than just the message, or throwing foreign key errors.

This should not be the case now, but this is the reason why some "delete" methods are weirdly missing or commented out.

The missing methods were not added to the data-store-json plugin to keep the API uniform, but we need to review this and normalize the API.

…viceEndpoint uri is DID

… MessagingRouter

…header support

nickreynolds

Looks great!

…comm-routing

nickreynolds reviewed Jan 4, 2023

View reviewed changes

codynhat force-pushed the feat/did-comm-routing branch 2 times, most recently from c752ea1 to de5353f Compare January 10, 2023 18:26

codynhat changed the title ~~[WIP] feat(did-comm) Support DIDComm Mediation~~ feat(did-comm) Support DIDComm Mediation Jan 10, 2023

codynhat marked this pull request as ready for review January 10, 2023 23:03

nickreynolds reviewed Jan 25, 2023

View reviewed changes

nickreynolds requested review from mirceanis, simonas-notcat and nickreynolds January 25, 2023 19:24

codynhat added 12 commits January 30, 2023 13:48

feat(did-comm) Wrap message in forward when routingKeys exists or ser…

7a29de5

…viceEndpoint uri is DID

feat(remote-server) Add support for returnMessage and return_route in…

789838b

… MessagingRouter

feat(did-comm) Initial coordinate-mediation handler and return_route …

e09fa78

…header support

feat(did-comm) Send MediateGrant reply via return_route

1573891

feat(did-comm) Recipient handles MediateGrant

7311e42

feat(did-comm) Recipient handles MediateDeny

36e29fe

feat(did-comm) Routing protocol to handle forward messages

709520f

feat(did-comm) Pickup protocol Status messages

33f1be2

feat(did-comm) Pickup protocol Delivery messages

67e900c

feat(did-comm) Pickup protocol MessagesReceived handlers

7150aa0

feat(did-comm) Pickup protocol handle message batch

bda100c

test(did-comm) Fix coordinate-mediation-message-handler test cases

a762bd2

codynhat force-pushed the feat/did-comm-routing branch from b3dece3 to a762bd2 Compare January 30, 2023 21:49

codynhat added 3 commits January 31, 2023 09:56

Merge branch 'next' into feat/did-comm-routing

2663d09

Fix jest tests

12533c9

Add .js to local package imports

24abfa4

nickreynolds approved these changes Feb 6, 2023

View reviewed changes

codynhat added 3 commits February 9, 2023 08:45

Merge branch 'next' of github.com:uport-project/veramo into feat/did-…

0285fb1

…comm-routing

Fix core-types

53c5bd9

Revert pnpm-lock file

765489b

nickreynolds merged commit 4b46a79 into decentralized-identity:next Feb 9, 2023

radleylewis mentioned this pull request Sep 25, 2023

Add Support for DIDCommv3 Coordinate Mediation #1255

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(did-comm) Support DIDComm Mediation #1095

feat(did-comm) Support DIDComm Mediation #1095

codynhat commented Dec 31, 2022 •

edited

Loading

codecov bot commented Dec 31, 2022 •

edited

Loading

nickreynolds Jan 4, 2023

codynhat Jan 4, 2023

nickreynolds Jan 4, 2023

codynhat Jan 4, 2023

codynhat commented Jan 11, 2023

nickreynolds commented Jan 12, 2023

codynhat commented Jan 12, 2023

nickreynolds Jan 25, 2023

mirceanis Jan 30, 2023

nickreynolds left a comment

feat(did-comm) Support DIDComm Mediation #1095

feat(did-comm) Support DIDComm Mediation #1095

Conversation

codynhat commented Dec 31, 2022 • edited Loading

What issue is this PR fixing

What is being changed

Quality

codecov bot commented Dec 31, 2022 • edited Loading

Codecov Report

nickreynolds Jan 4, 2023

Choose a reason for hiding this comment

codynhat Jan 4, 2023

Choose a reason for hiding this comment

nickreynolds Jan 4, 2023

Choose a reason for hiding this comment

codynhat Jan 4, 2023

Choose a reason for hiding this comment

codynhat commented Jan 11, 2023

nickreynolds commented Jan 12, 2023

codynhat commented Jan 12, 2023

nickreynolds Jan 25, 2023

Choose a reason for hiding this comment

mirceanis Jan 30, 2023

Choose a reason for hiding this comment

nickreynolds left a comment

Choose a reason for hiding this comment

codynhat commented Dec 31, 2022 •

edited

Loading

codecov bot commented Dec 31, 2022 •

edited

Loading