Merge pull request #7 from stringintech/static-link

Author: stringintech

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   ubuntu:
-    name: Build and Test on Ubuntu
+    name: Build, Test, and Lint on Ubuntu
     runs-on: ubuntu-latest
 
     steps:
@@ -31,6 +31,11 @@ jobs:
     - name: Run tests
       run: make test
 
+    - name: Run linter
+      uses: golangci/golangci-lint-action@v9
+      with:
+        version: v2.6.1
+
   macos:
     name: Build and Test on macOS
     runs-on: macos-latest
@@ -59,31 +64,30 @@ jobs:
   windows:
     name: Build and Test on Windows
     runs-on: windows-latest
+    defaults:
+      run:
+        shell: msys2 {0}
 
     steps:
       - uses: actions/checkout@v4
 
+      - name: Set up MSYS2 with MinGW
+        uses: msys2/setup-msys2@v2
+        with:
+          msystem: MINGW64
+          update: true
+          path-type: inherit
+          install: >-
+            mingw-w64-x86_64-gcc
+            mingw-w64-x86_64-cmake
+            mingw-w64-x86_64-boost
+            make
+
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
           go-version: '1.23.3'
 
-      - name: Install Boost library
-        run: |
-          git clone https://github.com/microsoft/vcpkg.git
-          cd vcpkg
-          .\bootstrap-vcpkg.bat
-          .\vcpkg install boost-multi-index:x64-windows boost-headers:x64-windows
-
-      - name: Set environment variables
-        run: |
-          echo "BOOST_ROOT=$env:GITHUB_WORKSPACE\vcpkg\installed\x64-windows" | Out-File -FilePath $env:GITHUB_ENV -Append
-          echo "BOOST_INCLUDEDIR=$env:GITHUB_WORKSPACE\vcpkg\installed\x64-windows\include" | Out-File -FilePath $env:GITHUB_ENV -Append
-          echo "$env:GITHUB_WORKSPACE\depend\bitcoin\build\bin\RelWithDebInfo" | Out-File -FilePath $env:GITHUB_PATH -Append
-
-      - name: Install make
-        run: choco install make
-
       - name: Build Kernel
         run: make build-kernel
 
@@ -92,20 +96,3 @@ jobs:
 
       - name: Run tests
         run: make test
-
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Go
-      uses: actions/setup-go@v5
-      with:
-        go-version: '1.23.3'
-
-    - name: Run linter
-      uses: golangci/golangci-lint-action@v9
-      with:
-        version: v2.6.1

Makefile

@@ -8,7 +8,7 @@ build-kernel:
 	cd depend/bitcoin && \
 	cmake -B build \
 		-DCMAKE_BUILD_TYPE=RelWithDebInfo \
-		-DBUILD_SHARED_LIBS=ON \
+		-DBUILD_SHARED_LIBS=OFF \
 		-DBUILD_KERNEL_LIB=ON \
 		-DBUILD_KERNEL_TEST=OFF \
 		-DBUILD_TESTS=OFF \
@@ -21,8 +21,11 @@ build-kernel:
 		-DBUILD_DAEMON=OFF \
 		-DBUILD_UTIL_CHAINSTATE=OFF \
 		-DBUILD_CLI=OFF \
-		-DENABLE_IPC=OFF && \
-	cmake --build build --config RelWithDebInfo --parallel$(if $(NUM_JOBS),=$(NUM_JOBS)) # Use NUM_JOBS variable if set (e.g., make build-kernel NUM_JOBS=8), otherwise auto-detect CPU cores
+		-DENABLE_IPC=OFF \
+		-DCMAKE_INSTALL_LIBDIR=lib \
+		-DCMAKE_INSTALL_PREFIX=$$PWD/install && \
+	cmake --build build --config RelWithDebInfo --parallel$(if $(NUM_JOBS),=$(NUM_JOBS)) && \
+	cmake --install build --config RelWithDebInfo
 
 build:
 	go build ./...
@@ -32,6 +35,7 @@ test:
 
 clean:
 	rm -rf depend/bitcoin/build
+	rm -rf depend/bitcoin/install
 	go clean ./...
 	go clean -testcache
 

README.md

@@ -39,11 +39,13 @@ cd go-bitcoinkernel
 make build-kernel
 ```
 
-This command will configure Bitcoin Core's CMake build system and build only the `libbitcoinkernel` shared library. Refer to Bitcoin Core's build documentation to for the minimum requirements to compile `libbitcoinkernel` from source:
+This command will configure Bitcoin Core's CMake build system and statically compile the `libbitcoinkernel` library. Building requires CMake, a C++ compiler, Boost library, and Make. For platform-specific setup instructions, consult Bitcoin Core's build documentation:
 ([Unix](./depend/bitcoin/doc/build-unix.md),
 [macOS](./depend/bitcoin/doc/build-osx.md),
 [Windows](./depend/bitcoin/doc/build-windows.md))
 
+**Addtional note for Windows:** MinGW toolchain is required. CGo uses GCC on Windows, so static linking requires the library to be compiled with GCC/MinGW rather than MSVC for ABI compatibility.
+
 ### Step 3: Run Tests
 
 ```bash
@@ -92,8 +94,4 @@ call `Destroy()` methods when you're done with owned objects to free resources i
 
 ### Error Handling
 
-The library uses structured error types for better error handling (see [errors.go](./kernel/errors.go)).
-
-### Runtime Dependencies
-
-Your Go application will have a runtime dependency on the shared `libbitcoinkernel` library produced by `make build-kernel` in `/path/to/go-bitcoinkernel/depend/bitcoin/build`. Do not delete or move these built library files as your application needs them to run.
+The library uses structured error types for better error handling (see [errors.go](./kernel/errors.go)).

kernel/block.go

@@ -1,7 +1,7 @@
 package kernel
 
 /*
-#include "kernel/bitcoinkernel.h"
+#include "bitcoinkernel.h"
 */
 import "C"
 import (

kernel/block_hash.go

@@ -1,7 +1,7 @@
 package kernel
 
 /*
-#include "kernel/bitcoinkernel.h"
+#include "bitcoinkernel.h"
 */
 import "C"
 import (

kernel/block_spent_outputs.go

@@ -1,7 +1,7 @@
 package kernel
 
 /*
-#include "kernel/bitcoinkernel.h"
+#include "bitcoinkernel.h"
 */
 import "C"
 import (

kernel/block_tree_entry.go

@@ -1,7 +1,7 @@
 package kernel
 
 /*
-#include "kernel/bitcoinkernel.h"
+#include "bitcoinkernel.h"
 */
 import "C"
 

kernel/block_validation_state.go

@@ -1,7 +1,7 @@
 package kernel
 
 /*
-#include "kernel/bitcoinkernel.h"
+#include "bitcoinkernel.h"
 */
 import "C"
 

kernel/cgo_unix.go

@@ -3,7 +3,8 @@
 package kernel
 
 /*
-#cgo CFLAGS: -I../depend/bitcoin/src
-#cgo LDFLAGS: -L../depend/bitcoin/build/lib -lbitcoinkernel -Wl,-rpath,${SRCDIR}/../depend/bitcoin/build/lib
+#cgo CFLAGS: -I../depend/bitcoin/install/include -DBITCOINKERNEL_STATIC
+#cgo darwin LDFLAGS: -L../depend/bitcoin/install/lib -lbitcoinkernel -lc++
+#cgo !darwin LDFLAGS: -L../depend/bitcoin/install/lib -lbitcoinkernel -lstdc++ -lm
 */
 import "C"

kernel/cgo_windows.go

@@ -3,7 +3,7 @@
 package kernel
 
 /*
-#cgo CFLAGS: -I../depend/bitcoin/src
-#cgo LDFLAGS: -L../depend/bitcoin/build/bin/RelWithDebInfo -lbitcoinkernel -lbcrypt -lshell32
+#cgo CFLAGS: -I../depend/bitcoin/install/include -DBITCOINKERNEL_STATIC
+#cgo LDFLAGS: -L../depend/bitcoin/install/lib -lbitcoinkernel -lstdc++ -lbcrypt -lshell32
 */
 import "C"