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 [ "$IS_MAC" = "true" -a "$2" != "wasm" ] && COMMON_CC="$COMMON_CC --target=$TARGET_STRING -mcpu=$LDK_TARGET_CPU"
80 [ "$IS_MAC" = "false" -a "$2" != "wasm" ] && COMMON_CC="$COMMON_CC --target=$TARGET_STRING -march=$LDK_TARGET_CPU -mtune=$LDK_TARGET_CPU"
83 if [ "$3" = "leaks" ]; then
87 cp "$1/lightning-c-bindings/include/lightning.h" ./
89 sed -i "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
91 # OSX sed is for some reason not compatible with GNU sed
92 sed -i '' "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
94 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" > header.c
95 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> header.c
98 if [ "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" = "" ]; then
99 export LDK_GARBAGECOLLECTED_GIT_OVERRIDE=$(git describe --tag --dirty)
101 if [ "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:0:1}" != "v" ]; then
102 echo "Version tag should start with a v" > /dev/stderr
107 if [ "$2" = "c_sharp" ]; then
108 echo "Creating C# bindings..."
109 mkdir -p c_sharp/src/org/ldk/{enums,structs,impl}
110 rm -f c_sharp/src/org/ldk/{enums,structs,impl}/*.cs
111 GEN_PLAT="c_sharp-linux"
112 [ "$IS_WIN" = "true" ] && GEN_PLAT="c_sharp-win"
113 [ "$IS_MAC" = "true" ] && GEN_PLAT="c_sharp-darwin"
114 ./genbindings.py "./lightning.h" c_sharp/src/org/ldk/impl c_sharp/src/org/ldk c_sharp/ $DEBUG_ARG $GEN_PLAT $4 $TARGET_STRING
115 rm -f c_sharp/bindings.c
116 if [ "$3" = "true" ]; then
117 echo "#define LDK_DEBUG_BUILD" > c_sharp/bindings.c
118 elif [ "$3" = "leaks" ]; then
119 # For leak checking we use release libldk which doesn't expose
120 # __unmangle_inner_ptr, but the C code expects to be able to call it.
121 echo "#define __unmangle_inner_ptr(a) (a)" > c_sharp/bindings.c
123 cat header.c >> c_sharp/bindings.c
124 cat header.c >> c_sharp/bindings.c
125 cat c_sharp/bindings.c.body >> c_sharp/bindings.c
128 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
130 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
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
136 # OSX sed is for some reason not compatible with GNU sed
137 sed -i '' "s/<version>.*<\/version>/<version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" c_sharp/packaging_artifacts/org.ldk.nuspec
138 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
141 # Compiling C# bindings with Mono
142 if [ "$3" = "true" ]; then
143 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
146 dotnet build --configuration Release
150 echo "Building C# bindings..."
151 COMPILE="$COMMON_COMPILE $COMMON_CC -pthread -fPIC"
152 LINK="$COMMON_CC -shared"
153 [ "$IS_WIN" = "false" ] && LINK="$LINK -ldl"
154 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
155 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
156 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
157 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
158 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
159 [ "$IS_WIN" = "true" ] && LINK="$LINK -lbcrypt -lntdll -static-libgcc"
160 [ "$IS_WIN" = "true" ] && COMPILE="$COMPILE -I/usr/x86_64-w64-mingw32/sys-root/mingw/include/ -I/usr/x86_64-w64-mingw32/include/"
162 if [ "$3" = "true" ]; then
163 $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
165 [ "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -fuse-ld=lld"
166 [ "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
167 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
168 [ "$IS_WIN" = "false" ] && LINK="$LINK -Wl,--lto-O3"
169 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
170 if [ "$IS_MAC" = "false" -a "$IS_WIN" = "false" -a "$4" = "false" ]; then
171 LINK="$LINK -Wl,--version-script=c_sharp/libcode.version -Wl,--build-id=0x0000000000000000"
174 # When building for Windows, a timestamp is included in the resulting dll,
175 # so we have to build with faketime.
176 faketime -f "2021-01-01 00:00:00" $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ c_sharp/bindings.c
177 faketime -f "2021-01-01 00:00:00" $COMPILE $LINK -o libldkcsharp_release$LDK_TARGET_SUFFIX.so -O3 bindings.o $LDK_LIB -lm
178 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip libldkcsharp_release$LDK_TARGET_SUFFIX.so
180 if [ "$LDK_JAR_TARGET" = "true" ]; then
181 # Copy resulting native binary for inclusion in release nuget zip
182 mkdir -p c_sharp/packaging_artifacts/lib/net6.0/
183 cp c_sharp/bin/Release/net6.0/csharpldk.dll c_sharp/packaging_artifacts/lib/net6.0/
185 mkdir -p c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/
186 if [ "$IS_WIN" = "true" ]; then
187 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/ldkcsharp.dll
188 elif [ "$IS_MAC" = "true" ]; then
189 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/libldkcsharp.dylib
191 cp libldkcsharp_release$LDK_TARGET_SUFFIX.so c_sharp/packaging_artifacts/runtimes/"$CS_PLATFORM_NAME"/native/libldkcsharp.so
195 elif [ "$2" = "python" ]; then
196 echo "Creating Python bindings..."
197 mkdir -p python/src/{enums,structs,impl}
198 rm -f python/src/{enums,structs,impl}/*.py
199 ./genbindings.py "./lightning.h" python/src/impl python/src python/ $DEBUG_ARG python $4 $TARGET_STRING
200 rm -f python/bindings.c
201 if [ "$3" = "true" ]; then
202 echo "#define LDK_DEBUG_BUILD" > python/bindings.c
203 elif [ "$3" = "leaks" ]; then
204 # For leak checking we use release libldk which doesn't expose
205 # __unmangle_inner_ptr, but the C code expects to be able to call it.
206 echo "#define __unmangle_inner_ptr(a) (a)" > python/bindings.c
208 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" >> python/bindings.c
209 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> python/bindings.c
210 cat python/bindings.c.body >> python/bindings.c
213 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
215 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
217 echo "Building Python bindings..."
218 COMPILE="$COMMON_COMPILE $COMMON_CC -Isrc/main/jni -pthread -fPIC"
219 LINK="$COMMON_CC -ldl -shared"
220 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
221 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
222 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
223 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
224 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
226 exit 0 # Sadly compilation doesn't currently work
227 if [ "$3" = "true" ]; then
228 $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
230 $COMPILE -o bindings.o -c -flto -O3 -I"$1"/lightning-c-bindings/include/ $2 c_sharp/bindings.c
231 $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
232 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip liblightningpython_release$LDK_TARGET_SUFFIX.so
234 elif [ "$2" = "wasm" ]; then
235 echo "Creating TS bindings..."
236 mkdir -p ts/{enums,structs}
237 rm -f ts/{enums,structs,}/*.{mjs,mts,mts.part}
238 if [ "$4" = "false" ]; then
239 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript node wasm
241 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript browser wasm
244 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' ts/package.json
245 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' node-net/package.json
246 sed -i 's/^ "lightningdevkit": .*/ "lightningdevkit": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'"/g' node-net/package.json
247 if [ "$3" = "true" ]; then
248 echo "#define LDK_DEBUG_BUILD" > ts/bindings.c
249 elif [ "$3" = "leaks" ]; then
250 # For leak checking we use release libldk which doesn't expose
251 # __unmangle_inner_ptr, but the C code expects to be able to call it.
252 echo "#define __unmangle_inner_ptr(a) (a)" > ts/bindings.c
254 cat header.c >> ts/bindings.c
255 cat ts/bindings.c.body >> ts/bindings.c
257 echo "Building TS bindings..."
258 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"
259 # We only need malloc and assert/abort, but for now just use WASI for those:
260 EXTRA_LINK=/usr/lib/wasm32-wasi/libc.a
261 [ "$3" != "false" ] && COMPILE="$COMPILE -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,reallocarray -Wl,-wrap,malloc -Wl,-wrap,aligned_alloc -Wl,-wrap,free"
262 if [ "$3" = "true" ]; then
263 WASM_FILE=liblightningjs_debug.wasm
264 $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
266 WASM_FILE=liblightningjs_release.wasm
267 $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
270 if [ -x "$(which tsc)" ]; then
272 for F in structs/*; do
273 cat imports.mts.part | grep -v " $(basename -s .mts $F)[ ,]" | cat - $F > $F.tmp
277 tsc --types node --typeRoots .
278 cp ../$WASM_FILE liblightningjs.wasm
279 cp ../README.md README.md
281 tsc --types node --typeRoots .
282 echo Ready to publish!
283 if [ -x "$(which node)" ]; then
284 NODE_V="$(node --version)"
285 if [ "${NODE_V:1:2}" -gt 14 ]; then
287 node --stack_trace_limit=200 --trace-uncaught test/node.mjs
289 node --stack_trace_limit=200 --trace-uncaught test/test.mjs
295 sed -i "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
297 # OSX sed is for some reason not compatible with GNU sed
298 sed -i '' "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
301 echo "Creating Java bindings..."
302 mkdir -p src/main/java/org/ldk/{enums,structs}
303 rm -f src/main/java/org/ldk/{enums,structs}/*.java
304 rm -f src/main/jni/*.h
305 if [ "$4" = "true" ]; then
306 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG android $4 $TARGET_STRING
308 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG java $4 $TARGET_STRING
310 rm -f src/main/jni/bindings.c
311 if [ "$3" = "true" ]; then
312 echo "#define LDK_DEBUG_BUILD" > src/main/jni/bindings.c
313 elif [ "$3" = "leaks" ]; then
314 # For leak checking we use release libldk which doesn't expose
315 # __unmangle_inner_ptr, but the C code expects to be able to call it.
316 echo "#define __unmangle_inner_ptr(a) (a)" > src/main/jni/bindings.c
318 cat header.c >> src/main/jni/bindings.c
319 cat header.c >> src/main/jni/bindings.c
320 cat src/main/jni/bindings.c.body >> src/main/jni/bindings.c
321 javac -h src/main/jni src/main/java/org/ldk/enums/*.java src/main/java/org/ldk/impl/*.java
322 rm src/main/java/org/ldk/enums/*.class src/main/java/org/ldk/impl/bindings*.class
324 echo "Building Java bindings..."
325 COMPILE="$COMMON_COMPILE $COMMON_CC -Isrc/main/jni -pthread -fPIC"
326 LINK="$COMMON_CC -shared"
327 [ "$IS_WIN" = "false" ] && LINK="$LINK -ldl"
328 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
329 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
330 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
331 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
332 [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
333 if [ "$3" = "true" ]; then
334 $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
336 [ "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -fuse-ld=lld"
337 [ "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
338 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
339 [ "$IS_WIN" = "false" ] && LINK="$LINK -Wl,--lto-O3"
340 [ "$IS_WIN" = "true" ] && LINK="$LINK -L/usr/lib/gcc/x86_64-w64-mingw32/12-win32/ -lbcrypt"
341 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
342 if [ "$IS_MAC" = "false" -a "$IS_WIN" = "false" -a "$4" = "false" ]; then
343 LINK="$LINK -Wl,--version-script=libcode.version"
346 $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ $2 src/main/jni/bindings.c
347 $COMPILE $LINK -o liblightningjni_release$LDK_TARGET_SUFFIX.so -O3 $2 bindings.o $LDK_LIB -lm
348 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip liblightningjni_release$LDK_TARGET_SUFFIX.so
350 if [ "$IS_MAC" = "false" -a "$4" = "false" ]; then
351 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)"
352 if [ "$GLIBC_SYMBS" != "" ]; then
353 echo "Unexpected glibc version dependency! Some users need glibc 2.35 support, symbols for newer glibcs cannot be included."
357 REALLOC_ARRAY_SYMBS="$(objdump -T liblightningjni_release$LDK_TARGET_SUFFIX.so | grep reallocarray || echo)"
358 if [ "$REALLOC_ARRAY_SYMBS" != "" ]; then
359 echo "Unexpected reallocarray dependency!"
364 if [ "$LDK_JAR_TARGET" = "true" ]; then
365 # Copy to JNI native directory for inclusion in JARs
366 mkdir -p src/main/resources/
367 cp liblightningjni_release$LDK_TARGET_SUFFIX.so src/main/resources/liblightningjni$LDK_TARGET_SUFFIX.nativelib