automate version sync

Author: dpaiton

.github/workflows/build_hyperdrivetypes.yml

@@ -1,21 +1,11 @@
 name: build and upload hyperdrivetypes wheel
 
-# TODO: We will want to sync the python version with the hyperdrive version & push on hyperdrive tags
-#on:
-#  push:
-#    tags:
-#      - "v*"
-
-# TODO: Temp for testing
 on:
   push:
+    # tags:
+    #   - "v*"
 
 jobs:
-  # TODO: Temp for testing; will sync version
-  detect-changes:
-    uses: ./.github/workflows/check_diff.yaml
-    with:
-      pattern: ^python/\hyperdrivetypes/\pyproject.toml
 
   build-wheel:
     name: build hyperdrivetypes wheel
@@ -46,7 +36,7 @@ jobs:
 
       - name: build hyperdrivetypes package
         shell: bash
-        run: source scripts/build-hyperdrivetypes-wheel.sh
+        run: scripts/build-hyperdrivetypes-wheel.sh
 
       - name: upload wheel
         uses: actions/upload-artifact@v4

CONTRIBUTING.md

@@ -6,7 +6,7 @@ If you find a bug, we recommend that you post an [issue](https://github.com/delv
 
 ## Release steps
 
-1. [ ] Double-check that the version in `contracts/src/libraries/Constants.sol` matches the version to be tagged. If it doesn't, open a PR to update the version before tagging.
+1. [ ] Double-check that the version in `contracts/src/libraries/Constants.sol` matches the version to be tagged. If it doesn't, update it and run `make build` to automatically update the hyperdrivetypes `pyproject.toml` file. Merge a PR with these changes before tagging.
 2. [ ] Tag the release with `git tag vX.Y.Z`.
-3. [ ] Push the release to Github with `git push --tags`
-4. [ ] Go to the `releases` tab in Github and add the new tag as a release. Click the "Generate Release Notes" button to generate release notes.
+3. [ ] Push the release to Github with `git push --tags`.
+4. [ ] Go to the `releases` tab in Github and add the new tag as a release. Click the "Generate Release Notes" button to generate release notes.

Makefile

@@ -15,7 +15,7 @@ build-sol:
 # forge build will do nothing if build-sol was previously run,
 # but we put it here so this can be called individually
 build-hyperdrivetypes:
-	forge build && pypechain --output-dir python/hyperdrivetypes/hyperdrivetypes --line-length 80 out/
+	forge build && pypechain --output-dir python/hyperdrivetypes/hyperdrivetypes --line-length 80 out/ && . scripts/set-hyperdrivetypes-version.sh 
 
 ### Test ###
 

python/hyperdrivetypes/pyproject.toml

@@ -1,6 +1,7 @@
 [project]
 name = "hyperdrivetypes"
-version = "0.0.2"
+version = "1.0.18"
+
 # Authors are the current, primary stewards of the repo
 # contributors can be found on github
 authors = [

scripts/build-hyperdrivetypes-wheel.sh

@@ -1,15 +1,29 @@
 #!/bin/bash
 
-# hyperdrivetypes install
+# Set the python project version to match the hyperdrive version
+. scripts/set-hyperdrivetypes-version.sh
 
-echo "install required packages for building wheels"
-python -m venv --upgrade-deps .venv
-source .venv/bin/activate
-python -m pip install --upgrade pip
+# Just in case, check the versions match
+. scripts/verify-hyperdrivetypes-version.sh
+if [ -z "$HYPERDRIVE_VERSIONS_MATCH" ]; then
+  echo "Environment variable HYPERDRIVE_VERSIONS_MATCH is not set. Exiting with failure."
+  exit 1
+fi
 
-echo "install hyperdrivetypes & test build"
-pip install python/hyperdrivetypes build
+# Build if the versions match
+if [ "$HYPERDRIVE_VERSIONS_MATCH" != "true" ]; then
+  echo "Version mismatch detected. Exiting with failure."
+  exit 1
+else
+  echo "Versions match. Installing required packages for building the wheel."
+  python -m venv --upgrade-deps .venv
+  source .venv/bin/activate
+  python -m pip install --upgrade pip
 
-echo "build the wheel for the current platform"
-python -m build --sdist --outdir dist python/hyperdrivetypes
-python -m pip wheel --no-deps --wheel-dir dist python/hyperdrivetypes
+  echo "install hyperdrivetypes & test build"
+  pip install python/hyperdrivetypes build
+
+  echo "build the wheel for the current platform"
+  python -m build --sdist --outdir dist python/hyperdrivetypes
+  python -m pip wheel --no-deps --wheel-dir dist python/hyperdrivetypes
+fi

scripts/set-hyperdrivetypes-version.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+echo "get hyperdrive version"
+
+# Extract version using sed by reading from the file
+HYPERDRIVE_FILE="contracts/src/libraries/Constants.sol"
+VERSION=$(sed -n -E 's/.*VERSION = "v([0-9]+\.[0-9]+\.[0-9]+)".*/\1/p' "$HYPERDRIVE_FILE")
+
+# Determine the OS using uname
+OS_TYPE=$(uname)
+
+# Append the version to hyperdrivetypes
+HYPERDRIVETYPES_FILE="python/hyperdrivetypes/pyproject.toml"
+echo "found version: v$VERSION"
+echo "writing to $HYPERDRIVETYPES_FILE"
+# Check the operating system to use the correct sed syntax
+if [[ "$OSTYPE" == "Darwin"* ]]; then
+  # e.g. macOS
+  sed -i '' -E "s/^(version = \")[0-9]+\.[0-9]+\.[0-9]+(\".*)/\1$VERSION\2/" "$HYPERDRIVETYPES_FILE"
+elif [[ "$OSTYPE" == "Linux"* ]]; then
+  # e.g. Ubuntu
+  sed -i -E "s/^(version = \")[0-9]+\.[0-9]+\.[0-9]+(\".*)/\1$VERSION\2/" "$HYPERDRIVETYPES_FILE"
+else
+  echo "Unsupported OS: $OSTYPE"
+  exit 1
+fi

scripts/verify-hyperdrivetypes-version.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Extract version from hyperdrive
+constants_file="contracts/src/libraries/Constants.sol"
+VERSION_CONSTANTS=$(sed -n -E 's/.*VERSION = "v([0-9]+\.[0-9]+\.[0-9]+)".*/\1/p' "$constants_file")
+
+# Extract version from hyperdrivetypes
+init_file="python/hyperdrivetypes/pyproject.toml"
+VERSION_INIT=$(sed -n -E 's/version = "([0-9]+\.[0-9]+\.[0-9]+)".*/\1/p' "$init_file")
+
+# Compare versions
+if [ "$VERSION_CONSTANTS" == "$VERSION_INIT" ]; then
+  echo "versions match!"
+  echo "hyperdrive version: $VERSION_CONSTANTS"
+  echo "hyperdrivetypes version: $VERSION_INIT"
+  export HYPERDRIVE_VERSIONS_MATCH=true
+else
+  echo "versions do not match!"
+  echo "hyperdrive version: $VERSION_CONSTANTS"
+  echo "hyperdrivetypes version: $VERSION_INIT"
+  export HYPERDRIVE_VERSIONS_MATCH=false
+fi