icpp-pro 3.0.0__tar.gz

icpp-pro-3.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 icppWorld
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

icpp-pro-3.0.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.1
+Name: icpp-pro
+Version: 3.0.0
+Summary: C++ Canister Development Kit (CDK) for the Internet Computer
+Home-page: https://docs.icpp.world/
+Author: icpp team
+Author-email: icpp@icpp.world
+License: MIT
+Keywords: Internet Computer,C++,Canister Development Kit,CDK,Smart Contracts,blockchain
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+[![icpp-pro](https://github.com/icppWorld/icpp-pro/actions/workflows/cicd.yml/badge.svg)](https://github.com/icppWorld/icpp-pro/actions/workflows/cicd.yml)
+
+# C++ Canister Development Kit
+
+icpp is a cdk to develop C++ smart contracts for the  [Internet Computer](https://internetcomputer.org/):
+
+## Donations welcome 
+
+Thank you for being part of our community. 
+
+It will be highly appreciated if you are able to support our project by donating tokens to the icpp treasury account.
+
+All donations will go towards the icpp project. With your support we will be able to implement new features at high velocity. And the faster we can go, the faster the IC C++ community will grow and eventually become an SNS governed DAO.
+
+| Token                                                        | Account                                                      |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| ICP                                                          | 96a1e58115f7bf2a067a7da8e6d058b23e085591ab838bc300ab9676de6af0d4 |
+| SNS Tokens:<br>- ckBTC<br>- SNS1<br>- CHAT<br>- KINIC<br>- HOT | v437w-ruphh-5q2ms-55iqi-55lso-uasrq-nprl7-v4egy-6jpye-rhox4-vqe |
+
+## Installation
+
+`icpp-pro` is available via PyPI:
+
+```bash
+# For Linux, Mac or Windows
+pip install icpp-pro
+
+# verify
+$ icpp --version
+icpp-pro version: x.y.z
+wasi-sdk version: wasi-sdk-X.Y
+```
+
+## [Documentation](https://docs.icpp.world)
+

icpp-pro-3.0.0/README.md

@@ -0,0 +1,35 @@
+[![icpp-pro](https://github.com/icppWorld/icpp-pro/actions/workflows/cicd.yml/badge.svg)](https://github.com/icppWorld/icpp-pro/actions/workflows/cicd.yml)
+
+# C++ Canister Development Kit
+
+icpp is a cdk to develop C++ smart contracts for the  [Internet Computer](https://internetcomputer.org/):
+
+## Donations welcome 
+
+Thank you for being part of our community. 
+
+It will be highly appreciated if you are able to support our project by donating tokens to the icpp treasury account.
+
+All donations will go towards the icpp project. With your support we will be able to implement new features at high velocity. And the faster we can go, the faster the IC C++ community will grow and eventually become an SNS governed DAO.
+
+| Token                                                        | Account                                                      |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| ICP                                                          | 96a1e58115f7bf2a067a7da8e6d058b23e085591ab838bc300ab9676de6af0d4 |
+| SNS Tokens:<br>- ckBTC<br>- SNS1<br>- CHAT<br>- KINIC<br>- HOT | v437w-ruphh-5q2ms-55iqi-55lso-uasrq-nprl7-v4egy-6jpye-rhox4-vqe |
+
+## Installation
+
+`icpp-pro` is available via PyPI:
+
+```bash
+# For Linux, Mac or Windows
+pip install icpp-pro
+
+# verify
+$ icpp --version
+icpp-pro version: x.y.z
+wasi-sdk version: wasi-sdk-X.Y
+```
+
+## [Documentation](https://docs.icpp.world)
+

icpp-pro-3.0.0/pyproject.toml

@@ -0,0 +1,22 @@
+# Declare python project metadata
+# https://packaging.python.org/en/latest/specifications/declaring-project-metadata/
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "icpp-pro"
+dynamic = [
+    "version",
+    "description",
+    "authors",
+    "readme",
+    "requires-python",
+    "classifiers",
+    "keywords",
+    "urls",
+    "entry-points",
+    "dependencies",
+    "optional-dependencies"
+]

icpp-pro-3.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

icpp-pro-3.0.0/setup.py

@@ -0,0 +1,241 @@
+"""A setuptools based setup module.
+
+See:
+https://packaging.python.org/guides/distributing-packages-using-setuptools/
+https://github.com/pypa/sampleproject
+"""
+import sys
+import pathlib
+from setuptools import setup, find_packages  # type: ignore
+
+here = pathlib.Path(__file__).parent.resolve()
+
+# Get the long description from the README file
+long_description = (here / "README.md").read_text(encoding="utf-8")
+
+# Get the version number
+# pylint: disable = wrong-import-position, no-member
+sys.path.append(str(here / "src/icpp"))
+import version  # type: ignore
+
+setup(
+    # This is the name of your project. The first time you publish this
+    # package, this name will be registered for you. It will determine how
+    # users can install this project, e.g.:
+    #
+    # $ pip install icpp-pro
+    #
+    # And where it will live on PyPI: https://pypi.org/project/icpp-pro/
+    #
+    # There are some restrictions on what makes a valid project name
+    # specification here:
+    # https://packaging.python.org/specifications/core-metadata/#name
+    name="icpp-pro",  # Required
+    #
+    # Versions should comply with PEP 440:
+    # https://www.python.org/dev/peps/pep-0440/
+    #
+    # For a discussion on single-sourcing the version across setup.py and the
+    # project code, see
+    # https://packaging.python.org/en/latest/single_source_version.html
+    version=version.__version__,  # Required
+    #
+    # This is a one-line description or tagline of what your project does. This
+    # corresponds to the "Summary" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#summary
+    description="C++ Canister Development Kit (CDK) for the Internet Computer",  # Optional
+    #
+    # This is an optional longer description of your project that represents
+    # the body of text which users will see when they visit PyPI.
+    #
+    # Often, this is the same as your README, so you can just read it in from
+    # that file directly (as we have already done above)
+    #
+    # This field corresponds to the "Description" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#description-optional
+    long_description=long_description,  # Optional
+    #
+    # Denotes that our long_description is in Markdown; valid values are
+    # text/plain, text/x-rst, and text/markdown
+    #
+    # Optional if long_description is written in reStructuredText (rst) but
+    # required for plain-text or Markdown; if unspecified, "applications should
+    # attempt to render [the long_description] as text/x-rst; charset=UTF-8 and
+    # fall back to text/plain if it is not valid rst" (see link below)
+    #
+    # This field corresponds to the "Description-Content-Type" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
+    long_description_content_type="text/markdown",  # Optional (see note above)
+    #
+    # This should be a valid link to your project's main homepage.
+    #
+    # This field corresponds to the "Home-Page" metadata field:
+    # https://packaging.python.org/specifications/core-metadata/#home-page-optional
+    url="https://docs.icpp.world/",  # Optional
+    #
+    # This should be your name or the name of the organization which owns the project.
+    author="icpp team",  # Optional
+    #
+    # This should be a valid email address corresponding to the author listed above.
+    author_email="icpp@icpp.world",  # Optional
+    #
+    # Classifiers help users find your project by categorizing it.
+    #
+    # For a list of valid classifiers, see https://pypi.org/classifiers/
+    classifiers=[  # Optional
+        # How mature is this project? Common values are
+        #   1 - Planning
+        #   2 - Pre-Alpha
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        "Development Status :: 4 - Beta",
+        # Pick your license as you wish
+        "License :: OSI Approved :: MIT License",
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate you support Python 3. These classifiers are *not*
+        # checked by 'pip install'. See instead 'python_requires' below.
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3 :: Only",
+    ],
+    #
+    # This field adds a description to the metatada in PKG-INFO.
+    # It is not used by PyPI
+    license="MIT",
+    #
+    # This field adds keywords for your project which will appear on the
+    # project page. What does your project relate to?
+    #
+    # Note that this is a list of additional keywords, separated
+    # by commas, to be used to assist searching for the distribution in a
+    # larger catalog.
+    keywords="Internet Computer, C++, Canister Development Kit, CDK, Smart Contracts, blockchain",  # Optional
+    #
+    # When your source code is in a subdirectory under the project root, e.g.
+    # `src/`, it is necessary to specify the `package_dir` argument.
+    package_dir={"": "src"},  # Optional
+    #
+    # You can just specify package directories manually here if your project is
+    # simple. Or you can use find_packages().
+    #
+    # Alternatively, if you just want to distribute a single Python file, use
+    # the `py_modules` argument instead as follows, which will expect a file
+    # called `my_module.py` to exist:
+    #
+    #   py_modules=["my_module"],
+    #
+    packages=find_packages(where="src"),  # Required
+    #
+    # Specify which Python versions you support. In contrast to the
+    # 'Programming Language' classifiers above, 'pip install' will check this
+    # and refuse to install the project if the version does not match. See
+    # https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
+    python_requires=">=3.8",
+    #
+    # This field lists other packages that your project depends on to run.
+    # Any package you put here will be installed by pip when your project is
+    # installed, so they must be valid existing projects.
+    #
+    # For an analysis of "install_requires" vs pip's requirements files see:
+    # https://packaging.python.org/en/latest/requirements.html
+    install_requires=[
+        f"icpp-candid=={version.__version__}",
+        "typer[all]>=0.9.0",
+        "tomli",
+        "requests",
+        "enlighten",
+        "pytest",
+    ],  # Optional
+    #
+    # List additional groups of dependencies here (e.g. development
+    # dependencies). Users will be able to install these using the "extras"
+    # syntax, for example:
+    #
+    #   $ pip install "sampleproject[dev]"
+    #
+    # Similar to `install_requires` above, these must be valid existing
+    # projects.
+    extras_require={  # Optional
+        "dev": [
+            "black",
+            "pylint==2.13.9",
+            "mypy",
+            "build",
+            "twine",
+            "mkdocs",
+            "types-requests",
+        ],
+    },
+    #
+    # If there are data files included in your packages that need to be
+    # installed, specify them here.
+    # https://setuptools.pypa.io/en/latest/userguide/datafiles.html#package-data
+    #
+    # (-) add 'py.typed', to play nice with mypy
+    #     https://mypy.readthedocs.io/en/latest/installed_packages.html
+    #     #making-pep-561-compatible-packages
+    # (-) add 'ic/'    , which contains the C++ & Header files of the API
+    # (-) add 'native/', which contains the C++ & Header files for a native build,
+    #                    with a mock IC, allowing interactive debugging.
+    #
+    package_data={  # Optional
+        "icpp": [
+            "canisters/greet/native/*",
+            "canisters/greet/src/*",
+            "canisters/greet/test/*",
+            "canisters/greet/dfx.json",
+            "canisters/greet/icpp.toml",
+            "canisters/greet/README.md",
+            "canisters/greet/demo.sh",
+            "canisters/greet/demo.ps1",
+            "ic/*/*.c",
+            "ic/*/*.cpp",
+            "ic/*/*.h",
+            "ic/*/*.hpp",
+            "py.typed",
+        ],
+    },
+    #
+    # Although 'package_data' is the preferred approach, in some case you may
+    # need to place data files outside of your packages. See:
+    # http://docs.python.org/distutils/setupscript.html#installing-additional-files
+    #
+    # In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
+    ##    data_files=[('my_data', ['data/data_file'])],  # Optional
+    #
+    # To provide executable scripts, use entry points in preference to the
+    # "scripts" keyword. Entry points provide cross-platform support and allow
+    # `pip` to create the appropriate form of executable for the target
+    # platform.
+    #
+    # For example, the following would provide a command called `icpp` which
+    # executes the function `main` from this package when invoked:
+    # NOTE: you can create multiple entry_points, for example, when distributing
+    #       more than one packages, you can create an entry_point for each package
+    entry_points={  # Optional
+        "console_scripts": [
+            "icpp=icpp.__main__:main",
+        ],
+    },
+    #
+    # List additional URLs that are relevant to your project as a dict.
+    #
+    # This field corresponds to the "Project-URL" metadata fields:
+    # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
+    #
+    # Examples listed include a pattern for specifying where the package tracks
+    # issues, where the source is hosted, where to say thanks to the package
+    # maintainers, and where to support the project financially. The key is
+    # what's used to render the link text on PyPI.
+    ##    project_urls={  # Optional
+    ##        'Bug Reports': 'https://github.com/pypa/sampleproject/issues',
+    ##        'Funding': 'https://donate.pypi.org',
+    ##        'Say Thanks!': 'http://saythanks.io/to/example',
+    ##        'Source': 'https://github.com/pypa/sampleproject/',
+    ##    },
+    #
+)

icpp-pro-3.0.0/src/icpp/__init__.py

@@ -0,0 +1,26 @@
+"""
+__init__.py.
+The double underscores in the filename tell us that this is a special file.
+__init__.py represents the root of your package.
+It should usually be kept quite simple, but it’s a good place to put package constants,
+documentation, and so on.
+
+The special variable __version__ is a convention in Python for adding version numbers
+to your package.
+
+Variables defined in __init__.py become available as variables in the package namespace:
+```
+import icpp
+icpp.__version__
+```
+
+reference: https://realpython.com/pypi-publish-python-package/
+"""
+import icpp.version
+import icpp.version_wasi_sdk
+
+# Version of package
+__version__ = icpp.version.__version__
+
+# Version of wasi-sdk
+__version_wasi_sdk__ = icpp.version_wasi_sdk.__version__

icpp-pro-3.0.0/src/icpp/__main__.py

@@ -0,0 +1,38 @@
+"""__main__.py
+The double underscores indicate that this file has a special meaning in Python.
+When running a package (!) as a script with -m, 'python -m icpp', Python
+executes the contents of the __main__.py file.
+
+In other words, __main__.py acts as the entry point of our program and takes care of
+the main flow, calling other parts as needed
+
+reference: https://realpython.com/pypi-publish-python-package/
+"""
+import typer
+
+
+# Instantiate the Typer app globally with app = typer.Typer().
+# That way, we can decorate any function we want to call from the command line,
+# using the @app.command() decorator.
+app = typer.Typer()
+
+# do some stuff with app
+# pylint: disable = wrong-import-position unused-import
+from icpp import options_main
+from icpp import commands_get
+from icpp import commands_init
+from icpp import commands_build_wasm
+from icpp import commands_build_native
+from icpp import commands_install_wasi_sdk
+
+
+def main() -> None:
+    """Entry point of program"""
+    app(prog_name="icpp")
+
+
+#
+# Always start it up or debug as a module:
+#  python -m icpp.__main__
+#
+main()

icpp-pro-3.0.0/src/icpp/canisters/greet/README.md

@@ -0,0 +1,3 @@
+# `greet`
+
+See the [Getting Started tutorial](https://docs.icpp.world/getting-started.html).

icpp-pro-3.0.0/src/icpp/canisters/greet/demo.ps1

@@ -0,0 +1,91 @@
+#######################################################################
+# This is a Windows PowerShell script
+#
+# (-) Install icpp-pro or icpp-free in a python environment on windows
+# (-) Install dfx  in wsl
+# (-) In a Windows PowerShell (*):
+#
+#     .\demo.ps1
+#
+# (*) The Miniconda Powershell is highly recommended
+#
+#######################################################################
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Stopping the local network in wsl"
+wsl dfx stop
+
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Starting the local network in wsl as a PowerShell background job"
+$jobName = "greet"
+
+# Stop the job if it already exist
+# Get a list of all the background jobs with a specific name
+$jobs = Get-Job -Name $jobName -ErrorAction SilentlyContinue
+
+# Stop all the jobs
+$jobs | Remove-Job
+
+# Start the local network with redirecting error messages to output stream
+$job = Start-Job -ScriptBlock { wsl dfx start --clean 2>&1 } -Name $jobName
+
+# Display the details of the job
+$job | Format-Table
+
+# Wait for 10 seconds
+Write-Host " "
+Write-Host "Waiting for 10 seconds to allow the local network to start..."
+Start-Sleep -Seconds 10
+
+# Get the output of the job
+$output = Receive-Job -Job $job
+Write-Host $output -ForegroundColor Green
+
+#######################################################################
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Building the wasm with wasi-sdk"
+icpp build-wasm --to-compile all
+# icpp build-wasm --to-compile mine
+
+#######################################################################
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Deploying the wasm to a canister on the local network"
+wsl --% dfx deploy
+
+#######################################################################
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Running some manual tests with dfx"
+wsl --% dfx canister call greet greet_0
+wsl --% dfx canister call greet greet_1
+wsl --% dfx canister call greet greet_2 '("C++ Developer")'
+wsl --% dfx canister call greet greet_3 '(record { "icpp version" = 1 : int; OS = "Linux" : text })'
+wsl --% dfx canister call greet greet_4 '(record { 6 = 42 : int; 9 = 43 : int }, record { 7 = 44 : int; 10 = 45 : int })'
+
+#######################################################################
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Running the full smoketests with pytest"
+pytest --network=local
+
+#######################################################################
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Stopping the local network in wsl"
+wsl dfx stop
+
+#######################################################################
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Building the Windows native debug executable with clang++"
+icpp build-native --to-compile all
+# icpp build-native --to-compile mine
+
+#######################################################################
+Write-Host " "
+Write-Host "--------------------------------------------------"
+Write-Host "Running the Windows native debug executable"
+.\build-native\mockic.exe

icpp-pro-3.0.0/src/icpp/canisters/greet/demo.sh

@@ -0,0 +1,67 @@
+#!/bin/sh
+
+#######################################################################
+# This is a Linux & Mac shell script
+#
+# (-) Install icpp-pro or icpp-free in a python environment
+# (-) Install dfx
+# (-) In a terminal:
+#
+#     ./demo.sh
+#
+#######################################################################
+echo " "
+echo "--------------------------------------------------"
+echo "Stopping the local network"
+dfx stop
+
+echo " "
+echo "--------------------------------------------------"
+echo "Starting the local network as a background process"
+dfx start --clean --background
+
+#######################################################################
+echo "--------------------------------------------------"
+echo "Building the wasm with wasi-sdk"
+icpp build-wasm --to-compile all
+# icpp build-wasm --to-compile mine
+
+#######################################################################
+echo " "
+echo "--------------------------------------------------"
+echo "Deploying the wasm to a canister on the local network"
+dfx deploy
+
+#######################################################################
+echo " "
+echo "--------------------------------------------------"
+echo "Running some manual tests with dfx"
+dfx canister call greet greet_0
+dfx canister call greet greet_1
+dfx canister call greet greet_2 '("C++ Developer")'
+dfx canister call greet greet_3 '(record { "icpp version" = 1 : int; OS = "Linux" : text })'
+dfx canister call greet greet_4 '(record { 6 = 42 : int; 9 = 43 : int }, record { 7 = 44 : int; 10 = 45 : int })'
+
+#######################################################################
+echo " "
+echo "--------------------------------------------------"
+echo "Running the full smoketests with pytest"
+pytest --network=local
+
+#######################################################################
+echo "--------------------------------------------------"
+echo "Stopping the local network"
+dfx stop
+
+#######################################################################
+echo " "
+echo "--------------------------------------------------"
+echo "Building the OS native debug executable with clang++"
+icpp build-native --to-compile all
+# icpp build-native --to-compile mine
+
+#######################################################################
+echo " "
+echo "--------------------------------------------------"
+echo "Running the OS native debug executable"
+./build-native/mockic.exe

icpp-pro-3.0.0/src/icpp/canisters/greet/dfx.json

@@ -0,0 +1,16 @@
+{
+  "version": 1,
+  "canisters": {
+    "greet": {
+      "type": "custom",
+      "candid": "src/greet.did",
+      "wasm": "build/greet.wasm"
+    }
+  },
+  "defaults": {
+    "build": {
+      "args": "",
+      "packtool": ""
+    }
+  }
+}

icpp-pro-3.0.0/src/icpp/canisters/greet/icpp.toml

@@ -0,0 +1,18 @@
+[build-wasm]
+canister          = "greet"
+did_path          = "src/greet.did"
+cpp_paths         = ["src/greet.cpp"]
+cpp_header_paths  = ["src/greet.h"]
+cpp_compile_flags = []
+cpp_link_flags    = []
+c_paths           = []
+c_header_paths    = []
+c_compile_flags   = []
+[build-native]
+cpp_paths         = ["native/main.cpp"]
+cpp_header_paths  = ["native/main.h"]
+cpp_compile_flags = []
+cpp_link_flags    = []
+c_paths           = []
+c_header_paths    = []
+c_compile_flags   = []