Update to workspace

Cargo.toml

@@ -1,20 +1,17 @@
-[package]
-name = "webln"
-version = "0.1.0"
-edition = "2021"
-description = "WebLN - Lightning Web Standard"
+[workspace]
+members = [
+    "webln",
+]
+resolver = "2"
+
+[workspace.package]
 authors = ["Yuki Kishimoto <[email protected]>"]
 homepage = "https://github.com/yukibtc/rust-webln"
 repository = "https://github.com/yukibtc/rust-webln.git"
 license = "MIT"
-#rust-version = "1.64.0" TODO: check MSRV
-keywords = ["webln", "lightning", "bitcoin"]
+rust-version = "1.64.0" # TODO: check MSRV
 
-[dependencies]
-js-sys = "0.3"
-wasm-bindgen = { version = "0.2", default-features = false }
-wasm-bindgen-futures = "0.4"
-web-sys = { version = "0.3", default-features = false, features = ["Window"] }
+[workspace.dependencies]
 
 [profile.release]
 lto = true

README.md

@@ -1,4 +1,6 @@
-# WebLN
+# WebLN - Lightning Web Standard
+
+* [webln](./webln/): Rust implementation of WebLN
 
 ## License
 

contrib/scripts/check-crates.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# Needed to exit from script on error
+set -e
+
+# MSRV
+msrv="1.64.0"
+
+is_msrv=false
+version=""
+
+# Check if "msrv" is passed as an argument
+if [[ "$#" -gt 0 && "$1" == "msrv" ]]; then
+    is_msrv=true
+    version="+$msrv"
+fi
+
+# Check if MSRV
+if [ "$is_msrv" == true ]; then
+    # Install MSRV
+    rustup install $msrv
+    rustup component add clippy --toolchain $msrv
+    rustup target add wasm32-unknown-unknown --toolchain $msrv
+fi
+
+buildargs=(
+    "-p webln --target wasm32-unknown-unknown"
+)
+
+for arg in "${buildargs[@]}"; do
+    if [[ $version == "" ]]; then
+        echo  "Checking '$arg' [default]"
+    else
+        echo  "Checking '$arg' [$version]"
+    fi
+    cargo $version check $arg
+    cargo $version clippy $arg -- -D warnings
+    echo
+done

contrib/scripts/check-docs.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Needed to exit from script on error
+set -e
+
+buildargs=(
+    "-p webln --target wasm32-unknown-unknown"
+)
+
+for arg in "${buildargs[@]}"; do
+    echo  "Checking '$arg' docs"
+    cargo doc $arg --all-features
+    echo
+done

justfile

@@ -1,7 +1,16 @@
 fmt:
     cargo fmt --all -- --config format_code_in_doc_comments=true
 
-check:
-    cargo check
-    cargo clippy
-    cargo doc
+check: fmt check-crates check-crates-msrv check-docs
+
+check-fmt:
+	cargo fmt --all -- --config format_code_in_doc_comments=true --check
+
+check-crates:
+	@bash contrib/scripts/check-crates.sh
+
+check-crates-msrv:
+	@bash contrib/scripts/check-crates.sh msrv
+
+check-docs:
+	@bash contrib/scripts/check-docs.sh

webln/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "webln"
+version = "0.1.0"
+edition = "2021"
+description = "WebLN - Lightning Web Standard"
+authors.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
+readme = "README.md"
+rust-version.workspace = true
+keywords = ["webln", "lightning", "bitcoin"]
+
+[dependencies]
+js-sys = "0.3"
+wasm-bindgen = { version = "0.2", default-features = false }
+wasm-bindgen-futures = "0.4"
+web-sys = { version = "0.3", default-features = false, features = ["Window"] }

webln/README.md

@@ -0,0 +1,11 @@
+# WebLN
+
+## License
+
+This project is distributed under the MIT software license - see the [LICENSE](../LICENSE) file for details
+
+## Donations
+
+⚡ Tips: https://getalby.com/p/yuki
+
+⚡ Lightning Address: [email protected]

src/lib.rs → webln/src/lib.rs

@@ -81,7 +81,7 @@ impl WebLN {
             .map_err(|_| Error::ObjectKeyNotFound(key.to_string()))
     } */
 
-    /// Check if `webln` is enabled without explicitly enabling it through `webln.enable()` 
+    /// Check if `webln` is enabled without explicitly enabling it through `webln.enable()`
     /// (which may cause a confirmation popup in some providers)
     pub async fn is_enabled(&self) -> Result<bool, Error> {
         let func: Function = self.get_func(&self.webln_obj, "isEnabled")?;