v1.0.14 Do not use cpp_sign() (#64)

* Add C++ library instructions

* Do not use cpp_sign()

* v1.0.14

Author: Kenadia

README.md

@@ -119,3 +119,16 @@ web3_client_with_keys = Client(
 web3_client_with_keys.onboarding.create_user()
 web3_client_with_keys.api_keys.create_api_key()
 ```
+
+### Using the C++ Library for STARK Signing
+
+By default, STARK curve operations such as signing and verification will use the Python native implementation. These operations occur whenever placing an order or requesting a withdrawal. To use the C++ implementation, initialize the client object with `crypto_c_exports_path`:
+
+```python
+client = Client(
+    crypto_c_exports_path='./libcrypto_c_exports.so',
+    ...
+)
+```
+
+The path should point to a C++ shared library file, built from Starkware's `crypto-cpp` library ([CMake target](https://github.com/starkware-libs/crypto-cpp/blob/601de408bee9f897315b8a5cb0c88e2450a91282/src/starkware/crypto/ffi/CMakeLists.txt#L3)) for the particular platform (e.g. Linux, etc.) that you are running your trading program on.

dydx3/starkex/starkex_resources/proxy.py

@@ -1,25 +1,39 @@
-from dydx3.starkex.starkex_resources.cpp_signature import (
-  check_cpp_lib_path, cpp_hash, cpp_sign, cpp_verify
-)
-from dydx3.starkex.starkex_resources.python_signature import (
-  py_sign, ECSignature, ECPoint, py_verify, py_pedersen_hash
-)
 from typing import Optional, Union
 
-def sign(msg_hash: int, priv_key: int, seed: Optional[int] = None) -> ECSignature:
-  if check_cpp_lib_path():
-    return cpp_sign(msg_hash=msg_hash, priv_key=priv_key, seed=seed)
+from dydx3.starkex.starkex_resources.cpp_signature import check_cpp_lib_path
+from dydx3.starkex.starkex_resources.cpp_signature import cpp_hash
+from dydx3.starkex.starkex_resources.cpp_signature import cpp_verify
+from dydx3.starkex.starkex_resources.python_signature import ECPoint
+from dydx3.starkex.starkex_resources.python_signature import ECSignature
+from dydx3.starkex.starkex_resources.python_signature import py_pedersen_hash
+from dydx3.starkex.starkex_resources.python_signature import py_sign
+from dydx3.starkex.starkex_resources.python_signature import py_verify
 
-  return py_sign(msg_hash=msg_hash, priv_key=priv_key, seed=seed)
 
-def verify(msg_hash: int, r: int, s: int, public_key: Union[int, ECPoint]) -> bool:
-  if check_cpp_lib_path():
-    return cpp_verify(msg_hash=msg_hash, r=r, s=s, stark_key=public_key)
+def sign(
+    msg_hash: int,
+    priv_key: int,
+    seed: Optional[int] = None,
+) -> ECSignature:
+    # Note: cpp_sign() is not optimized and is currently slower than py_sign().
+    #       So always use py_sign() for now.
+    return py_sign(msg_hash=msg_hash, priv_key=priv_key, seed=seed)
+
+
+def verify(
+    msg_hash: int,
+    r: int,
+    s: int,
+    public_key: Union[int, ECPoint],
+) -> bool:
+    if check_cpp_lib_path():
+        return cpp_verify(msg_hash=msg_hash, r=r, s=s, stark_key=public_key)
+
+    return py_verify(msg_hash=msg_hash, r=r, s=s, public_key=public_key)
 
-  return py_verify(msg_hash=msg_hash, r=r, s=s, public_key=public_key)
 
 def get_hash(*elements: int) -> int:
-  if check_cpp_lib_path():
-    return cpp_hash(*elements)
+    if check_cpp_lib_path():
+        return cpp_hash(*elements)
 
-  return py_pedersen_hash(*elements)
+    return py_pedersen_hash(*elements)

setup.py

@@ -19,7 +19,7 @@
 
 setup(
     name='dydx-v3-python',
-    version='1.0.13',
+    version='1.0.14',
     packages=find_packages(),
     package_data={
         'dydx3': [