!>Verida Datastore is under development. This is a preview release for developers to provide early feedback. Do not expect any data saved to be retained on the testnet, unless you run your own dataserver. API's and data schemas will possibly change before mainnet is launched.
Learn:
Other links:
The Verida Datastore enables developers to quickly build self-sovereign applications — allowing users to own their own data.
Applications developed using Verida Datastore and using common schemas allow data to by shared / syncronised across all other applications used by the same user. This provides unparallelled data portability.
The system is distributed by design, enabling user data to be stored on Verida infrastructure, a user's own infrastructure or use third party hosting providers.
Verida Datastore provides an easy to use library that abstracts the complexities of encryption, permissioning, schemas and user management. Applications can access user data once unlocked by a users blockchain wallet (ie: Ethereum, VeChain).
Applications can store unstructured data, but are encouraged to use the built-in data schemas pre-defined by Verida (or develop their own custom schemas). This ensures all applications built using Verida Datastore can interoperate together with data of a particular type created in one application available in all other applications that support that data type.
The Verida Datastore is the first component in a broader ecosystem of open source tools being developed by Verida.
A sandbox has been created so you can easily play with the Verida Datastore library within your browser.
Open Verida Datastore Sandbox.
This NodeJs library provides a drop in self sovereign data storage and communication platform for any web application.
Install into your application:
npm install @verida/datastore
Create an application instance and ask the user to authorize your application:
import Verida from '@verida/datastore';
// Fetch the users web3Provider and address
const web3Provider = await Verida.Helpers.wallet.connectWeb3('ethr');
const address = await Verida.Helpers.wallet.getAddress('ethr');
Verida.setConfig({
appName: 'Your Application Name'
});
let app = new Verida({
chain: 'ethr',
address: address,
web3Provider: web3Provider
});
At this point, the user will be asked to connect Metamask to your application (if they haven't already).
You now have an application instance that allows you to create databases, access other user's public profiles and receive data via the user's application inbox.
?>Note: You don't have to use the rather basic Verida.Helpers.wallet to obtain a web3Provider. You can use your own code or other third party libraries to facilitate this.
You can now connect the user to your application:
let connected = await app.connect(true);
A popup will appear asking the user to sign a consent message authorizing the application to use their data. The first time a user connects, the Datastore library will create new encryption keys that are used by this user and this application only.
Once complete, the user is logged into the application.
You can access the user's DID via:
console.log(app.user.did);
You can now open a private, encrypted database for the user. It will be created if it doesn't exist.
let db = await app.openDatabase('test_db');
let item = await db.save({
hello: 'world'
});
let items = await db.getMany();
console.log(items);
It's also possible to create public databases and connect to other user's public database. We are also working on permissioned databases where the database owner can control who has read or write access.
?>See Data Permissions
In a world where users own their own data, it's important their data is portable between applications. Otherwise we end up with the current situation of data silos, where user data is scatterred across lots of different applications.
Verida solves this problem by creating databases with a defined schema, called Datastores. This ensures data interoperability between applications.
Lets demonstrate by opening the datastore using the social/contact schema:
let contactsDs = await app.openDatastore('social/contact');
let contact = {
firstName: 'John',
lastName: 'Smith',
email: '[email protected]'
}
let success = await contactsDs.save(contact);
if (!success) {
console.error(contactsDb.errors);
} else {
console.log("Contact saved");
}
let contacts = await contactsDs.getMany();
console.log(contacts);
?>Learn more about databases and datastores
Your application has an inbox, where other applications and other users can send encrypted messages to users. Your application can listen to new inbox messages and handle them as appropriate.
This effectively creates a secure Peer-to-Peer communication channel between all users and applications.
!>Example coming soon