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

[proposal] add did:pkh support #1024

Closed
1 of 2 tasks
mirceanis opened this issue Oct 10, 2022 · 0 comments · Fixed by #1052
Closed
1 of 2 tasks

[proposal] add did:pkh support #1024

mirceanis opened this issue Oct 10, 2022 · 0 comments · Fixed by #1052
Labels
bounty enhancement New feature or request good first issue Good for newcomers pinned don't close this just for being stale

Comments

@mirceanis
Copy link
Member

mirceanis commented Oct 10, 2022

Requirements

import { getResolver as getPkhResolver } from 'pkh-did-resolver'
// ...
new DIDResolverPlugin({
  // ...
  ...getPkhResolver(),
})
  • @veramo/did-provider-pkh - at least for ethereum
    This requires an implementation of AbstractIdentifierProvider
    Since did:pkh doesn't support updates, this provider would be very similar to @veramo/did-provider-key, in the sense that most methods would be stubs, and that DIDs are created from a key.

The first implementation can support only the ethereum based DIDs, did:pkh:eip155:....
The parameters for creating a DID linked to a particular network should be inspired by @veramo/did-provider-ethr (the same file has a lot of other code that should prove useful).

testing

The PR closing this issue should contain a test where a did:pkh is created and used as an issuer in a call to createVerifiableCredential(), then that credential should be verified successfully using verifyCredential().
It is acceptable to provide only integration tests for this (meaning tests added to the top level __tests__ folder)

constraints

  • Environments: All plugin packages published in this repository are meant to work in nodejs, web(react) and mobile(react-native) environments. This will apply to this new package too.
  • No new dependencies: Packages in this repository are often installed together so dependencies must be reused between them when possible. No new dependencies should be introduced if this can be avoided.
@mirceanis mirceanis added enhancement New feature or request incomplete Issue is not well defined. Please ask for clarification before starting to work on it! good first issue Good for newcomers pinned don't close this just for being stale and removed incomplete Issue is not well defined. Please ask for clarification before starting to work on it! labels Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty enhancement New feature or request good first issue Good for newcomers pinned don't close this just for being stale
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant