Merge pull request #91 from danielgranhao/support-wasm

Support wasm

Author: i5hi

.github/workflows/build.yaml

@@ -1,7 +1,7 @@
 on:
   push:
     branches:
-    - master
+      - master
   pull_request:
 
 name: build
@@ -15,16 +15,14 @@ jobs:
       matrix:
         rust:
           - stable
-          - nightly 
-        features:
-          - default
+          - nightly
     steps:
       - name: checkout
         uses: actions/checkout@v3
       - name: Generate cache key
-        run: echo "${{ matrix.rust }} ${{ matrix.features }}" | tee .cache_key
+        run: echo "${{ matrix.rust }}" | tee .cache_key
       - name: cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -33,9 +31,35 @@ jobs:
           key: ${{ runner.os }}-cargo-${{ hashFiles('.cache_key') }}-${{ hashFiles('**/Cargo.toml','**/Cargo.lock') }}
       - name: Set default toolchain
         run: rustup default ${{ matrix.rust }}
+      - name: Add wasm target
+        run: rustup target add wasm32-unknown-unknown
       - name: Set profile
         run: rustup set profile minimal
       - name: Update toolchain
         run: rustup update
       - name: Build
-        run: cargo build --features ${{ matrix.features }}
+        run: make cargo-build
+      - name: Build wasm
+        run: make wasm-build
+
+  build-as-wasm-dependency:
+    name: Build as wasm dependency
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: Add wasm target
+        run: rustup target add wasm32-unknown-unknown
+      - name: Install wasm-pack
+        run: cargo install wasm-pack
+      - name: Create wasm project
+        run: |
+          wasm-pack new wasm-project
+          cd wasm-project
+          sed -i.bak -e 's/edition = .*/edition = "2021"/' Cargo.toml
+          rm Cargo.toml.bak
+          # Patch needed until secp256k1-zkp wasm compatibility is fixed
+          echo -e '\n[workspace]\n\n[patch.crates-io]\nsecp256k1-zkp = { git = "https://github.com/danielgranhao/rust-secp256k1-zkp.git", rev = "eac2e479255a6e32b5588bc25ee53c642fdd8395" }' >> Cargo.toml
+          # In this test, we reference the checked out repo (e.g. this PR branch)
+          cargo add --path ../ boltz-client
+          wasm-pack build --target web

.github/workflows/lint.yaml

@@ -1,7 +1,7 @@
 on:
   push:
     branches:
-    - master
+      - master
   pull_request:
 
 name: lint
@@ -22,9 +22,13 @@ jobs:
         run: rustup component add rustfmt
       - name: Add clippy
         run: rustup component add clippy
+      - name: Add wasm target
+        run: rustup target add wasm32-unknown-unknown
       - name: Update toolchain
         run: rustup update
       - name: Check fmt
         run: cargo fmt --all -- --check
       - name: Clippy
-        run: cargo clippy --all-targets --all-features -- -D warnings
+        run: make cargo-clippy
+      - name: Clippy wasm
+        run: make wasm-clippy

.github/workflows/test.yaml

@@ -1,7 +1,7 @@
 on:
   push:
     branches:
-    - master
+      - master
   pull_request:
 
 name: test
@@ -17,5 +17,41 @@ jobs:
         run: rustup default nightly
       - name: Set profile
         run: rustup set profile minimal
+      - name: Add wasm target
+        run: rustup target add wasm32-unknown-unknown
+      - name: Install wasm-pack
+        run: cargo install wasm-pack
       - name: Run cargo test
-        run: cargo test -- --nocapture
+        run: make cargo-test
+      - name: Run wasm-pack test
+        run: make wasm-test
+
+  regtest-test:
+    name: Run regtest tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Set up Docker
+        uses: docker/setup-buildx-action@v2
+      - name: Set up Docker Compose
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose
+      - name: Set default toolchain
+        run: rustup default nightly
+      - name: Set profile
+        run: rustup set profile minimal
+      - name: Add wasm target
+        run: rustup target add wasm32-unknown-unknown
+      - name: Install wasm-pack
+        run: cargo install wasm-pack
+      - name: Start regtest environment
+        working-directory: regtest
+        run: sh start.sh
+      - name: Run cargo regtest tests
+        run: make cargo-regtest-test
+      - name: Run WASM regtest tests
+        run: make wasm-regtest-test

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "regtest/boltz"]
+	path = regtest/boltz
+	url = https://github.com/BoltzExchange/regtest

Cargo.toml

@@ -2,15 +2,20 @@
 name = "boltz-client"
 description = "a boltz exchange client for swaps between BTC/LBTC & LN"
 authors = ["i5hi <[email protected]>", "Rajarshi Maitra <[email protected]>"]
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
-license="MIT"
+license = "MIT"
 
 [lib]
 name = "boltz_client"
 path = "src/lib.rs"
 doctest = false
-crate-type = ["lib"] 
+crate-type = ["lib"]
+
+[workspace]
+members = [
+    "macros"
+]
 
 [profile.release]
 strip = true
@@ -22,28 +27,53 @@ panic = "abort"
 [dependencies]
 serde = { version = "1.0.0", features = ["derive"] }
 serde_json = "1.0.0"
-ureq = { version = "2.5.0", features = ["json", "native-tls"] }
 bip39 = "2.0.0"
-electrum-client = { version = "0.21.0", default-features=false, features = ["use-rustls-ring", "proxy"] }
-bitcoin = {version = "0.32.2", features = ["rand", "base64", "rand-std"]}
+bitcoin = { version = "0.32.2", features = ["rand", "base64", "rand-std"] }
 elements = { version = "0.25.0", features = ["serde"] }
 lightning-invoice = "0.32.0"
-tungstenite = { version = "0.21.0", features = ["native-tls-vendored"] }
 url = "2.5.0"
 log = "^0.4"
 env_logger = "0.7"
-native-tls = "0.2.11"
 hex = "0.4"
-lnurl-rs = { version = "0.8.0", optional = true }
+lnurl-rs = { version = "0.9.0", default-features = false, features = ["async", "async-https"], optional = true }
+# Pin to commit until https://github.com/seanmonstar/reqwest/pull/1760 gets released
+reqwest = { git = "https://github.com/seanmonstar/reqwest", rev = "00b15b9a893d350388af513179e1a973dfa26f85", features = ["json"] }
+tokio-tungstenite-wasm = { version = "0.5.0", features = ["native-tls-vendored"] }
+async-trait = "0.1.86"
+macros = { path = "macros" }
+
+[target.'cfg(not(all(target_family = "wasm", target_os = "unknown")))'.dependencies]
+electrum-client = { version = "0.21.0", default-features = false, features = ["use-rustls-ring", "proxy"], optional = true }
+tokio = "1.43.0"
+
+[target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dependencies]
+getrandom = { version = "0.2", features = ["js"] }
+js-sys = "0.3.77"
+web-sys = "0.3.77"
+wasm-bindgen-futures = "0.4.50"
 
 [patch.crates-io]
-secp256k1-zkp = { git = "https://github.com/dangeross/rust-secp256k1-zkp.git", rev = "57d29b15269ca2ce3c3b118b6a72b66c1169e7b1" }
+secp256k1-zkp = { git = "https://github.com/danielgranhao/rust-secp256k1-zkp.git", rev = "eac2e479255a6e32b5588bc25ee53c642fdd8395" }
 
 [dev-dependencies]
-bitcoind = {version = "0.36.0", features = ["25_0"] }
-elementsd = {version  = "0.11.0", features = ["22_1_1"] }
+futures-util = "0.3.31"
+serial_test = "3.2.0"
+
+[target.'cfg(not(all(target_family = "wasm", target_os = "unknown")))'.dev-dependencies]
+bitcoind = { version = "0.36.0", features = ["25_0"] }
+elementsd = { version = "0.11.0", features = ["22_1_1"] }
+tokio = { version = "1.43.0", features = ["macros", "rt-multi-thread"] }
+
+[target.'cfg(all(target_family = "wasm", target_os = "unknown"))'.dev-dependencies]
+wasm-bindgen-test = "0.3.50"
+wasm-bindgen = "0.2.100"
+gloo-timers = { version = "0.3.0", features = ["futures"] }
+futures = "0.3.31"
 
-#Empty default feature set, (helpful to generalise in github actions)
 [features]
-default = []
+default = ["esplora"]
 lnurl = ["dep:lnurl-rs"]
+esplora = []
+electrum = ["dep:electrum-client"]
+# Feature to enable tests that require previous initialization of a regtest environment
+regtest = []

Makefile

@@ -0,0 +1,58 @@
+UNAME := $(shell uname)
+
+ifeq ($(UNAME), Darwin)
+	CLANG_PREFIX += AR=$(shell brew --prefix llvm)/bin/llvm-ar CC=$(shell brew --prefix llvm)/bin/clang
+endif
+
+LND_MACAROON_HEX=$(shell xxd -p regtest/boltz/data/lnd1/data/chain/bitcoin/regtest/admin.macaroon | tr -d '\n')
+BITCOIND_COOKIE=$(shell cat regtest/boltz/data/bitcoind/regtest/.cookie)
+REGTEST_PREFIX = LND_MACAROON_HEX=$(LND_MACAROON_HEX) BITCOIND_COOKIE=$(BITCOIND_COOKIE)
+
+init:
+	cargo install wasm-pack
+
+build: cargo-build cargo-clippy
+
+cargo-build:
+	cargo build --all-targets --all-features
+
+wasm-build:
+	cargo build --target=wasm32-unknown-unknown --all-features
+
+clippy: cargo-clippy wasm-clippy
+
+test: cargo-test wasm-test
+
+regtest-test: cargo-regtest-test wasm-regtest-test
+
+cargo-clippy:
+	cargo clippy --all-targets --all-features -- -D warnings
+
+cargo-test:
+	cargo test --features "esplora, electrum, lnurl"  -- --nocapture
+
+cargo-regtest-test:
+	$(REGTEST_PREFIX) cargo test regtest --features "electrum, regtest" -- --nocapture
+
+wasm-clippy:
+	$(CLANG_PREFIX) cargo clippy --target=wasm32-unknown-unknown --all-features -- -D warnings
+
+BROWSER ?= firefox
+
+wasm-test:
+	$(CLANG_PREFIX) wasm-pack test --headless --$(BROWSER)
+
+wasm-test-chrome:
+	BROWSER=chrome $(MAKE) wasm-test
+
+wasm-test-safari:
+	BROWSER=safari $(MAKE) wasm-test
+
+wasm-regtest-test:
+	$(CLANG_PREFIX) $(REGTEST_PREFIX) WASM_BINDGEN_TEST_TIMEOUT=500 wasm-pack test --headless --$(BROWSER) --features regtest -- regtest
+
+wasm-regtest-test-chrome:
+	BROWSER=chrome $(MAKE) wasm-regtest-test
+
+wasm-regtest-test-safari:
+	BROWSER=safari $(MAKE) wasm-regtest-test