Changelog
3.0.0 (2021-09-20)
keyManagetGet
no longer returns private key dataKeyStore
no longer requires a SecretBox
KeyManagementSystem
needs a PrivateKeyStore
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:
SecretBox
parameter from KeyManager
PrivateKeyStore
parameter to KeyManagementSystem
with a SecretBox
that you were using before with KeyManager
(and keep the same encryption key)@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.