Skip to content

aviarytech/did-peer

Repository files navigation

Typescript did:peer

This is a typescript implementation of the did:peer method.

Currently it more correctly aligns with the python peerdid implementation of the method. Work is required to update the did:peer method to be conformant with did-core and since this was created to interoperate with other did:peer didcomm participants interoperability has been chosen over spec correctness.

Assumptions and limitations

  • Only static layers 1, 2a, 2b are supported
  • Only X25519 keys are supported for key agreement
  • Only Ed25519 keys are supported for authentication
  • Supported verification materials (input and in the resolved DID Document)
    • 2020 verification materials (Ed25519VerificationKey2020 and X25519KeyAgreementKey2020) with multibase base58 (publicKeyMultibase) public key encoding.
    • JWK (JsonWebKey2020) using JWK (publicKeyJwk) public key encoding 2018/2019 verification materials (Ed25519VerificationKey2018 and X25519KeyAgreementKey2019)
    • using base58 (publicKeyBase58) public key encoding.

Development and Releases

This project uses semantic-release for automated versioning and publishing. When commits are pushed to the main branch, semantic-release will:

  • Analyze commit messages to determine the version bump (patch, minor, major)
  • Generate a changelog
  • Create a GitHub release
  • Publish to npm

Commit Message Format

Please use conventional commits format:

  • feat: new features (minor version bump)
  • fix: bug fixes (patch version bump)
  • feat!: or fix!: breaking changes (major version bump)
  • docs:, chore:, style:, refactor:, test: no version bump

About

Implementation of the did:peer method

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 5