Convert legacy publicKey* formats in createDidDocument to use publicKeyMultibase #3
Conversation
This file contains hidden or 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
In the did 1.0 spec, publicKeyHex, publicKeyBase58, publicKeyBase64 are all superseded by publicKeyMultibase, which can handle all of those formats. This change updates our handling when creating a didDocument to use either publicKeyMultibase or publicKeyJwk, regardless of the format that was provided to the createDidDocument method.
- Renames base64* methods to be explicit that they are base64url - Renames formatPublicKey to encodePublicKey - Updates encodePublicKey to return PublicKeyWithEncoding type - Simplifies publicKey encoding interfaces
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.
In the core DID v1.0 spec, the only supported formats for a public key in a
verificationMethodarepublicKeyMultibaseandpublicKeyJwk.This PR updates the
createDidDocumentmethod to convert publicKeyHex and publicKeyBase58 formatted publicKeys to usepublicKeyMultibasein the document. Multibase is chosen because it is the same fundamental representation as Hex/Base58 (string versus an object in Jwk)