Releases: decentralized-identity/veramo
Releases · decentralized-identity/veramo
v3.0.0
3.0.0 (2021-09-20)
Bug Fixes
- deps: update all non-major dependencies (8fc5312)
- deps: update builders-and-testers (acef171)
- deps: update builders-and-testers (ca746d2)
- deps: update dependency @microsoft/api-extractor to v7.18.6 (80b8f67)
- deps: update dependency @microsoft/api-extractor to v7.18.7 (28d7cf0)
- deps: update dependency uint8arrays to v3 (#669) (a5f5c42)
- did-ethr-provider: allow initialization with chainId number (#678) (38cd0ae), closes #677
- did-resolver: always include didResolutionMetadata in result (#682) (aabddb4), closes #681
- key-manager: handle eth_signTransaction with from field (#675) (50f074d), closes #674
Features
- data-store: initialize DB using migrations (#679) (41f6240), closes #676
- key-manager: move private key storage to kms-local (#661) (6b1d135), closes #539 #540 #680
BREAKING CHANGES
- key-manager:
keyManagetGet
no longer returns private key data - key-manager:
KeyStore
no longer requires aSecretBox
- key-manager:
KeyManagementSystem
needs aPrivateKeyStore
- key-manager: @veramo/cli configuration version update to 3.0
If you're already working with Veramo and wish to upgrade existing agents to veramo 3.0, you'll have to make some changes to your configuration, depending on how you're using the framework.
It boils down to these 3 steps:
- Update your database connection to use migrations
- Remove the
SecretBox
parameter fromKeyManager
- Add a
PrivateKeyStore
parameter toKeyManagementSystem
with aSecretBox
that you were using before withKeyManager
(and keep the same encryption key)
- feat(key-manager): move private key storage to kms-local
- data-store: database needs migrations for initialization. See #679 #676
The@veramo/data-store
package relies ontypeorm
as a database abstraction.
Typeorm has a connection flagsynchonize
which bootstraps the database along with schema and relations based on a set ofEntities
(annotated typescript classes).
This is very handy for fast development iterations but it is not recommended for production use because there is too much ambiguity possible when theEntities
change, and there is a risk of data loss.
The recommended way to do things is to use themigrations
mechanism. It allows you to migrate to new database schemas when necessary, and even customize the database to your own needs.
Going forward, this is the mechanism we will be recommending for connections.
v2.1.3
v2.1.2
v2.1.1
v2.1.0
2.1.0 (2021-08-11)
Bug Fixes
- cli: export recent methods from CLI local and remote (44da085)
- credentials-w3c: accept Presentations without Credentials (#616) (2389cd0)
- dataStoreDeleteVerifiableCredential (#652) (840d89b), closes #649
- deps: update dependency @microsoft/api-extractor to v7.18.4 (ec64d56)
- deps: update dependency ts-json-schema-generator to ^0.95.0 (76e0133)
- deps: update dependency ws to v8 (#643) (40fae61)
Features
v2.0.1
v2.0.0
2.0.0 (2021-07-14)
Bug Fixes
- credential-w3c: fixed handling of Ed25519 keys when creating VPs (#534)(#516) (988c76c)
- deps: bump did-jwt to 5.4.0 (#528) (65f22cf)
- deps: update all non-major dependencies (9f40f7d)
- deps: update dependency @microsoft/api-extractor to v7.18.1 (502c4c7)
- deps: update dependency did-jwt to v5.5.2 (ae0661f)
- deps: update dependency dotenv to v10 (#530) (1bd2c3f)
- deps: update dependency dotenv to v9 (#506) (4d1b720)
- deps: update dependency openapi-types to v9 (#517) (3c33265)
- deps: update dependency ts-json-schema-generator to v0.92.0 (a232e3a)
- did-comm: avoid double conversion for some keys while packing (78321a9)
- did-comm: fix potential null exception when unpacking message (584766c)
- improve subject selection and verification for SDR (#512) (01cb44e), closes #415
- kms-local: replace buggy didcomm clone with did jwt implementation (#548) (9dea353), closes #538
- remote-server: create an Ed25519 key for the default did:web (a2f7f8c)
- remote-server: list DIDCommMessaging service entry by default for did:web (339201a)
- speed up secp256k1 keygen (#551) (75e356c), closes #549
- use optional chaining in SDR message handler (#561) (ab24877), closes #560
Features
- add fake did method usable in tests (4fc587c)
- add support for did-comm over simple HTTP-based transports (#610) (78836a4), closes #552 #469
- cli: add DID discovery plugin to @veramo/cli (#600) (a484f4c)
- cli: export new agent methods and request LD DIDDocument by default (#617) (26d088b)
- did-discovery: implement a DID discovery plugin with simple providers (#597) (6f01df3)
- implement didcomm v2 packing/unpacking (#575) (249b07e), closes #559 #558
- key-manager: add generic signing capabilities (#529) (5f10a1b), closes #522
- key-manager: add method to compute a shared secret (#555) (393c316), closes #541
- key-manager: implement JWE functionality directly in
key-manager
(#557) (a030f0a), closes #556 - remote-server: express keys properly in did:web doc (c33e39e), closes #618
- sdr: return UniqueVerifiableCredential for selective-disclosure (#593) (9c6c090), closes #496
BREAKING CHANGES
- sdr:
getVerifiableCredentialsForSdr
andvalidatePresentationAgainstSdr
now returns { hash: string, verifiableCredential: VerifiableCredential} instead ofVerifiableCredential
- kms-local:
@veramo/kms-local-react-native
is no more. On react-native, please use@veramo/kms-local
instead, combined with@ethersproject/shims
v1.2.2
v1.2.1
v1.2.0
1.2.0 (2021-04-27)
Features
- core adapt to did core spec (#430) (9712db0), closes #418 #428 #417 #416 #412 #397 #384 #394
- data-store add
MemoryDIDStore
andMemoryKeyStore
(#447) (5ab1792) - credential-w3c add option to keep payload fields when creating JWT VC/VP (#431) (43923e1), closes #394
- core: add ability to define the agent context type (#350) (89255b9)
- did-provider-key: add did:key provider; fixes #335 (#351) (42cd2b0), closes decentralized-identity/did-jwt#78
- did-provider-key add native resolver for did:key (#458) (a026f24), closes #352
- url-handler: allow for URL redirects (#362) (#366) (92a86d6)
Bug Fixes
- remote-server: get alias for request (#455) (6ef7e3a)
- cli default CLI config OpenAPI schema (#429) (c985d37)
- cli open api schema x-methods (#414) (faa7940)
- use URI encoded host in web-did-doc-router (#384) (37186d5), closes #383
- deps: update dependencies (#369) (#462)(#395) (#396) (#398) (#433) (#446)