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
40 case "$TARGET_STRING" in
42 LDK_TARGET_SUFFIX="_Linux-amd64"
43 CS_PLATFORM_NAME="linux-x64"
46 "x86_64-redhat-linux"*)
47 LDK_TARGET_SUFFIX="_Linux-amd64"
48 CS_PLATFORM_NAME="linux-x64"
51 "x86_64-apple-darwin"*)
52 LDK_TARGET_SUFFIX="_MacOSX-x86_64"
53 CS_PLATFORM_NAME="osx-x64"
57 "aarch64-apple-darwin"*)
58 LDK_TARGET_CPU="apple-a14"
59 LDK_TARGET_SUFFIX="_MacOSX-aarch64"
60 CS_PLATFORM_NAME="osx-arm64"
65 LDK_TARGET_SUFFIX="_Win-amd64"
66 CS_PLATFORM_NAME="win-x64"
71 LDK_TARGET_SUFFIX="_${TARGET_STRING}"
73 if [ "$LDK_TARGET_CPU" = "" ]; then
74 LDK_TARGET_CPU="sandybridge"
77 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)="
79 [[ "$TARGET_STRING" != "x86"* ]] && COMMON_CC="$COMMON_CC --target=$TARGET_STRING -mcpu=$LDK_TARGET_CPU"
80 [[ "$TARGET_STRING" = "x86"* ]] && COMMON_CC="$COMMON_CC --target=$TARGET_STRING -march=$LDK_TARGET_CPU -mtune=$LDK_TARGET_CPU"
81 [ "$IS_MAC" = "true" -a "$MACOS_SDK" != "" ] && COMMON_COMPILE="$COMMON_COMPILE -isysroot $MACOS_SDK"
84 if [ "$3" = "leaks" ]; then
88 cp "$1/lightning-c-bindings/include/lightning.h" ./
90 sed -i "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
92 # OSX sed is for some reason not compatible with GNU sed
93 sed -i '' "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
95 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" > header.c
96 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> header.c
99 if [ "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" = "" ]; then
100 export LDK_GARBAGECOLLECTED_GIT_OVERRIDE=$(git describe --tag --dirty)
102 if [ "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:0:1}" != "v" ]; then
103 echo "Version tag should start with a v" > /dev/stderr
108 if [ "$2" = "c_sharp" ]; then
109 echo "Creating C# bindings..."
110 mkdir -p c_sharp/src/org/ldk/{enums,structs,impl}
111 rm -f c_sharp/src/org/ldk/{enums,structs,impl}/*.cs
112 GEN_PLAT="c_sharp-linux"
113 [ "$IS_WIN" = "true" ] && GEN_PLAT="c_sharp-win"
114 [ "$IS_MAC" = "true" ] && GEN_PLAT="c_sharp-darwin"
115 ./genbindings.py "./lightning.h" c_sharp/src/org/ldk/impl c_sharp/src/org/ldk c_sharp/ $DEBUG_ARG $GEN_PLAT $4 $TARGET_STRING
116 rm -f c_sharp/bindings.c
117 if [ "$3" = "true" ]; then
118 echo "#define LDK_DEBUG_BUILD" > c_sharp/bindings.c
119 elif [ "$3" = "leaks" ]; then
120 # For leak checking we use release libldk which doesn't expose
121 # __unmangle_inner_ptr, but the C code expects to be able to call it.
122 echo "#define __unmangle_inner_ptr(a) (a)" > c_sharp/bindings.c
124 cat header.c >> c_sharp/bindings.c
125 cat header.c >> c_sharp/bindings.c
126 cat c_sharp/bindings.c.body >> c_sharp/bindings.c
129 sed -i "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/org.ldk.nuspec
130 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
132 # OSX sed is for some reason not compatible with GNU sed
133 sed -i '' "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/org.ldk.nuspec
134 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 # Compiling C# bindings with Mono
138 if [ "$3" = "true" ]; then
139 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
142 dotnet build --configuration Release
146 echo "Building C# bindings..."
147 COMPILE="$COMMON_COMPILE $COMMON_CC -pthread -fPIC"
148 LINK="$COMMON_CC -shared"
149 [ "$IS_WIN" = "false" ] && LINK="$LINK -ldl"
150 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
151 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
152 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
153 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
154 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
155 [ "$IS_WIN" = "true" ] && LINK="$LINK -lbcrypt -lntdll -static-libgcc"
156 [ "$IS_WIN" = "true" ] && COMPILE="$COMPILE -I/usr/x86_64-w64-mingw32/sys-root/mingw/include/ -I/usr/x86_64-w64-mingw32/include/"
158 if [ "$3" = "true" ]; then
159 $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
161 [ "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -fuse-ld=lld"
162 [ "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
163 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
164 [ "$IS_WIN" = "false" ] && LINK="$LINK -Wl,--lto-O3"
165 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
166 if [ "$IS_MAC" = "false" -a "$IS_WIN" = "false" -a "$4" = "false" ]; then
167 LINK="$LINK -Wl,--version-script=c_sharp/libcode.version -Wl,--build-id=0x0000000000000000"
170 # When building for Windows, a timestamp is included in the resulting dll,
171 # so we have to build with faketime.
172 faketime -f "2021-01-01 00:00:00" $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ c_sharp/bindings.c
173 faketime -f "2021-01-01 00:00:00" $COMPILE $LINK -o libldkcsharp_release$LDK_TARGET_SUFFIX.so -O3 bindings.o $LDK_LIB -lm
174 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip -R .llvmbc -R .llvmcmd libldkcsharp_release$LDK_TARGET_SUFFIX.so
176 if [ "$LDK_JAR_TARGET" = "true" ]; then
177 # Copy resulting native binary for inclusion in release nuget zip
178 mkdir -p c_sharp/packaging_artifacts/lib/net6.0/
179 cp c_sharp/bin/Release/net6.0/csharpldk.dll c_sharp/packaging_artifacts/lib/net6.0/
181 mkdir -p c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/
182 if [ "$IS_WIN" = "true" ]; then
183 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/ldkcsharp.dll
184 elif [ "$IS_MAC" = "true" ]; then
185 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/libldkcsharp.dylib
187 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/libldkcsharp.so
191 elif [ "$2" = "python" ]; then
192 echo "Creating Python bindings..."
193 mkdir -p python/src/{enums,structs,impl}
194 rm -f python/src/{enums,structs,impl}/*.py
195 ./genbindings.py "./lightning.h" python/src/impl python/src python/ $DEBUG_ARG python $4 $TARGET_STRING
196 rm -f python/bindings.c
197 if [ "$3" = "true" ]; then
198 echo "#define LDK_DEBUG_BUILD" > python/bindings.c
199 elif [ "$3" = "leaks" ]; then
200 # For leak checking we use release libldk which doesn't expose
201 # __unmangle_inner_ptr, but the C code expects to be able to call it.
202 echo "#define __unmangle_inner_ptr(a) (a)" > python/bindings.c
204 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" >> python/bindings.c
205 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> python/bindings.c
206 cat python/bindings.c.body >> python/bindings.c
209 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
211 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
213 echo "Building Python bindings..."
214 COMPILE="$COMMON_COMPILE $COMMON_CC -Isrc/main/jni -pthread -fPIC"
215 LINK="$COMMON_CC -ldl -shared"
216 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
217 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
218 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
219 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
220 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
222 exit 0 # Sadly compilation doesn't currently work
223 if [ "$3" = "true" ]; then
224 $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
226 $COMPILE -o bindings.o -c -flto -O3 -I"$1"/lightning-c-bindings/include/ $2 c_sharp/bindings.c
227 $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
228 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip -R .llvmbc -R .llvmcmd liblightningpython_release$LDK_TARGET_SUFFIX.so
230 elif [ "$2" = "wasm" ]; then
231 echo "Creating TS bindings..."
232 mkdir -p ts/{enums,structs}
233 rm -f ts/{enums,structs,}/*.{mjs,mts,mts.part}
234 if [ "$4" = "false" ]; then
235 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript node wasm
237 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript browser wasm
240 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' ts/package.json
241 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' node-net/package.json
242 sed -i 's/^ "lightningdevkit": .*/ "lightningdevkit": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'"/g' node-net/package.json
243 if [ "$3" = "true" ]; then
244 echo "#define LDK_DEBUG_BUILD" > ts/bindings.c
245 elif [ "$3" = "leaks" ]; then
246 # For leak checking we use release libldk which doesn't expose
247 # __unmangle_inner_ptr, but the C code expects to be able to call it.
248 echo "#define __unmangle_inner_ptr(a) (a)" > ts/bindings.c
250 cat header.c >> ts/bindings.c
251 cat ts/bindings.c.body >> ts/bindings.c
253 echo "Building TS bindings..."
254 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"
255 # We only need malloc and assert/abort, but for now just use WASI for those:
256 EXTRA_LINK=/usr/lib/wasm32-wasi/libc.a
257 [ "$3" != "false" ] && COMPILE="$COMPILE -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,reallocarray -Wl,-wrap,malloc -Wl,-wrap,aligned_alloc -Wl,-wrap,free"
258 if [ "$3" = "true" ]; then
259 WASM_FILE=liblightningjs_debug.wasm
260 $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
262 WASM_FILE=liblightningjs_release.wasm
263 $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
266 if [ -x "$(which tsc)" ]; then
268 for F in structs/*; do
269 cat imports.mts.part | grep -v " $(basename -s .mts $F)[ ,]" | cat - $F > $F.tmp
273 tsc --types node --typeRoots .
274 cp ../$WASM_FILE liblightningjs.wasm
275 cp ../README.md README.md
277 tsc --types node --typeRoots .
278 echo Ready to publish!
279 if [ -x "$(which node)" ]; then
280 NODE_V="$(node --version)"
281 if [ "${NODE_V:1:2}" -gt 14 ]; then
283 node --stack_trace_limit=200 --trace-uncaught test/node.mjs
285 node --stack_trace_limit=200 --trace-uncaught test/test.mjs
291 sed -i "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
293 # OSX sed is for some reason not compatible with GNU sed
294 sed -i '' "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
297 echo "Creating Java bindings..."
298 mkdir -p src/main/java/org/ldk/{enums,structs}
299 rm -f src/main/java/org/ldk/{enums,structs}/*.java
300 rm -f src/main/jni/*.h
301 if [ "$4" = "true" ]; then
302 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG android $4 $TARGET_STRING
304 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG java $4 $TARGET_STRING
306 rm -f src/main/jni/bindings.c
307 if [ "$3" = "true" ]; then
308 echo "#define LDK_DEBUG_BUILD" > src/main/jni/bindings.c
309 elif [ "$3" = "leaks" ]; then
310 # For leak checking we use release libldk which doesn't expose
311 # __unmangle_inner_ptr, but the C code expects to be able to call it.
312 echo "#define __unmangle_inner_ptr(a) (a)" > src/main/jni/bindings.c
314 cat header.c >> src/main/jni/bindings.c
315 cat header.c >> src/main/jni/bindings.c
316 cat src/main/jni/bindings.c.body >> src/main/jni/bindings.c
317 javac -h src/main/jni src/main/java/org/ldk/enums/*.java src/main/java/org/ldk/impl/*.java
318 rm src/main/java/org/ldk/enums/*.class src/main/java/org/ldk/impl/bindings*.class
320 echo "Building Java bindings..."
321 COMPILE="$COMMON_COMPILE $COMMON_CC -Isrc/main/jni -pthread -fPIC"
322 LINK="$COMMON_CC -shared"
323 [ "$IS_WIN" = "false" ] && LINK="$LINK -ldl"
324 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
325 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
326 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
327 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
328 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
329 if [ "$3" = "true" ]; then
330 $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
332 [ "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -fuse-ld=lld"
333 [ "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
334 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
335 [ "$IS_WIN" = "false" ] && LINK="$LINK -Wl,--lto-O3"
336 [ "$IS_WIN" = "true" ] && LINK="$LINK -L/usr/lib/gcc/x86_64-w64-mingw32/12-win32/ -lbcrypt"
337 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
338 if [ "$IS_MAC" = "false" -a "$IS_WIN" = "false" -a "$4" = "false" ]; then
339 LINK="$LINK -Wl,--version-script=libcode.version"
342 $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ $2 src/main/jni/bindings.c
343 $COMPILE $LINK -o liblightningjni_release$LDK_TARGET_SUFFIX.so -O3 $2 bindings.o $LDK_LIB -lm
344 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip -R .llvmbc -R .llvmcmd liblightningjni_release$LDK_TARGET_SUFFIX.so
346 if [ "$IS_MAC" = "false" -a "$4" = "false" ]; then
347 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)"
348 if [ "$GLIBC_SYMBS" != "" ]; then
349 echo "Unexpected glibc version dependency! Some users need glibc 2.35 support, symbols for newer glibcs cannot be included."
353 REALLOC_ARRAY_SYMBS="$(objdump -T liblightningjni_release$LDK_TARGET_SUFFIX.so | grep reallocarray || echo)"
354 if [ "$REALLOC_ARRAY_SYMBS" != "" ]; then
355 echo "Unexpected reallocarray dependency!"
360 if [ "$LDK_JAR_TARGET" = "true" ]; then
361 # Copy to JNI native directory for inclusion in JARs
362 mkdir -p src/main/resources/
363 cp liblightningjni_release$LDK_TARGET_SUFFIX.so src/main/resources/liblightningjni$LDK_TARGET_SUFFIX.nativelib