@bitcoinerlab/miniscript-policies 1.0.0

package/Makefile

@@ -0,0 +1,14 @@
+MINISCRIPT_COMMIT ?= 6806dfb15a1fafabf7dd28aae3c9d2bc49db01f1
+# Pinned miniscript commit: "Merge sipa/miniscript#133: Hash clarifications"
+HEADERS := miniscript/bitcoin/util/vector.h miniscript/bitcoin/util/strencodings.h miniscript/bitcoin/span.h miniscript/bitcoin/util/spanparsing.h miniscript/bitcoin/script/script.h miniscript/bitcoin/script/miniscript.h miniscript/compiler.h miniscript/bitcoin/crypto/common.h miniscript/bitcoin/serialize.h miniscript/bitcoin/prevector.h miniscript/bitcoin/compat/endian.h miniscript/bitcoin/compat/byteswap.h miniscript/bitcoin/attributes.h miniscript/bitcoin/tinyformat.h miniscript/bitcoin/primitives/transaction.h
+SOURCES := miniscript/bitcoin/util/strencodings.cpp miniscript/bitcoin/util/spanparsing.cpp miniscript/bitcoin/script/script.cpp miniscript/bitcoin/script/miniscript.cpp miniscript/compiler.cpp
+src/bindings.js: miniscript $(HEADERS) $(SOURCES) miniscript/js_bindings.cpp
+	em++ -O3 -g0 -Wall -std=c++17 -fno-rtti -flto -Iminiscript/bitcoin $(SOURCES) miniscript/js_bindings.cpp -s WASM=0 -s EXPORT_ES6=0 --memory-init-file 0 -s MODULARIZE=1 -s MALLOC=emmalloc -s WASM_ASYNC_COMPILATION=0 -s FILESYSTEM=0 -s ENVIRONMENT=web -s DISABLE_EXCEPTION_CATCHING=0 -s EXPORTED_FUNCTIONS='["_miniscript_compile","_miniscript_analyze","_malloc","_free"]' -s EXPORTED_RUNTIME_METHODS='["cwrap","UTF8ToString"]' -o src/bindings.js
+miniscript:
+	git clone https://github.com/sipa/miniscript
+	git -C miniscript reset --hard $(MINISCRIPT_COMMIT)
+	#Patch: https://github.com/sipa/miniscript/pull/132
+	patch -p0 miniscript/compiler.cpp < patches/uppercase-h.patch
+	cp js_bindings.cpp miniscript/
+clean:
+	rm -rf miniscript src/bindings.js

package/README.md

@@ -0,0 +1,34 @@
+# Miniscript Policies
+
+This package exposes the reference C++ Miniscript policy compiler in JavaScript
+via Emscripten. It is a companion to https://github.com/bitcoinerlab/miniscript,
+which does the heavy lifting for compilation and satisfactions.
+
+Use this package when you need to compile policies into Miniscript expressions
+for P2WSH.
+
+## Usage
+
+```javascript
+import { compilePolicy, ready } from '@bitcoinerlab/miniscript-policies';
+
+await ready;
+const policy = 'or(and(pk(A),older(8640)),pk(B))';
+const result = compilePolicy(policy);
+console.log(result.miniscript);
+```
+
+## Build
+
+This package uses Emscripten. Build with:
+
+```bash
+make clean && make
+npm run build
+```
+
+## Test
+
+```bash
+npm test
+```