-
Notifications
You must be signed in to change notification settings - Fork 412
LSPS1: Service refactor - Part 1 #3864
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
martinsaposnic
wants to merge
1
commit into
lightningdevkit:main
Choose a base branch
from
martinsaposnic:lsps1-service-refactor-first-pass
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+249
−41
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,242 @@ | ||
| #![cfg(all(test, feature = "std"))] | ||
|
|
||
| mod common; | ||
|
|
||
| #[cfg(lsps1_service)] | ||
| use { | ||
| bitcoin::secp256k1::SecretKey, | ||
| common::create_service_and_client_nodes, | ||
| common::{get_lsps_message, Node}, | ||
| lightning::ln::peer_handler::CustomMessageHandler, | ||
| lightning_liquidity::events::LiquidityEvent, | ||
| lightning_liquidity::lsps0::ser::LSPSDateTime, | ||
| lightning_liquidity::lsps1::client::LSPS1ClientConfig, | ||
| lightning_liquidity::lsps1::event::LSPS1ClientEvent, | ||
| lightning_liquidity::lsps1::event::LSPS1ServiceEvent, | ||
| lightning_liquidity::lsps1::msgs::LSPS1OrderState, | ||
| lightning_liquidity::lsps1::msgs::{ | ||
| LSPS1OnchainPaymentInfo, LSPS1Options, LSPS1OrderParams, LSPS1PaymentInfo, | ||
| }, | ||
| lightning_liquidity::lsps1::service::LSPS1ServiceConfig, | ||
| lightning_liquidity::{LiquidityClientConfig, LiquidityServiceConfig}, | ||
| std::str::FromStr, | ||
| }; | ||
|
|
||
| #[cfg(lsps1_service)] | ||
| fn setup_test_lsps1( | ||
| persist_dir: &str, _supported_options: LSPS1Options, | ||
| ) -> (bitcoin::secp256k1::PublicKey, bitcoin::secp256k1::PublicKey, Node, Node, [u8; 32]) { | ||
| let promise_secret = [42; 32]; | ||
| let signing_key = SecretKey::from_slice(&promise_secret).unwrap(); | ||
|
|
||
| let lsps1_service_config = | ||
| LSPS1ServiceConfig { token: None, supported_options: Some(_supported_options) }; | ||
| let service_config: LiquidityServiceConfig = LiquidityServiceConfig { | ||
| lsps1_service_config: Some(lsps1_service_config), | ||
| lsps2_service_config: None, | ||
| advertise_service: true, | ||
| }; | ||
|
|
||
| let lsps1_client_config = LSPS1ClientConfig { max_channel_fees_msat: None }; | ||
| let client_config = LiquidityClientConfig { | ||
| lsps1_client_config: Some(lsps1_client_config), | ||
| lsps2_client_config: None, | ||
| }; | ||
|
|
||
| let (service_node, client_node) = | ||
| create_service_and_client_nodes(persist_dir, service_config, client_config); | ||
|
|
||
| let secp = bitcoin::secp256k1::Secp256k1::new(); | ||
| let service_node_id = bitcoin::secp256k1::PublicKey::from_secret_key(&secp, &signing_key); | ||
| let client_node_id = client_node.channel_manager.get_our_node_id(); | ||
|
|
||
| (service_node_id, client_node_id, service_node, client_node, promise_secret) | ||
| } | ||
|
|
||
| #[cfg(lsps1_service)] | ||
| #[test] | ||
| fn lsps1_happy_path() { | ||
| let expected_options_supported = LSPS1Options { | ||
| min_required_channel_confirmations: 0, | ||
| min_funding_confirms_within_blocks: 6, | ||
| supports_zero_channel_reserve: true, | ||
| max_channel_expiry_blocks: 144, | ||
| min_initial_client_balance_sat: 10_000_000, | ||
| max_initial_client_balance_sat: 100_000_000, | ||
| min_initial_lsp_balance_sat: 100_000, | ||
| max_initial_lsp_balance_sat: 100_000_000, | ||
| min_channel_balance_sat: 100_000, | ||
| max_channel_balance_sat: 100_000_000, | ||
| }; | ||
|
|
||
| let (service_node_id, client_node_id, service_node, client_node, _) = | ||
| setup_test_lsps1("lsps1_happy_path", expected_options_supported.clone()); | ||
|
|
||
| let client_handler = client_node.liquidity_manager.lsps1_client_handler().unwrap(); | ||
|
|
||
| let service_handler = service_node.liquidity_manager.lsps1_service_handler().unwrap(); | ||
|
|
||
| let request_supported_options_id = client_handler.request_supported_options(service_node_id); | ||
| let request_supported_options = get_lsps_message!(client_node, service_node_id); | ||
|
|
||
| service_node | ||
| .liquidity_manager | ||
| .handle_custom_message(request_supported_options, client_node_id) | ||
| .unwrap(); | ||
|
|
||
| let get_info_message = get_lsps_message!(service_node, client_node_id); | ||
|
|
||
| client_node.liquidity_manager.handle_custom_message(get_info_message, service_node_id).unwrap(); | ||
|
|
||
| let get_info_event = client_node.liquidity_manager.next_event().unwrap(); | ||
| if let LiquidityEvent::LSPS1Client(LSPS1ClientEvent::SupportedOptionsReady { | ||
| request_id, | ||
| counterparty_node_id, | ||
| supported_options, | ||
| }) = get_info_event | ||
| { | ||
| assert_eq!(request_id, request_supported_options_id); | ||
| assert_eq!(counterparty_node_id, service_node_id); | ||
| assert_eq!(expected_options_supported, supported_options); | ||
| } else { | ||
| panic!("Unexpected event"); | ||
| } | ||
|
|
||
| let order_params = LSPS1OrderParams { | ||
| lsp_balance_sat: 100_000, | ||
| client_balance_sat: 10_000_000, | ||
| required_channel_confirmations: 0, | ||
| funding_confirms_within_blocks: 6, | ||
| channel_expiry_blocks: 144, | ||
| token: None, | ||
| announce_channel: true, | ||
| }; | ||
|
|
||
| let _create_order_id = | ||
| client_handler.create_order(&service_node_id, order_params.clone(), None); | ||
| let create_order = get_lsps_message!(client_node, service_node_id); | ||
|
|
||
| service_node.liquidity_manager.handle_custom_message(create_order, client_node_id).unwrap(); | ||
|
|
||
| let _request_for_payment_event = service_node.liquidity_manager.next_event().unwrap(); | ||
|
|
||
| if let LiquidityEvent::LSPS1Service(LSPS1ServiceEvent::RequestForPaymentDetails { | ||
| request_id, | ||
| counterparty_node_id, | ||
| order, | ||
| }) = _request_for_payment_event | ||
| { | ||
| assert_eq!(request_id, _create_order_id.clone()); | ||
| assert_eq!(counterparty_node_id, client_node_id); | ||
| assert_eq!(order, order_params); | ||
| } else { | ||
| panic!("Unexpected event"); | ||
| } | ||
|
|
||
| let json_str = r#"{ | ||
| "state": "EXPECT_PAYMENT", | ||
| "expires_at": "2025-01-01T00:00:00Z", | ||
| "fee_total_sat": "9999", | ||
| "order_total_sat": "200999", | ||
| "address": "bc1p5uvtaxzkjwvey2tfy49k5vtqfpjmrgm09cvs88ezyy8h2zv7jhas9tu4yr", | ||
| "min_onchain_payment_confirmations": 1, | ||
| "min_fee_for_0conf": 253 | ||
| }"#; | ||
|
|
||
| let onchain: LSPS1OnchainPaymentInfo = | ||
| serde_json::from_str(json_str).expect("Failed to parse JSON"); | ||
| let payment_info = LSPS1PaymentInfo { bolt11: None, bolt12: None, onchain: Some(onchain) }; | ||
| let _now = LSPSDateTime::from_str("2024-01-01T00:00:00Z").expect("Failed to parse date"); | ||
|
|
||
| let _ = service_handler | ||
| .send_payment_details(_create_order_id.clone(), &client_node_id, payment_info.clone(), _now) | ||
| .unwrap(); | ||
|
|
||
| let create_order_response = get_lsps_message!(service_node, client_node_id); | ||
|
|
||
| client_node | ||
| .liquidity_manager | ||
| .handle_custom_message(create_order_response, service_node_id) | ||
| .unwrap(); | ||
|
|
||
| let order_created_event = client_node.liquidity_manager.next_event().unwrap(); | ||
| let expected_order_id = if let LiquidityEvent::LSPS1Client(LSPS1ClientEvent::OrderCreated { | ||
| request_id, | ||
| counterparty_node_id, | ||
| order_id, | ||
| order, | ||
| payment, | ||
| channel, | ||
| }) = order_created_event | ||
| { | ||
| assert_eq!(request_id, _create_order_id); | ||
| assert_eq!(counterparty_node_id, service_node_id); | ||
| assert_eq!(order, order_params); | ||
| assert_eq!(payment, payment_info); | ||
| assert!(channel.is_none()); | ||
| order_id | ||
| } else { | ||
| panic!("Unexpected event"); | ||
| }; | ||
|
|
||
| let check_order_status_id = | ||
| client_handler.check_order_status(&service_node_id, expected_order_id.clone()); | ||
| let check_order_status = get_lsps_message!(client_node, service_node_id); | ||
|
|
||
| service_node | ||
| .liquidity_manager | ||
| .handle_custom_message(check_order_status, client_node_id) | ||
| .unwrap(); | ||
|
|
||
| let _check_payment_confirmation_event = service_node.liquidity_manager.next_event().unwrap(); | ||
|
|
||
| if let LiquidityEvent::LSPS1Service(LSPS1ServiceEvent::CheckPaymentConfirmation { | ||
| request_id, | ||
| counterparty_node_id, | ||
| order_id, | ||
| }) = _check_payment_confirmation_event | ||
| { | ||
| assert_eq!(request_id, check_order_status_id); | ||
| assert_eq!(counterparty_node_id, client_node_id); | ||
| assert_eq!(order_id, expected_order_id.clone()); | ||
| } else { | ||
| panic!("Unexpected event"); | ||
| } | ||
|
|
||
| let _ = service_handler | ||
| .update_order_status( | ||
| check_order_status_id.clone(), | ||
| client_node_id, | ||
| expected_order_id.clone(), | ||
| LSPS1OrderState::Created, | ||
| None, | ||
| ) | ||
| .unwrap(); | ||
|
|
||
| let order_status_response = get_lsps_message!(service_node, client_node_id); | ||
|
|
||
| client_node | ||
| .liquidity_manager | ||
| .handle_custom_message(order_status_response, service_node_id) | ||
| .unwrap(); | ||
|
|
||
| let order_status_event = client_node.liquidity_manager.next_event().unwrap(); | ||
| if let LiquidityEvent::LSPS1Client(LSPS1ClientEvent::OrderStatus { | ||
| request_id, | ||
| counterparty_node_id, | ||
| order_id, | ||
| order, | ||
| payment, | ||
| channel, | ||
| }) = order_status_event | ||
| { | ||
| assert_eq!(request_id, check_order_status_id); | ||
| assert_eq!(counterparty_node_id, service_node_id); | ||
| assert_eq!(order, order_params); | ||
| assert_eq!(payment, payment_info); | ||
| assert!(channel.is_none()); | ||
| assert_eq!(order_id, expected_order_id); | ||
| } else { | ||
| panic!("Unexpected event"); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please leave these object references here, as we'll need them for when we implement tracking of on-chain payments.