-
Notifications
You must be signed in to change notification settings - Fork 33
/
subscribe_to_probe_for_route.js
405 lines (347 loc) · 12.1 KB
/
subscribe_to_probe_for_route.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
const EventEmitter = require('events');
const asyncAuto = require('async/auto');
const asyncWhilst = require('async/whilst');
const {getRouteToDestination} = require('./../info');
const {getIdentity} = require('./../info');
const {isLnd} = require('./../../lnd_requests');
const {mtokensAmount} = require('./../../bolt00');
const subscribeToPayViaRoutes = require('./subscribe_to_pay_via_routes');
const defaultPathTimeoutMs = 1000 * 60;
const defaultProbeTimeoutMs = 1000 * 60 * 60 * 24;
const {isArray} = Array;
const isIgnoreFailure = reason => reason === 'TemporaryChannelFailure';
const isPublicKey = n => /^[0-9A-F]{66}$/i.test(n);
const {nextTick} = process;
/** Subscribe to a probe attempt
Requires `offchain:write` permission
Preferred `confidence` is not supported on LND 0.14.5 and below
{
[cltv_delta]: <Final CLTV Delta Number>
[confidence]: <Preferred Route Confidence Number Out of One Million Number>
destination: <Destination Public Key Hex String>
[features]: [{
bit: <Feature Bit Number>
}]
[ignore]: [{
from_public_key: <Public Key Hex String>
[to_public_key]: <To Public Key Hex String>
}]
[incoming_peer]: <Incoming Peer Public Key Hex String>
lnd: <Authenticated LND API Object>
[max_fee]: <Maximum Fee Tokens Number>
[max_fee_mtokens]: <Maximum Fee Millitokens to Probe String>
[max_timeout_height]: <Maximum CLTV Timeout Height Number>
[messages]: [{
type: <Message To Final Destination Type Number String>
value: <Message To Final Destination Raw Value Hex Encoded String>
}]
[mtokens]: <Millitokens to Probe String>
[outgoing_channel]: <Outgoing Channel Id String>
[path_timeout_ms]: <Skip Individual Path Attempt After Milliseconds Number>
[payment]: <Payment Identifier Hex Strimng>
[probe_timeout_ms]: <Fail Entire Probe After Milliseconds Number>
[routes]: [[{
[base_fee_mtokens]: <Base Routing Fee In Millitokens String>
[channel_capacity]: <Channel Capacity Tokens Number>
[channel]: <Standard Format Channel Id String>
[cltv_delta]: <CLTV Blocks Delta Number>
[fee_rate]: <Fee Rate In Millitokens Per Million Number>
public_key: <Forward Edge Public Key Hex String>
}]]
[tokens]: <Tokens to Probe Number>
[total_mtokens]: <Total Millitokens Across Paths String>
}
@returns
<Probe Subscription Event Emitter Object>
@event 'error'
[<Failure Code Number>, <Failure Message String>]
@event 'probe_success'
{
route: {
[confidence]: <Route Confidence Score Out Of One Million Number>
fee: <Total Fee Tokens To Pay Number>
fee_mtokens: <Total Fee Millitokens To Pay String>
hops: [{
channel: <Standard Format Channel Id String>
channel_capacity: <Channel Capacity Tokens Number>
fee: <Fee Number>
fee_mtokens: <Fee Millitokens String>
forward: <Forward Tokens Number>
forward_mtokens: <Forward Millitokens String>
public_key: <Public Key Hex String>
timeout: <Timeout Block Height Number>
}]
[messages]: [{
type: <Message Type Number String>
value: <Message Raw Value Hex Encoded String>
}]
mtokens: <Total Millitokens To Pay String>
[payment]: <Payment Identifier Hex String>
safe_fee: <Payment Forwarding Fee Rounded Up Tokens Number>
safe_tokens: <Payment Sent Tokens Rounded Up Number>
timeout: <Expiration Block Height Number>
tokens: <Total Tokens To Pay Number>
[total_mtokens]: <Total Millitokens String>
}
}
@event 'probing'
{
route: {
[confidence]: <Route Confidence Score Out Of One Million Number>
fee: <Total Fee Tokens To Pay Number>
fee_mtokens: <Total Fee Millitokens To Pay String>
hops: [{
channel: <Standard Format Channel Id String>
channel_capacity: <Channel Capacity Tokens Number>
fee: <Fee Number>
fee_mtokens: <Fee Millitokens String>
forward: <Forward Tokens Number>
forward_mtokens: <Forward Millitokens String>
public_key: <Public Key Hex String>
timeout: <Timeout Block Height Number>
}]
[messages]: [{
type: <Message Type Number String>
value: <Message Raw Value Hex Encoded String>
}]
mtokens: <Total Millitokens To Pay String>
[payment]: <Payment Identifier Hex String>
safe_fee: <Payment Forwarding Fee Rounded Up Tokens Number>
safe_tokens: <Payment Sent Tokens Rounded Up Number>
timeout: <Expiration Block Height Number>
tokens: <Total Tokens To Pay Number>
[total_mtokens]: <Total Millitokens String>
}
}
@event 'routing_failure'
{
[channel]: <Standard Format Channel Id String>
index: <Failure Index Number>
[mtokens]: <Millitokens String>
[policy]: {
base_fee_mtokens: <Base Fee Millitokens String>
cltv_delta: <Locktime Delta Number>
fee_rate: <Fees Charged in Millitokens Per Million Number>
[is_disabled]: <Channel is Disabled Bool>
max_htlc_mtokens: <Maximum HLTC Millitokens Value String>
min_htlc_mtokens: <Minimum HTLC Millitokens Value String>
[public_key]: <Public Key Hex String>
[updated_at]: <Updated At ISO 8601 Date String>
}
[public_key]: <Public Key Hex String>
reason: <Failure Reason String>
route: {
[confidence]: <Route Confidence Score Out Of One Million Number>
fee: <Total Fee Tokens To Pay Number>
fee_mtokens: <Total Fee Millitokens To Pay String>
hops: [{
channel: <Standard Format Channel Id String>
channel_capacity: <Channel Capacity Tokens Number>
fee: <Fee Number>
fee_mtokens: <Fee Millitokens String>
forward: <Forward Tokens Number>
forward_mtokens: <Forward Millitokens String>
public_key: <Public Key Hex String>
timeout: <Timeout Block Height Number>
}]
[messages]: [{
type: <Message Type Number String>
value: <Message Raw Value Hex Encoded String>
}]
mtokens: <Total Millitokens To Pay String>
[payment]: <Payment Identifier Hex String>
safe_fee: <Payment Forwarding Fee Rounded Up Tokens Number>
safe_tokens: <Payment Sent Tokens Rounded Up Number>
timeout: <Expiration Block Height Number>
tokens: <Total Tokens To Pay Number>
[total_mtokens]: <Total Millitokens String>
}
[update]: {
chain: <Chain Id Hex String>
channel_flags: <Channel Flags Number>
extra_opaque_data: <Extra Opaque Data Hex String>
message_flags: <Message Flags Number>
signature: <Channel Update Signature Hex String>
}
}
*/
module.exports = args => {
if (!isPublicKey(args.destination)) {
throw new Error('ExpectedDestinationPublicKeyToSubscribeToProbe');
}
if (!!args.ignore && !isArray(args.ignore)) {
throw new Error('ExpectedIgnoreEdgesArrayInProbeSubscription');
}
if (!isLnd({lnd: args.lnd, method: 'sendToRouteV2', type: 'router'})) {
throw new Error('ExpectedRouterRpcToSubscribeToProbe');
}
const {mtokens} = mtokensAmount({
mtokens: args.mtokens,
tokens: args.tokens,
});
if (!mtokens) {
throw new Error('ExpectedTokenAmountToSubscribeToProbe');
}
const emitter = new EventEmitter();
const ignore = [];
let isErrored = false;
let isFinal = false;
let isTimedOut = false;
const temporaryChannelFailures = [];
if (!!args.ignore) {
args.ignore.forEach(n => ignore.push({
from_public_key: n.from_public_key,
to_public_key: n.to_public_key,
}));
}
const emitError = err => {
if (isErrored || !emitter.listenerCount('error')) {
return;
}
// Safeguard against returning multiple errors
isErrored = true;
return emitter.emit('error', err);
};
const probeTimeout = setTimeout(() => {
isFinal = true;
isTimedOut = true;
emitError([503, 'ProbeTimeout']);
emitter.emit('end');
return;
},
args.probe_timeout_ms || defaultProbeTimeoutMs);
asyncWhilst(
cbk => nextTick(() => cbk(null, !isFinal)),
cbk => {
return asyncAuto({
// Get public key
getInfo: cbk => getIdentity({lnd: args.lnd}, cbk),
// Get the next route
getNextRoute: cbk => {
return getRouteToDestination({
mtokens,
cltv_delta: args.cltv_delta,
confidence: args.confidence,
destination: args.destination,
features: args.features,
ignore: ignore.concat(temporaryChannelFailures),
incoming_peer: args.incoming_peer,
lnd: args.lnd,
max_fee: args.max_fee,
max_fee_mtokens: args.max_fee_mtokens,
max_timeout_height: args.max_timeout_height,
messages: args.messages,
outgoing_channel: args.outgoing_channel,
payment: args.payment,
routes: args.routes,
total_mtokens: args.total_mtokens,
},
cbk);
},
// Attempt paying the route
attemptRoute: [
'getNextRoute',
'getInfo',
({getInfo, getNextRoute}, cbk) =>
{
const routes = [getNextRoute.route].filter(n => !!n);
if (!routes.length) {
return cbk(null, {});
}
let currentRoute;
const sub = subscribeToPayViaRoutes({routes, lnd: args.lnd});
sub.on('paying', ({route}) => {
currentRoute = route;
return emitter.emit('probing', {route});
});
const next = () => {
sub.removeAllListeners();
return cbk(null, {});
};
const routeTimeout = setTimeout(() => {
const [lastHop, penultimate] = currentRoute.hops.slice().reverse();
const from = penultimate || getInfo;
// Ignore the final pair
currentRoute.hops.forEach(hop => {
return ignore.push({
from_public_key: from.public_key,
to_public_key: hop.public_key,
});
});
return next();
},
args.path_timeout_ms || defaultPathTimeoutMs);
sub.on('routing_failure', failure => {
if (failure.index === failure.route.hops.length) {
isFinal = true;
}
// Exit early when the probe timed out
if (!!isTimedOut) {
return;
}
// Exit early when the probe found a completed route
if (!!isFinal) {
return emitter.emit('probe_success', {route: failure.route});
}
if (!!failure.index && isIgnoreFailure(failure.reason)) {
const from = failure.route.hops[failure.index - 1];
const to = failure.route.hops[failure.index];
temporaryChannelFailures.push({
from_public_key: from.public_key,
to_public_key: to.public_key,
});
}
emitter.emit('routing_failure', {
channel: failure.channel,
index: failure.index,
mtokens: failure.mtokens,
policy: failure.policy || undefined,
public_key: failure.public_key,
reason: failure.reason,
route: failure.route,
update: failure.update,
});
return;
});
// Probing finished
sub.on('end', () => {
clearTimeout(routeTimeout);
return next();
});
sub.on('error', err => {
if (!!isTimedOut) {
return;
}
return emitError(err);
});
return;
}],
},
(err, res) => {
if (!!err) {
return cbk(err);
}
if (!!isFinal) {
return cbk();
}
if (!res.getNextRoute.route) {
isFinal = true;
}
return cbk();
});
},
err => {
// Exit early when the probe timed out
if (!!isTimedOut) {
return;
}
clearTimeout(probeTimeout);
if (!!err) {
emitError(err);
}
emitter.emit('end');
return;
},
);
return emitter;
};