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)="
78 [ "$IS_MAC" = "true" -a "$2" != "wasm" ] && COMMON_COMPILE="$COMMON_COMPILE --target=$TARGET_STRING -mcpu=$LDK_TARGET_CPU"
81 if [ "$3" = "leaks" ]; then
85 cp "$1/lightning-c-bindings/include/lightning.h" ./
87 sed -i "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
89 # OSX sed is for some reason not compatible with GNU sed
90 sed -i '' "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
92 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" > header.c
93 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> header.c
96 if [ "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" = "" ]; then
97 export LDK_GARBAGECOLLECTED_GIT_OVERRIDE=$(git describe --tag --dirty)
99 if [ "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:0:1}" != "v" ]; then
100 echo "Version tag should start with a v" > /dev/stderr
105 if [ "$2" = "c_sharp" ]; then
106 echo "Creating C# bindings..."
107 mkdir -p c_sharp/src/org/ldk/{enums,structs,impl}
108 rm -f c_sharp/src/org/ldk/{enums,structs,impl}/*.cs
109 ./genbindings.py "./lightning.h" c_sharp/src/org/ldk/impl c_sharp/src/org/ldk c_sharp/ $DEBUG_ARG c_sharp $4 $TARGET_STRING
110 rm -f c_sharp/bindings.c
111 if [ "$3" = "true" ]; then
112 echo "#define LDK_DEBUG_BUILD" > c_sharp/bindings.c
113 elif [ "$3" = "leaks" ]; then
114 # For leak checking we use release libldk which doesn't expose
115 # __unmangle_inner_ptr, but the C code expects to be able to call it.
116 echo "#define __unmangle_inner_ptr(a) (a)" > c_sharp/bindings.c
118 cat header.c >> c_sharp/bindings.c
119 cat header.c >> c_sharp/bindings.c
120 cat c_sharp/bindings.c.body >> c_sharp/bindings.c
123 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
125 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
128 sed -i "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/org.ldk.nuspec
129 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
131 # OSX sed is for some reason not compatible with GNU sed
132 sed -i '' "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/org.ldk.nuspec
133 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
136 # Compiling C# bindings with Mono
137 if [ "$3" = "true" ]; then
138 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
141 dotnet build --configuration Release
145 echo "Building C# bindings..."
146 COMPILE="$COMMON_COMPILE -pthread -fPIC"
148 [ "$IS_WIN" = "false" ] && LINK="$LINK -ldl"
149 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
150 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
151 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
152 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
153 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
155 if [ "$3" = "true" ]; then
156 $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
158 [ "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -fuse-ld=lld"
159 [ "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
160 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
161 [ "$IS_WIN" = "false" ] && LINK="$LINK -Wl,--lto-O3"
162 [ "$IS_WIN" = "true" ] && LINK="$LINK --target=x86_64-pc-windows-gnu -L/usr/lib/gcc/x86_64-w64-mingw32/12-win32/ -lbcrypt -lntdll -static-libgcc"
163 [ "$IS_WIN" = "true" ] && COMPILE="$COMPILE --target=x86_64-pc-windows-gnu"
164 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
165 if [ "$IS_MAC" = "false" -a "$IS_WIN" = "false" -a "$4" = "false" ]; then
166 LINK="$LINK -Wl,--version-script=c_sharp/libcode.version -Wl,--build-id=0x0000000000000000"
169 # When building for Windows, a timestamp is included in the resulting dll,
170 # so we have to build with faketime.
171 faketime -f "2021-01-01 00:00:00" $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ c_sharp/bindings.c
172 faketime -f "2021-01-01 00:00:00" $COMPILE $LINK -o libldkcsharp_release$LDK_TARGET_SUFFIX.so -O3 bindings.o $LDK_LIB -lm
173 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip libldkcsharp_release$LDK_TARGET_SUFFIX.so
175 if [ "$LDK_JAR_TARGET" = "true" ]; then
176 # Copy resulting native binary for inclusion in release nuget zip
177 mkdir -p c_sharp/packaging_artifacts/lib/net6.0/
178 cp c_sharp/bin/Release/net6.0/csharpldk.dll c_sharp/packaging_artifacts/lib/net6.0/
180 mkdir -p c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/
181 if [ "$IS_WIN" = "true" ]; then
182 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/ldkcsharp.dll
183 elif [ "$IS_MAC" = "true" ]; then
184 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/libldkcsharp.dylib
186 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/libldkcsharp.so
190 elif [ "$2" = "python" ]; then
191 echo "Creating Python bindings..."
192 mkdir -p python/src/{enums,structs,impl}
193 rm -f python/src/{enums,structs,impl}/*.py
194 ./genbindings.py "./lightning.h" python/src/impl python/src python/ $DEBUG_ARG python $4 $TARGET_STRING
195 rm -f python/bindings.c
196 if [ "$3" = "true" ]; then
197 echo "#define LDK_DEBUG_BUILD" > python/bindings.c
198 elif [ "$3" = "leaks" ]; then
199 # For leak checking we use release libldk which doesn't expose
200 # __unmangle_inner_ptr, but the C code expects to be able to call it.
201 echo "#define __unmangle_inner_ptr(a) (a)" > python/bindings.c
203 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" >> python/bindings.c
204 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> python/bindings.c
205 cat python/bindings.c.body >> python/bindings.c
208 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
210 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
212 echo "Building Python bindings..."
213 COMPILE="$COMMON_COMPILE -Isrc/main/jni -pthread -fPIC"
215 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
216 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
217 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
218 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
219 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
221 exit 0 # Sadly compilation doesn't currently work
222 if [ "$3" = "true" ]; then
223 $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
225 $COMPILE -o bindings.o -c -flto -O3 -I"$1"/lightning-c-bindings/include/ $2 c_sharp/bindings.c
226 $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
227 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip liblightningpython_release$LDK_TARGET_SUFFIX.so
229 elif [ "$2" = "wasm" ]; then
230 echo "Creating TS bindings..."
231 mkdir -p ts/{enums,structs}
232 rm -f ts/{enums,structs,}/*.{mjs,mts,mts.part}
233 if [ "$4" = "false" ]; then
234 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript node wasm
236 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript browser wasm
239 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' ts/package.json
240 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' node-net/package.json
241 sed -i 's/^ "lightningdevkit": .*/ "lightningdevkit": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'"/g' node-net/package.json
242 if [ "$3" = "true" ]; then
243 echo "#define LDK_DEBUG_BUILD" > ts/bindings.c
244 elif [ "$3" = "leaks" ]; then
245 # For leak checking we use release libldk which doesn't expose
246 # __unmangle_inner_ptr, but the C code expects to be able to call it.
247 echo "#define __unmangle_inner_ptr(a) (a)" > ts/bindings.c
249 cat header.c >> ts/bindings.c
250 cat ts/bindings.c.body >> ts/bindings.c
252 echo "Building TS bindings..."
253 COMPILE="$COMMON_COMPILE -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"
254 # We only need malloc and assert/abort, but for now just use WASI for those:
255 EXTRA_LINK=/usr/lib/wasm32-wasi/libc.a
256 [ "$3" != "false" ] && COMPILE="$COMPILE -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,reallocarray -Wl,-wrap,malloc -Wl,-wrap,aligned_alloc -Wl,-wrap,free"
257 if [ "$3" = "true" ]; then
258 WASM_FILE=liblightningjs_debug.wasm
259 $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
261 WASM_FILE=liblightningjs_release.wasm
262 $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
265 if [ -x "$(which tsc)" ]; then
267 for F in structs/*; do
268 cat imports.mts.part | grep -v " $(basename -s .mts $F)[ ,]" | cat - $F > $F.tmp
272 tsc --types node --typeRoots .
273 cp ../$WASM_FILE liblightningjs.wasm
274 cp ../README.md README.md
276 tsc --types node --typeRoots .
277 echo Ready to publish!
278 if [ -x "$(which node)" ]; then
279 NODE_V="$(node --version)"
280 if [ "${NODE_V:1:2}" -gt 14 ]; then
282 node --stack_trace_limit=200 --trace-uncaught test/node.mjs
284 node --stack_trace_limit=200 --trace-uncaught test/test.mjs
290 sed -i "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
292 # OSX sed is for some reason not compatible with GNU sed
293 sed -i '' "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
296 echo "Creating Java bindings..."
297 mkdir -p src/main/java/org/ldk/{enums,structs}
298 rm -f src/main/java/org/ldk/{enums,structs}/*.java
299 rm -f src/main/jni/*.h
300 if [ "$4" = "true" ]; then
301 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG android $4 $TARGET_STRING
303 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG java $4 $TARGET_STRING
305 rm -f src/main/jni/bindings.c
306 if [ "$3" = "true" ]; then
307 echo "#define LDK_DEBUG_BUILD" > src/main/jni/bindings.c
308 elif [ "$3" = "leaks" ]; then
309 # For leak checking we use release libldk which doesn't expose
310 # __unmangle_inner_ptr, but the C code expects to be able to call it.
311 echo "#define __unmangle_inner_ptr(a) (a)" > src/main/jni/bindings.c
313 cat header.c >> src/main/jni/bindings.c
314 cat header.c >> src/main/jni/bindings.c
315 cat src/main/jni/bindings.c.body >> src/main/jni/bindings.c
316 javac -h src/main/jni src/main/java/org/ldk/enums/*.java src/main/java/org/ldk/impl/*.java
317 rm src/main/java/org/ldk/enums/*.class src/main/java/org/ldk/impl/bindings*.class
319 echo "Building Java bindings..."
320 COMPILE="$COMMON_COMPILE -Isrc/main/jni -pthread -fPIC"
322 [ "$IS_WIN" = "false" ] && LINK="$LINK -ldl"
323 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
324 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
325 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
326 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
327 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
328 if [ "$3" = "true" ]; then
329 $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
331 [ "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -fuse-ld=lld"
332 [ "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
333 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
334 [ "$IS_WIN" = "false" ] && LINK="$LINK -Wl,--lto-O3"
335 [ "$IS_WIN" = "true" ] && LINK="$LINK -L/usr/lib/gcc/x86_64-w64-mingw32/12-win32/ -lbcrypt"
336 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
337 if [ "$IS_MAC" = "false" -a "$IS_WIN" = "false" -a "$4" = "false" ]; then
338 LINK="$LINK -Wl,--version-script=libcode.version"
341 $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ $2 src/main/jni/bindings.c
342 $COMPILE $LINK -o liblightningjni_release$LDK_TARGET_SUFFIX.so -O3 $2 bindings.o $LDK_LIB -lm
343 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip liblightningjni_release$LDK_TARGET_SUFFIX.so
345 if [ "$IS_MAC" = "false" -a "$4" = "false" ]; then
346 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)"
347 if [ "$GLIBC_SYMBS" != "" ]; then
348 echo "Unexpected glibc version dependency! Some users need glibc 2.35 support, symbols for newer glibcs cannot be included."
352 REALLOC_ARRAY_SYMBS="$(objdump -T liblightningjni_release$LDK_TARGET_SUFFIX.so | grep reallocarray || echo)"
353 if [ "$REALLOC_ARRAY_SYMBS" != "" ]; then
354 echo "Unexpected reallocarray dependency!"
359 if [ "$LDK_JAR_TARGET" = "true" ]; then
360 # Copy to JNI native directory for inclusion in JARs
361 mkdir -p src/main/resources/
362 cp liblightningjni_release$LDK_TARGET_SUFFIX.so src/main/resources/liblightningjni$LDK_TARGET_SUFFIX.nativelib