convex-sdk 0.3.2__tar.gz

convex_sdk-0.3.2/CHANGELOG.md

@@ -0,0 +1,97 @@
+## Change log
+
+### 0.3.2
++   **Renamed package to `convex-sdk`** — PyPI distribution `convex-api-py` → `convex-sdk` and import package `convex_api` → `convex_sdk` (`pip install convex-sdk`; `import convex_sdk`). The GitHub repository stays `convex-api-py`; the predecessor `convex-api-py` PyPI package remains frozen at 0.3.1.
++   Fix malformed `__version__` string in `convex_sdk/__init__.py` (also restores `bumpversion` matching)
++   Fix `KeyPair.remove_0x_prefix` to pass `re.IGNORECASE` as `flags` (it was silently passed as `count`, so `0X` prefixes were not stripped)
++   Surface CVM errors returned from `transaction/prepare` as `ConvexAPIError`, consistent with submit and query
++   Correct README examples (`KeyPair()` not `KeyPair.create()`, `convex` variable name, `Account(...)` constructor, real account-info fields)
++   Add PyPI trusted-publishing release workflow (`.github/workflows/publish.yml`, fires on `v*` tags) and remove the stale commented-out publish block from the docs deploy workflow; see `.github/PUBLISHING.md`
++   Bump development status classifier from Pre-Alpha to Beta and declare Python 3.11–3.13 support
+
+### 0.3.1
++   Minor fixes and sync from 0.3.0
+
+### 0.3.0
++   Add type hints for all the things
++   Rename `Address` method `is_address` to `has_address`
++   Move `convex_api.utils.is_address` to `Address` static method `is_address`
++   Move `convex_api.utils.to_address` to `Address` static method `to_address`
++   Move `convex_api.utils.is_public_key_hex` to `KeyPair` static method `is_public_key_hex`
++   Move `convex_api.utils.is_public_key` to `KeyPair` static method `is_public_key`
++   Move `convex_api.utils.to_public_key_checksum` to `KeyPair` static method `to_public_key_checksum`
++   Move `convex_api.utils.is_hexstr` to `KeyPair` static method `is_hexstr`
++   Move `convex_api.utils.add_0x_prefix` to `KeyPair` static method `add_0x_prefix`
++   Move `convex_api.utils.remove_0x_prefix` to `KeyPair` static method `remove_0x_prefix`
++   Move `convex_api.utils.to_bytes` to `KeyPair` static methods `to_bytes` for `data: bytes` argument use case and `to_` for `hexstr: string` argument use case
++   Move `convex_api.utils.to_hex` to `KeyPair` static method `to_hex`
++   Add pydantic dependency
+
+### 0.2.6
++   Add cr, tab to contract text encoding
+
+### 0.2.5
++   Rename contract 'register' to 'register_contract_name'
+
+### 0.2.4
++   Add escape_string to Contract class, to escape string data
+
+### 0.2.3
++   New Contract class, to allow for easier contract deployment and usage
+
+### 0.2.2
++   Upgrade to use Alpha-RC4 Convex
++   Add all address fields to have a prefix of #
++   Fix registry conversion issues
+
+### 0.2.1
++   Remove Convex Scrypt language
+
+### 0.2.0
++   Add KeyPair class, now you have to pass a KeyPair object to the `create_account` method.
++   Rename ConvexAPI to API
+
+### 0.1.4
++	Add address '#' identifier before each address number.
+
+### 0.1.3
++   Add transfer_account, the ability to change your account public key for a given account address
++   Remove eth-utils library dependency
++   Improve CLI to do account create / topup / fund / balance / info / name registration / name resolve, query and submit
+
+### 0.1.2
++   Improve registration of account names and resolving account names from the CNS registry
+
+### 0.1.1
++   Incease minimum topup_account funds to 10,000,000
++   Allow to register and load accounts using a name
+
+### 0.1.0
++   Now need to use ConvexAPI.create_account method to create a new account, and get the address number
++   Internal bug fixes, and name conventions for the API calls
+
+### 0.0.8
++   Rebuild with new release
+
+### 0.0.7
++   Rename Account create_new to create
++   Rename Account create_from_bytes to import_from_bytes
+
+### 0.0.6
++   Add topup_account method to api
+
+### 0.0.5
++   Add a 0x prefix to retuned addresses
+
+### 0.0.4
++   Import/export account private keys as a word phrase
++   Convex Wallet tool
+
+### 0.0.3
++   Pre-alpha release
+
+### 0.0.2
++   Add retry sending a transcation during a SEQUENCE error
+
+### 0.0.1
++   Initial Alpha Release

convex_sdk-0.3.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

convex_sdk-0.3.2/MANIFEST.in

@@ -0,0 +1,7 @@
+include CHANGELOG.md
+include LICENSE
+include README.md
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+

convex_sdk-0.3.2/PKG-INFO

@@ -0,0 +1,272 @@
+Metadata-Version: 2.4
+Name: convex-sdk
+Version: 0.3.2
+Summary: Convex api
+Home-page: https://github.com/Convex-Dev/convex-api-py
+Author: dex-company
+Author-email: devops@dex.sg
+License: Apache Software License 2.0
+Keywords: convex api
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography~=39.0
+Requires-Dist: requests~=2.28
+Requires-Dist: mnemonic~=0.2
+Requires-Dist: pydantic~=2.0
+Provides-Extra: test
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: isort; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Provides-Extra: docs
+Requires-Dist: Sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
+Requires-Dist: sphinxcontrib-plantuml; extra == "docs"
+Requires-Dist: sphinx-automodapi; extra == "docs"
+Requires-Dist: pygments; extra == "docs"
+Requires-Dist: devtools[pygments]; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: bumpversion; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: Sphinx; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: sphinxcontrib-apidoc; extra == "dev"
+Requires-Dist: sphinxcontrib-plantuml; extra == "dev"
+Requires-Dist: sphinx-automodapi; extra == "dev"
+Requires-Dist: pygments; extra == "dev"
+Requires-Dist: devtools[pygments]; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Convex Python SDK
+
+![](https://github.com/Convex-Dev/convex-api-py/workflows/testing/badge.svg)
+[![Checked with pyright](https://microsoft.github.io/pyright/img/pyright_badge.svg)](https://microsoft.github.io/pyright/)
+[![PyPI version](https://badge.fury.io/py/convex-sdk.svg)](https://badge.fury.io/py/convex-sdk)
+
+The official Python client library for interacting with the [Convex](https://convex.world) decentralised lattice network.
+
+## 📚 Documentation
+
+**Official documentation is available at [docs.convex.world/docs/tutorial/client-sdks/python](https://docs.convex.world/docs/tutorial/client-sdks/python)**
+
+- [Quickstart Guide](https://docs.convex.world/docs/tutorial/client-sdks/python/quickstart) - Build your first Python app
+- [Query Guide](https://docs.convex.world/docs/tutorial/client-sdks/python/queries) - Read network state
+- [Transaction Guide](https://docs.convex.world/docs/tutorial/client-sdks/python/transactions) - Submit transactions
+- [Account Management](https://docs.convex.world/docs/tutorial/client-sdks/python/accounts) - Manage keys and accounts
+
+## Installation
+
+```bash
+pip install convex-sdk
+```
+
+## Quick Example
+
+```python
+from convex_sdk import Convex, KeyPair
+
+# Connect to the network
+convex = Convex('https://peer.convex.live')
+
+# Create a new account
+key_pair = KeyPair()
+account = convex.create_account(key_pair)
+
+# Request test funds
+convex.request_funds(100_000_000, account)
+
+# Query balance
+balance = convex.get_balance(account)
+print(f'Balance: {balance / 1_000_000_000} Convex Coins')
+```
+
+## Resources
+
+- **[Official Documentation](https://docs.convex.world/docs/tutorial/client-sdks/python)** - Complete SDK guide
+- **[PyPI Package](https://pypi.org/project/convex-sdk/)** - Python Package Index
+- **[Convex Network](https://convex.world)** - Main website
+- **[Discord Community](https://discord.com/invite/xfYGq4CT7v)** - Get help and share ideas
+
+---
+
+### Development Setup
+
+To set up the project for development, follow these steps:
+
+**Prerequisites:**
+- Python 3.10 or higher
+- pip (Python package installer)
+
+**Setup Steps:**
+
+1. **Create a virtual environment:**
+   ```bash
+   python -m venv .venv
+   ```
+   
+   This creates a virtual environment in a `.venv` directory. 
+
+2. **Activate the virtual environment:**
+   
+   - **On Windows (PowerShell or Command Prompt):**
+     ```bash
+     .venv\Scripts\activate
+     ```
+   
+   - **On Windows (Git Bash):**
+     ```bash
+     source .venv/Scripts/activate
+     ```
+   
+   - **On Linux/Mac:**
+     ```bash
+     source .venv/bin/activate
+     ```
+   
+   When activated, you should see `(venv)` at the beginning of your command prompt.
+
+3. **Upgrade pip (recommended):**
+   ```bash
+   python -m pip install --upgrade pip
+   ```
+
+4. **Install the package in development mode with all dependencies:**
+   
+   Option 1 - Using setup.py extras (recommended):
+   ```bash
+   pip install -e ".[dev,test,docs]"
+   ```
+   
+   Option 2 - Using requirements files:
+   ```bash
+   pip install -r requirements-dev.txt
+   pip install -e .
+   ```
+
+5. **Verify the installation:**
+   ```bash
+   pytest tests
+   ```
+
+**Deactivating the virtual environment:**
+When you're done working, you can deactivate the virtual environment by running:
+```bash
+deactivate
+```
+
+**Note:** Always activate your virtual environment before working on the project. The virtual environment ensures that dependencies are isolated from your system Python installation.
+
+### Quick Start
+
+First you need to download the convex-sdk package from the python package index PyPi.
+
+    pip install convex-sdk
+
+You can now access the convex network, and get a balance from an existing account on the network by doing the following:
+
+    >>> from convex_sdk import Convex, KeyPair
+    >>> convex = Convex('https://peer.convex.live')
+    >>> convex.get_balance(9)
+    99396961137042
+
+You can create a new empty account, with no balance:
+
+    >>> key_pair = KeyPair()
+    >>> account = convex.create_account(key_pair)
+    >>> account.address
+    809
+
+You can request some funds to the new account and then get the account information:
+
+    >>> convex.request_funds(1000000, account)
+    1000000
+    >>> convex.get_account_info(account)
+    AccountDetailsResponse(sequence=0, address=809, memorySize=42, balance=1000000, allowance=0, type='user')
+
+
+You can export the accounts private key encoded as PKCS8 encrypt the key with a password:
+
+    >>> account.key_pair.export_to_text('secret')
+    '-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIGbMFcGCSqGSIb3DQEFDTBKMCkGCSqGSIb3DQEFDDAcBAiMY42UY4PXHAICCAAw\nDAYIKoZIhvcNAgkFADAdBglghkgBZQMEASoEEJpwDMicGbGj2iSJesktIVYEQBsp\nKMTAHzvUyw8jZRr8WSrmxH7938sjma8XWI6lgd9jwTZzcGamog7p3zatw0Wp+jFK\nKruWAZmIqhBZ/2ezDv8=\n-----END ENCRYPTED PRIVATE KEY-----\n'
+
+    >>> account.address
+    809
+
+To re-use your account again you need to import the encrypted private key and set the correct account address
+
+    >>> from convex_sdk import Account, KeyPair
+    >>> key_pair = KeyPair.import_from_file('my_key.dat', 'secret')
+    >>> account = Account(key_pair, 809)
+
+To create a new address with the same account keys in your new or imported account object, you can do:
+
+    >>> new_account = convex.create_account(key_pair)
+    >>> account.address
+    809
+    >>> new_account.address
+    934
+
+To use account names, where an account name is resolved to a fixed address. You can create or load
+an account based on it's name by doing the following:
+
+    >>> account = convex.setup_account('my-account-name', key_pair)
+    >>> account.address
+    934
+
+    >>> convex.resolve_account_name('my-account-name')
+    934
+
+    >>> same_account = convex.setup_account('my-account-name', key_pair)
+    >>> same_account.address
+    934
+
+To submit a transaction, use Convex.transact(). This will cost a small amount of juice, and reduce your balance
+
+    >>> convex.request_funds(1000000, account)
+    1000000
+    >>> convex.transact('(map inc [1 2 3 4])', account)
+    {'value': [2, 3, 4, 5]}
+    >>> convex.get_balance(account)
+    996360
+
+To send a query a transaction, this is free and can be performed by any valid account address.
+So for example to query a balance of an account:
+
+    >>> convex.query(f'(balance {account.address})', account)
+    {'value': 996360}
+
+    # this is the same as above
+    >>> convex.query(f'(balance {account.address})', account.address)
+    {'value': 996360}
+
+    # get the balance using one of the standard account addresses (#1)
+    >>> convex.query(f'(balance {account.address})', 1)
+    {'value': 996360}
+