Merge pull request #550 from singnet/development

Release 3.1.0

Author: Arondondon

.github/workflows/master.yml

@@ -71,3 +71,4 @@ jobs:
           export PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
           # sh -ex ./snet/cli/test/utils/run_all_functional.sh
           python3 ./snet/cli/test/functional_tests/test_entry_point.py
+          python3 ./snet/cli/test/functional_tests/func_tests.py

.github/workflows/test.yml

@@ -0,0 +1,66 @@
+name: tests_functional_tests_update
+on:
+  push:
+    branches: [ "functional-tests-update" ]
+#  pull_request:
+#    branches: [ "development" ]
+  workflow_dispatch:
+
+jobs:
+    run_tests_functional_tests_update:
+      runs-on: ubuntu-latest
+      container: node:20-bookworm
+      steps:
+
+      - name: install packs
+        run: |
+          apt update
+          apt install -y libudev-dev libusb-1.0-0-dev curl jq
+          apt install -y python3-pip python3.11-venv
+
+      - name: clone repo
+        uses: actions/checkout@v3
+
+      - name: install pip packages
+        run: |
+          pip3 install -r requirements.txt --break-system-packages
+          # pip3 install nose --break-system-packages
+          # pip3 uninstall pyreadline --break-system-packages
+          # pip3 install pyreadline3 --break-system-packages
+
+      - name: install snet-cli
+        run: |
+          # ./scripts/blockchain install
+          pip3 install -e . --break-system-packages
+
+      # - name: install platform-contracts
+      #   run: |
+      #     cd ..
+      #     git clone https://github.com/singnet/platform-contracts.git
+      #     cd platform-contracts
+      #     npm install
+      #     npm install ganache-cli
+      #     npm run-script compile
+
+      # - name: build example service
+      #   run: |
+      #     git clone https://github.com/singnet/example-service.git
+      #     cd example-service
+      #     pip3 install -r requirements.txt --break-system-packages
+      #     sh buildproto.sh
+
+      # - name: unit tests
+      #   run: |
+      #     cd ./snet/cli/test
+      #     nosetests -v --with-doctest
+
+      - name: functional tests for cli
+        run: |
+          export SNET_TEST_WALLET_PRIVATE_KEY=${{ secrets.PRIV_KEY }}
+          export SNET_TEST_INFURA_KEY=${{ secrets.INF_KEY }}
+          export SNET_TEST_WALLET_ADDRESS=${{ secrets.ADDR }}
+          export FORMER_SNET_TEST_INFURA_KEY=${{ secrets.FORM_INF_KEY }}
+          export PIP_BREAK_SYSTEM_PACKAGES=1
+          export PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
+          # sh -ex ./snet/cli/test/utils/run_all_functional.sh
+          python3 ./snet/cli/test/functional_tests/test_entry_point.py

pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = [
+    "setuptools>=61.0",
+    "wheel",
+    "protobuf~=6.30",
+    "grpcio-tools~=1.59"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "snet-cli"
+version = "3.1.0"
+description = "SingularityNET CLI"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "SingularityNET Foundation", email = "info@singularitynet.io"}
+]
+urls = {Homepage = "https://github.com/singnet/snet-cli"}
+
+# Cleaned dependencies list
+dependencies = [
+    "protobuf~=6.30",
+    "grpcio~=1.59",
+    "grpcio-tools~=1.59",
+    "wheel~=0.45",
+    "rlp~=4.0",
+    "web3~=7.0",
+    "mnemonic==0.21",
+    "pyyaml~=6.0.1",
+    "ipfshttpclient==0.4.13.2",
+    "pymultihash==0.8.2",
+    "base58==2.1.1",
+    "argcomplete~=3.1",
+    "grpcio-health-checking~=1.59",
+    "jsonschema~=4.1",
+    "eth-account~=0.9",
+    "trezor~=0.13.8",
+    "ledgerblue~=0.1.48",
+    "snet-contracts==1.0.1",
+    "lighthouseweb3~=0.1.4",
+    "cryptography~=46.0"
+]
+
+[project.scripts]
+snet = "snet.cli:main"
+
+[tool.setuptools.packages.find]
+include = ["snet*"]

requirements.txt

@@ -1,23 +1,24 @@
-protobuf==4.21.6
-grpcio-tools==1.59.0
-wheel==0.41.2
-jsonrpcclient==4.0.3
-eth-hash==0.5.2
-rlp==3.0.0
-eth-rlp==0.3.0
-web3==6.11.1
-mnemonic==0.20
-pycoin==0.92.20230326
-pyyaml==6.0.1
+protobuf~=6.30
+grpcio~=1.59
+grpcio-tools~=1.59
+wheel~=0.45
+# jsonrpcclient~=4.0
+# eth-hash~=0.5
+rlp~=4.0
+# eth-rlp~=2.0
+web3~=7.0
+mnemonic==0.21
+# pycoin==0.92.20241201
+pyyaml~=6.0.1
 ipfshttpclient==0.4.13.2
 pymultihash==0.8.2
 base58==2.1.1
-argcomplete==3.1.2
-grpcio-health-checking==1.59.0
-jsonschema==4.0.0
-eth-account==0.9.0
-trezor==0.13.8
-ledgerblue==0.1.48
-snet-contracts==1.0.0
-lighthouseweb3==0.1.4
-cryptography==44.0.1
+argcomplete~=3.1
+grpcio-health-checking~=1.59
+jsonschema~=4.1
+eth-account~=0.9
+trezor~=0.13.8
+ledgerblue~=0.1.48
+snet-contracts==1.0.1
+lighthouseweb3~=0.1.4
+cryptography~=46.0

setup.py

@@ -1,73 +1,71 @@
 import os
 from pathlib import Path
-from setuptools import find_namespace_packages, setup
+from setuptools import setup
 from setuptools.command.develop import develop as _develop
 from setuptools.command.install import install as _install
+from setuptools.command.build_py import build_py as _build_py
+from grpc_tools import protoc
+from pkg_resources import resource_filename
 
-from snet.cli.utils.utils import compile_proto
-from version import __version__
-
-PACKAGE_NAME = 'snet-cli'
-
-
-this_directory = os.path.abspath(os.path.dirname(__file__))
-with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f:
-    long_description = f.read()
+def install_and_compile_proto():
+    """
+    Compiles protobuf files directly.
+    """
+    proto_dir = Path(__file__).absolute().parent.joinpath(
+        "snet", "cli", "resources", "proto")
 
+    # Locate the standard grpc_tools internal protos (google/protobuf/...)
+    grpc_protos_include = resource_filename('grpc_tools', '_proto')
 
-with open("./requirements.txt") as f:
-    requirements_str = f.read()
-requirements = requirements_str.split("\n")
+    print(f"Proto directory: {proto_dir}")
+    print(f"Grpc include directory: {grpc_protos_include}")
 
+    if not proto_dir.exists():
+        print(f"Warning: Proto directory not found at {proto_dir}")
+        return
 
-def install_and_compile_proto():
-    proto_dir = Path(__file__).absolute().parent.joinpath(
-        "snet", "cli", "resources", "proto")
-    print(proto_dir, "->", proto_dir)
+    # glob('*.proto') is non-recursive. It will NOT look inside subfolders.
     for fn in proto_dir.glob('*.proto'):
-        print("Compiling protobuf", fn)
-        compile_proto(proto_dir, proto_dir, proto_file=fn)
-
+        print(f"Compiling protobuf: {fn}")
+
+        command = [
+            'grpc_tools.protoc',
+            f'-I{proto_dir}',
+            f'-I{grpc_protos_include}',  # <--- CRITICAL FIX: Add standard protos to include path
+            f'--python_out={proto_dir}',
+            f'--grpc_python_out={proto_dir}',
+            str(fn)
+        ]
+
+        if protoc.main(command) != 0:
+            print(f"Error: Failed to compile {fn}")
+            raise RuntimeError(f"Protocol buffer compilation failed for {fn}")
+
+class build_py(_build_py):
+    """
+    Override build_py to compile protos before building the wheel.
+    This is the hook used by 'python -m build'.
+    """
+    def run(self):
+        self.execute(install_and_compile_proto, (), msg="Compile protocol buffers")
+        _build_py.run(self)
 
 class develop(_develop):
-    """Post-installation for development mode."""
-
+    """Post-installation for development mode (pip install -e .)."""
     def run(self):
+        self.execute(install_and_compile_proto, (), msg="Compile protocol buffers")
         _develop.run(self)
-        self.execute(install_and_compile_proto, (),
-                     msg="Compile protocol buffers")
-
 
 class install(_install):
-    """Post-installation for installation mode."""
-
+    """Post-installation for legacy installation mode."""
     def run(self):
+        self.execute(install_and_compile_proto, (), msg="Compile protocol buffers")
         _install.run(self)
-        self.execute(install_and_compile_proto, (),
-                     msg="Compile protocol buffers")
-
 
 setup(
-    name=PACKAGE_NAME,
-    version=__version__,
-    packages=find_namespace_packages(include=['snet*']),
-    url='https://github.com/singnet/snet-cli',
-    author="SingularityNET Foundation",
-    author_email="info@singularitynet.io",
-    description="SingularityNET CLI",
-    long_description=long_description,
-    long_description_content_type='text/markdown',
-    license="MIT",
-    python_requires='>=3.10',
-    install_requires=requirements,
-    include_package_data=True,
     cmdclass={
         'develop': develop,
         'install': install,
+        'build_py': build_py,
     },
-    entry_points={
-        'console_scripts': [
-            'snet = snet.cli:main'
-        ],
-    }
-)
+)

snet/cli/arguments.py

@@ -24,18 +24,24 @@ def __init__(self, default_choice=None, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
     def error(self, message):
-        sys.stderr.write("error: {}\n\n".format(message))
+        sys.stderr.write(f"error: {message}\n\n")
         self.print_help(sys.stderr)
         sys.exit(2)
 
     def _parse_known_args(self, arg_strings, *args, **kwargs):
-        if self.default_choice and not len(list(filter(lambda option: option in arg_strings, {'-h', '--help'}))):
-            for action in list(filter(
-                    lambda subparser_action: isinstance(
-                        subparser_action, argparse._SubParsersAction),
-                    self._subparsers._actions
-            )):
-                if not len(list(filter(lambda arg: arg in action._name_parser_map.keys(), arg_strings))):
+        if self.default_choice and not any(arg in arg_strings for arg in {'-h', '--help'}):
+
+            subparser_action = next(
+                (a for a in self._actions if isinstance(a, argparse._SubParsersAction)),
+                None
+            )
+
+            if subparser_action:
+                is_subcommand_present = any(
+                    arg in subparser_action.choices for arg in arg_strings
+                )
+
+                if not is_subcommand_present:
                     arg_strings = [self.default_choice] + arg_strings
 
         return super()._parse_known_args(
@@ -575,8 +581,8 @@ def add_mpe_account_options(parser):
     subparsers = parser.add_subparsers(title="Commands", metavar="COMMAND")
     subparsers.required = True
 
-    def add_p_snt_address_opt(p):
-        p.add_argument(
+    def add_p_snt_address_opt(_p):
+        _p.add_argument(
             "--singularitynettoken-at", "--snt", default=None,
             help="Address of SingularityNetToken contract, if not specified we read address from \"networks\"")
 
@@ -1153,7 +1159,7 @@ def add_mpe_service_options(parser):
     p.add_argument("name", help="Name of the contributor")
     p.add_argument("email_id", help="Email of the contributor")
 
-    p = subparsers.add_parser("metadata-remove-contributor", help="Add contributor")
+    p = subparsers.add_parser("metadata-remove-contributor", help="Remove contributor")
     p.set_defaults(fn="metadata_remove_contributor")
     add_p_metadata_file_opt(p)
     p.add_argument("email_id", help="Email of the contributor")