.gitignore

@@ -213,7 +213,7 @@ built_package_info.json
 ts/wasm/lib/proto
 dist
 node_modules
-python/wax/proto
+python/wax/_private/proto
 python/cpp_python_bridge.cpp
 .parcel-cache
 .pnpm-store

.gitlab-ci.yml

@@ -11,6 +11,12 @@ include:
       - '/templates/npm_projects.gitlab-ci.yml'
       - '/templates/wasm_build.gitlab-ci.yml'
       - '/templates/python_projects.gitlab-ci.yml'
+      - '/templates/test_jobs.gitlab-ci.yml'
+      - '/templates/docker_image_jobs.gitlab-ci.yml'
+      - '/templates/cache_cleanup.gitlab-ci.yml'
+  - project: 'hive/hive'
+    ref: 824b7c295687c50a49e412aceb7a14f834927a1e   # develop
+    file: '/scripts/ci-helpers/prepare_data_image_job.yml'
 
 variables:
   GIT_DEPTH: 0
@@ -25,17 +31,50 @@ variables:
   PYTHON_IMAGE_TAG: "${CI_BASE_IMAGE_TAG}"
   PYTHON_IMAGE: "${CI_BASE_IMAGE}"
 
+  # PIP INDEX URL's
+  FIRST_INDEX: "https://gitlab.syncad.com/api/v4/projects/362/packages/pypi/simple "
+  SECOND_INDEX: "https://gitlab.syncad.com/api/v4/projects/434/packages/pypi/simple"
+
   # colors:
   TXT_BLUE: "\e[1;34m"
   TXT_CLEAR: "\e[0m"
   NPM_TOKEN: $CI_JOB_TOKEN
 
+  DATA_CACHE_HIVE_PREFIX: "/cache/replay_data_hive"
+  BLOCK_LOG_SOURCE_DIR_5M: /blockchain/block_log_5m
+
 image: "${CI_BASE_IMAGE}"
 
 default:
   tags:
     - public-runner-docker
 
+prepare_hived_image:
+  extends: .prepare_hived_image
+  stage: build
+  variables:
+    SUBMODULE_DIR: "$CI_PROJECT_DIR/hive"
+    REGISTRY_USER: "$HIVED_CI_IMGBUILDER_USER"
+    REGISTRY_PASS: $HIVED_CI_IMGBUILDER_PASSWORD
+    GIT_SUBMODULE_STRATEGY: recursive
+  tags:
+  - public-runner-docker
+  - hived-for-tests
+
+prepare_hived_data:
+  extends: .prepare_hived_data_5m
+  needs:
+  - job: prepare_hived_image
+    artifacts: true
+  stage: build
+  variables:
+    SUBMODULE_DIR: "$CI_PROJECT_DIR/hive"
+    BLOCK_LOG_SOURCE_DIR: $BLOCK_LOG_SOURCE_DIR_5M
+    CONFIG_INI_SOURCE: "$CI_PROJECT_DIR/hive/docker/config_5M.ini"
+    GIT_SUBMODULE_STRATEGY: recursive
+  tags:
+  - data-cache-storage
+
 build_wheel:
   extends: .build_wheel_template
   variables:
@@ -49,12 +88,29 @@ build_wheel:
     paths:
       - "${PYPROJECT_DIR}/dist/"
       - "${PYPROJECT_DIR}/.build/logs/"
-      - "${PYPROJECT_DIR}/.build/*.so"
+      - "${PYPROJECT_DIR}/wax/*.so"
       - "build_wheel.env"
-      - "${PYPROJECT_DIR}/wax/proto"
+      - "${PYPROJECT_DIR}/wax/_private/proto"
     reports:
       dotenv: "build_wheel.env"
 
+pre_commit_checks:
+  stage: static_code_analysis
+  extends: .pre_commit_checks_template
+  variables:
+    PYPROJECT_DIR: "${CI_PROJECT_DIR}/python"
+  before_script:
+    - cd ${PYPROJECT_DIR}
+    - !reference [ .configuration_template, before_script ]
+    - poetry install --no-root
+  after_script:
+    - cd ${CI_PROJECT_DIR}
+  artifacts:
+    when: always
+    expire_in: 1 week
+    paths:
+      - python/poetry.lock
+
 verify_poetry_lock_sanity:
   extends: .verify_poetry_lock_sanity_template
   stage: static_code_analysis
@@ -167,7 +223,7 @@ push_to_wiki:
       artifacts: true
   before_script:
     - !reference [.configuration_template, before_script]
-    - pip install ${PYPROJECT_DIR}/dist/*.whl
+    - pip install --index-url $FIRST_INDEX --extra-index-url $SECOND_INDEX ${PYPROJECT_DIR}/dist/*.whl
     - pip list
     - ls -al $(poetry -C "${PYPROJECT_DIR}" env info --path)/lib/python3.10/site-packages/
 
@@ -183,7 +239,7 @@ test_importing_wax:
   script:
     - echo -e "${TXT_BLUE}Testing...${TXT_CLEAR}"
     - cd ..  # needed to import installed package instead of local one
-    - python3 -c "import wax; print(wax.__version__); exit(wax.__version__ == '0.0.0')"
+    - python3 -c "import wax; print(wax.__version__); exit()"
 
 test_wax_protobuf_python:
   extends: .test_python_env
@@ -201,10 +257,10 @@ test_wax_protobuf_python_pattern:
       artifacts: true
   script:
     - echo -e "${TXT_BLUE}Testing generated proto files with patterns ...${TXT_CLEAR}"
-    - diff --brief --recursive --color=never --no-ignore-file-name-case --no-dereference  $CI_PROJECT_DIR/python/protobuf_patterns/ $CI_PROJECT_DIR/python/wax/proto/
+    - diff --brief --recursive --color=never --no-ignore-file-name-case --no-dereference  $CI_PROJECT_DIR/python/protobuf_patterns/ $CI_PROJECT_DIR/python/wax/_private/proto/
   artifacts:
     paths:
-      - $CI_PROJECT_DIR/python/wax/proto/
+      - $CI_PROJECT_DIR/python/wax/_private/proto/
 
     when: always
     expire_in: 1 week
@@ -343,3 +399,46 @@ deploy_wax_wasm_production_public_npm:
 
   tags:
     - public-runner-docker
+
+.run_tests_template:
+  extends: .test_python_env
+  needs:
+    - job: prepare_hived_image
+      artifacts: true
+    - job: build_wheel
+      artifacts: true
+  variables:
+    HIVED_COMMIT: $HIVED_COMMIT
+    HIVED_UID: $HIVED_UID
+    PATH_TO_REPORT: "$CI_PROJECT_DIR/report.xml"
+    PYPROJECT_DIR: "${CI_PROJECT_DIR}/python"
+    HIVED_HTTP_ENDPOINT: ""
+  script:
+    - if [ -z "${HIVED_HTTP_ENDPOINT}" ]; then HIVED_HTTP_ENDPOINT=""; else HIVED_HTTP_ENDPOINT="--hived-http-endpoint=${HIVED_HTTP_ENDPOINT}"; fi
+    - echo -e "${TXT_BLUE}Launching tests...${TXT_CLEAR}"
+    - cd ${PYPROJECT_DIR}/tests/helpy_test
+    - python3 -m pytest --asyncio-mode auto -n auto --durations 0 --junitxml=report.xml ${HIVED_HTTP_ENDPOINT}
+  artifacts:
+    when: always
+    expire_in: 1 week
+    reports:
+      junit: $PATH_TO_REPORT
+  tags:
+    - data-cache-storage
+
+run_helpy_tests:
+  stage: test
+  extends: .run_tests_template
+  needs:
+    - !reference [.run_tests_template, needs]
+    - job: prepare_hived_data
+      artifacts: true
+  services:
+    - name: $HIVED_IMAGE_NAME
+      alias: hived-instance
+      variables:
+        DATA_SOURCE: "${DATA_CACHE_HIVE_PREFIX}_${HIVED_COMMIT}"
+        LOG_FILE: $CI_JOB_NAME.log
+      command: ["--replay-blockchain", "--stop-at-block=5000000"]
+  variables:
+    HIVED_HTTP_ENDPOINT: "http://hived-instance:8091"
\ No newline at end of file

README.md

@@ -40,10 +40,16 @@ python3 -m venv venv
 source ./venv/bin/activate
 ```
 
+Before installing the wax module to python, set env variables to the following value:
+
+```bash
+export FIRST_INDEX="https://gitlab.syncad.com/api/v4/projects/362/packages/pypi/simple" SECOND_INDEX="https://gitlab.syncad.com/api/v4/projects/434/packages/pypi/simple"
+```
+
 Now in order to install wax module to python, one need to type.
 
 ```bash
-python3 -m pip install ./dist/CREATED-WAX-WHEEL.whl (for example wax-0.0.0-cp310-cp310-manylinux_2_35_x86_64.whl)
+python3 -m pip install --index-url $FIRST_INDEX --extra-index-url $SECOND_INDEX ./dist/CREATED-WAX-WHEEL.whl (for example wax-0.0.0-cp310-cp310-manylinux_2_35_x86_64.whl)
 ```
 
 You can always take prebuilt PyPI package also pushed to Gitlab package registry - here is for example some `develop` related version: `0.0.3a2.dev131+bb99c4e`:

examples/python/create_and_sign_transation.py

+import asyncio
+
+from beekeepy import AsyncBeekeeper
+from beekeepy.interfaces import HttpUrl
+from wax import create_wax_foundation
+from wax.proto.operations import transfer
+
+
+PASSWORD = "pass"
+WALLET_NAME = "alice"
+HIVED_ADDRESS = HttpUrl("https://api.hive.blog")
+
+wax = create_wax_foundation()
+keys = wax.suggest_brain_key()
+
+trx = wax.create_transaction_with_tapos("00000449f7860b82b4fbe2f317c670e9f01d6d9a")
+trx.push_operation(transfer(from_account="alice", to_account="bob", amount=wax.hive.satoshis(10)))
+
+
+async def sign_trx():
+    async with await AsyncBeekeeper.factory() as beekeeper:
+        async with await beekeeper.create_session() as session:
+            wallet = await session.create_wallet(name=WALLET_NAME, password=PASSWORD)
+            await wallet.import_key(private_key=keys.wif_private_key)
+            await trx.sign(wallet=wallet, public_key=keys.associated_public_key)
+            print(f"broadcasting: {trx.to_api_json()}")
+
+async def main():
+    await sign_trx()
+
+asyncio.run(main())

examples/python/visitor_example.py

 from google.protobuf.json_format import ParseDict
 
-from wax.proto import (
-    comment_pb2,
-    limit_order_cancel_pb2,
-    recurrent_transfer_pb2,
-    operation_pb2,
-    transaction_pb2,
-    vote_pb2,
-)
+from wax.proto.operations import comment, limit_order_cancel, recurrent_transfer, vote
+from wax.proto.transaction import transaction
 from wax.wax_visitor import OperationVisitor
 
 tx_json = {
@@ -41,19 +35,19 @@ tx_json = {
 
 
 class MyOperationVisitor(OperationVisitor):
-    def limit_order_cancel(self, op: limit_order_cancel_pb2.limit_order_cancel):
+    def limit_order_cancel(self, op: limit_order_cancel):
         print(f"Handling limit_order_cancel operation:\n{op}")
         assert op.owner == "orderabc"
         assert op.orderid == 5
 
-    def vote(self, op: vote_pb2.vote) -> None:
+    def vote(self, op: vote) -> None:
         print(f"Handling vote operation:\n{op}")
         assert op.voter == "Alice"
         assert op.author == "Bob"
         assert op.permlink == "/"
         assert op.weight == 11
 
-    def comment(self, op: comment_pb2.comment) -> None:
+    def comment(self, op: comment) -> None:
         print(f"Handling comment operation:\n{op}")
         assert op.parent_permlink == "/"
         assert op.parent_author == ""
@@ -63,7 +57,7 @@ class MyOperationVisitor(OperationVisitor):
         assert op.body == "<span>comment</span>"
         assert op.json_metadata == "{}"
 
-    def recurrent_transfer(self, op: recurrent_transfer_pb2.recurrent_transfer) -> None:
+    def recurrent_transfer(self, op: recurrent_transfer) -> None:
         print(f"Handling recurrent_transfer operation:\n{op}")
         assert op.from_account == "alice"
         assert op.to_account == "harry"
@@ -77,7 +71,7 @@ class MyOperationVisitor(OperationVisitor):
 
 
 if __name__ == "__main__":
-    tx = ParseDict(tx_json, transaction_pb2.transaction())
+    tx = ParseDict(tx_json, transaction())
     visit = MyOperationVisitor()
     for op in tx.operations:
         visit.accept(op)

python/.pre-commit-config.yaml

+files: |
+    (?x)(
+            ^python/wax/.*$|
+            ^python/tests/base_api/.*$|
+            ^python/tests/transactions/.*$|
+            ^python/tests/helpy_test/.*$
+    )
+exclude: |
+    (?x)(
+            ^python/wax/cpp_python_bridge.pyi|
+            ^python/wax/proto/.*$
+    )
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-yaml
+        args: [ "--unsafe" ]
+      - id: check-json
+      - id: pretty-format-json
+        args: [ "--autofix" ]
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: https://github.com/python-poetry/poetry
+    rev: 1.7.1
+    hooks:
+      - id: poetry-lock
+        name: checking if poetry.lock is consistent with pyproject.toml
+        args: [ "--no-update", "-C", "./python"]
+        language_version: python3.10
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.6.5'
+    hooks:
+      - id: ruff
+        name: linting code with Ruff
+        args: [ "--fix" ]
+      - id: ruff-format
+        name: format code using Ruff formatter
+  - repo: local
+    hooks:
+      - id: mypy
+        name: type check with mypy
+        entry: mypy
+        args: ["--config-file", "python/pyproject.toml"]
+        language: system
+        types: [ python ]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+    - id: codespell
+  - repo: https://github.com/lk16/detect-missing-init
+    rev: v0.1.6
+    hooks:
+      - id: detect-missing-init
+        args:
+          - "--create"
+          - "--python-folders"
+          - "\
+            wax,
+            "

python/cpp_python_bridge.pxd

@@ -194,3 +194,4 @@ cdef extern from "cpython_interface.hpp" namespace "cpp":
         result cpp_proto_to_api( string operation_or_tx )
         result cpp_proto_to_legacy_api( string operation_or_tx )
         result cpp_api_to_proto( string operation_or_tx )
+        bool cpp_is_valid_account_name (string name )

python/cpp_python_bridge.pyx

@@ -4,6 +4,7 @@
 from typing import Callable
 from functools import wraps
 
+from libcpp cimport bool
 from libcpp.string cimport string as cppstring
 from libcpp.set cimport set as cppset
 from libcpp.map cimport map as cppmap
@@ -280,6 +281,10 @@ def estimate_hive_collateral(current_median_history: python_price, current_min_h
     response = obj.cpp_estimate_hive_collateral(_current_median_history, _current_min_history, _hbd_amount_to_get)
     return response.amount, response.precision, response.nai
 
+def is_valid_account_name(account_name: bytes) -> bool:
+    cdef proto_protocol obj
+    return obj.cpp_is_valid_account_name(account_name)
+
 def proto_operation_get_impacted_accounts(operation: bytes) -> vector[string]:
     cdef proto_protocol obj
     return obj.cpp_operation_get_impacted_accounts(operation)

python/pyproject.toml

@@ -14,9 +14,11 @@ version = "0.0.0"
 description = ""
 repository = "https://gitlab.syncad.com/hive/wax"
 authors = []
-packages = [
-    { include = "wax"},
-    { include = "wax/proto" }
+packages = [{ include = "wax"}]
+source = [
+    { name = "PyPI", priority = "primary" },
+    { name = "gitlab-schemas", url = "https://gitlab.syncad.com/api/v4/projects/362/packages/pypi/simple", priority = "supplemental" },
+    { name = "gitlab-beekeepy", url = "https://gitlab.syncad.com/api/v4/projects/434/packages/pypi/simple", priority = "supplemental" },
 ]
 
 [tool.poetry.build]
@@ -26,16 +28,30 @@ generate-setup-file = true
 [tool.poetry.dependencies]
 python = "^3.10"
 protobuf = "4.24.4"
+beekeepy = "0.0.1.dev338+58e0bf7"
+aiohttp = "3.9.1"
+httpx = {extras = ["http2"], version = "0.23.3"}
+loguru = "0.7.2"
+python-dateutil = "2.8.2"
+requests = "2.27.1"
 
 [tool.poetry.dev-dependencies]
-pytest = "7.4.2"
+mypy = "1.11.2"
+pre-commit = "2.21.0"
+pytest = "8.3.5"
+pytest-asyncio = "0.25.3"
+pytest-xdist = "3.6.1"
 types-setuptools = ">=67.8.0"
+ruff = "0.6.5"
+grpcio = "1.59.0"
 mypy-protobuf = "3.5.0"
+types-python-dateutil = "2.8.19.14"
 types-protobuf = "4.24.0.3"
-grpcio = "1.59.0"
 grpc-stubs = "1.53.0.2"
 grpcio-tools = "1.59.0"
 
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
 
 [tool.poetry-dynamic-versioning]
 enable = true
@@ -54,3 +70,70 @@ format-jinja = """
 files = [
     "wax/__init__.py",
 ]
+
+[tool.mypy]
+mypy_path = "python"
+strict = true
+disallow_untyped_decorators = false
+plugins = "pydantic.mypy"
+
+[[tool.mypy.overrides]]
+module = "wax._private.proto.*"
+ignore_missing_imports = true
+follow_imports = "skip"
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = "wax.proto.*"
+ignore_missing_imports = true
+follow_imports = "skip"
+ignore_errors = true
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+# https://docs.astral.sh/ruff/rules/
+select = ["ALL"]
+ignore = [
+    "D1", # missing docstring in public
+    "D203", # 1 blank line required before class docstring; because we re using D211
+    "D212", # Multi-line docstring summary should start at the first line; because we re using D213
+    "D401", # First line of docstring should be in imperative mood
+    "D413", # Missing blank line after last section
+    "TRY003", # Avoid specifying long messages outside the exception class; too restrictive
+    "ANN101",  # Missing annotation for self; makes no sense
+    "ANN102",  # Missing annotation for cls; makes no sense
+    "TD002", # Missing author in to-do; no need for that
+    "TD003",  # Missing issue link on the line following this to-do; no need for that
+    "SLF001",  # Private member accessed: {access}; too restrictive
+    "COM812", # Trailing comma missing; handled by ruff formatter
+    "EM",  # agreed not to use it in our convention
+    "FIX", # can't have that enabled, as we treat ruff result as an error on CI
+    "S101",  # Use of assert detected; too restrictive
+    "S603", # `subprocess` call: check for execution of untrusted input; https://github.com/astral-sh/ruff/issues/4045
+    "ISC001", # Implicitly concatenated string literals on one line; disabled because conflicts with ruff formatter
+    "PLR2004", # Ignore "magic value used in comparison" warnings; explicit constants not always necessary in tests
+]
+
+[tool.ruff.lint.per-file-ignores]
+"**/sync_api.py" = [
+  "PLR0913", # api definitions can have as many arguments as they need
+  "FBT001", # api definitions have own argument restrictions
+  "FBT002", # api definitions have own argument restrictions
+  "TCH001",
+  "TCH002",
+]
+"**/async_api.py" = [
+  "PLR0913", # api definitions can have as many arguments as they need
+  "FBT001", # api definitions have own argument restrictions
+  "FBT002", # api definitions have own argument restrictions
+  "TCH001",
+  "TCH002",
+]
+
+[tool.ruff.lint.flake8-annotations]
+allow-star-arg-any = true
+
+[tool.ruff.lint.isort]
+known-first-party = ["wax", "beekeepy"]

python/pytest.ini

+[pytest]
+asyncio_mode = auto
+markers =
+    describe

python/scripts/compile_proto.sh

@@ -6,7 +6,7 @@ SCRIPTPATH="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
 PROJECT_DIR="${SCRIPTPATH}/.."
 PROTO_DIR="${PROJECT_DIR}/../hive/libraries/protocol/proto"
 
-OUTPUT_DIR="${PROJECT_DIR}/wax/proto"
+OUTPUT_DIR="${PROJECT_DIR}/wax/_private/proto"
 INIT_FILE_PATH="${OUTPUT_DIR}/__init__.py"
 
 if [ -d "${OUTPUT_DIR}" ]; then

python/setup.py

-from __future__ import annotations
-
-from setuptools import setup
-
-packages = ["wax", "wax/proto"]
-
-package_data = {"": ["*"]}
-
-setup_kwargs = {
-    "name": "wax",
-    "version": "0.0.0",
-    "description": "Exposes Hive Protocol features to Python",
-    "long_description": "None",
-    "author": "None",
-    "author_email": "None",
-    "maintainer": "None",
-    "maintainer_email": "None",
-    "url": "https://gitlab.syncad.com/hive/wax",
-    "packages": packages,
-    "package_data": package_data,
-    "python_requires": ">=3.10,<4.0",
-}
-from build import *
-
-build(setup_kwargs)
-
-setup(**setup_kwargs)  # type: ignore[arg-type]

python/tests/base_api/conftest.py

+from __future__ import annotations
+
+import re
+import shutil
+from pathlib import Path
+from typing import TYPE_CHECKING, AsyncGenerator, Generator
+
+import pytest
+
+from beekeepy import AsyncBeekeeper, Settings
+from wax import ITransaction, IWaxBaseInterface, create_wax_foundation
+
+if TYPE_CHECKING:
+    from beekeepy import AsyncUnlockedWallet
+
+
+@pytest.fixture(autouse=True)
+def beekeeper_output_dir(request: pytest.FixtureRequest) -> Generator[Path, None, None]:
+    function_dir = __get_directory_for_function(request)
+
+    if function_dir.exists():
+        shutil.rmtree(function_dir)
+
+    function_dir.mkdir(exist_ok=True)
+
+    yield function_dir
+
+    if not any(function_dir.iterdir()):
+        shutil.rmtree(function_dir)
+
+
+@pytest.fixture
+async def beekeeper(beekeeper_output_dir: Path) -> AsyncGenerator[AsyncBeekeeper, None]:
+    async with await AsyncBeekeeper.factory(settings=Settings(working_directory=beekeeper_output_dir)) as beekeeper:
+        yield beekeeper
+
+
+@pytest.fixture
+async def wallet(beekeeper: AsyncBeekeeper) -> AsyncUnlockedWallet:
+    session = await beekeeper.create_session()
+    await session.create_wallet(name="beekeeper_wallet_name", password="beekeeper_wallet_password")  # noqa: S106
+
+    return await (await session.open_wallet(name="beekeeper_wallet_name")).unlock("beekeeper_wallet_password")
+
+
+@pytest.fixture
+def wax() -> IWaxBaseInterface:
+    return create_wax_foundation()
+
+
+@pytest.fixture
+def tapos() -> str:
+    return "04c507a8c7fe5be96be64ce7c86855e1806cbde3"
+
+
+@pytest.fixture
+def transaction(wax: IWaxBaseInterface, tapos: str) -> ITransaction:
+    return wax.create_transaction_with_tapos(tapos)
+
+
+def __convert_test_name_to_directory_name(test_name: str) -> str:
+    def __truncate_name(name: str, max_length: int = 100) -> str:
+        if len(name) > max_length:
+            return name[:max_length] + "_truncated"
+        return name
+
+    directory_name = []
+
+    parametrized_test_match = re.match(r"([\w_]+)\[(.*)\]", test_name)
+    if parametrized_test_match:
+        test_name = f"{parametrized_test_match[1]}_with_parameters_{parametrized_test_match[2]}"
+
+    for character in test_name:
+        character_to_append = character
+        if not (character_to_append.isalnum() or character_to_append in "-_"):
+            character_to_append = f"-0x{ord(character):X}-"
+
+        directory_name.append(character_to_append)
+
+    return __truncate_name("".join(directory_name))
+
+
+def __get_directory_for_function(request: pytest.FixtureRequest) -> Path:
+    assert request.scope == "function"
+    directory_name = __convert_test_name_to_directory_name(request.node.name)
+    return Path(request.node.fspath.dirpath() / "generated_during_" + directory_name)

python/tests/base_api/templates.py

+from __future__ import annotations
+
+from typing import Any, Final
+
+from wax.wax_result import python_json_asset, python_price, python_witness_set_properties_data
+
+SIGNATURE_TRANSACTION: Final[dict[str, Any]] = {
+    "expiration": "2024-02-21T06:55:40",
+    "extensions": [],
+    "operations": [
+        {
+            "type": "account_update2_operation",
+            "value": {
+                "account": "thatcryptodave",
+                "extensions": [],
+                "json_metadata": "",
+                "posting_json_metadata": (
+                    '{"name":"David P.","about":"","website":"","location":"Ontario, Canada",'
+                    '"birthday":"03.28.1984","profile":{"name":"David P.","about":"",'
+                    '"website":"","location":"Ontario, Canada","birthday":"03.28.1984",'
+                    '"profile_image":"","cover_image":""}}'
+                ),
+            },
+        }
+    ],
+    "signatures": [
+        "1f6ad21ddf9f57f1a94c1462185744cb0ea779ec1e99899f2556a3ce02b18d1b810fcddaccb349a53037798aea8023909447df756db461235ba5b63984d515c977"
+    ],
+    "ref_block_num": 26295,
+    "ref_block_prefix": 26859167,
+}
+
+REQUIRED_ACTIVE_AUTHORITY_TRANSACTION: Final[dict[str, Any]] = {
+    "ref_block_num": 59819,
+    "ref_block_prefix": 1319397834,
+    "extensions": [],
+    "expiration": "2024-09-12T07:15:15",
+    "operations": [{"type": "limit_order_cancel_operation", "value": {"owner": "droida", "orderid": 877434673}}],
+    "signatures": [
+        "20470dc8de917827ea55328774123c93b4670cfe72133981072e2821e7fa20bfaf04f5dcec762ebc89a64232bc2c5d5d0de98a61ab670647cfb4c5ff5c438e865e"
+    ],
+}
+
+
+REQUIRED_OWNER_AUTHORITY_TRANSACTION: Final[dict[str, Any]] = {
+    "ref_block_num": 61120,
+    "ref_block_prefix": 1820528888,
+    "extensions": [],
+    "expiration": "2024-09-12T08:40:18",
+    "operations": [
+        {
+            "type": "account_update_operation",
+            "value": {
+                "owner": {
+                    "key_auths": [
+                        ["STM4xCRKtqz2GyCq4ctwyi2SFk29fyVyCMxpuNioGGi7JAJuTXWD2", 1],
+                        ["STM57pVtywZGeywtcxtozLjxRUZFSt9kcFv2LDP8YsTQzW1e4b8NT", 1],
+                        ["STM5QHDFfzSFzPRGknGiXAbFtdkadgFmDzMazCSFWch5k3QRYrNUu", 1],
+                        ["STM5gQ79TFvy483xLvW2ZDyZRw979yxeNSrVY278J5ZkRKfFkXn2u", 1],
+                        ["STM5jQxUpMn84tCFQCrhwvVxkhbgTBYGYYiPJys1QHd9bJvb92UdP", 1],
+                        ["STM5tzqAFVovzopZszs46P22PLUQzTVTyPdkFaGkxgRcFV3sPWUMa", 1],
+                        ["STM5victPsYtnLQvHi4V1c3ZshMMe1sxFHkj1YtM3sMwW49Dim5Rn", 1],
+                        ["STM6bzzDhAH7by2H8CuD742p89ZDEkPg3W3nhxcLWzjqxFTyfEUga", 1],
+                        ["STM6fSMwqr6F1c2aNf7ov8WnKnAn7Grrb8A7kQR4Qu5yDJF8Y5icL", 1],
+                        ["STM6hGTjCRfDHLuzzYKVwr9cmjzgXdBJ8Efv7SK75gGiywqNwbp8u", 1],
+                        ["STM6psb1cFxfd8YbWUfSbbMazp16Dq189sTcZ3oDuEAw96jY7fgvs", 1],
+                        ["STM6qtzpc2d4M2vWZJFJptcS5c8RYmYPgLrRfjx2s6PZJDViaEsAR", 1],
+                        ["STM6v5nGgfZ1jTPB7FbS92McNU2iA15oyi8FBGnemHuYU5yP9cmBF", 1],
+                        ["STM6wtyPzJ9DbExRQMGh39FrMPT9USFQxcEiNycVJToZ1YgBSRhka", 1],
+                        ["STM6xHrBQuK3HeQ6ydQwD1fLdL65H4W6XGA8tmzwntMuNuoxwKnD6", 1],
+                        ["STM76nQCMeBybWbHLNdoyTwLRxefc3CWAQUTPfkS981FCH4jKCKyU", 1],
+                        ["STM7Qt3bkotstLhuaNXGbDLcsGUxSauY8pqBFFKBqQXPmdCfFjWoN", 1],
+                        ["STM7upEkw7FBfNexisNxnotd6v47oA4Vd26gu69ijEZnxFnK3nYuU", 1],
+                        ["STM7zgquZgbBCw3SmgtyMvRcB67XGSDEAsPw3Unqay4NSYApuF6oQ", 1],
+                        ["STM859GqiDqMZBAjW1hZQ6JuK2EoCbMN8g1VomACiHLHUSXgwMJ1J", 1],
+                        ["STM8XB3ZtazYGLGpPVT6Vjwjeaiqgx8tfjmmUAfn31DDmzvVpaLqo", 1],
+                    ],
+                    "account_auths": [["vsc.network", 11]],
+                    "weight_threshold": 11,
+                },
+                "active": {"key_auths": [], "account_auths": [], "weight_threshold": 11},
+                "account": "vsc.gateway",
+                "posting": {"key_auths": [], "account_auths": [["vsc.network", 11]], "weight_threshold": 11},
+                "memo_key": "STM8buQNWovTcX7H8yLdYNx82xDddQE9R5MzQDNg4mocScnXTGSkE",
+                "json_metadata": '{"message":"VSC Multsig Account","epoch":378}',
+            },
+        }
+    ],
+    "signatures": [
+        "2025e4786d42348e3dcf68a19a35cfe690c196e02b77e87547710753bebe44e4da21b35f12b1e3fd786d5b867d114b12c676d7d6ee6c84c26d9430206677011461",
+        "1f078118754c4dac8161de0a9387e612eb51946a817ee7f0153c9a6f46b6e4d33c1491b166edeaaa496016342411c980def6c94162eb73e95f4fade4cd96c8f37a",
+        "1f0e3e48e0546372e5bd665dd39489d1d40b9db979b6678c627fc964dd20e5155e5dcf30ed41ed514c6b47be1ea95b0ff64cd3f91f6c6065ba4a63decd0f5d69fe",
+        "1f0edd1681496f394eecc7fa075ab776f6b7fbb1ce0251e7b636f6076699a741de368ff8d063bbe36f9a8fe0378935d8a2d9d9030625aa84552cb804bde6b19798",
+        "1f19b81eb6c2e97043933d6ca583b6c98c59514a88bb4e35e1a74007f27c6e9931748d44bebcebd6a18ecc4132e49411d17cf8236200009f76f93e2be4784af179",
+        "1f687c876c35d1074473a1ee044681f1d6d25b4331e1ec9502174880874be4011a23fd9b3205fa881765939d51070809bc68745c218947163b6f86de587e8a9189",
+        "1f752c413fa9378982fcc59668cfa14f38dd4ad24d2358ff98b702f807389d434a5271cdfacc8884e719d4cd515b6d7c2827c0735ac0e0c79468d85965821cd960",
+        "203231db1e1cc3f955958a2663d257dae1533fd3c2130bd0e0c5ad18edc854cbb5440a7c481497c92752e343330d53e07b93f7a9b6b441e0b3671835e3b6609e2e",
+        "2051589eddc26ed021ee53edfa45f75dbc960705410eb3b22f61bd0c74246382397cdcc57fc513262aefca21b8d03eef7773bd20a29f451198160079b564ff4130",
+        "20707cf3698fa3ec3848b73ae1def7c3344d4fe60a42c15ee5c1986b2ee1d5a80e730e7df2ad5759fc2ad0138249b4db6a3d0efbe9ac4bc136660285177177ba68",
+        "20724430ed1b6628616d20f95818e065f67799cbe05bb4f3aaeb588cbf85e0e18c460414e423fe80f2c0b429d292f6e6d1fd8890f26c5c00f18c46f93feafcebef",
+    ],
+}
+
+
+RECOVER_ACCOUNT_TRANSACTION: Final[dict[str, Any]] = {
+    "ref_block_num": 36,
+    "ref_block_prefix": 2180018243,
+    "expiration": "2024-04-24T08:30:15",
+    "extensions": [],
+    "signatures": [],
+    "operations": [
+        {
+            "type": "recover_account_operation",
+            "value": {
+                "account_to_recover": "bob",
+                "new_owner_authority": {
+                    "weight_threshold": 1,
+                    "account_auths": [],
+                    "key_auths": [["STM5P8syqoj7itoDjbtDvCMCb5W3BNJtUjws9v7TDNZKqBLmp3pQW", 1]],
+                },
+                "recent_owner_authority": {
+                    "weight_threshold": 1,
+                    "account_auths": [],
+                    "key_auths": [["STM4wJYLcRnALfbpb4ziqiH3oLEgw9PTJZTBBj8goFyjta3mm6D1s", 1]],
+                },
+                "extensions": [],
+            },
+        }
+    ],
+}
+
+
+INPUT_WITNESS_PROPERTIES: Final[python_witness_set_properties_data] = python_witness_set_properties_data(
+    key=b"STM5z76mjZJnTZHHZjgnFxFadTb1ztc6R7EuDgCzd6dNiv6ETB2tj",
+    new_signing_key=b"STM5z76mjZJnTZHHZjgnFxFadTb1ztc6R7EuDgCzd6dNiv6ETB2tj",
+    hbd_exchange_rate=python_price(
+        base=python_json_asset(amount=b"273", precision=3, nai=b"@@000000013"),
+        quote=python_json_asset(amount=b"1000", precision=3, nai=b"@@000000021"),
+    ),
+    account_creation_fee=python_json_asset(amount=b"5000", precision=3, nai=b"@@000000021"),
+    url=b"https://hive.io",
+    maximum_block_size=131072,
+    hbd_interest_rate=1000,
+    account_subsidy_budget=797,
+    account_subsidy_decay=347321,
+)
+
+WITNESS_PROPERTIES: Final[python_witness_set_properties_data] = python_witness_set_properties_data(
+    key=b"STM5RqVBAVNp5ufMCetQtvLGLJo7unX9nyCBMMrTXRWQ9i1Zzzizh",
+    new_signing_key=b"STM6TqSJaS1aRj6p6yZEo5xicX7bvLhrfdVqi5ToNrKxHU3FRBEdW",
+    account_creation_fee=python_json_asset(amount=b"5000", precision=3, nai=b"@@000000021"),
+    url=b"https://hive.io",
+    hbd_exchange_rate=python_price(
+        base=python_json_asset(amount=b"100", precision=3, nai=b"@@000000013"),
+        quote=python_json_asset(amount=b"100", precision=3, nai=b"@@000000021"),
+    ),
+    maximum_block_size=131072,
+    hbd_interest_rate=1000,
+    account_subsidy_budget=797,
+    account_subsidy_decay=347321,
+)
+
+
+WITNESS_PROPERTIES_HF26: Final[dict[str, Any]] = {
+    "type": "witness_set_properties_operation",
+    "value": {
+        "owner": "gtg",
+        "props": [
+            [
+                "account_creation_fee",
+                "88130000000000002320bcbe",
+            ],
+            [
+                "account_subsidy_budget",
+                "e8030000",
+            ],
+            [
+                "account_subsidy_decay",
+                "e8030000",
+            ],
+            [
+                "hbd_exchange_rate",
+                "e8030000000000000320bcbee8030000000000002320bcbe",
+            ],
+            [
+                "hbd_interest_rate",
+                "e803",
+            ],
+            [
+                "key",
+                "02472d6eb6d691b6de8b103b51ebdf4e128a523946d8cd03d6ded91b1497ee2e83",
+            ],
+            [
+                "maximum_block_size",
+                "e8030000",
+            ],
+            [
+                "new_signing_key",
+                "02cf69b1f999d133ebbe178a8b4bbf4da356b264dfdc843b1c740378bff8f65b33",
+            ],
+            [
+                "url",
+                "0f68747470733a2f2f686976652e696f",
+            ],
+        ],
+    },
+}

python/tests/base_api/test_asset_conversion.py

+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from wax.interfaces import IWaxBaseInterface
+
+
+@pytest.mark.describe("Should be able to convert HIVE to HBD using satoshis")
+def test_asset_conversion_0(wax: IWaxBaseInterface) -> None:
+    feed_price_base = wax.hbd.satoshis(amount=171)
+    feed_price_quote = wax.hive.satoshis(amount=1000)
+    amount = wax.hive.satoshis(amount=13316762799)
+
+    result = wax.hive_to_hbd(hive=amount, base=feed_price_base, quote=feed_price_quote)
+
+    assert result == wax.hbd.satoshis(amount=2277166438)
+
+
+@pytest.mark.describe("Should be able to convert HIVE to HBD using satoshis")
+def test_asset_conversion_1(wax: IWaxBaseInterface) -> None:
+    feed_price_base = wax.hbd.satoshis(amount=171_000)
+    feed_price_quote = wax.hive.satoshis(amount=1000_000)
+    amount = wax.hive.satoshis(amount=13316762799_000)
+
+    result = wax.hive_to_hbd(hive=amount, base=feed_price_base, quote=feed_price_quote)
+
+    assert result == wax.hbd.satoshis(amount=2277166438629)
+
+
+@pytest.mark.describe("Should be able to convert HIVE to HBD using coins")
+def test_asset_conversion_2(wax: IWaxBaseInterface) -> None:
+    feed_price_base = wax.hbd.coins(amount=171)
+    feed_price_quote = wax.hive.coins(amount=1000)
+    amount = wax.hive.coins(amount=13316762799)
+
+    result = wax.hive_to_hbd(hive=amount, base=feed_price_base, quote=feed_price_quote)
+
+    assert result == wax.hbd.coins(amount=2277166438.629)
+
+
+@pytest.mark.describe("Should be able to convert HIVE to HBD using mixed params")
+def test_asset_conversion_3(wax: IWaxBaseInterface) -> None:
+    feed_price_base = wax.hbd.satoshis(amount=171_000)
+    feed_price_quote = wax.hive.coins(amount=1000)
+    amount = wax.hive.coins(amount=13316762799)
+
+    result = wax.hive_to_hbd(hive=amount, base=feed_price_base, quote=feed_price_quote)
+
+    assert result == wax.hbd.coins(amount=2277166438.629)
+
+
+@pytest.mark.describe("Should be able to convert VESTS to HP (bug)")
+def test_asset_conversion_4(wax: IWaxBaseInterface) -> None:
+    delegated_vesting_shares = 6909522651976083
+    # according to result taken from:
+    # https://api.syncad.com/hafbe-api/witnesses/blocktrades/voters?sort=vests&direction=desc&result-limit=2147483647
+    self_witness_vote = 43357485398000965
+
+    blocktrades_delegated_hp = wax.vests_to_hp(
+        vests=wax.vests.satoshis(amount=delegated_vesting_shares),
+        total_vesting_fund_hive=wax.hive.satoshis(amount=182849539607),
+        total_vesting_shares=wax.vests.satoshis(amount=312353953479712805),
+    )
+
+    blocktrades_self_witness_vote_hp = wax.vests_to_hp(
+        vests=wax.vests.satoshis(amount=self_witness_vote),
+        total_vesting_fund_hive=wax.hive.satoshis(amount=182849539607),
+        total_vesting_shares=wax.vests.satoshis(amount=312353953479712805),
+    )
+
+    delegated_vesting_shares = 13261033608208
+    mcfarhat_delegated_hp = wax.vests_to_hp(
+        vests=wax.vests.satoshis(amount=delegated_vesting_shares),
+        total_vesting_fund_hive=wax.hive.satoshis(amount=182849539607),
+        total_vesting_shares=wax.vests.satoshis(amount=312353953479712805),
+    )
+
+    assert blocktrades_delegated_hp == wax.hive.satoshis(amount=4044780037)
+    assert blocktrades_self_witness_vote_hp == wax.hive.satoshis(amount=25381129821)
+    assert mcfarhat_delegated_hp == wax.hive.satoshis(amount=7762904)
+
+
+@pytest.mark.describe("Should be able to convert VESTS to HP using satoshis")
+def test_asset_conversion_5(wax: IWaxBaseInterface) -> None:
+    result = wax.vests_to_hp(
+        vests=wax.vests.satoshis(amount=10),
+        total_vesting_fund_hive=wax.hive.satoshis(amount=1),
+        total_vesting_shares=wax.vests.satoshis(amount=10),
+    )
+
+    assert result == wax.hive.satoshis(amount=1)
+
+
+@pytest.mark.describe("Should be able to convert VESTS to HP using coins")
+def test_asset_conversion_6(wax: IWaxBaseInterface) -> None:
+    result = wax.vests_to_hp(
+        vests=wax.vests.coins(amount=10),
+        total_vesting_fund_hive=wax.hive.coins(amount=10),
+        total_vesting_shares=wax.vests.coins(amount=10),
+    )
+
+    assert result == wax.hive.coins(amount=10)
+
+
+@pytest.mark.describe("Should be able to convert VESTS to HP using mixed params")
+def test_asset_conversion_7(wax: IWaxBaseInterface) -> None:
+    result = wax.vests_to_hp(
+        vests=wax.vests.satoshis(10),
+        total_vesting_fund_hive=wax.hive.coins(10),
+        total_vesting_shares=wax.vests.satoshis(10),
+    )
+
+    assert result == wax.hive.coins(10)
+
+
+@pytest.mark.describe("Should be able to convert HBD to HIVE using satoshis")
+def test_asset_conversion_8(wax: IWaxBaseInterface) -> None:
+    result = wax.hbd_to_hive(hbd=wax.hbd.satoshis(10), base=wax.hbd.satoshis(1), quote=wax.hive.satoshis(10))
+
+    assert result == wax.hive.satoshis(100)
+
+
+@pytest.mark.describe("Should be able to convert HBD to HIVE using coins")
+@pytest.mark.parametrize(("value_to_convert", "base", "quote"), [(2, 1, 1), (5, 1, 2), (10, 1, 10), (1000, 1, 20)])
+def test_asset_conversion_9(wax: IWaxBaseInterface, value_to_convert: int, base: int, quote: int) -> None:
+    result = wax.hbd_to_hive(hbd=wax.hbd.coins(value_to_convert), base=wax.hbd.coins(base), quote=wax.hive.coins(quote))
+
+    assert result == wax.hive.coins(int(value_to_convert * (base * quote)))
+
+
+@pytest.mark.describe("Should be able to convert HBD to HIVE using mixed params")
+def test_asset_conversion_10(wax: IWaxBaseInterface) -> None:
+    result = wax.hbd_to_hive(hbd=wax.hbd.coins(10), base=wax.hbd.satoshis(1), quote=wax.hive.satoshis(10))
+
+    assert result == wax.hive.coins(100)

python/tests/base_api/test_calculate_hp_apr.py

+from __future__ import annotations
+
+from decimal import Decimal
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from wax.interfaces import IWaxBaseInterface
+
+
+@pytest.mark.parametrize("unit_amount", ["coins", "satoshis"])
+@pytest.mark.descrbe("Should be able to calculate HP APR")
+def test_calculate_hp_apr(wax: IWaxBaseInterface, unit_amount: str) -> None:
+    hive_unit = getattr(wax.hive, unit_amount)
+
+    hp_apr = wax.calculate_hp_apr(
+        head_block_num=1_000_000,
+        vesting_reward_percent=1_500,
+        virtual_supply=hive_unit(10),
+        total_vesting_fund_hive=hive_unit(10),
+    )
+    assert hp_apr == Decimal("1.46")

python/tests/base_api/test_calculation.py

+from __future__ import annotations
+
+from datetime import datetime, timezone
+from decimal import Decimal
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from wax.interfaces import IWaxBaseInterface
+
+
+@pytest.mark.describe("Should be able to calculate current manabar value using hive chain interface")
+def test_current_manabar_calculation(wax: IWaxBaseInterface) -> None:
+    manabar = wax.calculate_current_manabar_value(
+        head_block_time=datetime.fromtimestamp(1702548351, tz=timezone.utc),
+        max_mana=2196088774870643,
+        current_mana=1952744111294225,
+        last_update_time=1702548249,
+    )
+
+    assert manabar.current_mana == 1953262632254958
+    assert manabar.max_mana == 2196088774870643
+    assert manabar.percent == Decimal("88.94")
+
+
+@pytest.mark.describe("Should be able to calculate witness votes HP")
+def test_calculate_witness_votes_hp_0(wax: IWaxBaseInterface) -> None:
+    # real input data for 5 million node
+    calculated_votes = wax.calculate_witness_votes_hp(
+        number=147408633689698596,
+        total_vesting_fund_hive=wax.hive.satoshis(180520335089),
+        total_vesting_shares=wax.vests.satoshis(304505804867506145),
+    )
+
+    assert calculated_votes == wax.hive.satoshis(87388337178)
+
+
+@pytest.mark.describe("Should be able to calculate witness votes HP with mixed params")
+def test_calculate_witness_votes_hp_1(wax: IWaxBaseInterface) -> None:
+    # real input data for 5 million node
+    calculated_votes = wax.calculate_witness_votes_hp(
+        number=147408633689698596,
+        total_vesting_fund_hive=wax.hive.satoshis(180520335089),
+        total_vesting_shares=wax.vests.coins(304505804867.506145),
+    )
+    assert calculated_votes == wax.hive.coins(87388337.178)
+
+
+@pytest.mark.parametrize("unit_amount", ["coins", "satoshis"])
+@pytest.mark.describe("Should be able to calculate account HP - coins/satoshis")
+def test_calculate_account_hp_0(wax: IWaxBaseInterface, unit_amount: str) -> None:
+    hive_unit = getattr(wax.hive, unit_amount)
+    vests_unit = getattr(wax.vests, unit_amount)
+
+    calculated_hp = wax.calculate_account_hp(
+        vests=vests_unit(10),
+        total_vesting_fund_hive=hive_unit(10),
+        total_vesting_shares=vests_unit(10),
+    )
+
+    assert calculated_hp == hive_unit(10)
+
+
+@pytest.mark.describe("Should be able to calculate account HP with mixed params")
+def test_calculate_account_hp_1(wax: IWaxBaseInterface) -> None:
+    calculated_hp = wax.calculate_account_hp(
+        vests=wax.vests.coins(10),
+        total_vesting_fund_hive=wax.hive.satoshis(10),
+        total_vesting_shares=wax.vests.satoshis(10),
+    )
+
+    assert calculated_hp == wax.hive.coins(10_000)