@digitalbazaar/did-method-key - npm Package Versions

5.2.0 - 2024-01-17

Added

• Allow fromKeyPair to be called with only a key agreement key pair.

5.1.0 - 2023-04-27

Changed

• Update get() and publicKeyToDidDoc() to support keyAgreement-only DIDs.

5.0.0 - 2023-04-11

Added

• Add use() method that allows multibase-multikey headers and a multibase-multikey deserializer (which replaces verificationSuite previously) to handle data using that header.
• Add fromKeyPair() that generates the DID Document along with the corresponding key pairs from a verificationKeyPair. fromKeyPair() also optionally takes a keyAgreementKeypair param.

Changed

• BREAKING Renamed createVerificationSuite() to createFromMultibase() which now no longer takes a generate param and is adapted to convert the legacy verification suites to provide proper .fromMultibase() method.

Removed

• BREAKING: DidKeyDriver no longer takes a verificationSuite param in the constructor.
• BREAKING: generate() method has now been replaced by a new method fromKeyPair(). This approach externalizes key pair generation to allow whatever parameters are necessary / possible (such as random bytes / seeds) to be provided in the key-pair-specific implementation. This also greatly reduces the complexity of this library and the need to import key pair libraries generally.

4.0.0 - 2023-04-03

Added

• Added ECDSA Multikey support. Exports createVerificationSuite() utility function that can be used to create a verificationSuite from a multikey library such as @digitalbazaar/ecdsa-multikey when creating a DidKeyDriver instance.

Changed

• BREAKING: Remove support for node <= 14.

3.0.0 - 2022-06-02

Changed

• BREAKING: Convert to module (ESM).
• BREAKING: Require Node.js >=14.
• Update dependencies.
• Lint module.

2.0.0 - 2021-06-19

Changed

• BREAKING: Update 2020 cryptosuites to use multicodec encoding for keys.

1.2.0 - 2021-05-26

Added

• Add backwards compatibility, allow returning the did:key document using the Ed25519VerificationKey2018 and X25519KeyAgreementKey2019 suites.

1.1.0 - 2021-05-04

Added

• Add didKeyDriver.publicKeyToDidDoc({keyPair}) method. (This used to be the keyToDidDoc() method, in <= v0.7.0, removed in v1.0 and brought back by popular demand.)

1.0.0 - 2021-04-09

Changed

• BREAKING: Rename npm package from did-method-key to @digitalbazaar/did-method-key.
• BREAKING: Return {didDocument, keyPairs, methodFor} from generate().
• BREAKING: Upgrade to crypto-ld v5.0 based key suites, update to use Ed25519VerificationKey2020 and X25519KeyAgreementKey2020 crypto suites.
• BREAKING: DID Document context changed from 'https://w3id.org/did/v0.11' to the DID WG-published https://www.w3.org/ns/did/v1, plus the contexts for the Ed25519VerificationKey2020 and X25519KeyAgreementKey2020 crypto suites. See the "Example DID Document" section of the README.
• BREAKING: Rename computeKeyId() -> computeId().
• Avoid mutation of ed25519 key passed into keyToDidDoc.
• Use underscores for utility functions.
• Add methodFor and publicMethodFor convenience functions.
• BREAKING: Move the lru-cache to did-io's CachedResolver class.
• BREAKING: keyToDidDoc driver method removed. (See Upgrading notes for alternatives.)
• BREAKING: The publicKey property of the DID Document has been deprecated by the DID Data Model, and is now renamed to verificationMethod.