forked from ElementsProject/lightning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
peer_control.c
3404 lines (3004 loc) · 103 KB
/
peer_control.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "config.h"
#include <arpa/inet.h>
#include <bitcoin/feerate.h>
#include <bitcoin/script.h>
#include <bitcoin/tx.h>
#include <ccan/array_size/array_size.h>
#include <ccan/cast/cast.h>
#include <ccan/io/io.h>
#include <ccan/mem/mem.h>
#include <ccan/noerr/noerr.h>
#include <ccan/str/str.h>
#include <ccan/take/take.h>
#include <ccan/tal/str/str.h>
#include <channeld/channeld_wiregen.h>
#include <common/addr.h>
#include <common/closing_fee.h>
#include <common/configdir.h>
#include <common/dev_disconnect.h>
#include <common/features.h>
#include <common/htlc_trim.h>
#include <common/initial_commit_tx.h>
#include <common/json_command.h>
#include <common/json_param.h>
#include <common/jsonrpc_errors.h>
#include <common/key_derive.h>
#include <common/scb_wiregen.h>
#include <common/shutdown_scriptpubkey.h>
#include <common/status.h>
#include <common/timeout.h>
#include <common/type_to_string.h>
#include <common/utils.h>
#include <common/version.h>
#include <common/wire_error.h>
#include <connectd/connectd_wiregen.h>
#include <errno.h>
#include <fcntl.h>
#include <gossipd/gossipd_wiregen.h>
#include <hsmd/hsmd_wiregen.h>
#include <inttypes.h>
#include <lightningd/anchorspend.h>
#include <lightningd/bitcoind.h>
#include <lightningd/chaintopology.h>
#include <lightningd/channel.h>
#include <lightningd/channel_control.h>
#include <lightningd/closing_control.h>
#include <lightningd/connect_control.h>
#include <lightningd/dual_open_control.h>
#include <lightningd/gossip_control.h>
#include <lightningd/hsm_control.h>
#include <lightningd/jsonrpc.h>
#include <lightningd/lightningd.h>
#include <lightningd/log.h>
#include <lightningd/memdump.h>
#include <lightningd/notification.h>
#include <lightningd/onchain_control.h>
#include <lightningd/opening_common.h>
#include <lightningd/opening_control.h>
#include <lightningd/options.h>
#include <lightningd/peer_control.h>
#include <lightningd/peer_fd.h>
#include <lightningd/peer_htlcs.h>
#include <lightningd/plugin_hook.h>
#include <lightningd/subd.h>
#include <limits.h>
#include <onchaind/onchaind_wiregen.h>
#include <openingd/dualopend_wiregen.h>
#include <openingd/openingd_wiregen.h>
#include <stdlib.h>
#include <unistd.h>
#include <wally_bip32.h>
#include <wire/onion_wire.h>
#include <wire/wire_sync.h>
static void destroy_peer(struct peer *peer)
{
peer_node_id_map_del(peer->ld->peers, peer);
if (peer->dbid)
peer_dbid_map_del(peer->ld->peers_by_dbid, peer);
}
void peer_set_dbid(struct peer *peer, u64 dbid)
{
assert(!peer->dbid);
assert(dbid);
peer->dbid = dbid;
peer_dbid_map_add(peer->ld->peers_by_dbid, peer);
}
struct peer *new_peer(struct lightningd *ld, u64 dbid,
const struct node_id *id,
const struct wireaddr_internal *addr,
const u8 *their_features,
bool connected_incoming)
{
/* We are owned by our channels, and freed manually by destroy_channel */
struct peer *peer = tal(NULL, struct peer);
peer->ld = ld;
peer->dbid = dbid;
peer->id = *id;
peer->uncommitted_channel = NULL;
peer->addr = *addr;
peer->connected_incoming = connected_incoming;
peer->remote_addr = NULL;
list_head_init(&peer->channels);
peer->direction = node_id_idx(&peer->ld->id, &peer->id);
peer->connected = PEER_DISCONNECTED;
peer->last_connect_attempt.ts.tv_sec
= peer->last_connect_attempt.ts.tv_nsec = 0;
if (their_features)
peer->their_features = tal_dup_talarr(peer, u8, their_features);
else
peer->their_features = NULL;
peer->dev_ignore_htlcs = false;
peer_node_id_map_add(ld->peers, peer);
if (dbid)
peer_dbid_map_add(ld->peers_by_dbid, peer);
tal_add_destructor(peer, destroy_peer);
return peer;
}
static void delete_peer(struct peer *peer)
{
assert(list_empty(&peer->channels));
assert(!peer->uncommitted_channel);
/* If it only ever existed because of uncommitted channel, it won't
* be in the database */
if (peer->dbid != 0)
wallet_delete_peer_if_unused(peer->ld->wallet, peer->dbid);
tal_free(peer);
}
/* Last one out deletes peer. */
void maybe_delete_peer(struct peer *peer)
{
if (!list_empty(&peer->channels))
return;
if (peer->uncommitted_channel) {
/* This isn't sufficient to keep it in db! */
if (peer->dbid != 0) {
wallet_delete_peer_if_unused(peer->ld->wallet, peer->dbid);
peer_dbid_map_del(peer->ld->peers_by_dbid, peer);
peer->dbid = 0;
}
return;
}
/* Maybe it's reconnected / reconnecting? */
if (peer->connected != PEER_DISCONNECTED)
return;
delete_peer(peer);
}
static void peer_channels_cleanup(struct lightningd *ld,
const struct node_id *id)
{
struct peer *peer;
struct channel *c, **channels;
peer = peer_by_id(ld, id);
if (!peer)
return;
/* Freeing channels can free peer, so gather first. */
channels = tal_arr(tmpctx, struct channel *, 0);
list_for_each(&peer->channels, c, list)
tal_arr_expand(&channels, c);
if (peer->uncommitted_channel) {
/* Frees peer if no channels */
kill_uncommitted_channel(peer->uncommitted_channel,
"Disconnected");
} else if (tal_count(channels) == 0)
/* Was completely idle. */
tal_free(peer);
for (size_t i = 0; i < tal_count(channels); i++) {
c = channels[i];
if (channel_state_wants_peercomms(c->state)) {
channel_cleanup_commands(c, "Disconnected");
channel_fail_transient(c, true, "Disconnected");
} else if (channel_state_uncommitted(c->state)) {
channel_unsaved_close_conn(c, "Disconnected");
}
}
}
struct peer *find_peer_by_dbid(struct lightningd *ld, u64 dbid)
{
return peer_dbid_map_get(ld->peers_by_dbid, dbid);
}
struct peer *peer_by_id(struct lightningd *ld, const struct node_id *id)
{
return peer_node_id_map_get(ld->peers, id);
}
struct peer *peer_from_json(struct lightningd *ld,
const char *buffer,
const jsmntok_t *peeridtok)
{
struct node_id peerid;
if (!json_to_node_id(buffer, peeridtok, &peerid))
return NULL;
return peer_by_id(ld, &peerid);
}
u8 *p2wpkh_for_keyidx(const tal_t *ctx, struct lightningd *ld, u64 keyidx)
{
struct pubkey shutdownkey;
bip32_pubkey(ld, &shutdownkey, keyidx);
return scriptpubkey_p2wpkh(ctx, &shutdownkey);
}
u8 *p2tr_for_keyidx(const tal_t *ctx, struct lightningd *ld, u64 keyidx)
{
struct pubkey shutdownkey;
bip32_pubkey(ld, &shutdownkey, keyidx);
return scriptpubkey_p2tr(ctx, &shutdownkey);
}
static struct bitcoin_tx *sign_last_tx(const tal_t *ctx,
const struct channel *channel,
const struct bitcoin_tx *last_tx,
const struct bitcoin_signature *last_sig)
{
struct lightningd *ld = channel->peer->ld;
struct bitcoin_signature sig;
const u8 *msg;
u8 **witness;
u64 commit_index = channel->next_index[LOCAL] - 1;
struct bitcoin_tx *tx = clone_bitcoin_tx(ctx, last_tx);
assert(!tx->wtx->inputs[0].witness);
msg = towire_hsmd_sign_commitment_tx(NULL,
&channel->peer->id,
channel->dbid,
tx,
&channel->channel_info
.remote_fundingkey,
commit_index);
msg = hsm_sync_req(tmpctx, ld, take(msg));
if (!fromwire_hsmd_sign_commitment_tx_reply(msg, &sig))
fatal("HSM gave bad sign_commitment_tx_reply %s",
tal_hex(tmpctx, msg));
witness =
bitcoin_witness_2of2(tx, last_sig,
&sig, &channel->channel_info.remote_fundingkey,
&channel->local_funding_pubkey);
bitcoin_tx_input_set_witness(tx, 0, take(witness));
return tx;
}
bool invalid_last_tx(const struct bitcoin_tx *tx)
{
/* This problem goes back further, but was discovered just before the
* 0.7.1 release. */
#ifdef COMPAT_V070
/* Old bug had commitment txs with no outputs; bitcoin_txid asserts. */
return !tx || !tx->wtx || tx->wtx->num_outputs == 0;
#else
return false;
#endif
}
static bool commit_tx_send_finished(struct channel *channel,
const struct bitcoin_tx *tx,
bool success,
const char *err,
struct anchor_details *adet)
{
struct bitcoin_txid txid;
bitcoin_txid(tx, &txid);
/* If it's already mined, stop retransmitting, stop boosting. */
if (wallet_transaction_height(channel->peer->ld->wallet, &txid) != 0) {
tal_free(adet);
return true;
}
/* Boost (if possible), and keep trying! */
commit_tx_boost(channel, adet, success);
return false;
}
static struct bitcoin_tx *sign_and_send_last(const tal_t *ctx,
struct lightningd *ld,
struct channel *channel,
const char *cmd_id,
const struct bitcoin_tx *last_tx,
const struct bitcoin_signature *last_sig)
{
struct bitcoin_txid txid;
struct anchor_details *adet;
struct bitcoin_tx *tx;
tx = sign_last_tx(ctx, channel, last_tx, last_sig);
bitcoin_txid(tx, &txid);
wallet_transaction_add(ld->wallet, tx->wtx, 0, 0);
wallet_extract_owned_outputs(ld->wallet, tx->wtx, false, NULL, NULL);
/* Remember anchor information for commit_tx_boost */
adet = create_anchor_details(NULL, channel, tx);
/* Keep broadcasting until we say stop (can fail due to dup,
* if they beat us to the broadcast). */
broadcast_tx(channel, ld->topology, channel, tx, cmd_id, false, 0,
commit_tx_send_finished, NULL, take(adet));
return tx;
}
/* FIXME: reorder! */
static enum watch_result funding_spent(struct channel *channel,
const struct bitcoin_tx *tx,
size_t inputnum UNUSED,
const struct block *block);
/* We coop-closed channel: if another inflight confirms, force close */
static enum watch_result closed_inflight_depth_cb(struct lightningd *ld,
const struct bitcoin_txid *txid,
const struct bitcoin_tx *tx,
unsigned int depth,
struct channel_inflight *inflight)
{
if (depth == 0)
return KEEP_WATCHING;
/* This is now the main tx. */
update_channel_from_inflight(ld, inflight->channel, inflight);
channel_fail_permanent(inflight->channel,
REASON_UNKNOWN,
"Inflight tx %s confirmed after mutual close",
type_to_string(tmpctx, struct bitcoin_txid, txid));
return DELETE_WATCH;
}
void drop_to_chain(struct lightningd *ld, struct channel *channel,
bool cooperative)
{
struct channel_inflight *inflight;
const char *cmd_id;
/* If we're not already (e.g. close before channel fully open),
* make sure we're watching for the funding spend */
if (!channel->funding_spend_watch) {
log_debug(channel->log, "Adding funding_spend_watch");
channel->funding_spend_watch = watch_txo(channel,
ld->topology, channel,
&channel->funding,
funding_spent);
}
/* If this was triggered by a close command, get a copy of the cmd id */
cmd_id = cmd_id_from_close_command(tmpctx, ld, channel);
/* BOLT #2:
*
* - if `next_revocation_number` is greater than expected
* above, AND `your_last_per_commitment_secret` is correct for that
* `next_revocation_number` minus 1:
* - MUST NOT broadcast its commitment transaction.
*/
if (channel->future_per_commitment_point && !cooperative) {
log_broken(channel->log,
"Cannot broadcast our commitment tx:"
" they have a future one");
} else if (channel_state_open_uncommitted(channel->state)) {
/* There's no commitment transaction, we can
* safely forget this channel */
log_info(channel->log,
"Initialized channel (v2) received error"
", we're deleting the channel");
} else if (invalid_last_tx(channel->last_tx)) {
log_broken(channel->log,
"Cannot broadcast our commitment tx:"
" it's invalid! (ancient channel?)");
} else {
struct bitcoin_tx *tx COMPILER_WANTS_INIT("gcc 12.3.0");
/* We need to drop *every* commitment transaction to chain */
if (!cooperative && !list_empty(&channel->inflights)) {
list_for_each(&channel->inflights, inflight, list) {
if (!inflight->last_tx)
continue;
tx = sign_and_send_last(tmpctx, ld, channel, cmd_id,
inflight->last_tx,
&inflight->last_sig);
}
} else
tx = sign_and_send_last(tmpctx, ld, channel, cmd_id, channel->last_tx,
&channel->last_sig);
resolve_close_command(ld, channel, cooperative, tx);
}
/* In cooperative mode, we're assuming that we closed the right one:
* this might not happen if we're splicing, or dual-funding still
* opening. So, if we get any unexpected inflight confirming, we
* force close. */
if (cooperative) {
list_for_each(&channel->inflights, inflight, list) {
if (bitcoin_outpoint_eq(&inflight->funding->outpoint,
&channel->funding)) {
continue;
}
watch_txid(inflight, ld->topology,
&inflight->funding->outpoint.txid,
closed_inflight_depth_cb, inflight);
}
}
}
void resend_closing_transactions(struct lightningd *ld)
{
struct peer *peer;
struct channel *channel;
struct peer_node_id_map_iter it;
for (peer = peer_node_id_map_first(ld->peers, &it);
peer;
peer = peer_node_id_map_next(ld->peers, &it)) {
list_for_each(&peer->channels, channel, list) {
switch (channel->state) {
case CHANNELD_AWAITING_LOCKIN:
case CHANNELD_NORMAL:
case DUALOPEND_OPEN_INIT:
case DUALOPEND_OPEN_COMMIT_READY:
case DUALOPEND_OPEN_COMMITTED:
case DUALOPEND_AWAITING_LOCKIN:
case CHANNELD_AWAITING_SPLICE:
case CHANNELD_SHUTTING_DOWN:
case CLOSINGD_SIGEXCHANGE:
case FUNDING_SPEND_SEEN:
case ONCHAIN:
case CLOSED:
continue;
case CLOSINGD_COMPLETE:
drop_to_chain(ld, channel, true);
continue;
case AWAITING_UNILATERAL:
drop_to_chain(ld, channel, false);
continue;
}
abort();
}
}
}
void channel_errmsg(struct channel *channel,
struct peer_fd *peer_fd,
const char *desc,
const u8 *err_for_them,
bool disconnect,
bool warning)
{
/* Clean up any in-progress open attempts */
channel_cleanup_commands(channel, desc);
if (channel_state_uncommitted(channel->state)) {
log_info(channel->log, "%s", "Unsaved peer failed."
" Deleting channel.");
delete_channel(channel);
return;
}
/* No peer_fd means a subd crash or disconnection. */
if (!peer_fd) {
/* If the channel is unsaved, we forget it */
channel_fail_transient(channel, disconnect, "%s: %s",
channel->owner->name, desc);
return;
}
/* Do we have an error to send? */
if (err_for_them && !channel->error && !warning)
channel->error = tal_dup_talarr(channel, u8, err_for_them);
/* LND sends "internal error" and we close the channel. But
* prior to 0.11 we would turn this into a warning, and they
* would recover after a reconnect. So we downgrade, but snark
* about it in the logs. */
if (!err_for_them && strends(desc, "internal error")) {
channel_fail_transient(channel, disconnect, "%s: %s",
channel->owner->name,
"lnd sent 'internal error':"
" let's give it some space");
return;
}
/* This is us, sending a warning. */
if (warning) {
channel_fail_transient(channel, disconnect, "%s sent %s",
channel->owner->name,
desc);
return;
}
/* BOLT #1:
*
* A sending node:
*...
* - when sending `error`:
* - MUST fail the channel(s) referred to by the error message.
* - MAY set `channel_id` to all zero to indicate all channels.
*/
/* FIXME: Close if it's an all-channels error sent or rcvd */
/* BOLT #1:
*
* A sending node:
*...
* - when sending `error`:
* - MUST fail the channel(s) referred to by the error message.
* - MAY set `channel_id` to all zero to indicate all channels.
*...
* The receiving node:
* - upon receiving `error`:
* - if `channel_id` is all zero:
* - MUST fail all channels with the sending node.
* - otherwise:
* - MUST fail the channel referred to by `channel_id`, if that channel is with the
* sending node.
*/
/* FIXME: We don't close all channels */
/* We should immediately forget the channel if we receive error during
* CHANNELD_AWAITING_LOCKIN if we are fundee. */
if (!err_for_them && channel->opener == REMOTE
&& channel->state == CHANNELD_AWAITING_LOCKIN)
channel_fail_forget(channel, "%s: %s %s",
channel->owner->name,
err_for_them ? "sent" : "received", desc);
else
channel_fail_permanent(channel,
err_for_them ? REASON_LOCAL : REASON_PROTOCOL,
"%s: %s %s",
channel->owner->name,
err_for_them ? "sent" : "received", desc);
}
static void json_add_htlcs(struct lightningd *ld,
struct json_stream *response,
const struct channel *channel)
{
/* FIXME: make per-channel htlc maps! */
const struct htlc_in *hin;
struct htlc_in_map_iter ini;
const struct htlc_out *hout;
struct htlc_out_map_iter outi;
u32 local_feerate = get_feerate(channel->fee_states,
channel->opener, LOCAL);
/* FIXME: Add more fields. */
json_array_start(response, "htlcs");
for (hin = htlc_in_map_first(ld->htlcs_in, &ini);
hin;
hin = htlc_in_map_next(ld->htlcs_in, &ini)) {
if (hin->key.channel != channel)
continue;
json_object_start(response, NULL);
json_add_string(response, "direction", "in");
json_add_u64(response, "id", hin->key.id);
json_add_amount_msat(response, "amount_msat", hin->msat);
json_add_u32(response, "expiry", hin->cltv_expiry);
json_add_sha256(response, "payment_hash", &hin->payment_hash);
json_add_string(response, "state",
htlc_state_name(hin->hstate));
if (htlc_is_trimmed(REMOTE, hin->msat, local_feerate,
channel->our_config.dust_limit, LOCAL,
channel_has(channel, OPT_ANCHOR_OUTPUTS),
channel_has(channel, OPT_ANCHORS_ZERO_FEE_HTLC_TX)))
json_add_bool(response, "local_trimmed", true);
if (hin->status != NULL)
json_add_string(response, "status", hin->status);
json_object_end(response);
}
for (hout = htlc_out_map_first(ld->htlcs_out, &outi);
hout;
hout = htlc_out_map_next(ld->htlcs_out, &outi)) {
if (hout->key.channel != channel)
continue;
json_object_start(response, NULL);
json_add_string(response, "direction", "out");
json_add_u64(response, "id", hout->key.id);
json_add_amount_msat(response, "amount_msat", hout->msat);
json_add_u64(response, "expiry", hout->cltv_expiry);
json_add_sha256(response, "payment_hash", &hout->payment_hash);
json_add_string(response, "state",
htlc_state_name(hout->hstate));
if (htlc_is_trimmed(LOCAL, hout->msat, local_feerate,
channel->our_config.dust_limit, LOCAL,
channel_has(channel, OPT_ANCHOR_OUTPUTS),
channel_has(channel, OPT_ANCHORS_ZERO_FEE_HTLC_TX)))
json_add_bool(response, "local_trimmed", true);
json_object_end(response);
}
json_array_end(response);
}
/* Fee a commitment transaction would currently cost */
static struct amount_sat commit_txfee(const struct channel *channel,
struct amount_msat amount,
enum side side)
{
/* FIXME: make per-channel htlc maps! */
const struct htlc_in *hin;
struct htlc_in_map_iter ini;
const struct htlc_out *hout;
struct htlc_out_map_iter outi;
struct lightningd *ld = channel->peer->ld;
size_t num_untrimmed_htlcs = 0;
u32 feerate = get_feerate(channel->fee_states,
channel->opener, side);
struct amount_sat dust_limit;
struct amount_sat fee;
bool option_anchor_outputs = channel_has(channel, OPT_ANCHOR_OUTPUTS);
bool option_anchors_zero_fee_htlc_tx = channel_has(channel, OPT_ANCHORS_ZERO_FEE_HTLC_TX);
if (side == LOCAL)
dust_limit = channel->our_config.dust_limit;
if (side == REMOTE)
dust_limit = channel->channel_info.their_config.dust_limit;
/* Assume we tried to add "amount" */
if (!htlc_is_trimmed(side, amount, feerate, dust_limit, side,
option_anchor_outputs, option_anchors_zero_fee_htlc_tx))
num_untrimmed_htlcs++;
for (hin = htlc_in_map_first(ld->htlcs_in, &ini);
hin;
hin = htlc_in_map_next(ld->htlcs_in, &ini)) {
if (hin->key.channel != channel)
continue;
if (!htlc_is_trimmed(!side, hin->msat, feerate, dust_limit,
side, option_anchor_outputs, option_anchors_zero_fee_htlc_tx))
num_untrimmed_htlcs++;
}
for (hout = htlc_out_map_first(ld->htlcs_out, &outi);
hout;
hout = htlc_out_map_next(ld->htlcs_out, &outi)) {
if (hout->key.channel != channel)
continue;
if (!htlc_is_trimmed(side, hout->msat, feerate, dust_limit,
side, option_anchor_outputs, option_anchors_zero_fee_htlc_tx))
num_untrimmed_htlcs++;
}
/*
* BOLT #2:
* A sending node:
*...
* - SHOULD NOT offer `amount_msat` if, after adding that HTLC to its
* commitment transaction, its remaining balance doesn't allow it to
* pay the commitment transaction fee when receiving or sending a
* future additional non-dust HTLC while maintaining its channel
* reserve. It is recommended that this "fee spike buffer" can
* handle twice the current `feerate_per_kw` to ensure
* predictability between implementations.
*/
fee = commit_tx_base_fee(2 * feerate, num_untrimmed_htlcs + 1,
option_anchor_outputs, option_anchors_zero_fee_htlc_tx);
if (option_anchor_outputs || option_anchors_zero_fee_htlc_tx) {
/* BOLT #3:
* If `option_anchors` applies to the commitment
* transaction, also subtract two times the fixed anchor size
* of 330 sats from the funder (either `to_local` or
* `to_remote`).
*/
if (!amount_sat_add(&fee, fee, AMOUNT_SAT(660)))
; /* fee is somehow astronomical already.... */
}
return fee;
}
static void subtract_offered_htlcs(const struct channel *channel,
struct amount_msat *amount)
{
const struct htlc_out *hout;
struct htlc_out_map_iter outi;
struct lightningd *ld = channel->peer->ld;
for (hout = htlc_out_map_first(ld->htlcs_out, &outi);
hout;
hout = htlc_out_map_next(ld->htlcs_out, &outi)) {
if (hout->key.channel != channel)
continue;
if (!amount_msat_sub(amount, *amount, hout->msat))
*amount = AMOUNT_MSAT(0);
}
}
static void subtract_received_htlcs(const struct channel *channel,
struct amount_msat *amount)
{
const struct htlc_in *hin;
struct htlc_in_map_iter ini;
struct lightningd *ld = channel->peer->ld;
for (hin = htlc_in_map_first(ld->htlcs_in, &ini);
hin;
hin = htlc_in_map_next(ld->htlcs_in, &ini)) {
if (hin->key.channel != channel)
continue;
if (!amount_msat_sub(amount, *amount, hin->msat))
*amount = AMOUNT_MSAT(0);
}
}
struct amount_msat channel_amount_spendable(const struct channel *channel)
{
struct amount_msat spendable;
bool wumbo;
/* Compute how much we can send via this channel in one payment. */
if (!amount_msat_sub_sat(&spendable,
channel->our_msat,
channel->channel_info.their_config.channel_reserve))
return AMOUNT_MSAT(0);
/* Take away any currently-offered HTLCs. */
subtract_offered_htlcs(channel, &spendable);
/* If we're opener, subtract txfees we'll need to spend this */
if (channel->opener == LOCAL) {
if (!amount_msat_sub_sat(&spendable, spendable,
commit_txfee(channel, spendable,
LOCAL)))
return AMOUNT_MSAT(0);
}
/* We can't offer an HTLC less than the other side will accept. */
if (amount_msat_less(spendable,
channel->channel_info.their_config.htlc_minimum))
return AMOUNT_MSAT(0);
wumbo = feature_negotiated(channel->peer->ld->our_features,
channel->peer->their_features,
OPT_LARGE_CHANNELS);
/* We can't offer an HTLC over the max payment threshold either. */
if (amount_msat_greater(spendable, chainparams->max_payment)
&& !wumbo) {
spendable = chainparams->max_payment;
}
return spendable;
}
struct amount_msat channel_amount_receivable(const struct channel *channel)
{
struct amount_msat their_msat, receivable;
bool wumbo;
/* Compute how much we can receive via this channel in one payment */
if (!amount_sat_sub_msat(&their_msat,
channel->funding_sats, channel->our_msat))
their_msat = AMOUNT_MSAT(0);
if (!amount_msat_sub_sat(&receivable,
their_msat,
channel->our_config.channel_reserve))
return AMOUNT_MSAT(0);
/* Take away any currently-offered HTLCs. */
subtract_received_htlcs(channel, &receivable);
/* If they're opener, subtract txfees they'll need to spend this */
if (channel->opener == REMOTE) {
if (!amount_msat_sub_sat(&receivable, receivable,
commit_txfee(channel,
receivable, REMOTE)))
return AMOUNT_MSAT(0);
}
/* They can't offer an HTLC less than what we will accept. */
if (amount_msat_less(receivable, channel->our_config.htlc_minimum))
return AMOUNT_MSAT(0);
wumbo = feature_negotiated(channel->peer->ld->our_features,
channel->peer->their_features,
OPT_LARGE_CHANNELS);
/* They can't offer an HTLC over the max payment threshold either. */
if (amount_msat_greater(receivable, chainparams->max_payment)
&& !wumbo) {
receivable = chainparams->max_payment;
}
return receivable;
}
void json_add_channel_type(struct json_stream *response,
const char *fieldname,
const struct channel_type *channel_type)
{
const char **fnames;
json_object_start(response, fieldname);
json_array_start(response, "bits");
for (size_t i = 0; i < tal_bytelen(channel_type->features) * CHAR_BIT; i++) {
if (!feature_is_set(channel_type->features, i))
continue;
json_add_u64(response, NULL, i);
}
json_array_end(response);
json_array_start(response, "names");
fnames = channel_type_name(tmpctx, channel_type);
for (size_t i = 0; i < tal_count(fnames); i++)
json_add_string(response, NULL, fnames[i]);
json_array_end(response);
json_object_end(response);
}
static void json_add_channel(struct lightningd *ld,
struct json_stream *response, const char *key,
const struct channel *channel,
/* Only set for listpeerchannels */
const struct peer *peer)
{
struct channel_stats channel_stats;
struct amount_msat funding_msat;
struct amount_sat peer_funded_sats;
struct state_change_entry *state_changes;
u32 feerate;
json_object_start(response, key);
if (peer) {
json_add_node_id(response, "peer_id", &peer->id);
json_add_bool(response, "peer_connected", peer->connected == PEER_CONNECTED);
json_add_channel_type(response, "channel_type", channel->type);
if (channel->ignore_fee_limits) {
json_add_bool(response, "ignore_fee_limits", channel->ignore_fee_limits);
}
/* This reflects current gossip */
json_object_start(response, "updates");
json_object_start(response, "local");
json_add_amount_msat(response,
"htlc_minimum_msat",
channel->htlc_minimum_msat);
json_add_amount_msat(response,
"htlc_maximum_msat",
channel->htlc_maximum_msat);
json_add_u32(response, "cltv_expiry_delta", ld->config.cltv_expiry_delta);
json_add_amount_msat(response, "fee_base_msat",
amount_msat(channel->feerate_base));
json_add_u32(response, "fee_proportional_millionths",
channel->feerate_ppm);
json_object_end(response);
if (channel->peer_update) {
json_object_start(response, "remote");
json_add_amount_msat(response,
"htlc_minimum_msat",
channel->peer_update->htlc_minimum_msat);
json_add_amount_msat(response,
"htlc_maximum_msat",
channel->peer_update->htlc_maximum_msat);
json_add_u32(response, "cltv_expiry_delta", channel->peer_update->cltv_delta);
json_add_amount_msat(response, "fee_base_msat",
amount_msat(channel->peer_update->fee_base));
json_add_u32(response, "fee_proportional_millionths",
channel->peer_update->fee_ppm);
json_object_end(response);
}
json_object_end(response);
}
json_add_string(response, "state", channel_state_name(channel));
if (channel->last_tx && !invalid_last_tx(channel->last_tx)) {
struct bitcoin_txid txid;
bitcoin_txid(channel->last_tx, &txid);
json_add_txid(response, "scratch_txid", &txid);
json_add_amount_sat_msat(response, "last_tx_fee_msat",
bitcoin_tx_compute_fee(channel->last_tx));
}
json_object_start(response, "feerate");
feerate = get_feerate(channel->fee_states, channel->opener, LOCAL);
json_add_u32(response, feerate_style_name(FEERATE_PER_KSIPA), feerate);
json_add_u32(response, feerate_style_name(FEERATE_PER_KBYTE),
feerate_to_style(feerate, FEERATE_PER_KBYTE));
json_object_end(response);
if (channel->owner)
json_add_string(response, "owner", channel->owner->name);
if (channel->scid)
json_add_short_channel_id(response, "short_channel_id",
channel->scid);
/* If there is any way we can use the channel we'd better have
* a direction attached. Technically we could always add it,
* as it's just the lexicographic order between node_ids, but
* why bother if we can't use it? */
if (channel->scid || channel->alias[LOCAL] || channel->alias[REMOTE])
json_add_num(response, "direction",
node_id_idx(&ld->id, &channel->peer->id));
json_add_string(response, "channel_id",
type_to_string(tmpctx, struct channel_id, &channel->cid));
json_add_txid(response, "funding_txid", &channel->funding.txid);
json_add_num(response, "funding_outnum", channel->funding.n);
if (!list_empty(&channel->inflights)) {
struct channel_inflight *initial, *inflight;
u32 last_feerate, next_feerate;
initial = list_top(&channel->inflights,
struct channel_inflight, list);
json_add_string(response, "initial_feerate",
tal_fmt(tmpctx, "%d%s",
initial->funding->feerate,
feerate_style_name(FEERATE_PER_KSIPA)));
last_feerate = channel_last_funding_feerate(channel);
assert(last_feerate > 0);
json_add_string(response, "last_feerate",
tal_fmt(tmpctx, "%d%s", last_feerate,
feerate_style_name(FEERATE_PER_KSIPA)));
/* BOLT-9e7723387c8859b511e178485605a0b9133b9869 #2:
* - MUST set `funding_feerate_perkw` greater than or equal to
* 65/64 times the last sent `funding_feerate_perkw`
* rounded down.
*/
next_feerate = last_feerate * 65 / 64;
assert(next_feerate > last_feerate);
json_add_string(response, "next_feerate",
tal_fmt(tmpctx, "%d%s", next_feerate,
feerate_style_name(FEERATE_PER_KSIPA)));
/* List the inflights */
json_array_start(response, "inflight");
list_for_each(&channel->inflights, inflight, list) {
struct bitcoin_txid txid;
json_object_start(response, NULL);
json_add_txid(response, "funding_txid",
&inflight->funding->outpoint.txid);
json_add_num(response, "funding_outnum",
inflight->funding->outpoint.n);
json_add_string(response, "feerate",
tal_fmt(tmpctx, "%d%s",
inflight->funding->feerate,
feerate_style_name(
FEERATE_PER_KSIPA)));
json_add_amount_sat_msat(response,
"total_funding_msat",
inflight->funding->total_funds);
json_add_amount_sat_msat(response,
"our_funding_msat",
inflight->funding->our_funds);
json_add_s64(response,
"splice_amount",
inflight->funding->splice_amnt);
/* Add the expected commitment tx id also */
if (inflight->last_tx) {
bitcoin_txid(inflight->last_tx, &txid);
json_add_txid(response, "scratch_txid", &txid);
}
json_object_end(response);
}
json_array_end(response);
}
if (channel->shutdown_scriptpubkey[LOCAL]) {
char *addr = encode_scriptpubkey_to_addr(tmpctx,
chainparams,
channel->shutdown_scriptpubkey[LOCAL]);
if (addr)
json_add_string(response, "close_to_addr", addr);
json_add_hex_talarr(response, "close_to",
channel->shutdown_scriptpubkey[LOCAL]);
}
json_add_bool(
response, "private",
!(channel->channel_flags & CHANNEL_FLAGS_ANNOUNCE_CHANNEL));
/* opener and closer */
assert(channel->opener != NUM_SIDES);
json_add_string(response, "opener", channel->opener == LOCAL ?
"local" : "remote");