Skip to content

Latest commit

 

History

History
1418 lines (984 loc) · 144 KB

CHANGELOG.md

File metadata and controls

1418 lines (984 loc) · 144 KB

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

6.0.0 (2024-04-02)

Bug Fixes

  • address edge case when getting DIDDoc component (#1365) (1694de1)
  • cli: remove revocable and send options from credential create command (#1345) (e1beeaf), closes #1342
  • cli: remove interactive prompting on CLI execute command (#1347) (5accc6b), closes #1281
  • credential-ld: let verifiers use all supported verification methods (#1331) (aa95af0), closes #1329
  • credential-w3c: forward DID resolution options to the resolver (#1344) (0c22cc6), closes #1343
  • data-store-json: order credentials with weird issuanceDate (#1273) (28c65f7)
  • data-store: return unique credentials for dataStoreORMGetVerifiableCredentialsByClaims (#1299) (5aa97a2), closes #1285
  • deps: add missing ethers dependency to each relevant modules (#1304) (2157e70), closes #1295
  • deps: bump ethr-did-resolver (#1278) (b6c54cd)
  • deps: update dependency @metamask/eth-sig-util to v7 (#1258) (ba88d6b)
  • deps: Update dependency did-jwt-vc to v3.2.9 (80272ca)
  • deps: update dependency ethr-did-resolver to v10 (#1291) (99c53e5), closes #1295
  • deps: Update dependency ethr-did-resolver to v10.1.5 (07c982f)
  • deps: Update dependency ethr-did-resolver to v9 (533a9e6)
  • deps: update dependency multiformats to v13 (c384fb9)
  • deps: Update devDeps (e674c58)
  • deps: Update did-vc-libraries (ba966d5)
  • deps: Update did-vc-libraries (01c01d5)
  • deps: Update did-vc-libraries (e2e794f)
  • deps: upgrade ethers and did-provider-ethr for sepolia support (#1306) (ac1b620)
  • did-provider-key: align did:key resolver to spec (#1332) (8e3b94c), closes #1330
  • export const plugin schemas instead of defaults (#1327) (7896cea), closes #1318 #1317 #1315
  • regenerate schema (#1260) (5b198ec)
  • selective-disclosure: deprecate the uPort SelectiveDisclosure plugin (#1307) (71e313f)
  • utils: bump did-jwt to 7.4.1 and reuse key conversion code from it (#1261) (fb192e7), closes #1248 #1245
  • utils: get chainId for any did method (#1334) (d5375bd)
  • utils: use synchronous version of sha256 digest for CID (#1253) (2e3972c), closes #1239

chore

Code Refactoring

Features

  • add Multikey support (#1316) (165de35)
  • cli: add support for did:jwk and did:peer to CLI (#1320) (3ac343e)
  • coordinate-mediation: implement did-comm coordinate-mediation v3.0 (#1282) (462735d)
  • core-types: add hash to TCredentialColumns (#1259) (306a398)
  • credential-w3c: list usable proof formats for an IIdentifier (#1268) (e94aaf2)
  • data-store: use IPFS CID instead of hex blake2 hashes for credential IDs (#1239) (acc47e6)
  • did-comm: Improve DIDComm Service compatibility (#1340) (6df704c)
  • did-comm: returnMessage from sendDIDCommMessage() when available (#1283) (f7a3851)
  • did-manager: matching DIDs by alias should not depend on the provider (#1218) (bfdfc4c), closes #1215
  • utils: export createJWK (#1325) (610ee66), closes #1324
  • utils: move JWK converter to utils package (#1298) (fc94764)

BREAKING CHANGES

  • did-comm: the DIDComm Message structure has changed. The message can now specify multiple recipients in the to property.
  • utils: The getChainIdForDidEthr method has been renamed to getChainId
  • The plugin.schema.json files are now generated as plugin.schema.ts.
  • did-comm: the return type of IDIDComm.sendDIDCommMessage() has changed from a string representing the transport ID to an object that may include a returnMessage property along with a transportId property.
  • did-manager: The behavior of DIDManager has changed when working with alias. It is mostly ignoring provider unless it is used to create new identifiers. AbstractDIDStore APIs have been adapted and implementations have changed.
  • deps: now using ethers v6 as a dependency which may need extra attention when merging. The output of eth_signTransaction algorithms may be slightly different as transactions are by default infered as type 1 (EIP1559)
  • data-store: going forward credentials and presentations will have a new ID format in the database. If you are relying on the IDs assigned internally by @veramo/data-store to work with your credentials, you will have to recompute them using the @veramo/utils#computeEntryHash method.

5.6.0 (2024-01-16)

Features

  • remote-client: allow dynamic headers param for AgentRestClient constructor (#1314) (1b8a0a2), closes #1313

5.5.3 (2023-10-09)

Bug Fixes

5.5.2 (2023-10-06)

Bug Fixes

  • data-store: match claims by credential hash when deleting credential (#1270) (4ee626d), closes #1269

5.5.1 (2023-09-21)

Bug Fixes

5.5.0 (2023-09-19)

Bug Fixes

  • data-store: order skip take in orm and json (#1243) (28c1224)
  • deps: update dependency @metamask/eth-sig-util to v6 (c60252c)
  • deps: Update dependency credential-status to v2.0.6 (423c0ae)
  • deps: update dependency cross-fetch to v4 (1c14d34)
  • deps: Update dependency did-jwt-vc to v3.2.5 (75e66d9)
  • deps: update dependency swagger-ui-express to v5 (7e070cc)
  • deps: Update did-vc-libraries (cb5f9d7)
  • deps: Update did-vc-libraries (518cc5a)
  • did-provider-key: use compressed keys for creating Secp256k1 did:key (#1217) (ba8f6f5), closes #1213

Features

  • core-types: export a basic mapping between key types and algorithms (57b6c58)
  • selective-disclosure: support multiple key types for generating requests (3406a04), closes #946

5.4.1 (2023-08-04)

Bug Fixes

  • ci: benign change meant to tag all packages for another patch release (#1211) (41b5c90)
  • deps: Update did-vc-libraries (08d0c39)
  • deps: Update did-vc-libraries to v6 (3cadd56)

5.4.0 (2023-08-01)

Bug Fixes

  • deps: Update dependency @aviarytech/did-peer to ^0.0.21 (1f84ae7)

Features

  • credential-w3c: allow issuers with query parameters for credentials and presentations (#1207) (688f59d), closes #1201
  • did-comm: add support for the AES based content and key encryption algorithms (#1180) (5294a81)

5.3.0 (2023-07-27)

Bug Fixes

  • add missing js extension for json canonicalizer import (#1175) (d6afc3f)
  • cli: prevent ExperimentalWarning messages form being printed (#1186) (a2971aa)
  • credential-eip712: remove JSON.stringify for string credential (#1176) (469dcd9)
  • deps: update dependency @decentralized-identity/ion-sdk to v1 (6981e68)
  • deps: update dependency commander to v11 (e2d7966)
  • deps: update dependency multiformats to v12 (11fa7c3)
  • deps: Update dependency web-did-resolver to v2.0.27 (b5b6f52)
  • deps: Update did-vc-libraries (78b4bfb)
  • deps: Update did-vc-libraries (f92c531)
  • did-resolver: send Accept header to universal resolver. (#1203) (c86d918)
  • support publicKeyJwk when comparing blockchainAccountId (#1194) (9110688)

Features

  • allow secp256r1 key type for JWT VC issuance (#1192) (2ce7056)
  • credential-w3c: support specifying a key when creating credential or presentation (#1202) (70d49f4)
  • export didcomm mediator utils (#1181) (264b6a7)
  • kv-store: add key-value store based on a typescript port of the keyv package (#1150) (e7138d3)

5.2.0 (2023-05-02)

Bug Fixes

  • add did-provider-peer to CLI dependencies (#1161) (38827c3)
  • cli: NODE_NO_WARNINGS on windows (#1164) (e9474e2)
  • credential-ld: external context handling with the fetchRemoteContexts option (#1149) (4a63f40)
  • credential-ld: fix Ed25519Signature2020 verification (#1166) (c965fd5)
  • data-store: fix react-native migrations on older Android installations (#1152) (826b994)
  • deps: update dependency canonicalize to v2 (8368462)
  • deps: update dependency express-handlebars to v7 (2621947)
  • deps: update dependency z-schema to v6 (0cdd100)
  • plugin schemas (#1159) (4b5f580)

Features

  • add did-peer provider and resolver (#1156) (9502063)
  • did-provider-key: add option to create the identifier from a given private key (#1165) (ad79a22)

5.1.4 (2023-03-16)

Bug Fixes

  • cli: fix credential verify command for JWT credentials (#1148) (697a14c)

5.1.3 (2023-03-16)

Bug Fixes

5.1.2 (2023-02-25)

Bug Fixes

  • ci: minor changes to trigger release alignment (9db312f)

5.1.1 (2023-02-25)

Bug Fixes

  • ci: add publishConfig for did-provider-jwk (b8b18e9)

5.1.0 (2023-02-24)

Bug Fixes

  • add missing .js file extension for ESM import (#1123) (6c850ac), closes #1122
  • cli: create veramo instance async in CLI (#1126) (05ab106), closes #1125
  • cli: typo in explore command (279168d)
  • correctly export PickupRecipientMessageHandler (#1121) (3a7a086)
  • credential-eip712: compatibility improvements for EthereumEIP712Signature2021 (#1131) (672f92b)
  • did-comm: correctly export PickupMediatorMessageHandler (#1120) (8de26b0)
  • did-provider-ethr: export KMSEthereumSigner for convenience (#1124) (cee8d2e)
  • P256 key parity corrections (#1137) (d0eca2b), closes #1136 #1135

Features

  • cli: export config methods and adopt Command instances instead of global program(#1130) (9c73d98)
  • cli: add did:3 resolver to CLI default config (#1129) (5887e04)
  • cli: add did:pkh support to the default CLI config (#1133) (19cccc1)
  • core-types: allow inline @context for Credentials and Presentations (#1119) (44bb365), closes #1073
  • did-provider-jwk: add did:jwk method support (#1128) (0a22d9c)

5.0.0 (2023-02-09)

Bug Fixes

  • did-manager: rename AbstractDIDStore methods for SES compatibility (0287340), closes #1090
  • did-provider-pkh: add missing caip dependency (#1112) (60bc5fd), closes #1111
  • did-provider-pkh: refactor and simplify did:pkh plugin (#1113) (42be48f)
  • key-manager: rename Abstract[Private]KeyStore methods for SES compatibility (91631b6), closes #1090

Build System

Features

BREAKING CHANGES

test(did-provider-ion): skip a couple of tests that fail with unreasonable errors chore: use ubuntu-latest on CI fix: temporarily remove puppeteer tests fix: use craco for test-react-app to enable babel config test: fix unit and integration tests (browser tests still broken) fix: fix some build issues that prevented tests from working fix: missing deps flagged by pnpm

4.3.0 (2023-01-27)

Bug Fixes

  • credential-ld: fix defaultContexts file extensions (#1086) (2f57cb1)
  • utils: convert JWK with curv Ed25519 to X25519 (#1078) (deb546b)

Features

  • did-comm: add trust ping protocol (#1080) (fb22e63)
  • did-comm: support DIDComm Messaging attachments (#1087) (6679574), closes #612
  • utils: add publicKeyJwk as valid verificationMethod in getEthereumAddress (#1096) (a4209f5)

4.2.0 (2022-12-05)

Bug Fixes

  • cli: fix bug in schema generator (d4c63c1)
  • credential-ld: simplify signature suite use of Uint8Array (49a10ec)
  • credential-w3c: correct verification of credentials given as objects with jwt proofs (#1071) (b0d75e9)
  • deps: bump dependencies (701b8ed)
  • deps: Update dependency @digitalcredentials/vc to v5 (1bdc802)
  • deps: Update dependency ethr-did-resolver to v8 (f475dbc)
  • did-provider-ion: await and update deps (#1074) (8cea4c0)
  • didcomm message handler should attempt to pass message to other handlers (#1064) (5e18427)
  • utils: correctly extract publicKeyHex from [Ed/X]25519 2020 keys (#1076) (c73002c), closes #1067

Features

  • add eip712 issuer to CLI and default agent config (#1065) (33c7cee)
  • credential-ld: add Ed25519Signature2020 & JsonWebSignature2020 experimental support (#1030) (fbf7d48), closes #1003
  • did-provider-pkh: implement did:pkh support. (#1052) (5ad0bfb), closes #1024

4.1.2 (2022-11-03)

Bug Fixes

  • deps: bump ethr-did to 2.3.6 and cosmetic changes in CLI config (#1054) (eb03b63)

4.1.1 (2022-11-01)

Note: Version bump only for package veramo

4.1.0 (2022-10-31)

Bug Fixes

Features

  • add ION DID Provider implementation (#987) (594571c), closes #336 #440
  • add support for did:ethr signed/meta transactions (#1031) (88f1da9)
  • add support for NIST Secp256r1 keys and ES256 signatures (#1039) (61eb369)
  • did-provider-ethr: implement TypedDataSigner in KmsEthereumSigner (#1026) (4371cb9)

4.0.2 (2022-10-04)

Bug Fixes

  • credential-eip712: add support for all did methods that use secp256k (#1011) (9940068), closes #991
  • data-store: use looser typeorm version range to fix #1013 (#1016) (83807f3)
  • deps: update dependency @metamask/eth-sig-util to v5 (bf3a406)
  • deps: update dependency uuid to v9 (4ff90a5)

4.0.1 (2022-09-23)

Bug Fixes

  • ci: add GH_TOKEN for checkout and auto-release (#1009) (1268bd2)
  • credential-w3c: manually merge schemas for ICredentialPlugin (#1008) (cff1765), closes #1007

4.0.0 (2022-09-22)

Bug Fixes

  • build: update lockfile and autogen tests (ea4966a)
  • cli: fix typo in command description (#913) (bfc61f3)
  • cli: update default CLI config to account for renamed class (#919) (d66c366)
  • core: plugin schema (e5a48ad)
  • credential-eip712: update plugin schema (#915) (3a0765e)
  • credential-ld: fix EcdsaSecp256k1RecoverySignature2020 suite context (#909) (48fbee3)
  • credential-ld: include credential context and fix context loader Map (ef7797d)
  • credential-ld: include LDDefaultContexts in npm bundle (3e2cf29)
  • credential-ld: remove fs dependency for JSON LD default contexts (#868) (2f75935), closes #837
  • credential-status: check credential status for all credential types (#949) (877c513), closes #934
  • credential-status: simplify credential-status scripts (45b8c1f)
  • credential-w3c: forward domain and challenge args to createVerifiablePresentationJwt (#887) (2374c71)
  • data-store-json: structuredClone (5369c28)
  • data-store-json: structuredClone (#885) (cf14cae), closes #857
  • deprecate the save parameter (#975) (598c0e1), closes #966
  • deps: Bump did-jwt, did-jwt-vc as direct package deps (#955) (e57edb3)
  • deps: pin dependencies (31c517c)
  • deps: pin dependencies (f895dee)
  • deps: pin dependency typescript to 4.5.5 (302e5f0)
  • deps: replace @transmute/lds-ecdsa-secp256k1-recovery2020 with fork (#953) (573a0ef), closes #952
  • deps: update all non-major dependencies (b537187)
  • deps: update all non-major dependencies (a7a5b5d)
  • deps: update all non-major dependencies (04c0053)
  • deps: update all non-major dependencies (d8aa16a)
  • deps: update all non-major dependencies (183b4bc)
  • deps: update builders-and-testers (a13f5f8)
  • deps: update builders-and-testers (509001f)
  • deps: update builders-and-testers (a72b33c)
  • deps: update builders-and-testers (ef08c52)
  • deps: update builders-and-testers (8a1884b)
  • deps: update builders-and-testers (60b8f79)
  • deps: update builders-and-testers (5202ef1)
  • deps: update builders-and-testers (4d5e912)
  • deps: update builders-and-testers (#930) (b3a5c52)
  • deps: Update dependency @digitalcredentials/vc to v4 (9ea90d3)
  • deps: update dependency @ethersproject/random to v5.5.1 (b5fcdb5)
  • deps: update dependency @microsoft/api-extractor to v7.23.1 (4081051)
  • deps: update dependency @types/react to v18 (c93bdea)
  • deps: update dependency @types/react-dom to v18 (0712b8c)
  • deps: update dependency @ungap/structured-clone to v1 (3d2a57b)
  • deps: update dependency commander to v9 (28c35e1)
  • deps: update dependency did-jwt to v5.12.0 (5b414d7)
  • deps: update dependency did-jwt-vc to v2.1.8 (d4520be)
  • deps: Update dependency did-jwt-vc to v3 (014c1ab)
  • deps: update dependency dotenv to v12 (ea7641e)
  • deps: update dependency dotenv to v14 (88bd6dc)
  • deps: update dependency dotenv to v16 (0ee5454)
  • deps: Update dependency ethr-did-resolver to v6.0.2 (#964) (48b937e)
  • deps: update dependency express-handlebars to v6 (4444828)
  • deps: update dependency inquirer-autocomplete-prompt to v2 (9bf0d0b)
  • deps: update dependency openapi-types to v10 (3d9cf88)
  • deps: update dependency openapi-types to v11 (992ad40)
  • deps: update dependency openapi-types to v12 (b8401f5)
  • deps: update dependency ts-json-schema-generator to v1 (74d0a66)
  • deps: update dependency typeorm to v0.2.41 (61a8103)
  • deps: update dependency typescript to v4.6.3 (6e54d07)
  • deps: update dependency typescript to v4.6.4 (dddaebd)
  • deps: update dependency web-did-resolver to v2.0.15 (c574d05)
  • deps: update dependency web-did-resolver to v2.0.16 (8fd46af)
  • deps: Update dependency web-did-resolver to v2.0.19 (aec6bea)
  • deps: update dependency yaml to v2 (9d5ee7c)
  • deps: update did-libraries (219cde2)
  • deps: update did-libraries (42e3d77)
  • deps: update did-libraries (e28a6b5)
  • deps: update react monorepo to v18 (5150b0e)
  • deps: use did-jwt v6 and ethr-did-resolver v6 (#925) (0c77d03), closes #923 #848
  • did-resolver: use interface Resolvable instead of the Resolver class (9c2e59f)
  • docs: fix relevant errors and warnings in TSDoc to enable proper docs generation on [@next](https://github.com/next) branch (79c3872)
  • fix inquirer prompt for subject DID during SDR (20d6cab), closes #790
  • key-manager: add missing uuid dependency (#807) (b6d9738)
  • kms-web3: use ethers _signTypedData (#939) (f198997), closes #938
  • remote-server: api-key-auth (#772) (cbe6f35), closes #771
  • remote-server: web-did-doc-router options (#777) (cc1ec7a)
  • update and fix inline documentation of all exported types (#921) (63e64e0)

Features

  • add key type definitions: 'Bls12381G1Key2020' and 'Bls12381G2Key2020' (#839) (0f0f517)
  • add partial match for dids and aliases in did discovery provider for data store (92b793e)
  • add support for serviceEndpoint property as defined in latest DID Spec (#988) (9bed70b)
  • cli: add choices when selecting credential Subject in CLI (#898) (c47c08e)
  • cli: in explore, allow copy to clipboard the text of identifier or credential or presentation (#902) (d3b87f5)
  • create DIDComm JWE with multiple recipients (#888) (06acacb)
  • credential-ld: add option to fetch remote contexts (60226a1)
  • credential-ld: add support for browser environments (#916) (435e4d2)
  • credential-status: add credential status check plugin for Veramo (#874) (cf62dfe)
  • credential-status: expect revoked boolean property from StatusMethods (e00daa4)
  • credential-status: rename plugin interfaces and methods (a5adaba), closes #981
  • credential-w3c: add ICredentialPlugin interface in core package (#1001) (7b6d195), closes #941
  • credential-w3c: add override policies to verifyPresentation (#990) (06b3147), closes #375 #954
  • credential-w3c: align verification API between formats (#996) (b987fc0), closes #935 #954 #375 #989
  • CredentialIssuerEIP712 (#899) (5d62c52)
  • data-store-json: BrowserLocalStorageStore (#914) (7b520ab)
  • data-store: use DataSource instead of Connection (#970) (3377930), closes #947
  • date-store-json: add JSON object storage implementation (#819) (934b34a)
  • define an interface for credential status manager (#956) (6fbd22f), closes #937 #981
  • did-manager: adddidManagerUpdate method for full DID document updates (#974) (5682b25), closes #971 #960 #948
  • did-provider-ethr: use multiple networks per EthrDIDProvider (#969) (0a88058), closes #968 #893
  • did-provider-ethr: Using meta account (994e5af)
  • did-resolver: simplify DIDResolverPlugin constructor (#986) (3a7eb0c), closes #976
  • kms-web3: add a KMS implementation backed by a web3 provider (#924) (14f71af), closes #688
  • kms-web3: add ability to list provider accounts as keys (#965) (31e3946), closes #933
  • update did-discover-provider to search by DID likeness in addition to name (3696a7a)
  • utils: add 2 utility functions for inspecting ethr dids (#842) (473e7fa)

BREAKING CHANGES

  • the did-resolver and connected libraries change the data-type for ServiceEndpoint to Service and the previous semantic has changed. Services can have multiple endpoints, not just a single string.
  • cli: ProfileDiscoveryProvider has been renamed to DataStoreDiscoveryProvider in #597. Please update your config accordingly

3.1.5 (2022-06-10)

Bug Fixes

  • ci: improve documentation CI workflows (#922) (0579764)

3.1.4 (2022-06-02)

Bug Fixes

  • deps: bump sqlite3 to 5.0.8 to enable build on apple M1 chips (#911) (daeadb7)

3.1.3 (2022-06-01)

Note: Version bump only for package veramo

3.1.2 (2022-05-30)

Bug Fixes

  • remote-server: fix error when resolving local did:web (#905) (782f64a)

3.1.1 (2022-01-13)

Bug Fixes

  • remote-server: api-key-auth (#772) (6d1916b), closes #771
  • remote-server: fix path for web-did-doc-router (6bb1003)

3.1.0 (2021-11-12)

Bug Fixes

  • data-store: add support for entityPrefix (#725) (801bb95), closes #724
  • deps: update all non-major dependencies (a6614e8)
  • deps: update builders-and-testers (5c4fa9e)
  • deps: update builders-and-testers (828bfa2)
  • deps: update builders-and-testers (e31a4be)
  • deps: update builders-and-testers (ba97cf1)
  • deps: update builders-and-testers (2e4e6e5)
  • deps: update dependency commander to v8 (#587) (9fc5c50)
  • deps: update dependency did-jwt to v5.10.0 (8424291)
  • deps: update dependency did-jwt to v5.9.0 (b9af0af)
  • deps: update dependency jsonpointer to v5 (5c0ab9f)
  • deps: update dependency passport to ^0.5.0 (a4dae24)
  • deps: update dependency ts-json-schema-generator to ^0.97.0 (c20a409)
  • deps: update did-libraries (0ea73fc)
  • deps: update did-libraries (417dc5d)

Features

  • cli: add command to verify an agent configuration file (#729) (2790ebc)
  • did-comm: didcomm messaging using did:ethr (#744) (1be5e04), closes #743
  • remote-server: add default services option for WebDidDocRouter (#715) (cfa6431)
  • remote-server: add MessagingRouter save option (#713) (0ca9b44)

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

BREAKING CHANGES

  • key-manager: keyManagetGet no longer returns private key data
  • key-manager: KeyStore no longer requires a SecretBox
  • key-manager: KeyManagementSystem needs a PrivateKeyStore
  • 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:

  1. Update your database connection to use migrations
  2. Remove the SecretBox parameter from KeyManager
  3. Add a PrivateKeyStore parameter to KeyManagementSystem with a SecretBox that you were using before with KeyManager (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 on typeorm as a database abstraction. Typeorm has a connection flag synchonize which bootstraps the database along with schema and relations based on a set of Entities (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 the Entities change, and there is a risk of data loss. The recommended way to do things is to use the migrations 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.

2.1.3 (2021-09-01)

Note: Version bump only for package veramo

2.1.2 (2021-09-01)

Note: Version bump only for package veramo

2.1.1 (2021-08-11)

Bug Fixes

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

2.0.1 (2021-07-20)

Bug Fixes

  • cli: export recent methods from CLI local and remote (#625) (36bce08)

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 and validatePresentationAgainstSdr now returns { hash: string, verifiableCredential: VerifiableCredential} instead of VerifiableCredential
  • kms-local: @veramo/kms-local-react-native is no more. On react-native, please use @veramo/kms-local instead, combined with @ethersproject/shims

1.2.2 (2021-05-18)

Bug Fixes

  • cli: print entire JSON tree resulting from DID resolution (#524) (e83d33c), closes #523

1.2.1 (2021-05-03)

Bug Fixes

  • integration tests and CLI config for did:key (#498) (2ec0687)

1.2.0 (2021-04-27)

Bug Fixes

  • ci: explicitly publish to latest tag from main branch (#494) (c7a3b98)
  • deps: update all non-major dependencies (#462) (4a2b206)
  • deps: update dependency inquirer to v8 (#395) (96c2129)
  • deps: update dependency multibase to v4 (#396) (7ea7a8d)
  • deps: update dependency multicodec to v3 (#398) (9e23a10)
  • deps: update dependency ngrok to v4 (#433) (176e221)
  • deps: update dependency openapi-types to v8 (#446) (7ab3737)
  • deps: update dependency ts-json-schema-generator to v0.90.0 (d806ab5)
  • remote-server: get alias for request (#455) (6ef7e3a)
  • default CLI config OpenAPI schema (#429) (c985d37)
  • open api schema x-methods (#414) (faa7940)
  • use URI encoded host in web-did-doc-router (#384) (37186d5), closes #383
  • deps: update dependency ts-json-schema-generator to v0.84.0 (#369) (86ec9b3)

Features

1.1.2 (2021-04-26)

Bug Fixes

1.1.1 (2021-03-09)

Bug Fixes

  • cli: validate config file version number (#413) (fb5668c)

1.1.0 (2021-01-26)

Bug Fixes

  • make privateKey property of Key entity nullable (#342) (aa48ed9)
  • deps: update dependency commander to v7 (#330) (f8a7566)
  • deps: update dependency z-schema to v5 (#323) (9cadf37)

Features

  • core: make agent context public readonly (#347) (802948e)

1.0.1 (2020-12-18)

Bug Fixes

Code Refactoring

  • Rename Identity to Identifier (#308) (7812e51)
  • daf-cli: Refactor CLI command palette (#304) (a5a0670), closes #264
  • Refactor and add inline documentation to daf-w3c package (f0e2cb9)

Features

  • ActionSendDIDComm (49e6841)
  • Add event system to agent (#262) (9a6747e)
  • Add GraphQL IdentityManager methods (189a218)
  • Add port option to cli server (4f66a38)
  • add removeKey, removeService methods to ethr-did-provider (#310) (faccca6), closes #144
  • Add version cmd to cli (64069e9)
  • Added credentialType to the Claim (45a4da2)
  • Added id and tag fields (0b62eaa)
  • Added identityManagerGetIdentityByAlias (43d0817)
  • Added identityManagerImportIdentity (ea7ba3a)
  • Added identityManagerSetAlias (a2bd513)
  • Added IIdentityManagerGetIdentitiesArgs (1e0c9aa)
  • Added keyManagerGetKeyManagementSystems (9741462)
  • Added save to GQL handleMessage (be23418)
  • Adding createProfilePresentation (ae5e73f)
  • Adding ethr-did gas and ttl config (d910b14)
  • Adding some key manager methods (ec6645d)
  • Agent dbConnection constructor option (e3dfc2f)
  • API key / Bearer token support in CLI (45e7591)
  • Authorized agent methods (53f9454)
  • Beta of daf-elem-did (fe286e3)
  • Bump version (63dd12d)
  • Bump version (cf659c0)
  • Changed DID type from ID to String (55ccdd4)
  • CLI config (5a3391e)
  • CLI create-config (ec96204)
  • CLI Data explorer (fb7d155)
  • CLI execute object type (e04b0ee)
  • CLI execute uses OpenApi (mvp) (cb310dd)
  • CLI handling ngrok errors (eed46d4)
  • CLI server homepage template (ac9cf52)
  • CLI upgraded to the latest API (b440dd1)
  • Constructing agent from YAML config (7a2498f)
  • Credential Status in data model (24e2d5d)
  • daf-elem-did (62776c2)
  • Daf-express overrides (31a0970)
  • Daf-react-native-libsodium (dbec780)
  • Daf-rest & daf-express (9c9a597)
  • DB Migration CredentialStatus (44fd36d)
  • Debug agent.execute (fb58ddc)
  • Default IdentityProvider (39f2e39)
  • Default IdentityProvider (3334f6e)
  • Docker image and docker-compose example (84ddcad)
  • Dynamic OpenAPI schema (f12236b)
  • enable CORS in daf-cli server by default (#284) (aca46b3)
  • Enable setting headers to DAF DID Comm (#239) (03f3dbb)
  • Encrypting private keys with SecretBox (8833931)
  • Encrypting private keys with SecretBox (b8cbdd4)
  • ENV support in yml config (1dee7b2)
  • Exporting findCredentialsForSdr (ef1c973)
  • Express router (4b8c3d6)
  • Generate plugin schema (#277) (c90473a)
  • Generating OpenAPI schema (broken) (e319c41)
  • Generating plugin schemas (d4450cd)
  • GQL count queries (9e859c1)
  • Gql Not operator (dd624c2)
  • GraphQL client settings: apiUrl, apiKey (9b1fd12)
  • GraphQL KeyManager (2b092e9)
  • GraphQL message handler (10d31cc)
  • GraphQL methods (6446f2d)
  • GraphQL w3c (967b916)
  • Handling credentials in SDR message (32d4a2c)
  • Identity provider for did:web (9b20fb1)
  • Identity provider for did:web (ba030bf)
  • Identity saveDate updateDate (e845a84)
  • Multiple audience dids (eaa1a40)
  • Network config for daf-resolver (5efd82c)
  • Query credentials for did (a39f956)
  • Remote methods example (9e61006)
  • release: Fix package descriptions and trigger new minor release (#233) (e67f4da)
  • release: Trigger a new minor release (#234) (7c905e1)
  • REST api handling incoming msg (372cd25)
  • Activity feed (50bc5d5)
  • Add JWT output for credential.ts and sdr.ts in cli (c16dea6)
  • Add whitelisted issuers in SDR (f486f07)
  • Added actionSignVc mutation (4ef9a15)
  • Added actionSignVp mutation (7cedec1)
  • Added daf-did-jwt (22898d4)
  • Added data-explorer to daf-cli (eebe040)
  • Added react-native-async-storage (1270740)
  • Adding daf-ethr-did-local-storage (f73b435)
  • Adding daf-random (f362f6b)
  • Adding daf-react-native-libsodium (6446411)
  • Adding list of messages (72dca61)
  • All ethr Identity Providers updated (552c967)
  • Breaking. New did management interfaces (c384159)
  • Bump minor version (npm conflicts) (67b77af)
  • Bump minor version (npm conflicts) (34cefc2)
  • cli identity management improvements (489b5e9)
  • Create + Send SDR request (d87127b)
  • Create and send VP from CLI (c7e1360)
  • daf-cli credential sending, receiving (7ca187e)
  • daf-cli identity-manager (8f89979)
  • daf-debug (ff8d66b)
  • daf-did-comm (2ee986f)
  • daf-ethr-did-fs (c2e8024)
  • Daf-ethr-did-fs using experimental interface (cecffd8)
  • daf-ethr-did-react-native (20a47d5)
  • daf-react-native-sqlite3 (cdcb5ac)
  • daf-resolver, daf-resolver-universal (2b2c00f)
  • daf-selective-disclosure (7bbcf12)
  • daf-sodium-fs (42b5d19)
  • daf-trust-graph (2ba3c4f)
  • daf-w3c (b0da9ae)
  • Data deduplication (c5c10b1)
  • Data-store upgrade (c4c0810)
  • Delet identity and conditions (37ca91e)
  • Entities (7f1c85f)
  • Ethr-did export/import (0f8ab11), closes #105
  • Example expressjs (3b79989)
  • Example id-hub (9187906)
  • Experimentation (134a812)
  • Experiments with KeyStore IdentityStore (cca8825)
  • Fetching URL to get the message payload (72596e4)
  • FS dids backed by jwk (7a93f7c)
  • FS IdentityStore (a2521e0)
  • FS KMS (1bcf4c1)
  • Global state for identity (06ff655)
  • GQL queries WIP (b581061)
  • GQL queries WIP (698aca4)
  • GQL query to get latest service messages (8061fbe)
  • GraphQL queries for entities (9faa883)
  • GraphQL queries for entities (0581795)
  • Graphql server in CLI (70890bd)
  • IdentityController, KeyStore (e86fec4)
  • IdentityStore and KeyStore in daf-core (238539c)
  • IdentityStore docs (190b505)
  • Initial dashboard layout (31b69a8)
  • Issue credential rewired (1351a56)
  • LatestClaimValue method (8df54b8)
  • List known identities in connections view (784c29b)
  • Loading indicator (a463e40)
  • Message object with validation (8bf6a9d)
  • Metamask Identity Controller (720b52c)
  • Method dataStoreORMGetIdentities (7952fbb)
  • Method identityManagerGetOrCreateIdentity (0155389)
  • More queries (30ac032)
  • More queries (29bf414)
  • Moving DID Doc management to the provider (b6bd930)
  • New DID management interfaces (9599e2a)
  • New Identity TS and GraphQL interfaces (3f8ff1c)
  • New Identity TS and GraphQL interfaces (a36d691)
  • Ngrok support in CLI (56c464d)
  • OpenAPI server in CLI (ccdd6a7)
  • Optional polling interval (f03aad6)
  • Optionally add permissions to gql resolvers (0d5b212)
  • pass along authentication metadata into handlers (199426b)
  • Passing keyStore to Identity object (dafcac2)
  • Provide link to DID document (1578c1c)
  • PublicProfile VP in CLI server (6d6b710)
  • Publishing serviceEndpoint to DID Doc (a9fb385)
  • Query for single credential by id(hash) (1283ce5)
  • Registry config (fe2ebc6)
  • Reinstate credentialStatus as top level attribute (4b17689)
  • Reinstate credentialStatus as top level attribute (8347b1f)
  • Removing daf-debug (a1ebe1d)
  • Removing examples from workspaces (5cf7343)
  • Removing GraphQL support (3646aab)
  • Removing profile service CLI (dc93089)
  • Renamed Core to Agent (f2c79b6)
  • Renaming MessageValidator to MessageHandler (586b43c)
  • Respond to SDR request (8aafc6b)
  • REST API example (0102582)
  • Return the txHash in addPublic key (c56ada2)
  • Sample auth (ef30a6e)
  • Saving message and VC meta data (1928125)
  • SDR helper and specs (c00b5c1)
  • SDR validation (12ff8eb)
  • Selective Disclosure Request (9afe0c5)
  • Sending encrypted DIDComm messages (2f12513)
  • Server / Client example (f757b7e)
  • Server config (b3b9639)
  • Set default did as first (cc9332c)
  • Setup routing and layout templates (19236cd)
  • Show credentials on connections (84abfa0)
  • Show gravatar for did (f537372)
  • Show Request in sidepanel (d930b92)
  • SignCredentialJwt returns Credential (8aefe92)
  • Simple login flow (8d6042a)
  • Simpler create VC/VP (#309) (172c908)
  • TypeORM wip (27e4ab2)
  • Unique (with hash) VC/VP in ORM results (bcfc3e8)
  • Universal resolver unit tests (8b92d1c)
  • Update readme (39a3261)
  • Updated architecture diagram (dafa3c0)
  • Updated entities (00db341)
  • Updated lock file (c46ecf2)
  • Updating docs (86ba15c)
  • Updating examples to the new API (13c7e3b)
  • URL message validator (7e516e4)
  • Use handleMessage instead of validateMessage (75fb74a)
  • Using agent created from YAML config (ce2960c)
  • Using data store (c2b76fd)
  • Using DIDComm for encryption (02fefa9)
  • Using EventEmitter instead of pubsub-js (5d50acf)
  • Using OpenAPI schema in rest & express (80d0bad)
  • Validating all plugin method arguments (2c868f7)
  • Validating returnType (c7d1ef3)
  • Validation in SDR response (fab06d2)
  • Version bump (5f8c0fe)
  • Version bump (f482187)
  • Version bump (c981add)
  • Version bump (4fd60a9)
  • Web DID path (multi user) support (#282) (08996bd)
  • WIP (f491371)

BREAKING CHANGES

  • This rename affects almost all the Identity management API Please look for IDIDManager.ts in daf-core/src/types to see the new method names. Functionality is the same but some renaming is required if already in use.

  • refactor: Rename Identity to Identifier

  • fix: Integration tests

  • refactor: WebDIDProvider

  • refactor: EthrDIDProvider

  • refactor: DIDStore

  • refactor: Resolver

  • refactor: DidManagerFind

  • refactor: DidManagerFind

  • refactor: DidManagerGet

  • refactor: DidManagerCreate

  • refactor: DidManagerGetOrCreate

  • refactor: DidManagerImport

  • refactor: DidManagerDelete

  • refactor: KeyManager

  • refactor: DefaultDID

  • refactor: IDIDManager

  • refactor: IDIDManager.ts

  • daf-cli: This refactor changes the CLI list of commands. Run daf --help to get the latest options. The same actions are possible, but under different (simpler) names and subcommands.

  • daf-resolver: The configuration for daf-resolver has changed to be less opinionated. It requires a did-resolver#Resolver that can be configured with whichever DID methods your agent needs.

Co-authored-by: Mircea Nistor [email protected]

  • the IW3c type and W3c class have been renamed to ICredentialIssuer and CredentialIssuer

fix(deps): update did-resolver and did-jwt libs for all packages to maintain type consistency

  • database schema change required to accept large claims
  • DB Schema change
  • Introducing TypeORM - support for more databases Deprecating some packages.
  • Introducing TypeORM - support for more databases Deprecating some packages.
  • new interfaces for IdentityManager AbstractIdentityController AbstractIdentityProvider AbstractIdentityStore AbstractIdentity AbstractKeyManagementSystem AbstractKey AbstractKeyStore