Feat/sdk readonly client

README.md

@@ -75,7 +75,21 @@ const {id} = await addDoc(collection, {
 // query the document
 const resultSet = await queryDoc<Book>(collection, "/[author=Cixin-Liu]")
 ```
-if you have any questions, please feel free to ask us for help
+
+if you have any questions, please feel free to ask us for help and you can find more detail about the example
+* the doc for [createClient](https://docs.db3.network/functions/createClient.html)
+* the doc about [queryDoc](https://docs.db3.network/functions/queryDoc.html)
+
+
+# Try Our Cloud Sandbox
+
+* [Console](https://console.cloud.db3.network/console/home)
+* Data Rollup Node: https://rollup.cloud.db3.network
+* Data Index Node: https://index.cloud.db3.network
+
+You can connect to the Data Rollup Node and Data Index Node with db3.js
+
+Note: the cloud sandbox is just for testing and unstable
 
 # How it works
 

sdk/README.md

@@ -6,32 +6,38 @@
 db3.js is the [db3 network](https://github.com/dbpunk-labs/db3) javascript API and you can use it to write and query JSON documents against the db3 network.
 and you can build fully decentralized applications combining [web3.js](https://github.com/web3/web3.js) and db3.js
 
-# Play with db3.js
+# Getting Started
 
 ## Install db3.js
 
 ```
 yarn add db3.js
 ```
 
-## Use db3.js in action
+## Quick Started
 
 ```typescript
 // create a account
 const account = createRandomAccount()
-// create the client
-const client = createClient('http://127.0.0.1:26619',
-                            'http://127.0.0.1:26639', 
+// create the client from db3 cloud sandbox
+const client = createClient('https://rollup.cloud.db3.network',
+                            'https://index.cloud.db3.network',
                              account)
-
+await syncAccountNonce(client)
 // get the collection
-const collection = await getCollection("0xF7..79", "book", client)
-
+const collection = await getCollection("0x6ef32f0d8fc6bc872ffa977eb80920a0a75d0206", "book", client)
 // add a document
 const {id} = await addDoc(collection, {
-                name:"The Three-Body Problem"，
+                name:"The Three-Body Problem",
                 author:"Cixin-Liu",
                 rate:"4.8"} as Book)
+console.log(id)
 // query the document
 const resultSet = await queryDoc<Book>(collection, "/[author=Cixin-Liu]")
 ```
+
+<img width="500px" src="./statics/quick_started.png" align="center"/>
+
+[Try on codesandbox](https://codesandbox.io/s/db3-js-helloword-447nxd?file=/src/App.tsx:673-710)
+
+

sdk/src/store/database_v2.ts

@@ -34,7 +34,7 @@ import {
     EventDatabaseMutation,
 } from '../proto/db3_mutation_v2'
 
-import { Client } from '../client/types'
+import { Client, ReadClient } from '../client/types'
 import { toHEX, fromHEX } from '../crypto/crypto_utils'
 import { Index } from '../proto/db3_database_v2'
 
@@ -172,7 +172,7 @@ export async function createDocumentDatabase(client: Client, desc: string) {
 export async function getCollection(
     addr: string,
     name: string,
-    client: Client
+    client: Client | ReadClient
 ) {
     const db = await getDatabase(addr, client)
     const collections = await showCollection(db)
@@ -197,7 +197,7 @@ export async function getCollection(
  * @returns the {@link Database}[]
  *
  **/
-export async function getDatabase(addr: string, client: Client) {
+export async function getDatabase(addr: string, client: Client | ReadClient) {
     const response = await client.provider.getDatabase(addr)
     const db = response.database
     if (!db) {
@@ -223,7 +223,7 @@ export async function getDatabase(addr: string, client: Client) {
  * @returns the {@link Database}[]
  *
  **/
-export async function showDatabase(owner: string, client: Client) {
+export async function showDatabase(owner: string, client: Client | ReadClient) {
     const response = await client.provider.getDatabaseOfOwner(owner)
     return response.databases
         .filter((item) => item.database.oneofKind != undefined)

sdk/src/store/types.ts

@@ -15,7 +15,7 @@
 // limitations under the License.
 //
 
-import { Client } from '../client/types'
+import { Client, ReadClient } from '../client/types'
 import { DocumentEntry, DocumentData } from '../client/base'
 import {
     DatabaseMessage as InternalDatabase,
@@ -37,7 +37,7 @@ export type CreateCollectionResult = {
 
 export type Database = {
     addr: string
-    client: Client
+    client: Client | ReadClient
     internal: InternalDatabase | undefined
     state: DatabaseState | undefined
 }

sdk/tests/query.test.ts

@@ -115,7 +115,7 @@ describe('test db3.js document_v2 module', () => {
             ],
         }
         await addDoc(collection, doc1)
-        await new Promise((r) => setTimeout(r, 1000))
+        await new Promise((r) => setTimeout(r, 2000))
         return collection
     }
 
@@ -125,7 +125,6 @@ describe('test db3.js document_v2 module', () => {
         const queryStr = '/* | count '
         const resultSet = await queryDoc(collection, queryStr)
         expect('1').toBe(resultSet.count)
-
     })
 
     test('test query with projection', async () => {

src/proto/proto/db3_database_v2.proto

@@ -56,6 +56,12 @@ message DatabaseState {
   uint64 total_col_count = 3;
 }
 
+message DatabaseStatePersistence {
+  string addr = 1;
+  uint64 total_doc_count = 2;
+  uint64 total_col_count = 3;
+}
+
 message EventTable {
   string name = 1;
   repeated Index index_fields = 2;

src/storage/src/db_store_v2.rs

@@ -44,6 +44,8 @@ use tracing::info;
 type StorageEngine = DBWithThreadMode<MultiThreaded>;
 type DBRawIterator<'a> = DBRawIteratorWithThreadMode<'a, StorageEngine>;
 
+const STATE_CF: &str = "DB_STATE_CF";
+
 #[derive(Clone)]
 pub struct DBStoreV2Config {
     pub db_path: String,
@@ -58,11 +60,13 @@ pub struct DBStoreV2Config {
     pub doc_store_conf: DocStoreConfig,
 }
 
+#[derive(Clone)]
 struct CollectionState {
     // the total doc count
     pub total_doc_count: u64,
 }
 
+#[derive(Clone)]
 struct DatabaseState {
     pub doc_order: i64,
     pub collection_state: HashMap<String, CollectionState>,
@@ -95,6 +99,7 @@ impl DBStoreV2 {
                     config.index_store_cf_name.as_str(),
                     config.doc_owner_store_cf_name.as_str(),
                     config.db_owner_store_cf_name.as_str(),
+                    STATE_CF,
                 ],
             )
             .map_err(|e| {
@@ -113,6 +118,7 @@ impl DBStoreV2 {
         })
     }
 
+    pub fn flush_state(&self) {}
     fn update_db_state_for_add_db(&self, db_addr: &str) {
         self.db_state.insert(
             db_addr.to_string(),