refactor: selective disclosure api #380
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
ack on the concept |
|
Nice! Looking forward to switching to this new API 👍 |
th4s
approved these changes
Oct 31, 2023
sinui0
force-pushed
the
refactor/commit-prove-api
branch
from
d4a7179 to
676a6c4
Compare
sinui0
force-pushed
the
refactor/commit-prove-api
branch
from
676a6c4 to
5839d72
Compare
|
At last, this is ready for review. We'll want to wait until outstanding PRs in |
sinui0
requested review from
th4s and
themighty1
and removed request for
themighty1
This was referenced Feb 6, 2024
Closed
This was
linked to
issues
Feb 6, 2024
themighty1
requested changes
Feb 7, 2024
There was a problem hiding this comment.
looks good,
can we use the same formatting for method args everywhere in this PR as per https://github.com/tlsnotary/tlsn/blob/dev/CONTRIBUTING.md#function-arguments
/// * arg1 - The first argument.
(The first letter capitalized and a period at the end)
themighty1
approved these changes
Feb 8, 2024
| Ok(()) | ||
| } | ||
|
|
||
| /// Commits to a JSON string. |
There was a problem hiding this comment.
Suggested change
| /// Commits to a JSON string. | |
| /// Commits to an unquoted JSON string. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 redesigns our selective disclosure API, inverting control over the parsed data structures, passing them out to the user instead.
All previous data format structures have been ripped out in favor of re-exporting types from
spansy, and then leveraging theToRangeSettrait fromtlsn-utilsin thetlsn-coreAPI. Users who want to implement their own format types can if they wish, their types only need to implementToRangeSetto integrate withtlsn-core.It introduces two new traits,
HttpCommitandJsonCommitwhich a user can either implement themselves, or just use our default committer. Both traits provide blanket impls for all the methods, so a user can override something without having to reimplement everything.This API is by no means final. It will continue to evolve as we introduce new commitment types. There is also room for new abstractions for generating proofs similar to how we do commitments via the
*Committraits. For now I've kept that out of scope of this PR and users will have to use theSubstringsProofBuilderAPI directly (which isn't too bad because at least now they can use typed data instead of manually specifying ranges).