Prepare 1.0 release [ECR-4377] (#59)

Author: popzxc

README.md

@@ -31,8 +31,9 @@ The following table shows versions compatibility:
 |--------------|-------------------------|
 | 0.1          | 0.9.*                   |
 | 0.2          | 0.10.*                  |
-| 0.3.x        | 0.12.*                  |
-| master       | dynamic_services branch |
+| 0.3.1        | 0.12.*                  |
+| 1.0.x        | 1.0.*                   |
+| master       | `exonum` master branch  |
 
 ## System Dependencies
 
@@ -180,32 +181,44 @@ working services:
 
 ```python
 {
-  'artifacts': [
+  "artifacts": [
     {
-      'runtime_id': 0,
-      'name': 'exonum-cryptocurrency-advanced:1.0.0'
+      "runtime_id": 0,
+      "name": "exonum-supervisor",
+      "version": "1.0.0"
     },
     {
-      'runtime_id': 0,
-      'name': 'exonum-supervisor:1.0.0'
+      "runtime_id": 0,
+      "name": "exonum-explorer-service",
+      "version": "1.0.0"
     }
   ],
-  'services': [
+  "services": [
     {
-      'id': 1024,
-      'name': 'XNM',
-      'artifact': {
-        'runtime_id': 0,
-        'name': 'exonum-cryptocurrency-advanced:1.0.0'
-      }
+      "spec": {
+        "id": 2,
+        "name": "explorer",
+        "artifact": {
+          "runtime_id": 0,
+          "name": "exonum-explorer-service",
+          "version": "1.0.0"
+        }
+      },
+      "status": "Active",
+      "pending_status": null
     },
     {
-      'id': 0,
-      'name': 'supervisor',
-      'artifact': {
-        'runtime_id': 0,
-        'name': 'exonum-supervisor:1.0.0'
-      }
+      "spec": {
+        "id": 0,
+        "name": "supervisor",
+        "artifact": {
+          "runtime_id": 0,
+          "name": "exonum-supervisor",
+          "version": "1.0.0"
+        }
+      },
+      "status": "Active",
+      "pending_status": null
     }
   ]
 }

docs/conf.py

@@ -14,17 +14,17 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath("../exonum"))
+sys.path.insert(0, os.path.abspath("../exonum_client"))
 
 
 # -- Project Information -----------------------------------------------------
 
 project = "Exonum Python light client"
-copyright = "2019, The Exonum team"
+copyright = "2020, The Exonum team"
 author = "The Exonum team"
 
 # The full version, including alpha/beta/rc tags:
-release = "0.3.0"
+release = "1.0.0"
 
 
 # -- General Configuration ---------------------------------------------------
@@ -65,6 +65,9 @@
 # unit titles (such as .. function::):
 add_module_names = False
 
+# Mock pysodium so there will be no need in libsodium for building docs
+autodoc_mock_imports = ["pysodium"]
+
 # -- Options for HTML Output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages. See the documentation for

docs/index.rst

@@ -151,42 +151,44 @@ list of working services:
 
 >>> client.public_api.available_services().json()
 {
-  'artifacts': [
+  "artifacts": [
     {
-      'runtime_id': 0,
-      'name': 'exonum-cryptocurrency-advanced',
-      'version': '0.12.0'
+      "runtime_id": 0,
+      "name": "exonum-supervisor",
+      "version": "1.0.0"
     },
     {
-      'runtime_id': 0,
-      'name': 'exonum-supervisor',
-      'version': '0.12.0'
+      "runtime_id": 0,
+      "name": "exonum-explorer-service",
+      "version": "1.0.0"
     }
   ],
-  'services': [
+  "services": [
     {
-      'spec': {
-        'id': 1024,
-        'name': 'XNM',
-        'artifact': {
-          'runtime_id': 0,
-          'name': 'exonum-cryptocurrency-advanced',
-          'version': '0.12.0'
+      "spec": {
+        "id": 2,
+        "name": "explorer",
+        "artifact": {
+          "runtime_id": 0,
+          "name": "exonum-explorer-service",
+          "version": "1.0.0"
         }
       },
-      'status': 'Active'
+      "status": "Active",
+      "pending_status": null
     },
     {
-      'spec': {
-        'id': 0,
-        'name': 'supervisor',
-        'artifact': {
-          'runtime_id': 0,
-          'name': 'exonum-supervisor',
-          'version': '0.12.0'
+      "spec": {
+        "id": 0,
+        "name": "supervisor",
+        "artifact": {
+          "runtime_id": 0,
+          "name": "exonum-supervisor",
+          "version": "1.0.0"
         }
       },
-      'status': 'Active'
+      "status": "Active",
+      "pending_status": null
     }
   ]
 }

examples/README.md

@@ -8,7 +8,10 @@ Recommended order is the following:
 - [api.py](api.py): Minimal example demonstrating how to initialize the client
   and retrieve some information via REST API.
 - [protobuf.py](protobuf.py): Example of downloading and compiling Protobuf
-  sources from the Exonum.
+  sources received from the Exonum node.
+- [custom_protobuf_source.py](custom_protobuf_source.py): Example of downloading 
+  and compiling Protobuf sources received from different sources
+  (github of filesystem).
 - [deploy.py](deploy.py): Sample script that deploys an artifact and starts a
   service instance.
 - [transactions.py](transactions.py): Sample script that uses the deployed and
@@ -37,17 +40,21 @@ pip install -e . --no-binary=protobuf
 Then, run the `exonum-cryptocurrency-advanced` example in the `run-dev` mode:
 
 ```sh
-exonum-cryptocurrency-advanced run-dev -a /tmp/crypt
+exonum-cryptocurrency-advanced run-dev -p /tmp/crypt
 ```
 
-`/tmp/crypt` here is a folder for temporary files of `exonum-cryptocurrency-advanced`.
+`/tmp/crypt` is a folder for temporary config and data files created 
+by the `exonum-cryptocurrency-advanced` process.
 
-You may optionally call `rm -rf /tmp/crypt` as well, if this is not the first launch.
+You may optionally run with `--clean` option as well, if this is not the first launch.
 
 Then, you can run any example:
 
 ```sh
 python examples/api.py
+python examples/custom_protobuf_source.py
 python examples/deploy.py
+python examples/proofs.py
+python examples/protobuf.py
 python examples/transactions.py
 ```

examples/custom_protobuf_source.py

@@ -5,77 +5,89 @@
 of actual one).
 
 Though this may be not really useful (since light client itself is not compatible with Exonum
-0.12), it can be extrapolated to other use cases, e.g. work with other runtimes that do not
+1.0.0), it can be extrapolated to other use cases, e.g. work with other runtimes that do not
 support obtaining protobuf sources from REST API.
 """
 from exonum_client.protobuf_provider import ProtobufProvider
 from exonum_client import ExonumClient, ModuleManager
 
 RUST_RUNTIME_ID = 0
-SERVICE_VERSION = "0.12"
+SERVICE_NAME = "cryptocurrency-advanced"
+SERVICE_VERSION = "0.2.0"
 
 
-def setup_protobuf_provider(protobuf_provider: ProtobufProvider) -> None:
-    """Setups a protobuf provider with main protobuf sources and cryptocurrency-advanced sources for v0.12.
+def setup_protobuf_provider(protobuf_provider: ProtobufProvider, source: str) -> None:
+    """Setups a protobuf provider with main protobuf sources and cryptocurrency-advanced sources for v0.2.0.
 
     Exonum client creates a ProtobufProvider object during its initialization, so we take it here
     and just extend with new sources."""
-    main_sources_url = "https://github.com/exonum/exonum/tree/v0.12/exonum/src/proto/schema/exonum"
-    cryptocurrency_sources_url = (
-        "https://github.com/exonum/exonum/tree/v0.12/examples/cryptocurrency-advanced/backend/src/proto"
-    )
-    protobuf_provider.add_main_source(main_sources_url)
-    protobuf_provider.add_service_source(cryptocurrency_sources_url, "cryptocurrency-advanced", SERVICE_VERSION)
 
+    if source == "github":
+        main_sources_url = "https://github.com/exonum/exonum-proto-sources/tree/master/src/exonum"
+        cryptocurrency_sources_url = (
+            "https://github.com/exonum/exonum/tree/v1.0.0/examples/cryptocurrency-advanced/backend/src/proto"
+        )
+    elif source == "file":
+        main_sources_url = "../tests/proto_dir/proto/main"
+        cryptocurrency_sources_url = "../tests/proto_dir/proto/exonum_cryptocurrency_advanced_1_0_0"
+    else:
+        raise RuntimeError("Wrong location type for protobuf loader")
+
+    protobuf_provider.add_main_source(main_sources_url)
+    protobuf_provider.add_service_source(cryptocurrency_sources_url, SERVICE_NAME, SERVICE_VERSION)
 
-def run() -> None:
-    """Example of downloading the Protobuf sources and using the compiled
-    module."""
 
+def run_example(source: str) -> None:
     # Create client.
     client = ExonumClient(hostname="127.0.0.1", public_api_port=8080, private_api_port=8081)
 
     # Setup protobuf provider.
-    setup_protobuf_provider(client.protobuf_provider)
+    setup_protobuf_provider(client.protobuf_provider, source)
 
     # Create ProtobufLoader via context manager (so that we will not have to
     # initialize/deinitialize it manually):
     with client.protobuf_loader() as loader:
         # Load core proto files:
         loader.load_main_proto_files()
         # Load proto files for the Exonum supervisor service:
-        loader.load_service_proto_files(RUST_RUNTIME_ID, "cryptocurrency-advanced", SERVICE_VERSION)
+        loader.load_service_proto_files(RUST_RUNTIME_ID, SERVICE_NAME, SERVICE_VERSION)
 
-        # Load the main module (helpers.proto).
-        helpers_module = ModuleManager.import_main_module("helpers")
+        # Load the main module (exonum/crypto/type.proto).
+        types_module = ModuleManager.import_main_module("exonum.crypto.types")
 
         # Create a Protobuf message object:
-        public_key = helpers_module.PublicKey()
+        public_key = types_module.PublicKey()
         public_key.data = bytes(i for i in range(32))
 
-        # Load the service module (cryptocurrency.proto from the cryptocurrency-advanced service).
-        # Note that we load "cryptocurrency" module, which is absent in current version
-        # of service, it only exists in Exonum 0.12.
-        service_module = ModuleManager.import_service_module(
-            "cryptocurrency-advanced", SERVICE_VERSION, "cryptocurrency"
-        )
-        # Note that if we want to work with service module, we should use helpers also from that module.
+        # Load the service module (service.proto from the cryptocurrency-advanced service).
+        # Note that we load "service" module, which is absent in current version
+        # of the service, it only exists in Exonum 1.0.
+        service_module = ModuleManager.import_service_module(SERVICE_NAME, SERVICE_VERSION, "service")
+        # Note that if we want to work with service module, we should use types also from that module.
         # That's required because of the inner python Protobuf implementation check system.
-        cryptocurrency_helpers_module = ModuleManager.import_service_module(
-            "cryptocurrency-advanced", SERVICE_VERSION, "helpers"
-        )
+        types_module = ModuleManager.import_service_module(SERVICE_NAME, SERVICE_VERSION, "exonum.crypto.types")
 
         # Workflow is the same as for the main modules:
         transfer = service_module.Transfer()
-        cryptocurrency_public_key = cryptocurrency_helpers_module.PublicKey()
-        cryptocurrency_public_key.data = bytes(i for i in range(32))
+        to = types_module.Hash()
+        to.data = bytes(i for i in range(32))
 
         # Working with Protobuf objects, you have to follow Protobuf Python API conventions.
         # See Protobuf Python API docs for details.
-        transfer.to.CopyFrom(cryptocurrency_public_key)
+        transfer.to.CopyFrom(to)
         transfer.amount = 10
         transfer.seed = 1
 
 
+def run() -> None:
+    """Example of downloading the Protobuf sources from different locations and using the compiled module."""
+
+    # Run example with sources from github.
+    run_example("github")
+
+    # Run example with sources from filesystem.
+    run_example("file")
+
+
 if __name__ == "__main__":
     run()

examples/deploy.py

@@ -5,10 +5,10 @@
 
 RUST_RUNTIME_ID = 0
 SUPERVISOR_ARTIFACT_NAME = "exonum-supervisor"
-SUPERVISOR_ARTIFACT_VERSION = "0.13.0-rc.2"
-CRYPTOCURRENCY_ARTIFACT_NAME = "exonum-cryptocurrency-advanced"
-CRYPTOCURRENCY_ARTIFACT_VERSION = "0.13.0-rc.2"
-CRYPTOCURRENCY_INSTANCE_NAME = "XNM"
+SUPERVISOR_ARTIFACT_VERSION = "1.0.0"
+CRYPTOCURRENCY_ARTIFACT_NAME = "exonum-cryptocurrency"
+CRYPTOCURRENCY_ARTIFACT_VERSION = "0.2.0"
+CRYPTOCURRENCY_INSTANCE_NAME = "crypto"
 
 
 def run() -> None:
@@ -118,23 +118,17 @@ def start_service(client: ExonumClient, service_name: str, service_version: str,
 
 def send_request(client: ExonumClient, endpoint: str, data: bytes) -> None:
     """This function encodes request from bytes to JSON, sends it to the Exonum and waits."""
-    # Convert the request to a hexadecimal string:
-    hex_request = data.hex()
-
-    # Convert the request to a JSON:
-    json_request = json.dumps(hex_request)
-
     # Post the request to Exonum:
     supervisor_private_api = client.service_private_api("supervisor")
-    response = supervisor_private_api.post_service(endpoint, json_request)
+    response = supervisor_private_api.post_service(endpoint, data, data_format="binary")
 
     if response.status_code != 200:
         error_msg = f"Error occurred during the request to the '{endpoint}' endpoint: {response.content!r}"
         raise RuntimeError(error_msg)
 
     # Wait for 10 seconds.
     # TODO: currently due to a bug in Exonum it takes up to 10 seconds to update the dispatcher info:
-    time.sleep(10)
+    time.sleep(5)
 
 
 if __name__ == "__main__":

examples/proofs.py

@@ -23,8 +23,7 @@
 def run() -> None:
     """This example creates a wallet in the Cryptocurrency service, retrieves
     proofs for the wallet and verifies them.
-    For the example to work, be sure to have `exonum-cryptocurrency-advanced`
-    service instance with name `XNM` deployed."""
+    For the example to work, be sure to have `exonum-cryptocurrency-advanced` run."""
     client = ExonumClient(hostname="127.0.0.1", public_api_port=8080, private_api_port=8081)
 
     with client.protobuf_loader() as loader: