BridgetteDB¶
About¶
BridgetteDB is a lightweight, key value store database built on top of the ethereum blockchain built for nodeJS. It sets and retrives values to a key.
Use¶
To use the system, you will need an ethereum node or RPC endpoint for communitcation. To set a kvs you will need to have an account which can be unlocked
Data flow¶
All data is saved within the BridgetteDB smart contract located on the public blockchain. #DO NOT SAVE ANYTHING THAT IS NOT PUBLIC INFORMATION!#
When interacting with data on chain, a DBKEY is appended to the data to index within the storage space.
The format of a database entry is: DBKEY + key : value The DBKEY is stored when initilizing the db and will be used for all keys within the session without a need to explicitly append it.
Install¶
Install using a packge manager
$ yarn add @chipprbots/bridgetteDB
$ npm install -s @chipprbots/bridgetteDB
Enable¶
To use BridgetteDB, require it within a script and create a new instance of the DB agent. All values are strings.
var bdb = require('@chipprbots/bridgetteDB');
var db = new bdb({
"nodeAddr": url of the ethereum node,
"accountAddress": ethereum account to use for transactions,
"accountPasswd" : ethereum account password,
"kvsAddr" : address the kvs is deployed to, "0x57EEB5d4D3E1Ac75D51067AE2dCF78922CF3F189",
"DBKEY": user assigned unique key for storage
})