feat: add ucan receipts capability #1113
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for getting receipts from executed task (and optionally follow task effects and also get receipts already available).
Capability
Called it
ucan/receipt
and put it together withucan/*
capabilities. However, I am not entirely sure this would be the expected scope, or maybe the name needs a better feeling of being a getter.Return type
It is not trivial to define the return type here, so would like feedback. For now, opted for simply mapping what
ucanto
does, even though I was first considering something like:which ended up feeling weird to me if chain is not complete.
Encoding
At first, I tried to rely on
ReceiptRecord
above as the return type of the invocation, which of course means that on the client side Receipt instance is lost. We could capture information enough to re-create it on the client, but I ended up just mimic whatucanto
does behind the scenes and encode this as a Message (which given it goes throughucanto
, will be a message inside a message 😅 ). However, it felt the cleaner and nicer approach to give back to user Receipts.