Immudb09 (#15)

* Removed use of SV functions

* Aligned with immudb schema 

* Deprecated safeset and safeget, switched to verified[GS]et

* Added Z function

* Updated readme with verified set and get

* Version 0.9.0

Author: SimoneLazzaris

Makefile

@@ -4,17 +4,22 @@ SHELL := /bin/bash
 PYTEST ?= python -m pytest
 PIP ?= pip
 COVERAGE ?= $(shell which coverage)
+ifndef VIRTUAL_ENV
+USERFLAG="--user"
+else
+USERFLAG=
+endif
 
 all: init test
 
 proto: immudb/grpc
 	make -C immudb/grpc
 
 init:
-	$(PIP) install -r requirements.txt --user
+	$(PIP) install -r requirements.txt $(USERFLAG)
 
 dev:
-	$(PIP) install -r requirements-dev.txt --user
+	$(PIP) install -r requirements-dev.txt $(USERFLAG)
 
 test:
 	$(PYTEST) -vv --color=yes tests/

README.md

@@ -31,18 +31,31 @@ please read [immudb research paper] for details of how immutability is ensured b
 
 ## Prerequisites
 
-immu-py assumes there is an existing instance of the immudb server up and running. Running `immudb` is quite simple, please refer to the
+immu-py assumes there is an existing instance of the immudb server up and running. 
+Running `immudb` is quite simple, please refer to the
 following link for downloading and running it: https://immudb.io/docs/quickstart.html
 
+immudb-py requires python version 3.6 or greater.
+If you are using 3.6, you'll need dataclasses package; on 3.7+,
+dataclasses is part of the python distribution.
+
 ## Installation
 
-Install the package using pip:
+You can install latest version cloning this repository, and then use the make command to install
+prerequisites and the package itself:
+
+```shell
+    make init
+    make install
+```
+
+Or, you can install latest stable version using pip:
 
 ```shell
     pip3 install immudb-py
 ```
 
- Then import the client as follows:
+Then, in you code, import the client library as as follows:
 
 ```python
     from immudb import ImmudbClient
@@ -58,7 +71,7 @@ Install the package using pip:
 
 immu-py supports the [latest immudb release].
 
-[latest immudb release]: https://github.com/codenotary/immudb/releases/tag/v0.7.1
+[latest immudb release]: https://github.com/codenotary/immudb/releases/tag/v0.9.0
 
 ## Quickstart
 
@@ -99,7 +112,8 @@ Use `login` and `logout` methods to initiate and terminate user sessions:
 ```
 ### Encoding
 
-Please note that, in order to provide maximum flexibility, all functions accept byte arrays as parameters. Therefore, unicode strings must be properly encoded.
+Please note that, in order to provide maximum flexibility, all functions accept byte arrays as parameters.
+Therefore, unicode strings must be properly encoded.
 It is possible to store structured objects, but they must be serialized (e.g., with pickle or json).
 
 ### Creating a database
@@ -130,16 +144,16 @@ may be used when validations can be post-poned:
     result = client.get(b"k123");
 ```
 
-### Verified or Safe read and write
+### Verified read and write
 
 immudb provides built-in cryptographic verification for any entry. The client
 implements the mathematical validations while the application uses as a traditional
 read or write operation:
 
 ```python
     try:
-        client.safeSet(b"k123", new byte[]{1, 2, 3});
-        results = client.safeGet(b"k123");
+        client.verifiedSet(b"k123", b"v123");
+        results = client.verifiedGet(b"k123");
     Except VerificationException as e:
         # Do something
 ```

devtest.py

@@ -3,32 +3,10 @@
 
 a = ImmudbClient()
 a.login("immudb","immudb")
-print(a.databaseUse(b"defaultdb"))
-#print(a.databaseCreate(b"testdb"))
-#print(a.databaseList())
-#print("Use:")
-#print(a.databaseUse(b"defaultdb"))
+kvs={}
+for t in range(0,100):
+        value="test_sago_value_{:04d}".format(t)
+        key="test_sago_key_{:04d}".format(t)
+        kvs[key.encode('ascii')]=value.encode('ascii')
+a.setAll(kvs)
 
-# print(a.databaseUse(b"testdb"))
-
-# b = a.safeSet(b"pythonkey",b"thisismyvalue")
-# print(b)
-# print(a.safeGet(bytes("pythonkey", encoding="utf-8")))
-
-# arr=[]
-# for i in range(0,100):
-#     k="key_{}".format(i).encode('utf8')
-#     v="value_{}".format(i).encode('utf8')
-#     a.safeSet(k,v)
-#     arr.append(k)
-# resp=a.getAll(arr)
-# print(resp)
-
-
-#xset = {b"key3": b"value3", b"key4": b"value4"}
-#print(a.setAll(xset))
-#print(a.getAll(xset.keys()))
-
-#print(a.safeSet(b'keykey2', b'valval2'))
-#print(a.get(b'keykey2'))
-print(a.history(b'key1'))

immudb/VerificationException.py

@@ -4,13 +4,12 @@
 from immudb import header_manipulator_client_interceptor
 from immudb.handler import (batchGet, batchSet, changePassword, createUser,
                           currentRoot, databaseCreate, databaseList, databaseUse, 
-                          get, listUsers, safeGet, safeSet, setValue, history, 
-                          scan, reference)
+                          get, listUsers, verifiedGet, verifiedSet, setValue, history, 
+                          scan, reference, verifiedreference, zadd, verifiedzadd, 
+                          zscan, healthcheck, txbyid, verifiedtxbyid)
 from immudb.rootService import RootService
 from immudb.grpc import schema_pb2_grpc
-
-OLDEST_FIRST=True
-NEWEST_FIRST=False
+import warnings
 
 class ImmudbClient:
     def __init__(self, immudUrl=None):
@@ -52,6 +51,7 @@ def shutdown(self):
         self.channel = None
         self.intercept_channel.close
         self.intercept_channel = None
+        self.__rs = None
 
     def set_token_header_interceptor(self, response):
         try:
@@ -72,42 +72,56 @@ def set_token_header_interceptor(self, response):
     @property
     def stub(self):
         return self.__stub
+    
+    def healthCheck(self):
+        return healthcheck.call(self.__stub, self.__rs)
+        
 
     def get(self, key: bytes):
-        request = schema_pb2_grpc.schema__pb2.Key(key=key)
-        return get.call(self.__stub, self.__rs, request)
+        return get.call(self.__stub, self.__rs, key)
+    
+    def getValue(self, key: bytes):
+        ret=get.call(self.__stub, self.__rs, key)
+        if ret==None:
+            return None
+        return ret.value
 
     def set(self, key: bytes, value: bytes):
-        request = schema_pb2_grpc.schema__pb2.KeyValue(key=key, value=value)
-        return setValue.call(self.__stub, self.__rs, request)
+        return setValue.call(self.__stub, self.__rs, key, value)
 
     def safeGet(self, key: bytes):
-        request = schema_pb2_grpc.schema__pb2.SafeGetOptions(key=key)
-        return safeGet.call(self.__stub, self.__rs, request)
+        warnings.warn("Call to deprecated safeGet. Use verifiedGet instead",
+            category=DeprecationWarning,
+            stacklevel=2
+            )
+        return verifiedGet.call(self.__stub, self.__rs, key)
+    
+    def verifiedGet(self, key: bytes):
+        return verifiedGet.call(self.__stub, self.__rs, key)
+    
+    def verifiedGetAt(self, key: bytes, atTx:int):
+        return verifiedGet.call(self.__stub, self.__rs, key, atTx)
 
     def safeSet(self, key: bytes, value: bytes):
-        request = schema_pb2_grpc.schema__pb2.SafeSetOptions(
-            kv={"key": key, "value": value})
-        return safeSet.call(self.__stub, self.__rs, request)
+        warnings.warn("Call to deprecated safeSet. Use verifiedSet instead",
+            category=DeprecationWarning,
+            stacklevel=2
+            )
+        return verifiedSet.call(self.__stub, self.__rs, key, value)
+    
+    def verifiedSet(self, key: bytes, value: bytes):
+        return verifiedSet.call(self.__stub, self.__rs, key, value)
 
-    def getAllItems(self, keys: list):
-        klist = [schema_pb2_grpc.schema__pb2.Key(key=k) for k in keys]
-        request = schema_pb2_grpc.schema__pb2.KeyList(keys=klist)
-        return batchGet.call(self.__stub, self.__rs, request)
+    def getAllValues(self, keys: list):
+        resp = batchGet.call(self.__stub, self.__rs, keys)
+        return resp
 
     def getAll(self, keys: list):
-        klist = [schema_pb2_grpc.schema__pb2.Key(key=k) for k in keys]
-        request = schema_pb2_grpc.schema__pb2.KeyList(keys=klist)
-        resp = batchGet.call(self.__stub, self.__rs, request)
-        return resp
+        resp = batchGet.call(self.__stub, self.__rs, keys)
+        return {key:value.value for key, value in resp.items()}
 
     def setAll(self, kv: dict):
-        _KVs = []
-        for i in kv.keys():
-            _KVs.append(schema_pb2_grpc.schema__pb2.KeyValue(
-                key=i, value=kv[i]))
-        request = schema_pb2_grpc.schema__pb2.KVList(KVs=_KVs)
-        return batchSet.call(self.__stub, self.__rs, request)
+        return batchSet.call(self.__stub, self.__rs, kv)
 
     def changePassword(self, user, newPassword, oldPassword):
         request = schema_pb2_grpc.schema__pb2.ChangePasswordRequest(
@@ -130,7 +144,8 @@ def listUsers(self):
         return listUsers.call(self.__stub, None)
 
     def databaseList(self):
-        return databaseList.call(self.__stub, self.__rs, None)
+        dbs=databaseList.call(self.__stub, self.__rs, None)
+        return [x.databasename for x in dbs.dblist.databases]
 
     def databaseUse(self, dbName: bytes):
         request = schema_pb2_grpc.schema__pb2.Database(databasename=dbName)
@@ -145,65 +160,42 @@ def databaseCreate(self, dbName: bytes):
         request = schema_pb2_grpc.schema__pb2.Database(databasename=dbName)
         return databaseCreate.call(self.__stub, self.__rs, request)
 
-    def currentRoot(self):
+    def currentState(self):
         return currentRoot.call(self.__stub, self.__rs, None)
 
     def history(self, key: bytes, offset: int, limit: int, sortorder: bool):
-        request = schema_pb2_grpc.schema__pb2.HistoryOptions(
-                key=key,
-                offset=offset,
-                limit=limit,
-                reverse=sortorder
-                )
-        return history.call(self.__stub, self.__rs, request)
+        return history.call(self.__stub, self.__rs, key, offset, limit, sortorder)
 
     def logout(self):
         self.__stub.Logout(google_dot_protobuf_dot_empty__pb2.Empty())
         self.__login_response = None
-
-    def scan(self, prefix: bytes, offset: bytes, limit:int=10, reverse:bool=False, deep:bool=False):
-        request = schema_pb2_grpc.schema__pb2.ScanOptions(
-            prefix=prefix,
-            offset=offset,
-            limit=limit,
-            reverse=reverse,
-            deep=deep)
-        return scan.call(self.__stub, self.__rs, request)
+        
+    def scan(self, key:bytes, prefix:bytes, desc:bool, limit:int,sinceTx:int=None):
+        return scan.call(self.__stub, self.__rs, key, prefix, desc, limit, sinceTx)
 
-    def reference(self, refkey: bytes, key:  bytes):
-        request = schema_pb2_grpc.schema__pb2.ReferenceOptions(
-            reference = refkey,
-            key=key
-            )
-        return reference.call(self.__stub, self.__rs, request)
-
+    def setReference(self, referredkey: bytes, newkey:  bytes):
+        return reference.call(self.__stub, self.__rs, referredkey, newkey)
 
-    def zadd(self):
-        pass
+    def verifiedSetReference(self, referredkey: bytes, newkey:  bytes):
+        return verifiedreference.call(self.__stub, self.__rs, referredkey, newkey)
 
-    def zscan(self):
-        pass
-        
-
-        
-    def scan(self, prefix: bytes, offset: bytes, limit:int=10, reverse:bool=False, deep:bool=False):
-        request = schema_pb2_grpc.schema__pb2.ScanOptions(
-            prefix=prefix,
-            offset=offset,
-            limit=limit,
-            reverse=reverse,
-            deep=deep)
-        return scan.call(self.__stub, self.__rs, request)
+    def zAdd(self, zset:bytes, score:float, key:bytes, atTx:int=0):
+        return zadd.call(self.__stub, self.__rs, zset, score, key, atTx)
 
-    def reference(self, refkey: bytes, key:  bytes):
-        request = schema_pb2_grpc.schema__pb2.ReferenceOptions(
-            reference = refkey,
-            key=key
-            )
-        return reference.call(self.__stub, self.__rs, request)
+    def verifiedZAdd(self, zset:bytes, score:float, key:bytes, atTx:int=0):
+        return verifiedzadd.call(self.__stub, self.__rs, zset, score, key, atTx)
 
-    def zadd(self):
-        pass
+    def zScan(self, zset:bytes, seekKey:bytes, seekScore:float,
+                          seekAtTx:int, inclusive: bool, limit:int, desc:bool, minscore:float,
+                          maxscore:float, sinceTx=None, nowait=False):
+        return zscan.call(self.__stub, self.__rs, zset, seekKey, seekScore,
+                          seekAtTx, inclusive, limit, desc, minscore,
+                          maxscore, sinceTx, nowait)
+                          
+    def txById(self, tx:int):
+        return txbyid.call(self.__stub, self.__rs, tx)
 
-    def zscan(self):
-        pass
+    def verifiedTxById(self, tx:int):
+        return verifiedtxbyid.call(self.__stub, self.__rs, tx)
+    
+