Implement external input parsing

breez · Dec 11, 2024 · 6d13f25 · 6d13f25
1 parent 1bf5be4
commit 6d13f25
Show file tree

Hide file tree

Showing 16 changed files with 217 additions and 147 deletions.
diff --git a/cli/Cargo.lock b/cli/Cargo.lock
diff --git a/cli/src/commands.rs b/cli/src/commands.rs
@@ -298,7 +298,7 @@ pub(crate) async fn handle_command(
             let mut result = command_result!(&response);
             result.push('\n');
 
-            match parse(&response.destination).await? {
+            match parse(&response.destination, None).await? {
                 InputType::Bolt11 { invoice } => result.push_str(&build_qr_text(&invoice.bolt11)),
                 InputType::LiquidAddress { address } => {
                     result.push_str(&build_qr_text(&address.to_uri().map_err(|e| {
@@ -574,14 +574,14 @@ pub(crate) async fn handle_command(
             command_result!("Liquid SDK instance disconnected")
         }
         Command::Parse { input } => {
-            let res = LiquidSdk::parse(&input).await?;
+            let res = sdk.parse(&input).await?;
             command_result!(res)
         }
         Command::LnurlPay {
             lnurl,
             validate_success_url,
         } => {
-            let input = LiquidSdk::parse(&lnurl).await?;
+            let input = sdk.parse(&lnurl).await?;
             let res = match input {
                 InputType::LnUrlPay { data: pd } => {
                     let prompt = format!(
@@ -618,7 +618,7 @@ pub(crate) async fn handle_command(
             command_result!(res)
         }
         Command::LnurlWithdraw { lnurl } => {
-            let input = LiquidSdk::parse(&lnurl).await?;
+            let input = sdk.parse(&lnurl).await?;
             let res = match input {
                 InputType::LnUrlWithdraw { data: pd } => {
                     let prompt = format!(
@@ -644,7 +644,7 @@ pub(crate) async fn handle_command(
         Command::LnurlAuth { lnurl } => {
             let lnurl_endpoint = lnurl.trim();
 
-            let res = match parse(lnurl_endpoint).await? {
+            let res = match parse(lnurl_endpoint, None).await? {
                 InputType::LnUrlAuth { data: ad } => {
                     let auth_res = sdk.lnurl_auth(ad).await?;
                     serde_json::to_string_pretty(&auth_res).map_err(|e| e.into())

diff --git a/lib/Cargo.lock b/lib/Cargo.lock
diff --git a/lib/bindings/langs/flutter/breez_sdk_liquid/include/breez_sdk_liquid.h b/lib/bindings/langs/flutter/breez_sdk_liquid/include/breez_sdk_liquid.h
@@ -1091,6 +1091,10 @@ void frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_lnurl_withdraw(
                                                                                 uintptr_t that,
                                                                                 struct wire_cst_ln_url_withdraw_request *req);
 
+void frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_parse(int64_t port_,
+                                                                       uintptr_t that,
+                                                                       struct wire_cst_list_prim_u_8_strict *input);
+
 void frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_pay_onchain(int64_t port_,
                                                                              uintptr_t that,
                                                                              struct wire_cst_pay_onchain_request *req);
@@ -1166,9 +1170,6 @@ void frbgen_breez_liquid_wire__crate__bindings__connect(int64_t port_,
 WireSyncRust2DartDco frbgen_breez_liquid_wire__crate__bindings__default_config(int32_t network,
                                                                                struct wire_cst_list_prim_u_8_strict *breez_api_key);
 
-void frbgen_breez_liquid_wire__crate__bindings__parse(int64_t port_,
-                                                      struct wire_cst_list_prim_u_8_strict *input);
-
 WireSyncRust2DartDco frbgen_breez_liquid_wire__crate__bindings__parse_invoice(struct wire_cst_list_prim_u_8_strict *input);
 
 void frbgen_breez_liquid_rust_arc_increment_strong_count_RustOpaque_flutter_rust_bridgefor_generatedRustAutoOpaqueInnerBindingLiquidSdk(const void *ptr);
@@ -1381,6 +1382,7 @@ static int64_t dummy_method_to_enforce_bundling(void) {
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_lnurl_auth);
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_lnurl_pay);
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_lnurl_withdraw);
+    dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_parse);
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_pay_onchain);
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_prepare_buy_bitcoin);
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__BindingLiquidSdk_prepare_lnurl_pay);
@@ -1402,7 +1404,6 @@ static int64_t dummy_method_to_enforce_bundling(void) {
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__breez_log_stream);
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__connect);
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__default_config);
-    dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__parse);
     dummy_var ^= ((int64_t) (void*) frbgen_breez_liquid_wire__crate__bindings__parse_invoice);
     dummy_var ^= ((int64_t) (void*) store_dart_post_cobject);
     return dummy_var;

diff --git a/lib/bindings/src/breez_sdk_liquid.udl b/lib/bindings/src/breez_sdk_liquid.udl
@@ -629,6 +629,12 @@ dictionary LogEntry {
     string level;
 };
 
+dictionary ExternalInputParser {
+    string provider_id;
+    string input_regex;
+    string parser_url;
+};
+
 namespace breez_sdk_liquid {
     [Throws=SdkError]
     BindingLiquidSdk connect(ConnectRequest req);
@@ -642,9 +648,6 @@ namespace breez_sdk_liquid {
     [Throws=SdkError]
     Config default_config(LiquidNetwork network, string? breez_api_key);
 
-    [Throws=PaymentError]
-    InputType parse(string input);
-
     [Throws=PaymentError]
     LNInvoice parse_invoice(string input);
 };
@@ -690,6 +693,11 @@ interface BindingLiquidSdk {
     [Throws=SdkError]
     CheckMessageResponse check_message(CheckMessageRequest req);
 
+    void set_external_input_parsers(sequence<ExternalInputParser> external_input_parsers);
+
+    [Throws=PaymentError]
+    InputType parse(string input);
+
     [Throws=PaymentError]
     PrepareSendResponse prepare_send_payment(PrepareSendRequest req);
 

diff --git a/lib/bindings/src/lib.rs b/lib/bindings/src/lib.rs
@@ -71,9 +71,6 @@ pub fn default_config(
     LiquidSdk::default_config(network, breez_api_key)
 }
 
-pub fn parse(input: String) -> Result<InputType, PaymentError> {
-    rt().block_on(async { LiquidSdk::parse(&input).await })
-}
 pub fn parse_invoice(input: String) -> Result<LNInvoice, PaymentError> {
     LiquidSdk::parse_invoice(&input)
 }
@@ -103,6 +100,18 @@ impl BindingLiquidSdk {
         self.sdk.check_message(&req)
     }
 
+    pub fn set_external_input_parsers(&self, external_input_parsers: Vec<ExternalInputParser>) {
+        rt().block_on(async {
+            self.sdk
+                .set_external_input_parsers(external_input_parsers)
+                .await
+        });
+    }
+
+    pub fn parse(&self, input: String) -> Result<InputType, PaymentError> {
+        rt().block_on(async { self.sdk.parse(&input).await })
+    }
+
     pub fn prepare_send_payment(
         &self,
         req: PrepareSendRequest,

diff --git a/lib/core/Cargo.toml b/lib/core/Cargo.toml
@@ -21,7 +21,7 @@ boltz-client = { git = "https://github.com/SatoshiPortal/boltz-rust", branch = "
 chrono = "0.4"
 env_logger = "0.11"
 flutter_rust_bridge = { version = "=2.4.0", features = [
-  "chrono",
+    "chrono",
 ], optional = true }
 # We need at least lightning v0.0.125 for the Bolt12 structs. The lightning version from sdk-common is too old (v0.0.118, matching vls-core).
 lightning = "0.0.125"
@@ -32,7 +32,7 @@ lwk_wollet = { git = "https://github.com/dangeross/lwk", branch = "savage-full-s
 #lwk_wollet = "0.7.0"
 rusqlite = { version = "0.31", features = ["backup", "bundled"] }
 rusqlite_migration = "1.0"
-sdk-common = { git = "https://github.com/breez/breez-sdk", rev = "5955216ec4ed003972b4473a77207dfb744da882", features = ["liquid"]}
+sdk-common = { git = "https://github.com/breez/breez-sdk", rev = "98e7994e40ebfec4b0b76632b4beeacd0ff73a34", features = ["liquid"] }
 serde = { version = "1.0.197", features = ["derive"] }
 serde_json = "1.0.116"
 strum = "0.25"
@@ -44,8 +44,8 @@ tokio = { version = "1", features = ["rt", "macros"] }
 tokio-stream = { version = "0.1.14", features = ["sync"] }
 url = "2.5.0"
 futures-util = { version = "0.3.28", default-features = false, features = [
-  "sink",
-  "std",
+    "sink",
+    "std",
 ] }
 async-trait = "0.1.80"
 hex = "0.4"

diff --git a/lib/core/src/bindings.rs b/lib/core/src/bindings.rs
@@ -66,10 +66,6 @@ pub fn default_config(
     LiquidSdk::default_config(network, breez_api_key)
 }
 
-pub async fn parse(input: String) -> Result<InputType, PaymentError> {
-    LiquidSdk::parse(&input).await
-}
-
 #[frb(sync)]
 pub fn parse_invoice(input: String) -> Result<LNInvoice, PaymentError> {
     LiquidSdk::parse_invoice(&input)
@@ -97,6 +93,10 @@ impl BindingLiquidSdk {
         self.sdk.check_message(&req)
     }
 
+    pub async fn parse(&self, input: String) -> Result<InputType, PaymentError> {
+        self.sdk.parse(&input).await
+    }
+
     pub async fn add_event_listener(
         &self,
         listener: StreamSink<SdkEvent>,