forked from alexbosworth/balanceofsatoshis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswap_out.js
1696 lines (1456 loc) · 51.2 KB
/
swap_out.js
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
const {createHash} = require('crypto');
const {addressForScript} = require('goldengate');
const asyncAuto = require('async/auto');
const asyncMap = require('async/map');
const asyncTimesSeries = require('async/timesSeries');
const {attemptSweep} = require('goldengate');
const {cancelSwapOut} = require('goldengate');
const {checkSwapTiming} = require('goldengate');
const {createChainAddress} = require('ln-service');
const {createInvoice} = require('ln-service');
const {createSwapOut} = require('goldengate');
const {decodeSwapRecovery} = require('goldengate');
const {encodeSwapRecovery} = require('goldengate');
const {decodePaymentRequest} = require('ln-service');
const {findDeposit} = require('goldengate');
const {findKey} = require('ln-sync');
const {formatTokens} = require('ln-sync');
const {getChainFeeRate} = require('ln-service');
const {getChannels} = require('ln-service');
const {getHeight} = require('ln-service');
const {getIdentity} = require('ln-service');
const {getNetwork} = require('ln-sync');
const {getNode} = require('ln-service');
const {getNodeAlias} = require('ln-sync');
const {getPayment} = require('ln-service');
const {getSwapOutQuote} = require('goldengate');
const {getSwapOutTerms} = require('goldengate');
const {getSyntheticOutIgnores} = require('probing');
const {lightningLabsSwapService} = require('goldengate');
const moment = require('moment');
const {payViaRoutes} = require('ln-service');
const {releaseSwapOutSecret} = require('goldengate');
const {returnResult} = require('asyncjs-util');
const {subscribeToBlocks} = require('ln-service');
const {subscribeToMultiPathPay} = require('probing');
const {subscribeToMultiPathProbe} = require('probing');
const {subscribeToPastPayment} = require('ln-service');
const {subscribeToPayViaRequest} = require('ln-service');
const {subscribeToSwapOutStatus} = require('goldengate');
const {Transaction} = require('bitcoinjs-lib');
const {authenticatedLnd} = require('./../lnd');
const {chains} = require('./../network/networks');
const channelForSend = require('./channel_for_send');
const {cltvDeltaBuffer} = require('./constants');
const {currencySymbols} = require('./../network/networks');
const {describeRoute} = require('./../display');
const {describeRoutingFailure} = require('./../display');
const {estimatedSweepVbytes} = require('./constants');
const {executeProbe} = require('./../network');
const {fastDelayMinutes} = require('./constants');
const {feeRateDenominator} = require('./constants');
const {fuzzBlocks} = require('./constants');
const {getIcons} = require('./../display');
const {getIgnores} = require('./../routing');
const getRoutesForFunding = require('./get_routes_for_funding');
const getPaidService = require('./get_paid_service');
const getRawRecoveries = require('./get_raw_recoveries');
const {getTags} = require('./../tags');
const {maxCltvExpiration} = require('./constants');
const {maxDepositTokens} = require('./constants');
const {maxExecutionFeeTokens} = require('./constants');
const {maxFeeMultiplier} = require('./constants');
const {maxFeeRate} = require('./constants');
const {maxPathfindingMs} = require('./constants');
const {maxRouteFailProbability} = require('./constants');
const {maxRoutingFeeDenominator} = require('./constants');
const {minCltvDelta} = require('./constants');
const {minConfs} = require('./constants');
const {minSweepConfs} = require('./constants');
const {minutesPerBlock} = require('./constants');
const {requiredBufferBlocks} = require('./constants');
const {slowDelayMinutes} = require('./constants');
const {swappable} = require('./../network/networks');
const {sweepProgressLogDelayMs} = require('./constants');
const addressMatch = /\b((bc|tb)(0([ac-hj-np-z02-9]{39}|[ac-hj-np-z02-9]{59})|1[ac-hj-np-z02-9]{8,87})|([13]|[mn2])[a-km-zA-HJ-NP-Z1-9]{25,39})\b/i;
const {ceil} = Math;
const cltvBuffer = 3;
const farFutureDate = () => moment().add(1, 'years').toISOString();
const flatten = arr => [].concat(...arr);
const {floor} = Math;
const hexAsBase64 = hex => Buffer.from(hex, 'hex').toString('base64');
const {isArray} = Array;
const {max} = Math;
const maxCltvDelta = 144 * 30;
const {min} = Math;
const minSend = spendTokens => Number(spendTokens) + 1e4;
const mtokPerTok = BigInt(1000);
const {round} = Math;
const sha256 = n => createHash('sha256').update(Buffer.from(n, 'hex'));
const swapDelayMinutes = fast => !!fast ? fastDelayMinutes : slowDelayMinutes;
const tokensAsBigUnit = tokens => ((tokens || 0) / 1e8).toFixed(8);
const uniq = arr => Array.from(new Set(arr));
/** Get additional inbound liquidity
{
[api_key]: <API Key CBOR String>
avoid: [<Avoid Forwarding Through Node With Public Key Hex String>]
confs: <Confirmations to Wait for Deposit Number>
fetch: <Fetch Function>
fs: {
getFile: <Read File Contents Function> (path, cbk) => {}
}
[is_fast]: <Execute Swap Immediately Bool>
[is_dry_run]: <Avoid Actually Executing Operation Bool>
[is_raw_recovery_shown]: <Show Raw Recovery Transactions Bool>
lnd: <Authenticated LND gRPC API Object>
logger: <Winston Logger Object>
[max_deposit]: <Maximum Swap Deposit Tokens Number>
[max_fee]: <Maximum Fee Tokens Number>
[max_paths]: <Maximum Paths For Funding Number>
[max_wait_blocks]: <Maximum Wait Blocks Number>
[node]: <Node Name String>
[out_address]: <Out Address String>
[peer]: <Peer Public Key Hex String>
[recovery]: <Recover In-Progress Swap Hex String>
request: <Request Function>
[socket]: <Custom Backing Service Host:Port String>
[spend_address]: <Attempt Spend Out To Address String>
[spend_tokens]: <Spend Address Exact Tokens Number>
timeout: <Wait for Deposit Timeout Milliseconds Number>
tokens: <Tokens Number>
}
@returns via cbk or Promise
*/
module.exports = (args, cbk) => {
return new Promise((resolve, reject) => {
return asyncAuto({
// Check arguments
validate: cbk => {
if (!isArray(args.avoid)) {
return cbk([400, 'ExpectedAvoidArrayToInitiateSwapOut']);
}
if (args.confs === undefined) {
return cbk([400, 'ExpectedConfirmationsCountToConsiderReorgSafe']);
}
if (!args.fetch) {
return cbk([400, 'ExpectedFetchFunctionToInitiateSwapOut']);
}
if (!args.fs) {
return cbk([400, 'ExpectedFileSystemFunctionsToInitiateSwapOut']);
}
if (!args.lnd) {
return cbk([400, 'ExpectedLndToInitiateSwapOut']);
}
if (!args.logger) {
return cbk([400, 'ExpectedLoggerForSwapProgressNotifications']);
}
if (!!args.out_address && !addressMatch.test(args.out_address)) {
return cbk([400, 'UnrecognizedFormatOfOutAddress']);
}
if (!args.request) {
return cbk([400, 'ExpectedRequestFunctionToInitiateSwapOut']);
}
if (!!args.spend_address && !args.spend_tokens) {
return cbk([400, 'ExpectedSpendAmountWhenSpecifyingSpendAddress']);
}
if (!!args.spend_tokens && !args.spend_address) {
return cbk([400, 'ExpectedSpendAddressWhenSpecifyingSpendTokens']);
}
if (args.spend_tokens > args.tokens) {
return cbk([400, 'ExpectedSpendTokensLessThanTotalTokens']);
}
if (!!args.spend_address && minSend(args.spend_tokens) > args.tokens) {
return cbk([
400,
'ExpectedSwapAmountGreaterThanSpendAmount',
{minimum: minSend(args.spend_tokens)},
]);
}
if (!args.timeout) {
return cbk([400, 'ExpectedTimeoutToWaitForSwapDeposit']);
}
if (!args.recovery && !args.tokens) {
return cbk([400, 'ExpectedTokensToIncreaseLiquidity']);
}
return cbk();
},
// Find peer
findPeer: ['validate', ({}, cbk) => {
return findKey({lnd: args.lnd, query: args.peer}, cbk);
}],
// Get current channel liquidity details
getChannels: ['validate', ({}, cbk) => {
return getChannels({lnd: args.lnd, is_active: true}, cbk);
}],
// Get the current block height
getHeight: ['validate', ({}, cbk) => getHeight({lnd: args.lnd}, cbk)],
// Get node icons
getIcons: ['validate', ({}, cbk) => {
if (!args.fs) {
return cbk();
}
return getIcons({fs: args.fs}, cbk);
}],
// Get the node public key
getIdentity: ['validate', ({}, cbk) => {
// Exit early when there are no avoids
if (!args.avoid.length) {
return cbk();
}
return getIdentity({lnd: args.lnd}, cbk);
}],
// Get the network this swap is taking place on
getNetwork: ['validate', ({}, cbk) => getNetwork({lnd: args.lnd}, cbk)],
// Get tags for figuring out avoid flags
getTags: ['validate', ({}, cbk) => {
// Exit early when there are no avoids
if (!args.avoid.length) {
return cbk();
}
return getTags({fs: args.fs}, cbk);
}],
// Get peer details
getPeerDetails: ['findPeer', ({findPeer}, cbk) => {
if (!findPeer.public_key) {
return cbk();
}
return getNodeAlias({id: findPeer.public_key, lnd: args.lnd}, cbk);
}],
// Decode the swap recovery if necessary
recover: ['validate', ({}, cbk) => {
if (!args.recovery) {
return cbk();
}
return decodeSwapRecovery({recovery: args.recovery}, cbk);
}],
// External sends
sends: ['validate', ({}, cbk) => {
if (!args.spend_address) {
return cbk();
}
return cbk(null, [{
address: args.spend_address,
tokens: Number(args.spend_tokens),
}]);
}],
// Create a sweep address
createAddress: ['recover', ({recover}, cbk) => {
// Exit early when there is a sweep address specified in recovery
if (!!recover && recover.sweep_address) {
return cbk(null, {address: recover.sweep_address});
}
// Exit early when the sweep out address is directly specified
if (!!args.out_address) {
return cbk(null, {address: args.out_address});
}
return createChainAddress({format: 'p2wpkh', lnd: args.lnd}, cbk);
}],
// Network for swap
network: ['getNetwork', ({getNetwork}, cbk) => {
return cbk(null, getNetwork.network);
}],
// The start height of the swap
startHeight: ['getHeight', 'recover', ({getHeight, recover}, cbk) => {
// Exit early when recovering from an in-progress swap
if (!!recover) {
return cbk(null, recover.start_height);
}
return cbk(null, getHeight.current_block_height);
}],
// Figure out which channel to use when swapping with a peer
channel: ['findPeer', 'getChannels', ({findPeer, getChannels}, cbk) => {
// Exit early when this is a recovery, or there is no peer selected
if (!!args.recovery || !findPeer.public_key) {
return cbk();
}
const {id} = channelForSend({
tokens: args.tokens,
channels: getChannels.channels,
peer: findPeer.public_key,
});
// There was no channel found to use for the swap
if (!id) {
return cbk([400, 'InsufficientOutboundLiquidityToConvertToInbound']);
}
return cbk(null, {id});
}],
// Get base ignores
getBaseIgnores: [
'getChannels',
'getIdentity',
'getTags',
({getChannels, getIdentity, getTags}, cbk) =>
{
// Exit early when there are no avoids
if (!args.avoid.length) {
return cbk(null, {ignore: []});
}
return getIgnores({
avoid: args.avoid,
channels: getChannels.channels,
lnd: args.lnd,
logger: args.logger,
public_key: getIdentity.public_key,
tags: getTags.tags,
},
cbk);
}],
// Get the ignore list from avoid directives
getIgnores: [
'findPeer',
'getBaseIgnores',
({findPeer, getBaseIgnores}, cbk) =>
{
// Exit early when there is no specific peer
if (!findPeer.public_key) {
return cbk(null, {ignore: getBaseIgnores.ignore});
}
return getSyntheticOutIgnores({
ignore: getBaseIgnores.ignore,
lnd: args.lnd,
out: [findPeer.public_key],
},
cbk);
}],
// Currency of swap
currency: ['network', ({network}, cbk) => {
return cbk(null, currencySymbols[network]);
}],
// Derive recovery address for an in-progress swap
recoverAddress: ['network', 'recover', ({network, recover}, cbk) => {
if (!args.recovery) {
return cbk();
}
try {
addressForScript({network, script: recover.script})
} catch (err) {
return cbk([400, 'FailedToDeriveSwapAddress', {err}]);
}
const {address} = addressForScript({network, script: recover.script});
return cbk(null, address);
}],
// Get a paid service object, or convert prepaid token to service object
getService: [
'network',
'recover',
'recoverAddress',
({network}, cbk) =>
{
// Exit early when the swap is already initiated
if (!!args.recovery) {
return cbk();
}
return getPaidService({
network,
fetch: args.fetch,
lnd: args.lnd,
socket: args.socket,
token: args.api_key,
},
cbk);
}],
// Get swap out limits
getLimits: ['getService', ({getService}, cbk) => {
// Exit early when in recovery
if (!!args.recovery) {
return cbk();
}
return getSwapOutTerms({
metadata: getService.metadata,
service: getService.service,
},
cbk);
}],
// Get the quote for swaps
getQuote: [
'getLimits',
'getService',
'startHeight',
({getLimits, getService, startHeight}, cbk) =>
{
// Exit early when this is a recovery of an existing swap
if (!!args.recovery) {
return cbk();
}
if (args.tokens > getLimits.max_tokens) {
return cbk([400, 'SwapSizeTooLarge', {max: getLimits.max_tokens}]);
}
if (args.tokens < getLimits.min_tokens) {
return cbk([400, 'SwapSizeTooSmall', {min: getLimits.min_tokens}]);
}
const fundAt = moment().add(swapDelayMinutes(args.is_fast), 'minutes');
return getSwapOutQuote({
delay: !args.is_fast ? fundAt.toISOString() : undefined,
metadata: getService.metadata,
service: getService.service,
timeout: getLimits.max_cltv_delta + startHeight,
tokens: args.tokens,
},
cbk);
}],
// Check quote to validate parameters of the swap
checkQuote: ['getLimits', 'getQuote', ({getLimits, getQuote}, cbk) => {
if (!!args.recovery) {
return cbk();
}
if (getQuote.deposit > (args.max_deposit || maxDepositTokens)) {
return cbk([400, 'SwapDepositExceedsMaxDepositLimit']);
}
if (getQuote.fee > round(args.tokens * maxFeeRate)) {
return cbk([400, 'TotalFeeExceedsMaxFeeRate']);
}
if (!!args.max_fee && getQuote.fee > args.max_fee) {
return cbk([400, 'FeeForSwapExceedsMaximumFeeLimit', getQuote]);
}
const fundConfs = (args.confs || minConfs);
const swapDelayMin = swapDelayMinutes(args.is_fast);
const sweepConfs = (args.confs || minConfs);
const allFees = getQuote.fee;
const swapMinimumMinutes = (fundConfs + sweepConfs) * minutesPerBlock;
const swapTimeoutMinutes = getLimits.max_cltv_delta * minutesPerBlock;
const fastestSwapTime = moment().add(swapMinimumMinutes, 'minutes');
const swapTimeout = moment().add(swapTimeoutMinutes, 'minutes');
args.logger.info({
estimated_time: {
start_at: moment().calendar(),
earliest_completion: fastestSwapTime.add(swapDelayMin).fromNow(),
forfeit_funds_deadline_at: swapTimeout.fromNow(),
},
});
return cbk(null, {deposit: getQuote.deposit, service_fee: allFees});
}],
// Get the ultimate timeout height to request for the swap
getTimeout: [
'getLimits',
'startHeight',
({getLimits, startHeight}, cbk) =>
{
// Exit early when the swap is already started
if (!!args.recovery) {
return cbk();
}
if (getLimits.max_cltv_delta < minCltvDelta) {
return cbk([503, 'ServerMaxCltvDeltaTooLow']);
}
return cbk(null, startHeight + getLimits.max_cltv_delta);
}],
// Request a new swap out
initiateSwap: [
'checkQuote',
'getService',
'getTimeout',
'network',
'recover',
'recoverAddress',
({getService, getTimeout, network, recover, recoverAddress}, cbk) =>
{
// Exit early when the swap is already initiated
if (!!args.recovery) {
return cbk(null, {
address: recoverAddress,
private_key: recover.claim_private_key,
script: recover.script,
secret: recover.secret,
start_height: recover.start_height,
timeout: recover.timeout,
version: recover.version,
});
}
if (!!getService.paid && !!getService.token) {
args.logger.info({
amount_paid_for_api_key: tokensAsBigUnit(getService.paid),
service_api_key: getService.token,
service_user_id: getService.id,
});
}
const fundAt = moment().add(swapDelayMinutes(args.is_fast), 'minutes');
return createSwapOut({
network,
fund_at: fundAt.toISOString(),
metadata: getService.metadata,
service: getService.service,
timeout: getTimeout,
tokens: args.tokens,
},
cbk);
}],
// Decode swap execution request
decodeExecutionRequest: ['initiateSwap', ({initiateSwap}, cbk) => {
if (!!args.recovery) {
return cbk();
}
return decodePaymentRequest({
lnd: args.lnd,
request: initiateSwap.swap_execute_request,
},
cbk);
}],
// Check swap
checkSwap: [
'createAddress',
'decodeExecutionRequest',
'initiateSwap',
'startHeight',
({
createAddress,
decodeExecutionRequest,
initiateSwap,
startHeight,
},
cbk) =>
{
// Exit early when the swap is already started or is just a test run
if (!!args.is_dry_run || !!args.recovery) {
return cbk();
}
// Output a recovery blob that can be used to restart the swap
try {
const {recovery} = encodeSwapRecovery({
claim_private_key: initiateSwap.private_key,
execution_id: decodeExecutionRequest.id,
refund_public_key: initiateSwap.service_public_key,
secret: initiateSwap.secret,
start_height: startHeight,
sweep_address: createAddress.address,
timeout: initiateSwap.timeout,
tokens: args.tokens,
version: initiateSwap.version,
});
args.logger.info({
restart_recovery_secret: recovery.toString('hex'),
});
} catch (err) {
return cbk([500, 'UnexpectedErrorGeneratingRecoveryState', {err}]);
}
try {
checkSwapTiming({
current_block_height: startHeight,
required_buffer_blocks: requiredBufferBlocks,
required_funding_confirmations: args.confs,
required_sweep_confirmations: args.confs,
timeout_height: initiateSwap.timeout,
});
} catch (err) {
return cbk([503, 'InsufficientTimeAvailableToCompleteSwap', {err}]);
}
return cbk();
}],
// Decode funding request
decodeFundingRequest: ['initiateSwap', ({initiateSwap}, cbk) => {
if (!!args.recovery) {
return cbk();
}
return decodePaymentRequest({
lnd: args.lnd,
request: initiateSwap.swap_fund_request,
},
cbk);
}],
// Track server swap status
trackStatus: [
'decodeFundingRequest',
'getService',
({decodeFundingRequest, getService}, cbk) =>
{
if (!!args.recovery) {
return cbk();
}
const sub = subscribeToSwapOutStatus({
id: decodeFundingRequest.id,
metadata: getService.metadata,
service: getService.service,
});
const swap = {};
sub.on('status_update', update => {
// Server reports swap broadcast
if (!swap.is_broadcast && !!update.is_broadcast) {
swap.is_broadcast = true;
args.logger.info({
server_update: 'On-chain transaction published',
});
}
if (!!update.is_claimed) {
sub.removeAllListeners();
return cbk();
}
});
}],
// Check that the payment requests match the validated quote
checkRequestAmounts: [
'decodeExecutionRequest',
'decodeFundingRequest',
'getQuote',
({decodeExecutionRequest, decodeFundingRequest, getQuote}, cbk) =>
{
if (!!args.recovery) {
return cbk();
}
// Check that the no-strings-attached prepay is as quoted
if (decodeExecutionRequest.tokens !== getQuote.deposit) {
return cbk([503, 'UnexpectedUnilateralDepositTokensAmount']);
}
if (decodeFundingRequest.tokens > getQuote.fee + args.tokens) {
return cbk([503, 'UnexpectedServiceCostForSwap']);
}
return cbk();
}],
// Probe for execution
findRouteForExecution: [
'channel',
'decodeExecutionRequest',
'decodeFundingRequest',
'getIcons',
'getIgnores',
'getService',
({
channel,
decodeExecutionRequest,
decodeFundingRequest,
getIcons,
getIgnores,
getService,
},
cbk) =>
{
// Exit early when there is a swap recovery
if (!!args.recovery) {
return cbk();
}
const isFeatured = !!decodeExecutionRequest.features.length;
return executeProbe({
cltv_delta: decodeExecutionRequest.cltv_delta + cltvBuffer,
destination: decodeExecutionRequest.destination,
features: !!isFeatured ? decodeExecutionRequest.features : undefined,
ignore: getIgnores.ignore,
lnd: args.lnd,
logger: args.logger,
max_fee: maxExecutionFeeTokens,
mtokens: decodeExecutionRequest.mtokens,
outgoing_channel: !!channel ? channel.id : undefined,
payment: decodeExecutionRequest.payment,
routes: decodeExecutionRequest.routes,
tagged: !!getIcons ? getIcons.nodes : undefined,
tokens: decodeExecutionRequest.tokens,
},
(err, res) => {
if (!!err || !res.route) {
return cancelSwapOut({
id: decodeFundingRequest.id,
metadata: getService.metadata,
payment: decodeFundingRequest.payment,
service: getService.service,
},
() => {
if (!!err) {
return cbk([503, 'UnexpectedErrorFindingExecutionRoute', {err}]);
}
if (!res.route) {
return cbk([503, 'FailedToFindAPathToPaySwapExecutionFee']);
}
});
}
return cbk(null, res.route);
});
}],
// Get peers of the destination node
getGateways: ['decodeFundingRequest', ({decodeFundingRequest}, cbk) => {
if (!!args.recovery) {
return cbk();
}
const finalKey = decodeFundingRequest.destination;
return getNode({lnd: args.lnd, public_key: finalKey}, (err, res) => {
if (!!err) {
return cbk(null, {});
}
const policies = res.channels.map(channel => {
return channel.policies.find(n => n.public_key !== finalKey);
});
const keys = uniq(policies.map(n => n.public_key));
const gateways = keys.filter(n => !!n).map(gateway => ({
from_public_key: gateway,
to_public_key: finalKey,
}));
return cbk(null, {gateways});
});
}],
// Get funding routes for a multiple path payment
getFundingRoutes: [
'decodeFundingRequest',
'getGateways',
'getIgnores',
'getService',
({decodeFundingRequest, getGateways, getIgnores, getService}, cbk) =>
{
if (!!args.recovery) {
return cbk();
}
// Exit early when not doing multipath funding
if (args.max_paths < 2) {
return cbk();
}
const hasFeatures = !!decodeFundingRequest.features.length;
const paths = [];
const sub = subscribeToMultiPathProbe({
allow_stacking: getGateways.gateways,
cltv_delta: decodeFundingRequest.cltv_delta + cltvBuffer,
destination: decodeFundingRequest.destination,
features: !!hasFeatures ? decodeFundingRequest.features : undefined,
ignore: getIgnores.ignore,
lnd: args.lnd,
logger: args.logger,
max_paths: args.max_paths || undefined,
routes: decodeFundingRequest.routes,
});
sub.on('error', err => {
return cbk([503, 'UnexpectedErrorProbingRouteToSwapService', {err}]);
});
sub.on('evaluating', ({tokens}) => {
return args.logger.info({evaluating: tokens});
});
sub.on('failure', () => {
return cbk([503, 'FailedToFindAnyPathsToSwapServiceDestination']);
});
sub.on('path', path => {
paths.push(path);
const liquidity = paths.reduce((m, n) => m + n.liquidity, Number());
return args.logger.info({
found_liquidity: formatTokens({tokens: liquidity}).display,
found_paths: paths.length,
});
});
sub.on('probing', async ({route}) => {
const {description} = await describeRoute({route, lnd: args.lnd});
return args.logger.info({probing: description});
});
sub.on('routing_failure', async failure => {
const {description} = await describeRoutingFailure({
index: failure.index,
lnd: args.lnd,
reason: failure.reason,
route: failure.route,
});
return args.logger.info({failure: description});
});
sub.on('success', ({paths}) => {
const liquidity = paths.reduce((m, n) => m + n.liquidity, Number());
if (decodeFundingRequest.tokens > liquidity) {
return cancelSwapOut({
id: decodeFundingRequest.id,
metadata: getService.metadata,
payment: decodeFundingRequest.payment,
service: getService.service,
},
() => {
return cbk([
503,
'FailedToFindEnoughLiquidityOnPathsToFundSwap',
{available_liquidity: liquidity},
]);
});
}
return cbk(null, {paths});
});
}],
// Get a funding route for a single path payment
findRoutesForFunding: [
'channel',
'decodeFundingRequest',
'findPeer',
'getFundingRoutes',
'getIgnores',
'getService',
'initiateSwap',
({
channel,
decodeFundingRequest,
findPeer,
getIgnores,
getService,
initiateSwap,
},
cbk) =>
{
if (!!args.recovery) {
return cbk();
}
// Exit early when doing multiple paths
if (args.max_paths > 1) {
return cbk();
}
const hasFeatures = !!decodeFundingRequest.features.length;
const {tokens} = decodeFundingRequest;
return getRoutesForFunding({
cltv_delta: decodeFundingRequest.cltv_delta + cltvBuffer,
destination: decodeFundingRequest.destination,
features: !!hasFeatures ? decodeFundingRequest.features : undefined,
ignore: getIgnores.ignore,
lnd: args.lnd,
logger: args.logger,
max_fee: round(tokens / maxRoutingFeeDenominator),
max_paths: args.max_paths || undefined,
mtokens: decodeFundingRequest.mtokens,
out_through: findPeer.public_key || undefined,
outgoing_channel: !!channel ? channel.id : undefined,
payment: decodeFundingRequest.payment,
request: initiateSwap.swap_fund_request,
routes: decodeFundingRequest.routes,
tokens: decodeFundingRequest.tokens,
},
(err, res) => {
if (!!err) {
return cancelSwapOut({
id: decodeFundingRequest.id,
metadata: getService.metadata,
payment: decodeFundingRequest.payment,
service: getService.service,
},
() => cbk(err, res));
}
return cbk(null, res);
});
}],
// Get info about the peer we are going to get inbound liquidity with
getSwapPeers: [
'findPeer',
'findRoutesForFunding',
'getChannels',
'getFundingRoutes',
'getPeerDetails',
({
findPeer,
findRoutesForFunding,
getChannels,
getFundingRoutes,
getPeerDetails,
},
cbk) =>
{
// Exit early when this is a recovery
if (!!args.recovery) {
return cbk();
}
// Exit early when a peer is specified
if (!!findPeer.public_key) {
return cbk(null, [{
alias: getPeerDetails.alias || undefined,
peer_channels: getChannels.channels.filter(channel => {
return channel.partner_public_key === findPeer.public_key;
}),
public_key: findPeer.public_key,
}]);
}
// Exit early when the funding routes are found
if (!!getFundingRoutes) {
return asyncMap(getFundingRoutes.paths, (path, cbk) => {
const [outPeer] = path.relays;
return getNode({
is_omitting_channels: true,
lnd: args.lnd,
public_key: outPeer,
},
(err, res) => {
return cbk(null, {
alias: !!res ? res.alias : undefined,
peer_channels: getChannels.channels.filter(channel => {
return channel.partner_public_key === outPeer;
}),
public_key: outPeer,
});
});
},
cbk);
}