From 4379ffdafca5582dc5cb87d7262314145603b004 Mon Sep 17 00:00:00 2001 From: x Date: Fri, 28 Jul 2023 21:48:15 +0000 Subject: [PATCH] darkfi-sdk-python: Clean up doc and support zkbin.k() --- src/sdk/python/Makefile | 5 ++++- src/sdk/python/README.md | 8 +++----- src/sdk/python/src/zk_binary.rs | 4 ++++ 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/src/sdk/python/Makefile b/src/sdk/python/Makefile index 5e90e8781..0dbeedc62 100644 --- a/src/sdk/python/Makefile +++ b/src/sdk/python/Makefile @@ -5,6 +5,9 @@ MATURIN = maturin all: $(MATURIN) build --release - @echo "You can install this wheel with pip install" + @echo "You can install this wheel with make install" +dev: + $(MATURIN) develop --release + .PHONY: all diff --git a/src/sdk/python/README.md b/src/sdk/python/README.md index 0c286a400..896ee8511 100644 --- a/src/sdk/python/README.md +++ b/src/sdk/python/README.md @@ -4,7 +4,7 @@ Python bindings for some parts of the `darkfi-sdk` and the `zkvm`. ## Build and install -1. Install `maturin` via your package manager or from whatever source. +1. Install `maturin` via your package manager or from source. 2. Run `make` to build the wheel 3. (Optional) Run pip install --user @@ -15,16 +15,14 @@ For a development version you can use a venv: ``` $ python3 -m venv venv $ source venv/bin/activate -(venv) $ maturin develop --release +(venv) $ make dev ``` ## Usage ``` -$ python3 +$ python >>> import darkfi_sdk_py ->>> darkfi_sdk_py.__dir__() ->>> >>> from darkfi_sdk_py.base import Base >>> a = Base.from_u64(42) >>> b = Base.from_u64(69) diff --git a/src/sdk/python/src/zk_binary.rs b/src/sdk/python/src/zk_binary.rs index 452ab9a60..7c562a33d 100644 --- a/src/sdk/python/src/zk_binary.rs +++ b/src/sdk/python/src/zk_binary.rs @@ -64,6 +64,10 @@ impl ZkBinary { }) .collect() } + + fn k(&self) -> u32 { + self.0.k + } } pub fn create_module(py: pyo3::Python<'_>) -> pyo3::PyResult<&PyModule> {