Skip to content

Commit 3e99138

Browse files
tankyleotankyleo
committed
Add Node::{open_0reserve_channel, open_0reserve_channel_with_all}
LSPs can now allow their clients to spend their entire channel balance. Note that LSPs will still be required to maintain a reserve on their side of the channel.
1 parent bf7713d commit 3e99138

File tree

6 files changed

+151
-35
lines changed

6 files changed

+151
-35
lines changed

‎Cargo.toml‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,17 +39,17 @@ default = []
3939
#lightning-liquidity = { version = "0.2.0", features = ["std"] }
4040
#lightning-macros = { version = "0.2.0" }
4141

42-
lightning = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7", features = ["std"] }
43-
lightning-types = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7" }
44-
lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7", features = ["std"] }
45-
lightning-net-tokio = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7" }
46-
lightning-persister = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7", features = ["tokio"] }
47-
lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7" }
48-
lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7" }
49-
lightning-block-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7", features = ["rest-client", "rpc-client", "tokio"] }
50-
lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7", features = ["esplora-async-https", "time", "electrum-rustls-ring"] }
51-
lightning-liquidity = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7", features = ["std"] }
52-
lightning-macros = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7" }
42+
lightning = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a", features = ["std"] }
43+
lightning-types = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a" }
44+
lightning-invoice = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a", features = ["std"] }
45+
lightning-net-tokio = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a" }
46+
lightning-persister = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a", features = ["tokio"] }
47+
lightning-background-processor = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a" }
48+
lightning-rapid-gossip-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a" }
49+
lightning-block-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a", features = ["rest-client", "rpc-client", "tokio"] }
50+
lightning-transaction-sync = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a", features = ["esplora-async-https", "time", "electrum-rustls-ring"] }
51+
lightning-liquidity = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a", features = ["std"] }
52+
lightning-macros = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a" }
5353

5454
bdk_chain = { version = "0.23.0", default-features = false, features = ["std"] }
5555
bdk_esplora = { version = "0.22.0", default-features = false, features = ["async-https-rustls", "tokio"]}
@@ -79,13 +79,13 @@ async-trait = { version = "0.1", default-features = false }
7979
vss-client = { package = "vss-client-ng", version = "0.5" }
8080
prost = { version = "0.11.6", default-features = false}
8181
#bitcoin-payment-instructions = { version = "0.6" }
82-
bitcoin-payment-instructions = { git = "https://github.com/joostjager/bitcoin-payment-instructions", branch = "ldk-dcf0c203e166da2348bef12b2e5eff4a250cdec7" }
82+
bitcoin-payment-instructions = { git = "https://github.com/tankyleo/bitcoin-payment-instructions", rev = "654c25c2c1234fadf01adec1554497610f554f09" }
8383

8484
[target.'cfg(windows)'.dependencies]
8585
winapi = { version = "0.3", features = ["winbase"] }
8686

8787
[dev-dependencies]
88-
lightning = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "dcf0c203e166da2348bef12b2e5eff4a250cdec7", features = ["std", "_test_utils"] }
88+
lightning = { git = "https://github.com/lightningdevkit/rust-lightning", rev = "688544da72cb348e4405d39a75e4d81102c1278a", features = ["std", "_test_utils"] }
8989
rand = { version = "0.9.2", default-features = false, features = ["std", "thread_rng", "os_rng"] }
9090
proptest = "1.0.0"
9191
regex = "1.5.6"

‎bindings/ldk_node.udl‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,10 @@ interface Node {
113113
[Throws=NodeError]
114114
UserChannelId open_announced_channel_with_all(PublicKey node_id, SocketAddress address, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
115115
[Throws=NodeError]
116+
UserChannelId open_0reserve_channel(PublicKey node_id, SocketAddress address, u64 channel_amount_sats, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
117+
[Throws=NodeError]
118+
UserChannelId open_0reserve_channel_with_all(PublicKey node_id, SocketAddress address, u64? push_to_counterparty_msat, ChannelConfig? channel_config);
119+
[Throws=NodeError]
116120
void splice_in([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id, u64 splice_amount_sats);
117121
[Throws=NodeError]
118122
void splice_in_with_all([ByRef]UserChannelId user_channel_id, PublicKey counterparty_node_id);

‎src/event.rs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ use lightning::events::{
2222
ReplayEvent,
2323
};
2424
use lightning::impl_writeable_tlv_based_enum;
25-
use lightning::ln::channelmanager::PaymentId;
25+
use lightning::ln::channelmanager::{PaymentId, TrustedChannelFeatures};
2626
use lightning::ln::types::ChannelId;
2727
use lightning::routing::gossip::NodeId;
2828
use lightning::sign::EntropySource;
@@ -1285,10 +1285,11 @@ where
12851285
}
12861286
}
12871287
let res = if allow_0conf {
1288-
self.channel_manager.accept_inbound_channel_from_trusted_peer_0conf(
1288+
self.channel_manager.accept_inbound_channel_from_trusted_peer(
12891289
&temporary_channel_id,
12901290
&counterparty_node_id,
12911291
user_channel_id,
1292+
TrustedChannelFeatures::ZeroConf,
12921293
channel_override_config,
12931294
)
12941295
} else {

‎src/lib.rs‎

Lines changed: 99 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1128,7 +1128,7 @@ impl Node {
11281128
fn open_channel_inner(
11291129
&self, node_id: PublicKey, address: SocketAddress, channel_amount_sats: FundingAmount,
11301130
push_to_counterparty_msat: Option<u64>, channel_config: Option<ChannelConfig>,
1131-
announce_for_forwarding: bool,
1131+
announce_for_forwarding: bool, set_0reserve: bool,
11321132
) -> Result<UserChannelId, Error> {
11331133
if !*self.is_running.read().unwrap() {
11341134
return Err(Error::NotRunning);
@@ -1196,25 +1196,46 @@ impl Node {
11961196
self.keys_manager.get_secure_random_bytes()[..16].try_into().unwrap(),
11971197
);
11981198

1199-
match self.channel_manager.create_channel(
1200-
peer_info.node_id,
1201-
channel_amount_sats,
1202-
push_msat,
1203-
user_channel_id,
1204-
None,
1205-
Some(user_config),
1206-
) {
1199+
let result = if set_0reserve {
1200+
self.channel_manager.create_channel_to_trusted_peer_0reserve(
1201+
peer_info.node_id,
1202+
channel_amount_sats,
1203+
push_msat,
1204+
user_channel_id,
1205+
None,
1206+
Some(user_config),
1207+
)
1208+
} else {
1209+
self.channel_manager.create_channel(
1210+
peer_info.node_id,
1211+
channel_amount_sats,
1212+
push_msat,
1213+
user_channel_id,
1214+
None,
1215+
Some(user_config),
1216+
)
1217+
};
1218+
1219+
let zero_reserve_string = if set_0reserve { "0reserve " } else { "" };
1220+
1221+
match result {
12071222
Ok(_) => {
12081223
log_info!(
12091224
self.logger,
1210-
"Initiated channel creation with peer {}. ",
1225+
"Initiated {}channel creation with peer {}. ",
1226+
zero_reserve_string,
12111227
peer_info.node_id
12121228
);
12131229
self.peer_store.add_peer(peer_info)?;
12141230
Ok(UserChannelId(user_channel_id))
12151231
},
12161232
Err(e) => {
1217-
log_error!(self.logger, "Failed to initiate channel creation: {:?}", e);
1233+
log_error!(
1234+
self.logger,
1235+
"Failed to initiate {}channel creation: {:?}",
1236+
zero_reserve_string,
1237+
e
1238+
);
12181239
Err(Error::ChannelCreationFailed)
12191240
},
12201241
}
@@ -1290,6 +1311,7 @@ impl Node {
12901311
push_to_counterparty_msat,
12911312
channel_config,
12921313
false,
1314+
false,
12931315
)
12941316
}
12951317

@@ -1330,6 +1352,7 @@ impl Node {
13301352
push_to_counterparty_msat,
13311353
channel_config,
13321354
true,
1355+
false,
13331356
)
13341357
}
13351358

@@ -1358,6 +1381,7 @@ impl Node {
13581381
push_to_counterparty_msat,
13591382
channel_config,
13601383
false,
1384+
false,
13611385
)
13621386
}
13631387

@@ -1395,6 +1419,70 @@ impl Node {
13951419
push_to_counterparty_msat,
13961420
channel_config,
13971421
true,
1422+
false,
1423+
)
1424+
}
1425+
1426+
/// Connect to a node and open a new unannounced channel, in which the target node can
1427+
/// spend its entire balance.
1428+
///
1429+
/// This channel allows the target node to try to steal your funds with no financial
1430+
/// penalty, so this channel should only be opened to nodes you trust.
1431+
///
1432+
/// Disconnects and reconnects are handled automatically.
1433+
///
1434+
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
1435+
/// channel counterparty on channel open. This can be useful to start out with the balance not
1436+
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
1437+
///
1438+
/// If Anchor channels are enabled, this will ensure the configured
1439+
/// [`AnchorChannelsConfig::per_channel_reserve_sats`] is available and will be retained before
1440+
/// opening the channel.
1441+
///
1442+
/// Returns a [`UserChannelId`] allowing to locally keep track of the channel.
1443+
///
1444+
/// [`AnchorChannelsConfig::per_channel_reserve_sats`]: crate::config::AnchorChannelsConfig::per_channel_reserve_sats
1445+
pub fn open_0reserve_channel(
1446+
&self, node_id: PublicKey, address: SocketAddress, channel_amount_sats: u64,
1447+
push_to_counterparty_msat: Option<u64>, channel_config: Option<ChannelConfig>,
1448+
) -> Result<UserChannelId, Error> {
1449+
self.open_channel_inner(
1450+
node_id,
1451+
address,
1452+
FundingAmount::Exact { amount_sats: channel_amount_sats },
1453+
push_to_counterparty_msat,
1454+
channel_config,
1455+
false,
1456+
true,
1457+
)
1458+
}
1459+
1460+
/// Connect to a node and open a new unannounced channel, using all available on-chain funds
1461+
/// minus fees and anchor reserves. The target node will be able to spend its entire channel
1462+
/// balance.
1463+
///
1464+
/// This channel allows the target node to try to steal your funds with no financial
1465+
/// penalty, so this channel should only be opened to nodes you trust.
1466+
///
1467+
/// Disconnects and reconnects are handled automatically.
1468+
///
1469+
/// If `push_to_counterparty_msat` is set, the given value will be pushed (read: sent) to the
1470+
/// channel counterparty on channel open. This can be useful to start out with the balance not
1471+
/// entirely shifted to one side, therefore allowing to receive payments from the getgo.
1472+
///
1473+
/// Returns a [`UserChannelId`] allowing to locally keep track of the channel.
1474+
pub fn open_0reserve_channel_with_all(
1475+
&self, node_id: PublicKey, address: SocketAddress, push_to_counterparty_msat: Option<u64>,
1476+
channel_config: Option<ChannelConfig>,
1477+
) -> Result<UserChannelId, Error> {
1478+
self.open_channel_inner(
1479+
node_id,
1480+
address,
1481+
FundingAmount::Max,
1482+
push_to_counterparty_msat,
1483+
channel_config,
1484+
false,
1485+
true,
13981486
)
13991487
}
14001488

‎src/liquidity.rs‎

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,10 @@ pub struct LSPS2ServiceConfig {
142142
///
143143
/// [`bLIP-52`]: https://github.com/lightning/blips/blob/master/blip-0052.md#trust-models
144144
pub client_trusts_lsp: bool,
145+
/// When set, clients that we open channels to will be allowed to spend their entire channel
146+
/// balance. This allows clients to try to steal your funds with no financial penalty, so
147+
/// this should only be set if you trust your clients.
148+
pub allow_client_0reserve: bool,
145149
}
146150

147151
pub(crate) struct LiquiditySourceBuilder<L: Deref>
@@ -786,22 +790,38 @@ where
786790
config.channel_config.forwarding_fee_base_msat = 0;
787791
config.channel_config.forwarding_fee_proportional_millionths = 0;
788792

789-
match self.channel_manager.create_channel(
790-
their_network_key,
791-
channel_amount_sats,
792-
0,
793-
user_channel_id,
794-
None,
795-
Some(config),
796-
) {
793+
let result = if service_config.allow_client_0reserve {
794+
self.channel_manager.create_channel_to_trusted_peer_0reserve(
795+
their_network_key,
796+
channel_amount_sats,
797+
0,
798+
user_channel_id,
799+
None,
800+
Some(config),
801+
)
802+
} else {
803+
self.channel_manager.create_channel(
804+
their_network_key,
805+
channel_amount_sats,
806+
0,
807+
user_channel_id,
808+
None,
809+
Some(config),
810+
)
811+
};
812+
813+
match result {
797814
Ok(_) => {},
798815
Err(e) => {
799816
// TODO: We just silently fail here. Eventually we will need to remember
800817
// the pending requests and regularly retry opening the channel until we
801818
// succeed.
819+
let zero_reserve_string =
820+
if service_config.allow_client_0reserve { "0reserve " } else { "" };
802821
log_error!(
803822
self.logger,
804-
"Failed to open LSPS2 channel to {}: {:?}",
823+
"Failed to open LSPS2 {}channel to {}: {:?}",
824+
zero_reserve_string,
805825
their_network_key,
806826
e
807827
);

‎tests/integration_tests_rust.rs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1705,6 +1705,7 @@ async fn do_lsps2_client_service_integration(client_trusts_lsp: bool) {
17051705
min_channel_opening_fee_msat: 0,
17061706
max_client_to_self_delay: 1024,
17071707
client_trusts_lsp,
1708+
allow_client_0reserve: false,
17081709
};
17091710

17101711
let service_config = random_config(true);
@@ -2023,6 +2024,7 @@ async fn lsps2_client_trusts_lsp() {
20232024
min_channel_opening_fee_msat: 0,
20242025
max_client_to_self_delay: 1024,
20252026
client_trusts_lsp: true,
2027+
allow_client_0reserve: false,
20262028
};
20272029

20282030
let service_config = random_config(true);
@@ -2197,6 +2199,7 @@ async fn lsps2_lsp_trusts_client_but_client_does_not_claim() {
21972199
min_channel_opening_fee_msat: 0,
21982200
max_client_to_self_delay: 1024,
21992201
client_trusts_lsp: false,
2202+
allow_client_0reserve: false,
22002203
};
22012204

22022205
let service_config = random_config(true);

0 commit comments

Comments
 (0)