3 echo "USAGE: path/to/ldk-c-bindings [wasm|\"JNI_CFLAGS\"] debug android_web"
4 echo "For JNI_CFLAGS you probably want -I/usr/lib/jvm/java-11-openjdk-amd64/include/ -I/usr/lib/jvm/java-11-openjdk-amd64/include/linux/"
5 echo "If JNI_CFLAGS is instead set to wasm, we build for wasm/TypeScript instead of Java"
6 echo "debug should either be true, false, or leaks"
7 echo "debug of leaks turns on leak tracking on an optimized release bianry"
8 echo "android_web should either be true or false and indicates if we build for android (Java) or web (WASM)"
9 echo "Note that web currently generates the same results as !web (ie Node.JS)"
12 [ "$1" = "" ] && usage
13 [ "$3" != "true" -a "$3" != "false" -a "$3" != "leaks" ] && usage
14 [ "$4" != "true" -a "$4" != "false" ] && usage
19 function is_gnu_sed(){
20 sed --version >/dev/null 2>&1
23 if [ "$CC" = "" ]; then
27 TARGET_STRING="$LDK_TARGET"
28 if [ "$TARGET_STRING" = "" ]; then
29 # We assume clang-style $CC --version here, but worst-case we just get an empty suffix
30 TARGET_STRING="$($CC --version | grep Target | awk '{ print $2 }')"
36 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
38 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
41 [ "$IS_APPLE_CLANG" = "true" ] && STRIP=echo
43 case "$TARGET_STRING" in
45 LDK_TARGET_SUFFIX="_Linux-amd64"
46 CS_PLATFORM_NAME="linux-x64"
49 "x86_64-redhat-linux"*)
50 LDK_TARGET_SUFFIX="_Linux-amd64"
51 CS_PLATFORM_NAME="linux-x64"
54 "x86_64-apple-darwin"*)
55 LDK_TARGET_SUFFIX="_MacOSX-x86_64"
56 CS_PLATFORM_NAME="osx-x64"
60 "aarch64-apple-darwin"*)
61 LDK_TARGET_CPU="apple-a14"
62 LDK_TARGET_SUFFIX="_MacOSX-aarch64"
63 CS_PLATFORM_NAME="osx-arm64"
68 LDK_TARGET_SUFFIX="_Win-amd64"
69 CS_PLATFORM_NAME="win-x64"
72 # llvm-strip currently corrupts DLLs - https://github.com/llvm/llvm-project/issues/63081
76 LDK_TARGET_SUFFIX="_${TARGET_STRING}"
78 if [ "$LDK_TARGET_CPU" = "" ]; then
79 LDK_TARGET_CPU="sandybridge"
82 COMMON_COMPILE="$CC -std=c11 -Wall -Wextra -Wno-unused-parameter -Wno-ignored-qualifiers -Wno-unused-function -Wno-nullability-completeness -Wno-pointer-sign -Wdate-time -ffile-prefix-map=$(pwd)="
84 [[ "$TARGET_STRING" != "x86"* ]] && COMMON_CC="$COMMON_CC --target=$TARGET_STRING -mcpu=$LDK_TARGET_CPU"
85 [[ "$TARGET_STRING" = "x86"* ]] && COMMON_CC="$COMMON_CC --target=$TARGET_STRING -march=$LDK_TARGET_CPU -mtune=$LDK_TARGET_CPU"
86 [ "$IS_MAC" = "true" -a "$MACOS_SDK" != "" ] && COMMON_COMPILE="$COMMON_COMPILE -isysroot $MACOS_SDK"
89 if [ "$3" = "leaks" ]; then
93 cp "$1/lightning-c-bindings/include/lightning.h" ./
95 sed -i "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
97 # OSX sed is for some reason not compatible with GNU sed
98 sed -i '' "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
100 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" > header.c
101 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> header.c
104 if [ "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" = "" ]; then
105 export LDK_GARBAGECOLLECTED_GIT_OVERRIDE=$(git describe --tag --dirty)
107 if [ "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:0:1}" != "v" ]; then
108 echo "Version tag should start with a v" > /dev/stderr
113 if [ "$2" = "c_sharp" ]; then
114 echo "Creating C# bindings..."
115 mkdir -p c_sharp/src/org/ldk/{enums,structs,impl}
116 rm -f c_sharp/src/org/ldk/{enums,structs,impl}/*.cs
117 GEN_PLAT="c_sharp-linux"
118 [ "$IS_WIN" = "true" ] && GEN_PLAT="c_sharp-win"
119 [ "$IS_MAC" = "true" ] && GEN_PLAT="c_sharp-darwin"
120 ./genbindings.py "./lightning.h" c_sharp/src/org/ldk/impl c_sharp/src/org/ldk c_sharp/ $DEBUG_ARG $GEN_PLAT $4 $TARGET_STRING
121 rm -f c_sharp/bindings.c
122 if [ "$3" = "true" ]; then
123 echo "#define LDK_DEBUG_BUILD" > c_sharp/bindings.c
124 elif [ "$3" = "leaks" ]; then
125 # For leak checking we use release libldk which doesn't expose
126 # __unmangle_inner_ptr, but the C code expects to be able to call it.
127 echo "#define __unmangle_inner_ptr(a) (a)" > c_sharp/bindings.c
129 cat header.c >> c_sharp/bindings.c
130 cat header.c >> c_sharp/bindings.c
131 cat c_sharp/bindings.c.body >> c_sharp/bindings.c
134 sed -i "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/org.ldk.nuspec
135 sed -i "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/package/services/metadata/core-properties/ldk.psmdcp
137 # OSX sed is for some reason not compatible with GNU sed
138 sed -i '' "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/org.ldk.nuspec
139 sed -i '' "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/package/services/metadata/core-properties/ldk.psmdcp
142 # Compiling C# bindings with Mono
143 if [ "$3" = "true" ]; then
144 mono-csc -g -out:csharpldk.dll -langversion:3 -t:library -unsafe c_sharp/src/org/ldk/enums/*.cs c_sharp/src/org/ldk/impl/*.cs c_sharp/src/org/ldk/util/*.cs c_sharp/src/org/ldk/structs/*.cs
147 dotnet build --configuration Release
151 echo "Building C# bindings..."
152 COMPILE="$COMMON_COMPILE $COMMON_CC -pthread -fPIC"
153 LINK="$COMMON_CC -shared"
154 [ "$IS_WIN" = "false" ] && LINK="$LINK -ldl"
155 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
156 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
157 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
158 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
159 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
160 [ "$IS_WIN" = "true" ] && LINK="$LINK -lbcrypt -lntdll -static-libgcc"
161 [ "$IS_WIN" = "true" ] && COMPILE="$COMPILE -I/usr/x86_64-w64-mingw32/sys-root/mingw/include/ -I/usr/x86_64-w64-mingw32/include/"
163 if [ "$3" = "true" ]; then
164 $COMPILE $LINK -o libldkcsharp_debug$LDK_TARGET_SUFFIX.so -g -fsanitize=address -shared-libasan -rdynamic -I"$1"/lightning-c-bindings/include/ c_sharp/bindings.c "$1"/lightning-c-bindings/target/$LDK_TARGET/debug/libldk.a -lm
166 [ "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -fuse-ld=lld"
167 [ "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
168 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
169 [ "$IS_WIN" = "false" ] && LINK="$LINK -Wl,--lto-O3"
170 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
171 if [ "$IS_MAC" = "false" -a "$IS_WIN" = "false" -a "$4" = "false" ]; then
172 LINK="$LINK -Wl,--version-script=c_sharp/libcode.version -Wl,--build-id=0x0000000000000000"
175 # When building for Windows, a timestamp is included in the resulting dll,
176 # so we have to build with faketime.
177 faketime -f "2021-01-01 00:00:00" $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ c_sharp/bindings.c
178 faketime -f "2021-01-01 00:00:00" $COMPILE $LINK -o libldkcsharp_release$LDK_TARGET_SUFFIX.so -O3 bindings.o $LDK_LIB -lm
179 $STRIP -R .llvmbc -R .llvmcmd libldkcsharp_release$LDK_TARGET_SUFFIX.so
181 if [ "$LDK_JAR_TARGET" = "true" ]; then
182 # Copy resulting native binary for inclusion in release nuget zip
183 mkdir -p c_sharp/packaging_artifacts/lib/net6.0/
184 cp c_sharp/bin/Release/net6.0/csharpldk.dll c_sharp/packaging_artifacts/lib/net6.0/
186 mkdir -p c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/
187 if [ "$IS_WIN" = "true" ]; then
188 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/ldkcsharp.dll
189 elif [ "$IS_MAC" = "true" ]; then
190 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/libldkcsharp.dylib
192 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/libldkcsharp.so
196 elif [ "$2" = "python" ]; then
197 echo "Creating Python bindings..."
198 mkdir -p python/src/{enums,structs,impl}
199 rm -f python/src/{enums,structs,impl}/*.py
200 ./genbindings.py "./lightning.h" python/src/impl python/src python/ $DEBUG_ARG python $4 $TARGET_STRING
201 rm -f python/bindings.c
202 if [ "$3" = "true" ]; then
203 echo "#define LDK_DEBUG_BUILD" > python/bindings.c
204 elif [ "$3" = "leaks" ]; then
205 # For leak checking we use release libldk which doesn't expose
206 # __unmangle_inner_ptr, but the C code expects to be able to call it.
207 echo "#define __unmangle_inner_ptr(a) (a)" > python/bindings.c
209 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" >> python/bindings.c
210 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> python/bindings.c
211 cat python/bindings.c.body >> python/bindings.c
214 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
216 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
218 echo "Building Python bindings..."
219 COMPILE="$COMMON_COMPILE $COMMON_CC -Isrc/main/jni -pthread -fPIC"
220 LINK="$COMMON_CC -ldl -shared"
221 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
222 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
223 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
224 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
225 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
227 exit 0 # Sadly compilation doesn't currently work
228 if [ "$3" = "true" ]; then
229 $COMPILE $LINK -o liblightningpython_debug$LDK_TARGET_SUFFIX.so -g -fsanitize=address -shared-libasan -rdynamic -I"$1"/lightning-c-bindings/include/ $2 c_sharp/bindings.c "$1"/lightning-c-bindings/target/$LDK_TARGET/debug/libldk.a -lm
231 $COMPILE -o bindings.o -c -flto -O3 -I"$1"/lightning-c-bindings/include/ $2 c_sharp/bindings.c
232 $COMPILE $LINK -o liblightningpython_release$LDK_TARGET_SUFFIX.so -Wl,--version-script=python/libcode.version -flto -O3 -Wl,--lto-O3 -Wl,-O3 -I"$1"/lightning-c-bindings/include/ $2 bindings.o "$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a -lm
233 $STRIP -R .llvmbc -R .llvmcmd liblightningpython_release$LDK_TARGET_SUFFIX.so
235 elif [ "$2" = "wasm" ]; then
236 echo "Creating TS bindings..."
237 mkdir -p ts/{enums,structs}
238 rm -f ts/{enums,structs,}/*.{mjs,mts,mts.part}
239 if [ "$4" = "false" ]; then
240 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript node wasm
242 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript browser wasm
245 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' ts/package.json
246 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' node-net/package.json
247 sed -i 's/^ "lightningdevkit": .*/ "lightningdevkit": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'"/g' node-net/package.json
248 if [ "$3" = "true" ]; then
249 echo "#define LDK_DEBUG_BUILD" > ts/bindings.c
250 elif [ "$3" = "leaks" ]; then
251 # For leak checking we use release libldk which doesn't expose
252 # __unmangle_inner_ptr, but the C code expects to be able to call it.
253 echo "#define __unmangle_inner_ptr(a) (a)" > ts/bindings.c
255 cat header.c >> ts/bindings.c
256 cat ts/bindings.c.body >> ts/bindings.c
258 echo "Building TS bindings..."
259 COMPILE="$COMMON_COMPILE $COMMON_CC -flto -Wl,--no-entry -nostdlib --target=wasm32-wasi -Wl,-z -Wl,stack-size=$((8*1024*1024)) -Wl,--initial-memory=$((16*1024*1024)) -Wl,--max-memory=$((1024*1024*1024)) -Wl,--global-base=4096"
260 # We only need malloc and assert/abort, but for now just use WASI for those:
261 EXTRA_LINK=/usr/lib/wasm32-wasi/libc.a
262 [ "$3" != "false" ] && COMPILE="$COMPILE -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,reallocarray -Wl,-wrap,malloc -Wl,-wrap,aligned_alloc -Wl,-wrap,free"
263 if [ "$3" = "true" ]; then
264 WASM_FILE=liblightningjs_debug.wasm
265 $COMPILE -o liblightningjs_debug.wasm -g -O1 -I"$1"/lightning-c-bindings/include/ ts/bindings.c "$1"/lightning-c-bindings/target/wasm32-wasi/debug/libldk.a $EXTRA_LINK
267 WASM_FILE=liblightningjs_release.wasm
268 $COMPILE -o liblightningjs_release.wasm -s -Oz -I"$1"/lightning-c-bindings/include/ ts/bindings.c "$1"/lightning-c-bindings/target/wasm32-wasi/release/libldk.a $EXTRA_LINK
271 if [ -x "$(which tsc)" ]; then
273 for F in structs/*; do
274 cat imports.mts.part | grep -v " $(basename -s .mts $F)[ ,]" | cat - $F > $F.tmp
278 tsc --types node --typeRoots .
279 cp ../$WASM_FILE liblightningjs.wasm
280 cp ../README.md README.md
282 tsc --types node --typeRoots .
283 echo Ready to publish!
284 if [ -x "$(which node)" ]; then
285 NODE_V="$(node --version)"
286 if [ "${NODE_V:1:2}" -gt 14 ]; then
288 node --stack_trace_limit=200 --trace-uncaught test/node.mjs
290 node --stack_trace_limit=200 --trace-uncaught test/test.mjs
296 sed -i "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
298 # OSX sed is for some reason not compatible with GNU sed
299 sed -i '' "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
302 echo "Creating Java bindings..."
303 mkdir -p src/main/java/org/ldk/{enums,structs}
304 rm -f src/main/java/org/ldk/{enums,structs}/*.java
305 rm -f src/main/jni/*.h
306 if [ "$4" = "true" ]; then
307 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG android $4 $TARGET_STRING
309 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG java $4 $TARGET_STRING
311 rm -f src/main/jni/bindings.c
312 if [ "$3" = "true" ]; then
313 echo "#define LDK_DEBUG_BUILD" > src/main/jni/bindings.c
314 elif [ "$3" = "leaks" ]; then
315 # For leak checking we use release libldk which doesn't expose
316 # __unmangle_inner_ptr, but the C code expects to be able to call it.
317 echo "#define __unmangle_inner_ptr(a) (a)" > src/main/jni/bindings.c
319 cat header.c >> src/main/jni/bindings.c
320 cat header.c >> src/main/jni/bindings.c
321 cat src/main/jni/bindings.c.body >> src/main/jni/bindings.c
322 javac -h src/main/jni src/main/java/org/ldk/enums/*.java src/main/java/org/ldk/impl/*.java
323 rm src/main/java/org/ldk/enums/*.class src/main/java/org/ldk/impl/bindings*.class
325 echo "Building Java bindings..."
326 COMPILE="$COMMON_COMPILE $COMMON_CC -Isrc/main/jni -pthread -fPIC"
327 LINK="$COMMON_CC -shared"
328 [ "$IS_WIN" = "false" ] && LINK="$LINK -ldl"
329 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
330 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
331 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
332 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
333 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
334 if [ "$3" = "true" ]; then
335 $COMPILE $LINK -o liblightningjni_debug$LDK_TARGET_SUFFIX.so -g -fsanitize=address -shared-libasan -rdynamic -I"$1"/lightning-c-bindings/include/ $2 src/main/jni/bindings.c "$1"/lightning-c-bindings/target/$LDK_TARGET/debug/libldk.a -lm
337 [ "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -fuse-ld=lld"
338 [ "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
339 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
340 [ "$IS_WIN" = "false" ] && LINK="$LINK -Wl,--lto-O3"
341 [ "$IS_WIN" = "true" ] && LINK="$LINK -L/usr/lib/gcc/x86_64-w64-mingw32/12-win32/ -lbcrypt"
342 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
343 if [ "$IS_MAC" = "false" -a "$IS_WIN" = "false" -a "$4" = "false" ]; then
344 LINK="$LINK -Wl,--version-script=libcode.version"
347 $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ $2 src/main/jni/bindings.c
348 $COMPILE $LINK -o liblightningjni_release$LDK_TARGET_SUFFIX.so -O3 $2 bindings.o $LDK_LIB -lm
349 $STRIP -R .llvmbc -R .llvmcmd liblightningjni_release$LDK_TARGET_SUFFIX.so
351 if [ "$IS_MAC" = "false" -a "$4" = "false" ]; then
352 GLIBC_SYMBS="$(objdump -T liblightningjni_release$LDK_TARGET_SUFFIX.so | grep GLIBC_ | grep -v "GLIBC_2\.\(2\|3\)\(\.\|)\)" | grep -v "GLIBC_2.\(3\.4\|14\|17\|18\|25\|28\|29\|32\|33\|34\|\))" || echo)"
353 if [ "$GLIBC_SYMBS" != "" ]; then
354 echo "Unexpected glibc version dependency! Some users need glibc 2.35 support, symbols for newer glibcs cannot be included."
358 REALLOC_ARRAY_SYMBS="$(objdump -T liblightningjni_release$LDK_TARGET_SUFFIX.so | grep reallocarray || echo)"
359 if [ "$REALLOC_ARRAY_SYMBS" != "" ]; then
360 echo "Unexpected reallocarray dependency!"
365 if [ "$LDK_JAR_TARGET" = "true" ]; then
366 # Copy to JNI native directory for inclusion in JARs
367 mkdir -p src/main/resources/
368 cp liblightningjni_release$LDK_TARGET_SUFFIX.so src/main/resources/liblightningjni$LDK_TARGET_SUFFIX.nativelib