-
Notifications
You must be signed in to change notification settings - Fork 90
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CoreDocument
& Service
and VerificationMethod
are now in the document
and verification
modules respectively
#1104
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
olivereanderson
added
Breaking change
A change to the API that requires a major release. Part of "Changed" section in changelog
Rust
Related to the core Rust code. Becomes part of the Rust changelog.
labels
Jan 18, 2023
PhilippGackstatter
approved these changes
Jan 19, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
Couple of comments on the workspace feature and other minor stuff.
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
Co-authored-by: Philipp Gackstatter <philipp.gackstatter@iota.org>
olivereanderson
changed the title
Split
Feb 15, 2023
identity_did
. CoreDocument
&Service
and VerificaitonMethod
are now in the document
and verification
modules respectively
eike-hass
changed the title
Feb 15, 2023
CoreDocument
&Service
and VerificaitonMethod
are now in the document
and verification
modules respectivelyCoreDocument
& Service
and VerificaitonMethod
are now in the document
and verification
modules respectively
eike-hass
changed the title
Feb 15, 2023
CoreDocument
& Service
and VerificaitonMethod
are now in the document
and verification
modules respectivelyCoreDocument
& Service
and VerificationMethod
are now in the document
and verification
modules respectively
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Breaking change
A change to the API that requires a major release. Part of "Changed" section in changelog
Rust
Related to the core Rust code. Becomes part of the Rust changelog.
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.
Description of change
This PR splits the
identity_did
crate as follows:did
module is moved into a new dedicated crate.revocation bitmap
functionality is moved toidentity_credential
(since it mainly concerns credentials).verification
module is moved to a new crateidentity_verification
that we expect to grow over time and perhaps take ownership over some of the things inidentity_core::crypto
.Motivation
The
identity_did
crate was getting large and hard to maintain. By splitting functionality into smaller more dedicated crates we encourage more modular code which is easier to understand (one of the advantages listed in the prefer small crates pattern).Furthermore since we have roughly speaking one (enum) error per module in the main
identity_iota
crate, we obtain more errors by having more crates (as these correspond to modules at that level) which then lowers the amount of variants in each error enum and makes it easier for users to reason about what can fail.What not to expect
I did not spend much time on improving on the errors/error variants that were split out (and some may in fact be less helpful now) . The reason is that I expect there to be quite some more refactoring to be done before the next release, and it is better not to waste time making errors for code that is likely to change significantly in the near future.
Links to any relevant issues
Sub-task of #1103 .
Type of change
Add an
x
to the boxes that are relevant to your changes.How the change has been tested
Describe the tests that you ran to verify your changes.
Make sure to provide instructions for the maintainer as well as any relevant configurations.
Change checklist
Add an
x
to the boxes that are relevant to your changes.