From cb7e753c95d8547e4e8e0dceffa26982ccf5d1d1 Mon Sep 17 00:00:00 2001 From: ok300 <106775972+ok300@users.noreply.github.com> Date: Thu, 2 May 2024 05:44:47 +0000 Subject: [PATCH] Rename project: Rust, uniffi (#133) * Rename rust crates, uniffi bindings * Rename uniffi tests * Rename uniffi UDL file --- cli/Cargo.lock | 70 +++++++++---------- cli/Cargo.toml | 4 +- cli/src/commands.rs | 2 +- cli/src/main.rs | 8 +-- lib/Cargo.lock | 62 ++++++++-------- lib/ls-sdk-bindings/Cargo.toml | 6 +- .../bindings-react-native/src/main.rs | 2 +- lib/ls-sdk-bindings/build.rs | 2 +- lib/ls-sdk-bindings/makefile | 12 ++-- .../src/{ls_sdk.udl => breez_liquid_sdk.udl} | 2 +- lib/ls-sdk-bindings/src/lib.rs | 4 +- ...t_ls_sdk.kts => test_breez_liquid_sdk.kts} | 2 +- ...est_ls_sdk.py => test_breez_liquid_sdk.py} | 4 +- ..._sdk.swift => test_breez_liquid_sdk.swift} | 4 +- .../tests/test_generated_bindings.rs | 6 +- lib/ls-sdk-bindings/uniffi.toml | 8 +-- lib/ls-sdk-core/Cargo.toml | 4 +- 17 files changed, 101 insertions(+), 101 deletions(-) rename lib/ls-sdk-bindings/src/{ls_sdk.udl => breez_liquid_sdk.udl} (98%) rename lib/ls-sdk-bindings/tests/bindings/{test_ls_sdk.kts => test_breez_liquid_sdk.kts} (78%) rename lib/ls-sdk-bindings/tests/bindings/{test_ls_sdk.py => test_breez_liquid_sdk.py} (71%) rename lib/ls-sdk-bindings/tests/bindings/{test_ls_sdk.swift => test_breez_liquid_sdk.swift} (70%) diff --git a/cli/Cargo.lock b/cli/Cargo.lock index 8767fbe..9c45c54 100644 --- a/cli/Cargo.lock +++ b/cli/Cargo.lock @@ -360,6 +360,41 @@ dependencies = [ "url", ] +[[package]] +name = "breez-liquid-cli" +version = "0.0.1" +dependencies = [ + "anyhow", + "bip39", + "breez-liquid-sdk", + "clap", + "env_logger 0.11.3", + "log", + "qrcode-rs", + "rustyline", + "serde", + "serde_json", +] + +[[package]] +name = "breez-liquid-sdk" +version = "0.0.1" +dependencies = [ + "anyhow", + "bip39", + "boltz-client", + "flutter_rust_bridge", + "log", + "lwk_common", + "lwk_signer", + "lwk_wollet", + "openssl", + "rusqlite", + "rusqlite_migration", + "serde", + "thiserror", +] + [[package]] name = "build-target" version = "0.4.0" @@ -1279,41 +1314,6 @@ version = "0.4.21" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "90ed8c1e510134f979dbc4f070f87d4313098b704861a105fe34231c70a3901c" -[[package]] -name = "ls-sdk" -version = "0.0.1" -dependencies = [ - "anyhow", - "bip39", - "boltz-client", - "flutter_rust_bridge", - "log", - "lwk_common", - "lwk_signer", - "lwk_wollet", - "openssl", - "rusqlite", - "rusqlite_migration", - "serde", - "thiserror", -] - -[[package]] -name = "ls-sdk-cli" -version = "0.0.1" -dependencies = [ - "anyhow", - "bip39", - "clap", - "env_logger 0.11.3", - "log", - "ls-sdk", - "qrcode-rs", - "rustyline", - "serde", - "serde_json", -] - [[package]] name = "lwk_common" version = "0.3.0" diff --git a/cli/Cargo.toml b/cli/Cargo.toml index ad2eeaa..d715a5e 100644 --- a/cli/Cargo.toml +++ b/cli/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "ls-sdk-cli" +name = "breez-liquid-cli" edition = "2021" version = "0.0.1" @@ -8,10 +8,10 @@ version = "0.0.1" [dependencies] anyhow = "1.0.80" bip39 = "2.0.0" +breez-liquid-sdk = { path = "../lib/ls-sdk-core" } clap = { version = "4.5.1", features = ["derive"] } env_logger = "0.11" log = "0.4.20" -ls-sdk = { path = "../lib/ls-sdk-core" } qrcode-rs = { version = "0.1", default-features = false } rustyline = { version = "13.0.0", features = ["derive"] } serde = { version = "1.0.197", features = ["derive"] } diff --git a/cli/src/commands.rs b/cli/src/commands.rs index 4813f53..567a235 100644 --- a/cli/src/commands.rs +++ b/cli/src/commands.rs @@ -5,8 +5,8 @@ use std::thread; use std::time::Duration; use anyhow::Result; +use breez_liquid_sdk::{model::PrepareReceiveRequest, wallet::Wallet}; use clap::{arg, Parser}; -use ls_sdk::{model::PrepareReceiveRequest, wallet::Wallet}; use qrcode_rs::render::unicode; use qrcode_rs::{EcLevel, QrCode}; use rustyline::highlight::Highlighter; diff --git a/cli/src/main.rs b/cli/src/main.rs index 56aef1e..39e5364 100644 --- a/cli/src/main.rs +++ b/cli/src/main.rs @@ -7,13 +7,13 @@ use std::{ }; use anyhow::{anyhow, Result}; -use clap::Parser; -use commands::{handle_command, CliHelper, Command, CommandResult}; -use log::{error, info}; -use ls_sdk::{ +use breez_liquid_sdk::{ model::Network, wallet::{Wallet, DEFAULT_DATA_DIR}, }; +use clap::Parser; +use commands::{handle_command, CliHelper, Command, CommandResult}; +use log::{error, info}; use persist::CliPersistence; use rustyline::{error::ReadlineError, hint::HistoryHinter, Editor}; diff --git a/lib/Cargo.lock b/lib/Cargo.lock index 776ade9..ce21862 100644 --- a/lib/Cargo.lock +++ b/lib/Cargo.lock @@ -483,6 +483,37 @@ dependencies = [ "url", ] +[[package]] +name = "breez-liquid-sdk" +version = "0.0.1" +dependencies = [ + "anyhow", + "bip39", + "boltz-client", + "flutter_rust_bridge", + "log", + "lwk_common", + "lwk_signer", + "lwk_wollet", + "openssl", + "rusqlite", + "rusqlite_migration", + "serde", + "tempdir", + "thiserror", + "uuid", +] + +[[package]] +name = "breez-liquid-sdk-bindings" +version = "0.0.1" +dependencies = [ + "anyhow", + "breez-liquid-sdk", + "thiserror", + "uniffi 0.27.1", +] + [[package]] name = "build-target" version = "0.4.0" @@ -1468,37 +1499,6 @@ version = "0.4.21" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "90ed8c1e510134f979dbc4f070f87d4313098b704861a105fe34231c70a3901c" -[[package]] -name = "ls-sdk" -version = "0.0.1" -dependencies = [ - "anyhow", - "bip39", - "boltz-client", - "flutter_rust_bridge", - "log", - "lwk_common", - "lwk_signer", - "lwk_wollet", - "openssl", - "rusqlite", - "rusqlite_migration", - "serde", - "tempdir", - "thiserror", - "uuid", -] - -[[package]] -name = "ls-sdk-bindings" -version = "0.0.1" -dependencies = [ - "anyhow", - "ls-sdk", - "thiserror", - "uniffi 0.27.1", -] - [[package]] name = "lwk_common" version = "0.3.0" diff --git a/lib/ls-sdk-bindings/Cargo.toml b/lib/ls-sdk-bindings/Cargo.toml index 75f2f83..9fdbcd7 100644 --- a/lib/ls-sdk-bindings/Cargo.toml +++ b/lib/ls-sdk-bindings/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "ls-sdk-bindings" +name = "breez-liquid-sdk-bindings" edition = "2021" version.workspace = true @@ -8,13 +8,13 @@ name = "uniffi-bindgen" path = "uniffi-bindgen.rs" [lib] -name = "ls_sdk_bindings" +name = "breez_liquid_sdk_bindings" crate-type = ["staticlib", "cdylib", "lib"] [dependencies] anyhow = { workspace = true } -ls-sdk = { path = "../ls-sdk-core" } +breez-liquid-sdk = { path = "../ls-sdk-core" } uniffi = { workspace = true, features = [ "bindgen-tests", "cli" ] } thiserror = { workspace = true } diff --git a/lib/ls-sdk-bindings/bindings-react-native/src/main.rs b/lib/ls-sdk-bindings/bindings-react-native/src/main.rs index cb87db1..3135a72 100644 --- a/lib/ls-sdk-bindings/bindings-react-native/src/main.rs +++ b/lib/ls-sdk-bindings/bindings-react-native/src/main.rs @@ -19,7 +19,7 @@ fn main() { let cli_binding_dir = cli.binding_dir.unwrap_or("../".into()); let cli_out_dir = cli.out_dir.unwrap_or("./".into()); let binding_dir = Utf8Path::new(cli_binding_dir.as_str()); - let udl_file = binding_dir.join(Utf8Path::new("src/ls_sdk.udl")); + let udl_file = binding_dir.join(Utf8Path::new("src/breez_liquid_sdk.udl")); let config = binding_dir.join(Utf8Path::new("uniffi.toml")); let out_dir = Utf8Path::new(cli_out_dir.as_str()); diff --git a/lib/ls-sdk-bindings/build.rs b/lib/ls-sdk-bindings/build.rs index c8f7a11..15a8aa6 100644 --- a/lib/ls-sdk-bindings/build.rs +++ b/lib/ls-sdk-bindings/build.rs @@ -36,5 +36,5 @@ fn setup_x86_64_android_workaround() { fn main() { setup_x86_64_android_workaround(); - uniffi::generate_scaffolding("src/ls_sdk.udl").unwrap(); + uniffi::generate_scaffolding("src/breez_liquid_sdk.udl").unwrap(); } diff --git a/lib/ls-sdk-bindings/makefile b/lib/ls-sdk-bindings/makefile index 04d343e..aa4a17b 100644 --- a/lib/ls-sdk-bindings/makefile +++ b/lib/ls-sdk-bindings/makefile @@ -34,7 +34,7 @@ all: bindings-swift bindings-android python react-native ## Android android: aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android - cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/ls_sdk.udl --no-format --language kotlin -o ffi/kotlin + cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/breez_liquid_sdk.udl --no-format --language kotlin -o ffi/kotlin aarch64-linux-android: $(SOURCES) ndk-home cargo ndk -t aarch64-linux-android -o ffi/kotlin/jniLibs build --release @@ -62,7 +62,7 @@ bindings-android: android ## Kotlin kotlin: $(SOURCES) cargo build --release --target $(TARGET) - cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/ls_sdk.udl --no-format --language kotlin -o ffi/kotlin + cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/breez_liquid_sdk.udl --no-format --language kotlin -o ffi/kotlin ## Apple ios-universal: $(SOURCES) @@ -85,18 +85,18 @@ darwin-universal: $(SOURCES) ## Swift swift-ios: ios-universal - cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/ls_sdk.udl -l swift -o ffi/swift-ios + cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/breez_liquid_sdk.udl -l swift -o ffi/swift-ios cp ../target/ios-universal/release/libls_sdk_bindings.a ffi/swift-ios cd ffi/swift-ios && "swiftc" "-emit-module" "-module-name" "ls_sdk_bindings" "-Xcc" "-fmodule-map-file=$(CURRENT_DIR)/ffi/swift-ios/ls_sdkFFI.modulemap" "-I" "." "-L" "." "-lls_sdk_bindings" ls_sdk.swift swift-darwin: darwin-universal - cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/ls_sdk.udl -l swift -o ffi/swift-darwin + cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/breez_liquid_sdk.udl -l swift -o ffi/swift-darwin cp ../target/darwin-universal/release/libls_sdk_bindings.dylib ffi/swift-darwin cd ffi/swift-darwin && "swiftc" "-emit-module" "-module-name" "ls_sdk_bindings" "-Xcc" "-fmodule-map-file=$(CURRENT_DIR)/ffi/swift-darwin/ls_sdkFFI.modulemap" "-I" "." "-L" "." "-lls_sdk_bindings" ls_sdk.swift bindings-swift: ios-universal darwin-universal mkdir -p bindings-swift/Sources/LiquidSwapSDK - cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/ls_sdk.udl --no-format --language swift -o bindings-swift/Sources/LiquidSwapSDK + cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/breez_liquid_sdk.udl --no-format --language swift -o bindings-swift/Sources/LiquidSwapSDK mv bindings-swift/Sources/LiquidSwapSDK/ls_sdk.swift bindings-swift/Sources/LiquidSwapSDK/LiquidSwapSDK.swift cp bindings-swift/Sources/LiquidSwapSDK/ls_sdkFFI.h bindings-swift/ls_sdkFFI.xcframework/ios-arm64/ls_sdkFFI.framework/Headers cp bindings-swift/Sources/LiquidSwapSDK/ls_sdkFFI.h bindings-swift/ls_sdkFFI.xcframework/ios-arm64_x86_64-simulator/ls_sdkFFI.framework/Headers @@ -110,7 +110,7 @@ bindings-swift: ios-universal darwin-universal ## Python python: $(SOURCES) cargo build --release --target $(TARGET) - cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/ls_sdk.udl --no-format --language python -o ffi/python + cargo run --features=uniffi/cli --bin uniffi-bindgen generate src/breez_liquid_sdk.udl --no-format --language python -o ffi/python ## React Native react-native: diff --git a/lib/ls-sdk-bindings/src/ls_sdk.udl b/lib/ls-sdk-bindings/src/breez_liquid_sdk.udl similarity index 98% rename from lib/ls-sdk-bindings/src/ls_sdk.udl rename to lib/ls-sdk-bindings/src/breez_liquid_sdk.udl index 0f0f7e7..9dc3fe7 100644 --- a/lib/ls-sdk-bindings/src/ls_sdk.udl +++ b/lib/ls-sdk-bindings/src/breez_liquid_sdk.udl @@ -56,7 +56,7 @@ dictionary ReceivePaymentResponse { string invoice; }; -namespace ls_sdk { +namespace breez_liquid_sdk { [Throws=LsSdkError] BindingWallet connect(string mnemonic, string? data_dir, Network network); }; diff --git a/lib/ls-sdk-bindings/src/lib.rs b/lib/ls-sdk-bindings/src/lib.rs index 313d280..5bdd08e 100644 --- a/lib/ls-sdk-bindings/src/lib.rs +++ b/lib/ls-sdk-bindings/src/lib.rs @@ -1,7 +1,7 @@ use std::sync::Arc; use anyhow::{Error, Result}; -use ls_sdk::{ +use breez_liquid_sdk::{ error::PaymentError, model::{ Network, PrepareReceiveRequest, PrepareReceiveResponse, PrepareSendResponse, @@ -78,4 +78,4 @@ impl BindingWallet { } } -uniffi::include_scaffolding!("ls_sdk"); +uniffi::include_scaffolding!("breez_liquid_sdk"); diff --git a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.kts b/lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.kts similarity index 78% rename from lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.kts rename to lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.kts index 9a1f19e..1aaee3f 100644 --- a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.kts +++ b/lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.kts @@ -1,6 +1,6 @@ try { var mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about" - var sdk = ls_sdk.connect(mnemonic, null, ls_sdk.Network.LIQUID_TESTNET) + var sdk = breez_liquid_sdk.connect(mnemonic, null, breez_liquid_sdk.Network.LIQUID_TESTNET) var nodeInfo = sdk.getInfo(false) println("$nodeInfo") assert(nodeInfo.pubkey.equals("03d902f35f560e0470c63313c7369168d9d7df2d49bf295fd9fb7cb109ccee0494")) diff --git a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.py b/lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.py similarity index 71% rename from lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.py rename to lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.py index 3ac2f72..2367783 100644 --- a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.py +++ b/lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.py @@ -1,8 +1,8 @@ -import ls_sdk +import breez_liquid_sdk def test(): mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about" - sdk = ls_sdk.connect(mnemonic, None, ls_sdk.Network.LIQUID_TESTNET) + sdk = breez_liquid_sdk.connect(mnemonic, None, breez_liquid_sdk.Network.LIQUID_TESTNET) node_info = sdk.get_info(False) print(node_info) assert node_info.pubkey == "03d902f35f560e0470c63313c7369168d9d7df2d49bf295fd9fb7cb109ccee0494" diff --git a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.swift b/lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.swift similarity index 70% rename from lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.swift rename to lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.swift index cf75c39..9ee4bfa 100644 --- a/lib/ls-sdk-bindings/tests/bindings/test_ls_sdk.swift +++ b/lib/ls-sdk-bindings/tests/bindings/test_breez_liquid_sdk.swift @@ -1,7 +1,7 @@ -import ls_sdk +import breez_liquid_sdk let mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"; -let sdk = try ls_sdk.connect(mnemonic: mnemonic, dataDir: nil, network: .liquidTestnet); +let sdk = try breez_liquid_sdk.connect(mnemonic: mnemonic, dataDir: nil, network: .liquidTestnet); let nodeInfo = try sdk.getInfo(withScan: false); print(nodeInfo); assert(nodeInfo.pubkey == "03d902f35f560e0470c63313c7369168d9d7df2d49bf295fd9fb7cb109ccee0494", "nodeInfo.pubkey"); \ No newline at end of file diff --git a/lib/ls-sdk-bindings/tests/test_generated_bindings.rs b/lib/ls-sdk-bindings/tests/test_generated_bindings.rs index 80958b0..02ec71a 100644 --- a/lib/ls-sdk-bindings/tests/test_generated_bindings.rs +++ b/lib/ls-sdk-bindings/tests/test_generated_bindings.rs @@ -1,5 +1,5 @@ uniffi::build_foreign_language_testcases!( - "tests/bindings/test_ls_sdk.swift", - "tests/bindings/test_ls_sdk.kts", - "tests/bindings/test_ls_sdk.py" + "tests/bindings/test_breez_liquid_sdk.swift", + "tests/bindings/test_breez_liquid_sdk.kts", + "tests/bindings/test_breez_liquid_sdk.py" ); diff --git a/lib/ls-sdk-bindings/uniffi.toml b/lib/ls-sdk-bindings/uniffi.toml index e9f8571..24c216a 100644 --- a/lib/ls-sdk-bindings/uniffi.toml +++ b/lib/ls-sdk-bindings/uniffi.toml @@ -1,12 +1,12 @@ # https://mozilla.github.io/uniffi-rs/swift/configuration.html [bindings.swift] -cdylib_name = "ls_sdk_bindings" +cdylib_name = "breez_liquid_sdk_bindings" # https://mozilla.github.io/uniffi-rs/kotlin/configuration.html [bindings.kotlin] -package_name = "ls_sdk" -cdylib_name = "ls_sdk_bindings" +package_name = "breez_liquid_sdk" +cdylib_name = "breez_liquid_sdk_bindings" # https://mozilla.github.io/uniffi-rs/python/configuration.html [bindings.python] -cdylib_name = "ls_sdk_bindings" +cdylib_name = "breez_liquid_sdk_bindings" diff --git a/lib/ls-sdk-core/Cargo.toml b/lib/ls-sdk-core/Cargo.toml index f907b11..750c4de 100644 --- a/lib/ls-sdk-core/Cargo.toml +++ b/lib/ls-sdk-core/Cargo.toml @@ -1,10 +1,10 @@ [package] -name = "ls-sdk" +name = "breez-liquid-sdk" edition = "2021" version.workspace = true [lib] -name = "ls_sdk" +name = "breez_liquid_sdk" [dependencies] anyhow = { workspace = true }