FEAT: Transition to scikit-build-core CMake-based build process (#162)

Co-authored-by: Ofek Lev <[email protected]>

Author: MementoRC

Diff for: .github/workflows/build.yml

@@ -16,13 +16,14 @@ concurrency:
 
 env:
   COINCURVE_UPSTREAM_REF: 1ad5185cd42c0636104129fcc9f6a4bf9c67cc40
-  COINCURVE_IGNORE_SYSTEM_LIB: '1'
-  # Only 'SHARED' is recognized, any other string means 'not SHARED'
-  COINCURVE_SECP256K1_BUILD: 'STATIC'
+  COINCURVE_IGNORE_SYSTEM_LIB: 'ON'
+  COINCURVE_SECP256K1_STATIC: 'ON'
+  COINCURVE_CROSS_HOST: ''
   CIBW_ENVIRONMENT_PASS_LINUX: >
     COINCURVE_UPSTREAM_REF
     COINCURVE_IGNORE_SYSTEM_LIB
-    COINCURVE_SECP256K1_BUILD
+    COINCURVE_SECP256K1_STATIC
+    COINCURVE_CROSS_HOST
   CIBW_PROJECT_REQUIRES_PYTHON: '>=3.8'
   CIBW_BEFORE_ALL_MACOS: ./.github/scripts/install-macos-build-deps.sh
   CIBW_TEST_REQUIRES: pytest pytest-benchmark
@@ -68,7 +69,7 @@ jobs:
       run: tox -e lint,typing
 
     - name: Run tests
-      run: tox -e ${PYTHON_VERSION}
+      run: tox -e ${PYTHON_VERSION} -vvv
 
     - name: Run benchmarks
       run: tox -e bench
@@ -149,40 +150,14 @@ jobs:
       uses: pypa/[email protected]
       env:
         CIBW_ARCHS_WINDOWS: 'AMD64'
-        CIBW_BEFORE_ALL: choco install -y --no-progress --no-color cmake>=3.28 pkgconfiglite
+        CIBW_BEFORE_ALL: choco install -y --no-progress --no-color cmake>=3.28
 
     - uses: actions/upload-artifact@v4
       with:
         name: artifact-windows-wheels-x86_64
         path: wheelhouse/*.whl
         if-no-files-found: error
 
-  windows-wheels-x86:
-    name: Build Windows wheels x86
-    needs:
-    - test
-    runs-on: windows-latest
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: actions/setup-python@v5
-      with:
-        python-version: '3.12'
-
-    - name: Build wheels
-      uses: pypa/[email protected]
-      env:
-        COINCURVE_CROSS_HOST: 'x86'
-        CIBW_ARCHS_WINDOWS: 'x86'
-        CIBW_BEFORE_ALL: choco install -y --no-progress --no-color cmake>=3.28 pkgconfiglite
-
-    - uses: actions/upload-artifact@v4
-      with:
-        name: artifact-windows-wheels-x86
-        path: wheelhouse/*.whl
-        if-no-files-found: error
-
   windows-wheels-arm:
     name: Build Windows wheels for ARM64
     needs:
@@ -197,7 +172,7 @@ jobs:
       env:
         COINCURVE_CROSS_HOST: 'arm64'
         CIBW_ARCHS_WINDOWS: 'ARM64'
-        CIBW_BEFORE_ALL: choco install -y --no-progress --no-color cmake>=3.28 pkgconfiglite
+        CIBW_BEFORE_ALL: choco install -y --no-progress --no-color cmake>=3.28
 
     - uses: actions/upload-artifact@v4
       with:
@@ -262,7 +237,6 @@ jobs:
     - macos-wheels-x86_64
     - macos-wheels-arm
     - windows-wheels-x86_64
-    - windows-wheels-x86
     - windows-wheels-arm
     - sdist
     - linux-wheels-arm

Diff for: .github/workflows/verify_conda_build.yml

@@ -16,13 +16,14 @@ concurrency:
 
 env:
   COINCURVE_UPSTREAM_REF: __no_upstream__
-  COINCURVE_IGNORE_SYSTEM_LIB: '0'
-  # conda-forge only has SHARED libsecp256k1
-  COINCURVE_SECP256K1_BUILD: 'SHARED'
+  COINCURVE_IGNORE_SYSTEM_LIB: 'OFF'
+  COINCURVE_SECP256K1_STATIC: 'OFF'
+  COINCURVE_CROSS_HOST: ''
   CIBW_ENVIRONMENT_PASS_LINUX: >
     COINCURVE_UPSTREAM_REF
     COINCURVE_IGNORE_SYSTEM_LIB
-    COINCURVE_SECP256K1_BUILD
+    COINCURVE_SECP256K1_STATIC
+    COINCURVE_CROSS_HOST
   CIBW_PROJECT_REQUIRES_PYTHON: '>=3.8'
   CIBW_BEFORE_ALL_MACOS: ./.github/scripts/install-macos-build-deps.sh
   CIBW_TEST_REQUIRES: pytest pytest-benchmark
@@ -34,7 +35,6 @@ env:
     assert a.ecdh(b.public_key.format())==b.ecdh(a.public_key.format())
     " &&
     python -m pytest {project}
-  CIBW_TEST_SKIP: "*-macosx_arm64"
   CIBW_SKIP: >
       pp*
 
@@ -63,7 +63,7 @@ jobs:
       run: tox -e lint,typing
 
     - name: Run tests
-      run: LD_LIBRARY_PATH=$CONDA_PREFIX/lib tox -e ${PYTHON_VERSION}
+      run: LD_LIBRARY_PATH=$CONDA_PREFIX/lib tox -e ${PYTHON_VERSION} -vvv
 
     - name: Run benchmarks
       run: LD_LIBRARY_PATH=$CONDA_PREFIX/lib tox -e bench

Diff for: .gitignore

@@ -10,8 +10,3 @@
 /build
 /dist
 /site
-/wheelhouse
-/pip-wheel-metadata
-
-/src/coincurve/_libsecp256k1.py
-/src/coincurve/libsecp256k1.dll

Diff for: CMakeLists.txt

@@ -0,0 +1,47 @@
+cmake_minimum_required(VERSION 3.26)
+
+project(${SKBUILD_PROJECT_NAME}
+    VERSION ${SKBUILD_PROJECT_VERSION}
+    LANGUAGES C
+)
+
+# Path to custom CMake functions
+set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
+
+# Name of the vendored library CMake target
+include(SetDefaultVendoredLibrary)
+SetDefaultVendoredLibrary()
+
+set(CFFI_INPUT_LIBRARY ${VENDORED_LIBRARY_CMAKE_TARGET})
+
+# Set the output directories for the generated C code and headers
+set(CFFI_C_CODE_DIR ${PROJECT_BINARY_DIR}/_gen_c_file)
+set(CFFI_C_CODE "${CFFI_INPUT_LIBRARY}_cffi_bindings.c")
+set(CFFI_HEADERS_DIR ${PROJECT_BINARY_DIR}/_gen_cffi_headers)
+
+# Shared object that wraps the CFFI binding of the vendored library
+set(CFFI_OUTPUT_LIBRARY "_${VENDORED_LIBRARY_PKG_CONFIG}")
+
+# Setting python for the host system (before change in CMAKE_SYSTEM_PROCESSOR)
+find_package(Python 3 REQUIRED COMPONENTS Interpreter Development.Module Development.SABIModule)
+
+include(SetCrossCompilerGithubActions)
+SetCrossCompilerGithubActions()
+
+# Add the subdirectories. Append CONDA to the PKG_CONFIG_PATH
+if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    set(PKG_CONFIG_ARGN "--dont-define-prefix")
+endif()
+find_package(PkgConfig REQUIRED)
+
+# Set VENDORED_AS_SYSTEM_LIB to true if the vendored library is installed as a system library
+include(SetSystemLibIfExists)
+SetSystemLibIfExists()
+
+add_subdirectory(cm_vendored_library)
+add_subdirectory(cm_library_cffi_headers)
+add_subdirectory(cm_library_c_binding)
+add_subdirectory(cm_python_module)
+
+# Configure installation of the shared library ${CFFI_OUTPUT_LIBRARY} in the package
+install(TARGETS ${CFFI_OUTPUT_LIBRARY} LIBRARY DESTINATION ${SKBUILD_PLATLIB_DIR}/${SKBUILD_PROJECT_NAME})