Skip to content
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

feat(docs): add pluto breaking changes in the JSDOC comments #115

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

elribonazo
Copy link
Contributor

@elribonazo elribonazo commented Nov 7, 2023

We are about to release prism 2.6 and as reported by a user we have missed introducing the breaking change in Pluto. Despite Pluto is not part of our bundle anymore, we do cause disruption with existing users and the correct is to apply the breaking change.

Only positive thing is that 2.5.0 is part of 2.6 prism release which is not yet released, its a draft release.

This PR does not introduce the breaking change but just applies the configuration and doc changes.

  • X25519 keys were wrongly set as EC (elliptic) key types which is wrong. EC25519 + Secp256k1 belong to EC key type, X25519 should have Curve25519 instead to be valid. If you previously had a key stored as EC (x25519) changing that keyType to KeyTypes.X25519 (Curve25519).
  • As we have introduced new credential types we have also built a credential abstraction so storing and fetching credentials becomes easier.

…ducing credential abstraction and anoncred issuing functionality.

- X25519 keys were wrongly set as EC (elliptic) key types which is wrong. EC25519 + Secp256k1 belong to EC key type, X25519 should have Curve25519 instead to be valid. If you previously had a key stored as EC (x25519) changing that keyType to KeyTypes.X25519 (Curve25519).
- As we have introduced new credential types we have also built a credential abstraction so storing and fetching credentials becomes easier.
Copy link

github-actions bot commented Nov 7, 2023

Lines Statements Branches Functions
Coverage: 41%
36.93% (1541/4172) 24.9% (721/2895) 38.6% (486/1259)

JUnit

Tests Skipped Failures Errors Time
209 2 💤 0 ❌ 0 🔥 1m 12s ⏱️

@elribonazo elribonazo changed the title BREAKING CHANGE: Introduced breaking changes in Pluto as we are intro… feat(docs): add pluto breaking changes in the JSDOC comments Nov 7, 2023
@elribonazo elribonazo marked this pull request as ready for review November 7, 2023 10:25
@elribonazo elribonazo merged commit b42b7f2 into master Nov 7, 2023
5 checks passed
@elribonazo elribonazo deleted the feature/pluto-breaking branch November 7, 2023 10:31
@elribonazo elribonazo restored the feature/pluto-breaking branch November 7, 2023 10:33
@elribonazo elribonazo deleted the feature/pluto-breaking branch November 7, 2023 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants