Release v0.55.0

.github/PULL_REQUEST_TEMPLATE/feature_branch_pr_template.md

@@ -0,0 +1,11 @@
+### Motivation
+
+What was the motivation for the changes in this PR?
+
+### Acceptance Criteria
+
+- Include here all things that this PR should solve
+
+### Checklist
+
+- [ ] If you are requesting a merge into `master`, confirm this code is production-ready and can be included in future releases as soon as it gets merged 

.github/PULL_REQUEST_TEMPLATE/release_candidate_pr_template.md

@@ -0,0 +1,8 @@
+# Changes
+
+Link here all the PRs that are included in this release candidate
+
+# Checklist
+
+- [ ] I've read and followed the release candidate process described in https://github.com/HathorNetwork/ops-tools/blob/master/docs/release-guides/hathor-core.md#release-candidate
+- [ ] I confirm this release candidate only includes production-ready changes

.github/PULL_REQUEST_TEMPLATE/release_pr_template.md

@@ -0,0 +1,12 @@
+# Changes
+
+Link here all the PRs that are included in this release
+
+# Release-candidates
+
+Link here the release-candidates that were deployed as part of this release
+
+# Checklist
+
+- [ ] I've read and followed the release process described in https://github.com/HathorNetwork/ops-tools/blob/master/docs/release-guides/hathor-core.md#stable-release
+- [ ] The QA process was run successfully during the tests of the corresponding release-candidate(s)

.github/pull_request_template.md

@@ -0,0 +1,5 @@
+Please go to the `Preview` tab and select the appropriate Pull Request template:
+
+* [Feature Branch](?expand=1&template=feature_branch_pr_template.md) - Use this PR template when you are merging a feature branch into `master`
+* [Release Candidate](?expand=1&template=release_candidate_pr_template.md) - Use this PR template when you are merging `master` into `release-candidate`
+* [Release](?expand=1&template=release_pr_template.md) - Use this PR template when you are merging `release-candidate` into `release`

.github/workflows/docker.yml

@@ -28,9 +28,7 @@ jobs:
           - '3.10'
           - '3.11'
         exclude:
-          # XXX: neither pypy-3.10 nor pypy-3.11 exist yet, maybe pypy-3.10 will be out on PyPy v7.3.10
-          - python-impl: pypy
-            python-version: '3.10'
+          # XXX: pypy-3.11 does exist yet
           - python-impl: pypy
             python-version: '3.11'
     steps:
@@ -52,8 +50,9 @@ jobs:
           python extras/github/docker.py
       - name: Check version
         if: steps.prep.outputs.check-version
-        run: |
-          make check-version VERSION='${{ steps.prep.outputs.check-version }}'
+        env:
+          VERSION: ${{ steps.prep.outputs.check-version }}
+        run: make check-custom
       - name: Set up QEMU  # arm64 is not available natively
         uses: docker/setup-qemu-action@v2
       - name: Set up Docker Buildx

.github/workflows/main.yml

@@ -38,7 +38,8 @@ jobs:
               matrix = full_matrix
           else:
               matrix = reduced_matrix
-          print('::set-output name=matrix::' + json.dumps(matrix))
+          with open(os.environ['GITHUB_OUTPUT'], 'a') as f:
+            f.write('matrix={}\n'.format(json.dumps(matrix)))
   check-matrix:
     runs-on: ubuntu-latest
     needs: matrix

Dockerfile

@@ -1,6 +1,6 @@
 # before changing these variables, make sure the tag $PYTHON-alpine$ALPINE exists first
 # list of valid tags hese: https://hub.docker.com/_/python
-ARG PYTHON=3.9
+ARG PYTHON=3.10
 ARG DEBIAN=bullseye
 
 # stage-0: copy pyproject.toml/poetry.lock and install the production set of dependencies

Dockerfile.pypy

@@ -1,6 +1,6 @@
 # before changing these variables, make sure the tag $PYTHON-alpine$ALPINE exists first
 # list of valid tags hese: https://hub.docker.com/_/pypy
-ARG PYTHON=3.9
+ARG PYTHON=3.10
 ARG DEBIAN=bullseye
 
 # stage-0: copy pyproject.toml/poetry.lock and install the production set of dependencies

Makefile

@@ -78,15 +78,15 @@ isort-check:
 yamllint:
 	yamllint .
 
-.PHONY: check-version
-check-version:
-	bash ./extras/check_version.sh $(VERSION)
+.PHONY: check-custom
+check-custom:
+	bash ./extras/custom_checks.sh
 
 .PHONY: check
-check: check-version yamllint flake8 isort-check mypy
+check: check-custom yamllint flake8 isort-check mypy
 
 .PHONY: dcheck
-dcheck: check-version yamllint flake8 isort-check dmypy
+dcheck: check-custom yamllint flake8 isort-check dmypy
 
 # formatting:
 

extras/custom_checks.sh

@@ -0,0 +1,112 @@
+#!/bin/bash
+
+# Define colors
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+NC='\033[0m' # No Color
+
+# Source dirs
+SOURCE_DIRS=(hathor tests)
+
+# Define your custom linter check functions here
+# Each function should return 0 if everything is OK, and 1 if something is wrong.
+
+function check_version_match() {
+    # This function will check all source files containing the project version and return 1 in case
+    # they don't match. When a version is provided as an environment variable, it is checked against the package version.
+
+    OPENAPI_FILE="hathor/cli/openapi_files/openapi_base.json"
+    SRC_FILE="hathor/version.py"
+    PACKAGE_FILE="pyproject.toml"
+
+    OPENAPI_VERSION=`grep "version\":" ${OPENAPI_FILE} | cut -d'"' -f4`
+    SRC_VERSION=`grep "BASE_VERSION =" ${SRC_FILE} | cut -d "'" -f2`
+    PACKAGE_VERSION=`grep '^version' ${PACKAGE_FILE} | cut -d '"' -f2`
+
+    # For debugging:
+    # echo x${SRC_VERSION}x
+    # echo x${OPENAPI_VERSION}x
+    # echo x${PACKAGE_VERSION}x
+
+    EXITCODE=0
+
+    if [[ x${PACKAGE_VERSION}x != x${SRC_VERSION}x ]]; then
+        echo "Version different in ${PACKAGE_FILE} and ${SRC_FILE}"
+        EXITCODE=1
+    fi
+
+    if [[ x${PACKAGE_VERSION}x != x${OPENAPI_VERSION}x ]]; then
+        echo "Version different in ${PACKAGE_FILE} and ${OPENAPI_FILE}"
+        EXITCODE=1
+    fi
+
+    # We expect an optional environment variable containing a version string to be checked against the others
+    if [[ -n ${VERSION} ]]; then
+        if [[ x${PACKAGE_VERSION}x != x${VERSION}x ]]; then
+            echo "Version different in ${PACKAGE_FILE} and VERSION environment variable"
+            EXITCODE=1
+        fi
+    fi
+
+    return $EXITCODE
+}
+
+function check_do_not_use_builtin_random_in_tests() {
+	# If the check fails, return 1
+	# If the check passes, return 0
+	exclude=(
+		hathor/merged_mining/debug_api.py
+		hathor/client.py
+		hathor/cli/tx_generator.py
+	)
+	exclude_params=()
+	for item in "${exclude[@]}"; do
+		exclude_params+=(-not -path "*$item*")
+	done
+	if find "${SOURCE_DIRS[@]}" "${exclude_params[@]}" -type f -print0 | xargs -0 grep -l '\<import .*\<random\>'; then
+		echo '"import random" found in the files above'
+		echo 'use `self.rng` or `hathor.util.Random` instead of `random`'
+		return 1
+	fi
+	return 0
+}
+
+function check_deprecated_typing() {
+	if grep -R '\<typing .*\<import .*\<\(Tuple\|List\|Dict\|Set\|FrozenSet\|AbstractSet\|DefaultDict\|OrderedDict\)\>' "${SOURCE_DIRS[@]}"; then
+		echo 'do not use typing.List/Tuple/Dict/... for type annotations use builtin list/tuple/dict/... instead'
+		echo 'for more info check the PEP 585 doc: https://peps.python.org/pep-0585/'
+		return 1
+	fi
+	return 0
+}
+
+# List of functions to be executed
+checks=(
+	check_version_match
+	check_do_not_use_builtin_random_in_tests
+	check_deprecated_typing
+)
+
+# Initialize a variable to track if any check fails
+any_check_failed=0
+
+# Loop over all checks
+for check in "${checks[@]}"; do
+	$check
+	result=$?
+	if [ $result -ne 0 ]; then
+		echo -e "${RED}Check $check FAILED${NC}"
+		any_check_failed=1
+	else
+		echo -e "${GREEN}Check $check PASSED${NC}"
+	fi
+done
+
+# Exit with code 0 if no check failed, otherwise exit with code 1
+if [ $any_check_failed -eq 0 ]; then
+	echo -e "${GREEN}All checks PASSED${NC}"
+	exit 0
+else
+	echo -e "${RED}Some checks FAILED${NC}"
+	exit 1
+fi

extras/gen_release_candidate_changes.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python
+"""
+This script finds all PRs that have been merged into the `master` branch but not into the `release-candidate` branch in a given GitHub repository.
+
+Usage:
+
+    ./extras/gen_release_candidate_changes.py
+
+Example output:
+
+```
+- #701
+- #697
+- #686
+```
+"""
+
+import yaml
+import os
+import requests
+
+BASE_API_URL = 'https://api.github.com'
+REPO = 'HathorNetwork/hathor-core'
+
+
+def get_gh_token():
+    config_path = os.path.expanduser('~/.config/gh/hosts.yml')
+
+    if not os.path.exists(config_path):
+        print("GitHub CLI configuration not found. Please authenticate with 'gh auth login'.")
+        exit(1)
+
+    with open(config_path, 'r') as file:
+        config = yaml.safe_load(file)
+
+    token = config['github.com']['oauth_token']
+    return token
+
+
+def get_headers(token):
+    return {'Authorization': f'token {token}'}
+
+
+def get_commits_ahead(base, compare, token):
+    response = requests.get(
+        f'{BASE_API_URL}/repos/{REPO}/compare/{base}...{compare}',
+        headers=get_headers(token)
+    )
+    data = response.json()
+    return [commit['sha'] for commit in data['commits']]
+
+
+def get_pr_for_commit(commit, token):
+    response = requests.get(
+        f'{BASE_API_URL}/repos/{REPO}/commits/{commit}/pulls',
+        headers=get_headers(token),
+        params={'state': 'all'}
+    )
+    data = response.json()
+    if data:
+        return data[0]['number']
+    return None
+
+
+def get_new_prs_in_master(token):
+    commits = get_commits_ahead('release-candidate', 'master', token)
+    prs = []
+    for commit in commits:
+        pr = get_pr_for_commit(commit, token)
+        if pr and pr not in prs:
+            prs.append(pr)
+    return prs
+
+
+if __name__ == '__main__':
+    token = get_gh_token()
+    prs = get_new_prs_in_master(token)
+    for pr in prs:
+        print(f'- #{pr}')

extras/github/docker.py

@@ -3,9 +3,9 @@
 from typing import Dict
 
 def print_output(output: Dict):
-    for k, v in output.items():
-        print(f'::set-output name={k}::{v}')
-
+    outputs = ['{}={}\n'.format(k, v) for k, v in output.items()]
+    with open(os.environ['GITHUB_OUTPUT'], 'a') as f:
+        f.writelines(outputs)
 
 def prep_base_version(environ: Dict):
     GITHUB_REF = environ.get('GITHUB_REF')