Build a demo on DB3 Network is super easy, follow the steps:
Step1: Create or Find a database
You can create or find a database on Data Manager System
Every public databases on DB3 can be find and be reused by every builder
Step2: Build dApps based on the database
Since you've got a database , now you can build dApps based on the database.
Here is a Demo example you may refer to Message_wall
Or try On line Website of the demo
Chosing Nodes
DB3 network is composed by a group of nodes. You can chose what ever node to connect when building a dApp, or you can run self-running a node.
Find exsiting node
We have two types of node: Normal Nodes & Validator Nodes. Both types of node can be connected directly, the differences is that you have to sign when querying data from the validator nodes while no signiture is required when querying from normal nodes. The normal nodes will give user a better using experience but sacrifice some data security. All the data querid from normal nodes is not verified and this means the truth of the data cannot be trusted. While validator nodes do not have a security and trust problem but you have to sign for every Query Session
Normal Nodes
- https://grpc.devnet.db3.network
Validator Nodes
- http://18.162.230.6:26659
- http://16.163.108.68:26659
- http://18.162.114.26:26659
Running a local Node
Use this command line to download and install a client
$ curl --proto '=https' --tlsv1.2 -sSf https://up.db3.network/db3up_init.sh | sh
Note: curl and python3 are required in your environment
A db3 command and db3up command will be available on your terminal if everything goes well
Note: If you encounter the error 'db3 not found' or 'db3up not found', use the following solution to resolve it:
Run thesource ~/.zshrcif you use zsh orsource ~/.bashrcif you use bash
You have two options available. The first is to host an independent local network, while the second involves connecting to a community network that will synchronize data from remote nodes.
As independent local network
Command line
$ db3up localnet
This command will init a local network at the end point of http://127.0.0.1:26659
As Community node
Command line
$ db3up join_devnet
This command will also init a local network at the end point of http://127.0.0.1:26659 but as a communit node and it will synchronize data from remote nodes and keep same block height
Build a dapp with JS
Start with npm install db3.js
1. Build db3 client
// the key seed
const mnemonic = "...";
// create a wallet
const wallet = DB3BrowserWallet.createNew(mnemonic, "DB3_SECP259K1");
// build db3 client
const client = new DB3Client("http://127.0.0.1:26659", wallet);
2. Init databases and collection instance
// The database address
const databaseAddr = "0x14c4eacfcb43d09b09139a0323d49fbe4ea0d5c9";
// The collection that store data
const collectionName = "message";
const db = new DB3Store(databaseAddr, client);
const collectionIns = await collection(db, collectionName);
3. CRUD data by collection
// add a doc to collection
const result = await addDoc(collectionIns, {
msg: "hello",
time: new Date(),
address: "north",
});
// get all docs from collection
const docs = await getDocs(collectionIns);
// get docs by condition
const re = await getDocs(query(collectionIns, where("docId", "==", "xxxxx")));
For a full demo build with npm install db3.js go to the repository TODO MVC Demo
For more info please go to db3.js repository
Use console client
1. Start db3 console client
$ ./target/debug/db3 console
██████╗ ██████╗ ██████╗
██╔══██╗██╔══██╗╚════██╗
██║ ██║██████╔╝ █████╔╝
██║ ██║██╔══██╗ ╚═══██╗
██████╔╝██████╔╝██████╔╝
╚═════╝ ╚═════╝ ╚═════╝
@db3.network🚀🚀🚀
db3>-$
db3>-$ new-db
database address | mutation id
--------------------------------------------+----------------------------------------------
0x59cd014b73b81e36daa90f2dee940709474809ac | au3Q+hMreJe2MGXeIjxtKcUFhwJbPDciVyFOZd2bvgQ=
db3>-$ show-db --addr 0x59cd014b73b81e36daa90f2dee940709474809ac
# | database address | description | sender address | related mutations | collections
---+--------------------------------------------+-------------+--------------------------------------------+----------------------------------------------+-------------
1 | 0x59cd014b73b81e36daa90f2dee940709474809ac | | 0x6922f1bf2cbde237e0bf53dda36186e9ed2e5e08 | au3Q+hMreJe2MGXeIjxtKcUFhwJbPDciVyFOZd2bvgQ= |
3. Create a new collection in the database
db3>-$ new-collection --addr 0x59cd014b73b81e36daa90f2dee940709474809ac --name userinfo --index '{"id": 1,"name": "idx1","fields": [{"field_path": "name","value_mode": {"Order": 1}},{"field_path": "bio","value_mode": {"Order": 2}}]}'
send add collection done!
mutation_id
----------------------------------------------
9Uo1VL1I/sMYHbzY+vHybYMn4Z2KPPrJQ2+sfZvI8sM=
db3>-$ show-collection --addr 0x59cd014b73b81e36daa90f2dee940709474809ac
name | index
----------+--------------------------------------------------------------------------------------------------------------------------------
userinfo | {"name":"idx1","id":0,"fields":[{"field_path":"name","value_mode":{"Order":1}},{"field_path":"bio","value_mode":{"Order":2}}]}
4. Create a new doc in the collection
db3>-$ new-doc --addr 0x59cd014b73b81e36daa90f2dee940709474809ac --collection-name userinfo --documents '{"name": "Bob","age": 43,"bio": "a virtual person in Blockchain"}'
send add document done
mutation id
----------------------------------------------
ct9xhtOtnrbUj+g6c8cppHaKn9RknQNSF5kx0xxw5NQ=
db3>-$ show-doc --addr 0x59cd014b73b81e36daa90f2dee940709474809ac --collection-name userinfo
id_base64 | owner | document | mutation_id
--------------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------
AQAAAAAAAFy3AAEAAQAAAAAAAF0bAAEAAA== | 0x6922f1bf2cbde237e0bf53dda36186e9ed2e5e08 | Document({"name": String("Bob"), "age": Int64(43), "bio": String("a virtual person in Blockchain")}) | ct9xhtOtnrbUj+g6c8cppHaKn9RknQNSF5kx0xxw5NQ=
5. Query a doc by limit
db3>-$ show-doc --addr 0x59cd014b73b81e36daa90f2dee940709474809ac --collection-name userinfo --limit 1
id_base64 | owner | document | mutation_id
--------------------------------------+--------------------------------------------+------------------------------------------------------------------------------------------------------+----------------------------------------------
AQAAAAAAAFy3AAEAAQAAAAAAAF0bAAEAAA== | 0x6922f1bf2cbde237e0bf53dda36186e9ed2e5e08 | Document({"name": String("Bob"), "age": Int64(43), "bio": String("a virtual person in Blockchain")}) | ct9xhtOtnrbUj+g6c8cppHaKn9RknQNSF5kx0xxw5NQ=
db3>-$ show-doc --addr 0x59cd014b73b81e36daa90f2dee940709474809ac --collection-name userinfo --limit 2
id_base64 | owner | document | mutation_id
--------------------------------------+--------------------------------------------+--------------------------------------------------------------------------------------------------------+----------------------------------------------
AQAAAAAAAFy3AAEAAQAAAAAAAF0bAAEAAA== | 0x6922f1bf2cbde237e0bf53dda36186e9ed2e5e08 | Document({"name": String("Bob"), "age": Int64(43), "bio": String("a virtual person in Blockchain")}) | ct9xhtOtnrbUj+g6c8cppHaKn9RknQNSF5kx0xxw5NQ=
AQAAAAAAAFy3AAEAAQAAAAAAAF8YAAEAAA== | 0x6922f1bf2cbde237e0bf53dda36186e9ed2e5e08 | Document({"name": String("alice"), "age": Int64(43), "bio": String("a virtual person in Blockchain")}) | X1Ml6FfwYm9x2ZWXdLCjWrDDk3YlLaOty/pOz/i/icE=
6. Query a doc by filter
db3>-$ show-doc --addr 0x59cd014b73b81e36daa90f2dee940709474809ac --collection-name userinfo --filter '{"field": "name", "value": "Bob", "op": "=="}'