forked from lightningdevkit/ldk-swift
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathHumanObjectPeerTestInstance.swift
981 lines (806 loc) · 45.5 KB
/
HumanObjectPeerTestInstance.swift
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
//
// HumanObjectPeerTestInstance.swift
// LDKConsumerExperiment
//
// Created by Arik Sosman on 7/22/21.
//
#if SWIFT_PACKAGE
import LDKSwift
import LDKHeaders
#endif
import XCTest
public class HumanObjectPeerTestInstance {
private let configuration: Configuration
public class Configuration {
//
public var useFilter: Bool = false
public var useRouter: Bool = false
public var useWrappedSignerProvider: Bool = false
public var shouldRecipientRejectPayment: Bool = false
public var ephemeralNetworkGraphForScorer: Bool = false
public var reserializedProbabilisticScorer: Bool = false
// public var nice_close: Bool = false;
// public var use_km_wrapper: Bool = false;
// public var use_manual_watch: Bool = false;
// public var reload_peers: Bool = false;
// public var break_cross_peer_refs: Bool = false;
// public var use_nio_peer_handler: Bool = false;
private class func listCustomizeableProperties() -> [String] {
return ["useFilter", "useRouter", "useWrappedSignerProvider", "shouldRecipientRejectPayment", "ephemeralNetworkGraphForScorer", "reserializedProbabilisticScorer"]
}
public class func combinationCount() -> UInt {
return 1 << self.listCustomizeableProperties().count
}
}
public init(configuration: Configuration) {
self.configuration = configuration
}
fileprivate class Peer {
private(set) var txBroadcaster: BroadcasterInterface!
weak var master: HumanObjectPeerTestInstance!
let logger: Logger
let feeEstimator: FeeEstimator
let seed: UInt8
var filterAdditions: Set<String>
let monitors: [String: ChannelMonitor]
private(set) var filter: Filter?
private(set) var explicitKeysManager: KeysManager!
private(set) var wrappedKeysManager: WrappedSignerProviderTests.MyKeysManager?
private(set) var router: GossipSync!
private(set) var channelManager: ChannelManager!
private(set) var peerManager: PeerManager!
private(set) var constructor: ChannelManagerConstructor?
private(set) var tcpSocketHandler: TCPPeerHandler?
private(set) var tcpPort: UInt16?
fileprivate enum SocketBindError: Error {
case failedToBindSocket
}
fileprivate enum ChannelManagerEventError: Error {
case notUsingChannelManagerConstructor
}
fileprivate actor PendingEventTracker {
private(set) var pendingManagerEvents: [Event] = []
private(set) var continuations: [CheckedContinuation<Void, Never>] = []
private func triggerContinuations(){
let continuations = self.continuations
self.continuations.removeAll()
for currentContinuation in continuations {
currentContinuation.resume()
}
}
func addEvent(event: Event) {
self.pendingManagerEvents.append(event)
self.triggerContinuations()
}
func addEvents(events: [Event]) {
self.pendingManagerEvents.append(contentsOf: events)
self.triggerContinuations()
}
func getCount() -> Int {
return self.pendingManagerEvents.count
}
func getEvents() -> [Event] {
return self.pendingManagerEvents
}
func getAndClearEvents() -> [Event]{
let events = self.pendingManagerEvents
self.pendingManagerEvents.removeAll()
return events
}
func awaitAddition() async {
await withCheckedContinuation({ continuation in
self.continuations.append(continuation)
})
}
}
private(set) var pendingEventTracker = PendingEventTracker()
fileprivate actor PendingBroadcastTracker {
private(set) var pendingBroadcastSet: Set<[UInt8]> = Set()
private(set) var continuations: [CheckedContinuation<Void, Never>] = []
func addTransaction(tx: [UInt8]) {
self.pendingBroadcastSet.insert(tx)
self.triggerContinuations()
}
func getCount() -> Int {
return self.pendingBroadcastSet.count
}
func getTransactions() -> Set<[UInt8]> {
return self.pendingBroadcastSet
}
func getAndClearTransactions() -> Set<[UInt8]> {
let txs = self.pendingBroadcastSet
self.pendingBroadcastSet.removeAll()
return txs
}
private func triggerContinuations(){
let continuations = self.continuations
self.continuations.removeAll()
for currentContinuation in continuations {
currentContinuation.resume()
}
}
func awaitAddition() async {
await withCheckedContinuation({ continuation in
self.continuations.append(continuation)
})
}
}
private(set) var pendingBroadcastTracker = PendingBroadcastTracker()
private(set) var nodeId: [UInt8]?
var chainWatch: Watch?
var chainMonitor: ChainMonitor?
fileprivate class TestBroadcaster: BroadcasterInterface {
weak var master: Peer!
fileprivate init(master: Peer) {
self.master = master
super.init()
}
override func broadcastTransactions(txs: [[UInt8]]) {
for tx in txs {
Task {
await self.master.pendingBroadcastTracker.addTransaction(tx: tx)
}
}
}
}
fileprivate class TestFilter: Filter {
weak var master: Peer!
fileprivate init(master: Peer) {
self.master = master
super.init()
}
override func registerOutput(output: WatchedOutput) {
let outpoint = output.getOutpoint()
self.master.filterAdditions.insert("\(outpoint.getTxid()):\(outpoint.getIndex())")
}
override func registerTx(txid: [UInt8]?, scriptPubkey: [UInt8]) {
self.master.filterAdditions.insert("\(txid)")
}
}
fileprivate class TestKeysInterface: SignerProvider {
weak var master: Peer!
let interface: SignerProvider
fileprivate init(master: Peer, underlyingInterface: SignerProvider) {
self.master = master
self.interface = underlyingInterface
super.init()
}
override func deriveChannelSigner(channelValueSatoshis: UInt64, channelKeysId: [UInt8]) -> Bindings.WriteableEcdsaChannelSigner {
let ck = self.interface.deriveChannelSigner(channelValueSatoshis: channelValueSatoshis, channelKeysId: channelKeysId)
return ck
}
}
fileprivate class TestChannelManagerPersister: Persister, ExtendedChannelManagerPersister {
weak var master: Peer!
fileprivate init(master: Peer) {
self.master = master
super.init()
}
func handleEvent(event: Event) {
// let eventClone = event.clone()
print("peer \(self.master.seed) received event: \(event.getValueType())")
Task {
// clone to avoid deallocation-related issues
await master.pendingEventTracker.addEvent(event: event)
}
}
override func persistScorer(scorer: Bindings.WriteableScore) -> Bindings.Result_NoneIOErrorZ {
.initWithOk()
}
override func persistGraph(networkGraph: Bindings.NetworkGraph) -> Bindings.Result_NoneIOErrorZ {
let writtenGraph = networkGraph.write();
return .initWithOk()
}
override func persistManager(channelManager: Bindings.ChannelManager) -> Bindings.Result_NoneIOErrorZ {
.initWithOk()
}
}
fileprivate class TestPersister: Persist {
override func persistNewChannel(channelFundingOutpoint channelId: Bindings.OutPoint, data: Bindings.ChannelMonitor, updateId: Bindings.MonitorUpdateId) -> Bindings.ChannelMonitorUpdateStatus {
.Completed
}
override func updatePersistedChannel(channelFundingOutpoint channelId: Bindings.OutPoint, update: Bindings.ChannelMonitorUpdate, data: Bindings.ChannelMonitor, updateId: Bindings.MonitorUpdateId) -> Bindings.ChannelMonitorUpdateStatus {
.Completed
}
}
fileprivate init(master: HumanObjectPeerTestInstance, _dummy: Any, seed: UInt8) {
self.master = master
self.logger = TestLogger()
self.feeEstimator = TestFeeEstimator()
self.monitors = [String: ChannelMonitor]()
self.seed = seed
let persister = TestPersister()
self.filterAdditions = Set<String>()
self.txBroadcaster = TestBroadcaster(master: self)
if master.configuration.useFilter {
self.filter = TestFilter(master: self)
}
// never use manual watch
do {
self.chainMonitor = ChainMonitor(chainSource: self.filter, broadcaster: self.txBroadcaster, logger: self.logger, feeest: self.feeEstimator, persister: persister)
self.chainWatch = self.chainMonitor!.asWatch()
}
var keySeed = [UInt8](repeating: 0, count: 32)
for i in 0..<32 {
keySeed[i] = UInt8(i) ^ seed
}
let timestamp_seconds = UInt64(NSDate().timeIntervalSince1970)
let timestamp_nanos = UInt32(truncating: NSNumber(value: timestamp_seconds * 1000 * 1000))
let keysManager = KeysManager(seed: keySeed, startingTimeSecs: timestamp_seconds, startingTimeNanos: timestamp_nanos)
self.explicitKeysManager = keysManager
if master.configuration.useWrappedSignerProvider {
self.wrappedKeysManager = WrappedSignerProviderTests.MyKeysManager(seed: keySeed, startingTimeSecs: timestamp_seconds, startingTimeNanos: timestamp_nanos)
}
if master.configuration.useRouter {
let networkGraph = NetworkGraph(network: .Regtest, logger: self.logger)
self.router = GossipSync.initWithP2P(a: P2PGossipSync(networkGraph: networkGraph, utxoLookup: nil, logger: self.logger))
} else {
self.router = GossipSync.none()
}
}
fileprivate convenience init(master: HumanObjectPeerTestInstance, seed: UInt8) {
self.init(master: master, _dummy: (), seed: seed)
do {
// channel manager constructor is mandatory
let graph = NetworkGraph(network: .Regtest, logger: self.logger)
var scorerGraph = graph
if master.configuration.ephemeralNetworkGraphForScorer {
scorerGraph = NetworkGraph(network: .Regtest, logger: self.logger)
}
let decayParams = ProbabilisticScoringDecayParameters.initWithDefault()
var probabalisticScorer = ProbabilisticScorer(decayParams: decayParams, networkGraph: scorerGraph, logger: self.logger)
if master.configuration.reserializedProbabilisticScorer {
let serializedScorer = probabalisticScorer.write()
let probabalisticScorerResult = ProbabilisticScorer.read(ser: serializedScorer, argA: decayParams, argB: scorerGraph, argC: self.logger)
probabalisticScorer = probabalisticScorerResult.getValue()!
}
let score = probabalisticScorer.asScore()
let multiThreadedScorer = MultiThreadedLockableScore(score: score)
let signerProvider = master.configuration.useWrappedSignerProvider ? self.wrappedKeysManager!.signerProvider : self.explicitKeysManager.asSignerProvider()
let constructionParameters = ChannelManagerConstructionParameters(
config: UserConfig.initWithDefault(),
entropySource: self.explicitKeysManager.asEntropySource(),
nodeSigner: self.explicitKeysManager.asNodeSigner(),
signerProvider: signerProvider,
feeEstimator: self.feeEstimator,
chainMonitor: self.chainMonitor!,
txBroadcaster: self.txBroadcaster,
logger: self.logger,
scorer: multiThreadedScorer
)
self.constructor = ChannelManagerConstructor(network: .Bitcoin, currentBlockchainTipHash: [UInt8](repeating: 0, count: 32), currentBlockchainTipHeight: 0, netGraph: graph, params: constructionParameters)
self.constructor?.chainSyncCompleted(persister: TestChannelManagerPersister(master: self))
self.channelManager = self.constructor!.channelManager
self.peerManager = self.constructor!.peerManager
}
self.nodeId = self.channelManager.getOurNodeId()
try! self.bindSocketHandler()
}
fileprivate convenience init(original: Peer) {
self.init(master: original.master, _dummy: (), seed: original.seed)
do {
// channel manager constructor is mandatory
let graph = NetworkGraph(network: .Bitcoin, logger: self.logger)
let constructionParameters = ChannelManagerConstructionParameters(
config: UserConfig.initWithDefault(),
entropySource: self.explicitKeysManager.asEntropySource(),
nodeSigner: self.explicitKeysManager.asNodeSigner(),
signerProvider: self.explicitKeysManager.asSignerProvider(),
feeEstimator: self.feeEstimator,
chainMonitor: self.chainMonitor!,
txBroadcaster: self.txBroadcaster,
logger: self.logger
)
self.constructor = ChannelManagerConstructor(network: .Bitcoin, currentBlockchainTipHash: [UInt8](repeating: 0, count: 32), currentBlockchainTipHeight: 0, netGraph: graph, params: constructionParameters)
self.constructor?.chainSyncCompleted(persister: TestChannelManagerPersister(master: self))
self.channelManager = self.constructor!.channelManager
Task {
let events = await original.pendingEventTracker.getEvents()
await self.pendingEventTracker.addEvents(events: events)
}
}
self.nodeId = self.channelManager.getOurNodeId()
try! self.bindSocketHandler()
}
private func bindSocketHandler() throws {
self.tcpSocketHandler = self.constructor!.getTCPPeerHandler()
print("Attempting to bind socket…")
for i in 10000...65535 {
let port = UInt16(i)
let bound = self.tcpSocketHandler!.bind(address: "127.0.0.1", port: port)
if bound {
print("Bound socket to port \(port) on attempt \(i-9999)")
self.tcpPort = port
return
}
}
print("Failed to bind on any port")
throw SocketBindError.failedToBindSocket
}
fileprivate func payInvoice() {
}
fileprivate func getManualWatch() {
}
fileprivate func getManagerEvents(expectedCount: UInt) async throws -> [Event] {
print("Awaiting \(expectedCount) manager events…")
while true {
if await self.pendingEventTracker.getCount() >= expectedCount {
print("Found enough manager events for expected count of \(expectedCount)")
let events = await self.pendingEventTracker.getAndClearEvents()
print("Found manager event count: \(events.count)")
return events
}
// sleep for 0.1 seconds
// try await Task.sleep(nanoseconds: 0_100_000_000)
await self.pendingEventTracker.awaitAddition()
}
}
fileprivate func getPendingBroadcasts(expectedCount: UInt) async -> Set<[UInt8]> {
while true {
if await self.pendingBroadcastTracker.getCount() >= expectedCount {
return await self.pendingBroadcastTracker.getAndClearTransactions()
}
await self.pendingBroadcastTracker.awaitAddition()
}
}
fileprivate func connectBlock(block: BTCBlock, height: UInt32, expectedMonitorUpdateLength: Int) {
let blockSerialization = block.serialize()
var transactionTuples: [(UInt, [UInt8])] = []
if block.transactions.count > 0 {
XCTAssertEqual(block.transactions.count, 1)
transactionTuples.append((0, block.transactions[0].serialize()))
}
if let chainMonitor = self.chainMonitor {
self.channelManager.asListen().blockConnected(block: blockSerialization, height: height)
chainMonitor.asListen().blockConnected(block: blockSerialization, height: height)
} else {
let blockHeader = block.calculateHeader()
self.channelManager.asConfirm().transactionsConfirmed(header: blockHeader, txdata: transactionTuples, height: height)
self.channelManager.asConfirm().bestBlockUpdated(header: blockHeader, height: height)
for (_, monitor) in self.monitors {
let connectionResult = monitor.blockConnected(header: blockHeader, txdata: transactionTuples, height: height, broadcaster: self.txBroadcaster, feeEstimator: self.feeEstimator, logger: self.logger)
XCTAssertEqual(connectionResult.count, expectedMonitorUpdateLength)
}
}
}
deinit {
print("deiniting Peer")
}
}
func do_read_event(pm: PeerManager, descriptor: SocketDescriptor, data: [UInt8]) {
let res = pm.readEvent(peerDescriptor: descriptor, data: data)
assert(res.isOk())
}
fileprivate func connectPeers(peerA: Peer, peerB: Peer) {
let connectionResult = peerA.tcpSocketHandler?.connect(address: "127.0.0.1", port: peerB.tcpPort!, theirNodeId: peerB.nodeId!)
print("connection result: \(connectionResult)")
}
func test_multiple_peer_connections() async {
let peerA = Peer(master: self, seed: 1)
let peerB = Peer(master: self, seed: 2)
let peerC = Peer(master: self, seed: 3)
let originalPeersA = peerA.peerManager.listPeers()
let originalPeersB = peerB.peerManager.listPeers()
let originalPeersC = peerC.peerManager.listPeers()
XCTAssertEqual(originalPeersA.count, 0)
XCTAssertEqual(originalPeersB.count, 0)
XCTAssertEqual(originalPeersC.count, 0)
do {
connectPeers(peerA: peerA, peerB: peerB)
// sleep for one second
try! await Task.sleep(nanoseconds: 1_000_000_000)
let connectedPeersA = peerA.peerManager.listPeers()
let connectedPeersB = peerB.peerManager.listPeers()
XCTAssertEqual(connectedPeersA.count, 1)
XCTAssertEqual(connectedPeersB.count, 1)
}
do {
connectPeers(peerA: peerA, peerB: peerC)
// sleep for one second
try! await Task.sleep(nanoseconds: 1_000_000_000)
let connectedPeersA = peerA.peerManager.listPeers()
let connectedPeersC = peerC.peerManager.listPeers()
XCTAssertEqual(connectedPeersA.count, 2)
XCTAssertEqual(connectedPeersC.count, 1)
}
do {
// sleep for a total of 10 seconds
for i in 0..<100 {
// sleep for 100ms
try! await Task.sleep(nanoseconds: 0_100_000_000)
}
peerA.constructor?.interrupt()
peerB.constructor?.interrupt()
peerC.constructor?.interrupt()
}
}
fileprivate class func openChannel(peerA: Peer, peerB: Peer, fundingAmount: UInt64, latestBlock: BTCBlock? = nil, otherPeers: [Peer] = []) async -> BTCBlock? {
do {
// initiate channel opening
let config = UserConfig.initWithDefault()
let theirNodeId = peerB.channelManager.getOurNodeId()
let userChannelId: [UInt8] = [UInt8](repeating: 42, count: 16);
let channelOpenResult = peerA.channelManager.createChannel(theirNetworkKey: theirNodeId, channelValueSatoshis: fundingAmount, pushMsat: 1000, userChannelId: userChannelId, temporaryChannelId: ChannelId.initWithZero(), overrideConfig: config)
XCTAssertTrue(channelOpenResult.isOk())
let channels = peerA.channelManager.listChannels()
let firstChannel = channels[0]
let fundingTxo = firstChannel.getFundingTxo()
XCTAssertNil(fundingTxo)
}
let channelsA = peerA.channelManager.listChannels()
XCTAssertEqual(channelsA.count, 1)
let managerEvents = try! await peerA.getManagerEvents(expectedCount: 1)
XCTAssertEqual(managerEvents.count, 1)
let managerEvent = managerEvents[0]
guard case .FundingGenerationReady = managerEvent.getValueType() else {
XCTAssert(false, "Expected .FundingGenerationReady, got \(managerEvent.getValueType())")
return nil
}
let fundingReadyEvent = managerEvent.getValueAsFundingGenerationReady()!
XCTAssertEqual(fundingReadyEvent.getChannelValueSatoshis(), fundingAmount)
let expectedUserChannelId: [UInt8] = [UInt8](repeating: 42, count: 16);
XCTAssertEqual(fundingReadyEvent.getUserChannelId(), expectedUserChannelId)
let fundingOutputScript = fundingReadyEvent.getOutputScript();
let temporaryChannelId = fundingReadyEvent.getTemporaryChannelId();
XCTAssertEqual(fundingOutputScript.count, 34)
XCTAssertEqual(fundingOutputScript[0], 0)
XCTAssertEqual(fundingOutputScript[1], 32)
let fundingTransaction = BTCTransaction()
fundingTransaction.version = 1
let input = BTCTransaction.Input(
previousTransactionHash: BTCHashing.SHA_ZERO_HASH,
previousOutputIndex: 0xffffffff, // coinbase transaction has a u32::MAX prev output index
script: []
)
fundingTransaction.inputs = [input]
fundingTransaction.setWitnessForInput(inputIndex: 0, witness: BTCTransaction.Witness(stackElements: [[1]]))
let output = BTCTransaction.Output(value: fundingAmount, script: fundingOutputScript)
fundingTransaction.outputs = [output]
let serializedFundingTx = fundingTransaction.serialize()
let fundingResult = peerA.channelManager.fundingTransactionGenerated(temporaryChannelId: temporaryChannelId, counterpartyNodeId: peerB.channelManager.getOurNodeId(), fundingTransaction: serializedFundingTx)
XCTAssertTrue(fundingResult.isOk())
let pendingBroadcasts = await peerA.getPendingBroadcasts(expectedCount: 1)
XCTAssertEqual(pendingBroadcasts.count, 1)
XCTAssertEqual(pendingBroadcasts.first!, serializedFundingTx)
let fundingBlock = BTCBlock()
fundingBlock.version = 2
fundingBlock.previousBlockHash = latestBlock?.calculateHash() ?? BTCHashing.SHA_ZERO_HASH
fundingBlock.merkleRoot = BTCHashing.SHA_ZERO_HASH
fundingBlock.timestamp = 42
fundingBlock.difficultyTarget = 0
fundingBlock.nonce = 0
fundingBlock.height = (latestBlock?.height ?? 0) + 1;
fundingBlock.transactions = [fundingTransaction]
print("Connecting funding block…")
peerA.connectBlock(block: fundingBlock, height: fundingBlock.height, expectedMonitorUpdateLength: 0)
peerB.connectBlock(block: fundingBlock, height: fundingBlock.height, expectedMonitorUpdateLength: 0)
for currentPeer in otherPeers {
currentPeer.connectBlock(block: fundingBlock, height: fundingBlock.height, expectedMonitorUpdateLength: 0)
}
print("Connecting confirmation blocks…")
var previousBlock = fundingBlock
for height in (fundingBlock.height+1)..<(fundingBlock.height+100) {
let currentBlock = BTCBlock()
currentBlock.version = 2
currentBlock.previousBlockHash = previousBlock.calculateHash()
currentBlock.merkleRoot = BTCHashing.SHA_ZERO_HASH
currentBlock.timestamp = UInt32(42 + height)
currentBlock.difficultyTarget = 0
currentBlock.nonce = 0
currentBlock.height = height
peerA.connectBlock(block: currentBlock, height: UInt32(height), expectedMonitorUpdateLength: 0)
peerB.connectBlock(block: currentBlock, height: UInt32(height), expectedMonitorUpdateLength: 0)
for currentPeer in otherPeers {
currentPeer.connectBlock(block: currentBlock, height: UInt32(height), expectedMonitorUpdateLength: 0)
}
previousBlock = currentBlock
}
let peer1Events = try! await peerA.getManagerEvents(expectedCount: 2)
let peer1ReadyEvent = peer1Events[1]
guard case .ChannelReady = peer1ReadyEvent.getValueType() else {
XCTAssert(false, "Expected .ChannelReady, got \(peer1ReadyEvent.getValueType())")
return nil
}
let peer2Events = try! await peerB.getManagerEvents(expectedCount: 2)
let peer2ReadyEvent = peer2Events[1]
guard case .ChannelReady = peer2ReadyEvent.getValueType() else {
XCTAssert(false, "Expected .ChannelReady, got \(peer2ReadyEvent.getValueType())")
return nil
}
var usableChannelsA = [ChannelDetails]()
var usableChannelsB = [ChannelDetails]()
print("Awaiting usable channels to populate…")
while (usableChannelsA.isEmpty || usableChannelsB.isEmpty) {
usableChannelsA = peerA.channelManager.listUsableChannels()
usableChannelsB = peerB.channelManager.listUsableChannels()
// sleep for 100ms
try! await Task.sleep(nanoseconds: 0_100_000_000)
}
print("Usable channels have been populated")
XCTAssertEqual(usableChannelsA.count, 1)
XCTAssertEqual(usableChannelsB.count, 1)
let channelAToB = usableChannelsA[0]
let channelBToA = usableChannelsB[0]
XCTAssertEqual(channelAToB.getChannelValueSatoshis(), fundingAmount)
let shortChannelId = channelAToB.getShortChannelId()!
let fundingChannelId = ChannelId.initWithV1FromFundingTxid(txid: fundingTransaction.calculateId(), outputIndex: 0)
XCTAssertEqual(usableChannelsA[0].getChannelId().write(), fundingChannelId.write())
XCTAssertEqual(usableChannelsB[0].getChannelId().write(), fundingChannelId.write())
let originalChannelBalanceAToB = channelAToB.getBalanceMsat()
let originalChannelBalanceBToA = channelBToA.getBalanceMsat()
print("original balance A->B mSats: \(originalChannelBalanceAToB)")
print("original balance B->A mSats: \(originalChannelBalanceBToA)")
// return the latest block after activating the channel
return previousBlock
}
func testMessageHandling() async {
let FUNDING_SATOSHI_AMOUNT: UInt64 = 100_000 // 100k satoshis
let SEND_MSAT_AMOUNT_A_TO_B: UInt64 = 10_000_000 // 10k satoshis
let SEND_MSAT_AMOUNT_B_TO_A: UInt64 = 3_000_000 // 3k satoshis
let SEND_MSAT_AMOUNT_A_TO_C: UInt64 = 5_000_000 // 5k satoshis, with intermediate hop
let peer1 = Peer(master: self, seed: 1)
let peer2 = Peer(master: self, seed: 2)
let peer3 = Peer(master: self, seed: 3)
do {
// connect the nodes
let originalPeersA = peer1.peerManager.listPeers()
let originalPeersB = peer2.peerManager.listPeers()
XCTAssertEqual(originalPeersA.count, 0)
XCTAssertEqual(originalPeersB.count, 0)
connectPeers(peerA: peer1, peerB: peer2)
connectPeers(peerA: peer2, peerB: peer3)
// sleep for one second
try! await Task.sleep(nanoseconds: 1_000_000_000)
let connectedPeersA = peer1.peerManager.listPeers()
let connectedPeersB = peer2.peerManager.listPeers()
let connectedPeersC = peer3.peerManager.listPeers()
XCTAssertEqual(connectedPeersA.count, 1)
XCTAssertEqual(connectedPeersB.count, 2)
XCTAssertEqual(connectedPeersC.count, 1)
}
var confirmedChannelBlock = await HumanObjectPeerTestInstance.openChannel(peerA: peer1, peerB: peer2, fundingAmount: FUNDING_SATOSHI_AMOUNT, otherPeers: [peer3])
let usableChannelsA = peer1.channelManager.listUsableChannels()
let usableChannelsB = peer2.channelManager.listUsableChannels()
let channelAToB = usableChannelsA[0]
let channelBToA = usableChannelsB[0]
// confirmedChannelBlock = await HumanObjectPeerTestInstance.openChannel(peerA: peer2, peerB: peer3, fundingAmount: FUNDING_SATOSHI_AMOUNT, latestBlock: confirmedChannelBlock, otherPeers: [peer1])
let originalChannelBalanceAToB = channelAToB.getBalanceMsat()
let originalChannelBalanceBToA = channelBToA.getBalanceMsat()
let secondChannelBalanceAToB = channelAToB.getBalanceMsat()
let secondChannelBalanceBToA = channelBToA.getBalanceMsat()
let logger = TestLogger()
do {
// create invoice for 10k satoshis to pay to peer2
let invoiceResult = Bindings.createInvoiceFromChannelmanager(channelmanager: peer2.channelManager, nodeSigner: peer2.explicitKeysManager.asNodeSigner(), logger: logger, network: .Bitcoin, amtMsat: SEND_MSAT_AMOUNT_A_TO_B, description: "Invoice description", invoiceExpiryDeltaSecs: 60, minFinalCltvExpiryDelta: 24)
if let invoiceError = invoiceResult.getError(){
let creationError = invoiceError.getValueAsCreationError()
print("creation error: \(creationError)")
}
let invoice = invoiceResult.getValue()!
print("Invoice: \(invoice.toStr())")
let recreatedInvoice = Bolt11Invoice.fromStr(s: invoice.toStr())
XCTAssertTrue(recreatedInvoice.isOk())
// find route
do {
let payerPubkey = peer1.channelManager.getOurNodeId()
let payeePubkey = peer2.channelManager.getOurNodeId()
let paymentParameters = PaymentParameters.initForKeysend(payeePubkey: payeePubkey, finalCltvExpiryDelta: 3, allowMpp: false)
let amount = invoice.amountMilliSatoshis()!
let routeParameters = RouteParameters(paymentParamsArg: paymentParameters, finalValueMsatArg: amount, maxTotalRoutingFeeMsatArg: nil)
let randomSeedBytes: [UInt8] = [UInt8](repeating: 0, count: 32)
let scoringParams = ProbabilisticScoringDecayParameters.initWithDefault()
let networkGraph = peer1.constructor!.netGraph!
let scorer = ProbabilisticScorer(decayParams: scoringParams, networkGraph: networkGraph, logger: logger)
let score = scorer.asScoreLookUp()
let scoreParams = ProbabilisticScoringFeeParameters.initWithDefault()
let foundRoute = Bindings.findRoute(
ourNodePubkey: payerPubkey,
routeParams: routeParameters,
networkGraph: networkGraph,
firstHops: usableChannelsA,
logger: logger,
scorer: score,
scoreParams: scoreParams,
randomSeedBytes: randomSeedBytes
)
let route = foundRoute.getValue()!
let fees = route.getTotalFees()
print("found route fees: \(fees)")
}
let channelManagerConstructor = peer1.constructor!
let (paymentHash, recipientOnion, routeParameters) = Bindings.paymentParametersFromInvoice(invoice: invoice).getValue()!
let paymentId = invoice.paymentHash()!
let invoicePaymentResult = channelManagerConstructor.channelManager.sendPayment(paymentHash: paymentHash, recipientOnion: recipientOnion, paymentId: paymentId, routeParams: routeParameters, retryStrategy: Bindings.Retry.initWithAttempts(a: 3))
// let invoicePaymentResult = Bindings.payInvoice(invoice: invoice, retryStrategy: Bindings.Retry.initWithAttempts(a: 3), channelmanager: channelManagerConstructor.channelManager)
XCTAssertTrue(invoicePaymentResult.isOk())
do {
// process HTLCs
let peer2Event = try! await peer2.getManagerEvents(expectedCount: 1)[0]
guard case .PendingHTLCsForwardable = peer2Event.getValueType() else {
return XCTAssert(false, "Expected .PendingHTLCsForwardable, got \(peer2Event.getValueType())")
}
let pendingHTLCsForwardable = peer2Event.getValueAsPendingHtlcsForwardable()!
print("forwardable time: \(pendingHTLCsForwardable.getTimeForwardable())")
peer2.channelManager.processPendingHtlcForwards()
print("processed pending HTLC forwards")
}
do {
// process payment
let peer2Event = try! await peer2.getManagerEvents(expectedCount: 1)[0]
guard case .PaymentClaimable = peer2Event.getValueType() else {
return XCTAssert(false, "Expected .PaymentReceived, got \(peer2Event.getValueType())")
}
let paymentClaimable = peer2Event.getValueAsPaymentClaimable()!
let paymentHash = paymentClaimable.getPaymentHash()
print("received payment of \(paymentClaimable.getAmountMsat()) with hash \(paymentHash)")
let paymentPurpose = paymentClaimable.getPurpose()
guard case .Bolt11InvoicePayment = paymentPurpose.getValueType() else {
return XCTAssert(false, "Expected .InvoicePayment, got \(paymentPurpose.getValueType())")
}
let invoicePayment = paymentPurpose.getValueAsBolt11InvoicePayment()!
let preimage = invoicePayment.getPaymentPreimage()!
let secret = invoicePayment.getPaymentSecret()
if self.configuration.shouldRecipientRejectPayment {
print("about to fail payment because shouldRecipientRejectPayment flag is set")
peer2.channelManager.failHtlcBackwards(paymentHash: paymentHash)
print("deliberately failed payment with hash \(paymentHash)")
for _ in 0..<10{
// this may have a random delay, run it repeatedly
peer2.channelManager.processPendingHtlcForwards()
try! await Task.sleep(nanoseconds: 0_100_000_000)
}
} else {
peer2.channelManager.claimFunds(paymentPreimage: preimage)
print("claimed payment with secret \(secret) using preimage \(preimage)")
}
}
if self.configuration.shouldRecipientRejectPayment {
let peer1Events = try! await peer1.getManagerEvents(expectedCount: 1)
let paymentPathFailedEvent = peer1Events[0]
guard case .PaymentPathFailed = paymentPathFailedEvent.getValueType() else {
return XCTAssert(false, "Expected .PaymentPathFailed, got \(paymentPathFailedEvent.getValueType())")
}
let paymentPathFailed = paymentPathFailedEvent.getValueAsPaymentPathFailed()!
let failureDescriptor: [String: Any] = [
"payment_id": paymentPathFailed.getPaymentId(),
"payment_hash": paymentPathFailed.getPaymentHash(),
"payment_failed_permanently": paymentPathFailed.getPaymentFailedPermanently(),
"short_channel_id": paymentPathFailed.getShortChannelId(),
"path": paymentPathFailed.getPath().getHops().map { $0.getShortChannelId() },
"failure": paymentPathFailed.getFailure()
]
print("payent path failure: \(failureDescriptor)")
print("here")
return
} else {
// process payment
let peer1Events = try! await peer1.getManagerEvents(expectedCount: 2)
let paymentSentEvent = peer1Events[0]
let paymentPathSuccessfulEvent = peer1Events[1]
guard case .PaymentSent = paymentSentEvent.getValueType() else {
return XCTAssert(false, "Expected .PaymentSent, got \(paymentSentEvent.getValueType())")
}
guard case .PaymentPathSuccessful = paymentPathSuccessfulEvent.getValueType() else {
return XCTAssert(false, "Expected .PaymentPathSuccessful, got \(paymentPathSuccessfulEvent.getValueType())")
}
let paymentSent = paymentSentEvent.getValueAsPaymentSent()!
let paymentPathSuccessful = paymentPathSuccessfulEvent.getValueAsPaymentPathSuccessful()!
print("sent payment \(paymentSent.getPaymentId()) with fee \(paymentSent.getFeePaidMsat()) via \(paymentPathSuccessful.getPath().getHops().map { h in h.getShortChannelId() })")
}
var currentChannelABalance = secondChannelBalanceAToB
var currentChannelBBalance = secondChannelBalanceBToA
while true {
let channelA = peer1.channelManager.listUsableChannels()[0]
let channelB = peer2.channelManager.listUsableChannels()[0]
currentChannelABalance = channelA.getBalanceMsat()
currentChannelBBalance = channelB.getBalanceMsat()
if currentChannelABalance != secondChannelBalanceAToB && currentChannelBBalance != secondChannelBalanceBToA {
break
}
// sleep for 100ms
try! await Task.sleep(nanoseconds: 0_100_000_000)
}
// let invoicePayment = invoicePaymentResult.getValue()!
XCTAssert(invoicePaymentResult.isOk())
XCTAssertEqual(currentChannelABalance, secondChannelBalanceAToB - SEND_MSAT_AMOUNT_A_TO_B)
XCTAssertEqual(currentChannelBBalance, secondChannelBalanceBToA + SEND_MSAT_AMOUNT_A_TO_B)
}
do {
// send some money back
// create invoice for 10k satoshis to pay to peer2
let prePaymentBalanceAToB = peer1.channelManager.listUsableChannels()[0].getBalanceMsat()
let prePaymentBalanceBToA = peer2.channelManager.listUsableChannels()[0].getBalanceMsat()
print("pre-payment balance A->B mSats: \(prePaymentBalanceAToB)")
print("pre-payment balance B->A mSats: \(prePaymentBalanceBToA)")
let invoiceResult = Bindings.createInvoiceFromChannelmanager(channelmanager: peer1.channelManager, nodeSigner: peer1.explicitKeysManager.asNodeSigner(), logger: logger, network: .Bitcoin, amtMsat: nil, description: "Second invoice description", invoiceExpiryDeltaSecs: 60, minFinalCltvExpiryDelta: 24)
let invoice = invoiceResult.getValue()!
print("Implicit amount invoice: \(invoice.toStr())")
let invoiceString = invoice.toStr()
let recreatedInvoice = Bolt11Invoice.fromStr(s: invoiceString)
XCTAssertTrue(recreatedInvoice.isOk())
let (paymentHash, recipientOnion, routeParameters) = Bindings.paymentParametersFromZeroAmountInvoice(invoice: invoice, amountMsat: SEND_MSAT_AMOUNT_B_TO_A).getValue()!
let paymentId = invoice.paymentHash()!
let invoicePaymentResult = peer2.channelManager.sendPayment(paymentHash: paymentHash, recipientOnion: recipientOnion, paymentId: paymentId, routeParams: routeParameters, retryStrategy: Retry.initWithAttempts(a: 3))
if let error = invoicePaymentResult.getError() {
print("sending error: \(error)")
}
XCTAssertTrue(invoicePaymentResult.isOk())
do {
// process HTLCs
let peer1Event = try! await peer1.getManagerEvents(expectedCount: 1)[0]
guard case .PendingHTLCsForwardable = peer1Event.getValueType() else {
return XCTAssert(false, "Expected .PendingHTLCsForwardable, got \(peer1Event.getValueType())")
}
let pendingHTLCsForwardable = peer1Event.getValueAsPendingHtlcsForwardable()!
print("forwardable time: \(pendingHTLCsForwardable.getTimeForwardable())")
peer1.channelManager.processPendingHtlcForwards()
print("processed pending HTLC forwards")
}
do {
// process payment
let peer1Event = try! await peer1.getManagerEvents(expectedCount: 1)[0]
guard case .PaymentClaimable = peer1Event.getValueType() else {
return XCTAssert(false, "Expected .PaymentReceived, got \(peer1Event.getValueType())")
}
let paymentClaimable = peer1Event.getValueAsPaymentClaimable()!
let paymentHash = paymentClaimable.getPaymentHash()
print("received payment of \(paymentClaimable.getAmountMsat()) with hash \(paymentHash)")
let paymentPurpose = paymentClaimable.getPurpose()
guard case .Bolt11InvoicePayment = paymentPurpose.getValueType() else {
return XCTAssert(false, "Expected .InvoicePayment, got \(paymentPurpose.getValueType())")
}
let invoicePayment = paymentPurpose.getValueAsBolt11InvoicePayment()!
let preimage = invoicePayment.getPaymentPreimage()!
let secret = invoicePayment.getPaymentSecret()
peer1.channelManager.claimFunds(paymentPreimage: preimage)
print("claimed payment with secret \(secret) using preimage \(preimage)")
}
do {
// process payment
let peer2Events = try! await peer2.getManagerEvents(expectedCount: 3)
print("received event count: \(peer2Events.count)")
let paymentClaimedEvent = peer2Events[0]
let paymentSentEvent = peer2Events[1]
let paymentPathSuccessfulEvent = peer2Events[2]
guard case .PaymentClaimed = paymentClaimedEvent.getValueType() else {
return XCTAssert(false, "Expected .PaymentClaimed, got \(paymentClaimedEvent.getValueType())")
}
guard case .PaymentSent = paymentSentEvent.getValueType() else {
return XCTAssert(false, "Expected .PaymentSent, got \(paymentSentEvent.getValueType())")
}
guard case .PaymentPathSuccessful = paymentPathSuccessfulEvent.getValueType() else {
return XCTAssert(false, "Expected .PaymentPathSuccessful, got \(paymentPathSuccessfulEvent.getValueType())")
}
let paymentClaimed = paymentClaimedEvent.getValueAsPaymentClaimed()!
let paymentSent = paymentSentEvent.getValueAsPaymentSent()!
let paymentPathSuccessful = paymentPathSuccessfulEvent.getValueAsPaymentPathSuccessful()!
print("sent payment \(paymentSent.getPaymentId()) worth \(paymentClaimed.getAmountMsat()) with fee \(paymentSent.getFeePaidMsat()) via \(paymentPathSuccessful.getPath().getHops().map { h in h.getShortChannelId() })")
}
var currentChannelABalance = prePaymentBalanceAToB
var currentChannelBBalance = prePaymentBalanceBToA
while true {
let channelA = peer1.channelManager.listUsableChannels()[0]
let channelB = peer2.channelManager.listUsableChannels()[0]
currentChannelABalance = channelA.getBalanceMsat()
currentChannelBBalance = channelB.getBalanceMsat()
if currentChannelABalance != prePaymentBalanceAToB && currentChannelBBalance != prePaymentBalanceBToA {
break
}
// sleep for 100ms
try! await Task.sleep(nanoseconds: 0_100_000_000)
}
// let invoicePayment = invoicePaymentResult.getValue()!
XCTAssert(invoicePaymentResult.isOk())
XCTAssertEqual(currentChannelABalance, prePaymentBalanceAToB + SEND_MSAT_AMOUNT_B_TO_A)
XCTAssertEqual(currentChannelBBalance, prePaymentBalanceBToA - SEND_MSAT_AMOUNT_B_TO_A)
XCTAssertEqual(currentChannelABalance, secondChannelBalanceAToB - SEND_MSAT_AMOUNT_A_TO_B + SEND_MSAT_AMOUNT_B_TO_A)
XCTAssertEqual(currentChannelBBalance, secondChannelBalanceBToA + SEND_MSAT_AMOUNT_A_TO_B - SEND_MSAT_AMOUNT_B_TO_A)
}
do {
// sleep for 5 seconds to ensure sanity
try! await Task.sleep(nanoseconds: 5_000_000_000)
peer1.constructor?.interrupt()
peer2.constructor?.interrupt()
}
}
}