-
Notifications
You must be signed in to change notification settings - Fork 0
/
NBitcoin.xml
7244 lines (7114 loc) · 376 KB
/
NBitcoin.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>NBitcoin</name>
</assembly>
<members>
<member name="T:NBitcoin.Base58Data">
<summary>
Base class for all Base58 check representation of data
</summary>
</member>
<member name="T:NBitcoin.BitStream">
<summary> Provides a view of an array of bits as a stream of bits. </summary>
</member>
<member name="T:NBitcoin.GolombRiceFilter">
<summary>
Implements a Golomb-coded set to be use in the creation of client-side filter
for a new kind Bitcoin light clients. This code is based on the BIP:
https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
</summary>
</member>
<member name="P:NBitcoin.GolombRiceFilter.P">
<summary>
a value which is computed as 1/fp where fp is the desired false positive rate.
</summary>
</member>
<member name="P:NBitcoin.GolombRiceFilter.M">
<summary>
a value which is computed as N * fp (or false positive rate = 1/M).
this value allows filter to uniquely tune the range that items are hashed onto
before compressing
</summary>
</member>
<member name="P:NBitcoin.GolombRiceFilter.N">
<summary>
Number of elements in the filter
</summary>
</member>
<member name="P:NBitcoin.GolombRiceFilter.Data">
<summary>
Raw filter data
</summary>
</member>
<member name="M:NBitcoin.GolombRiceFilter.Parse(System.String)">
<summary>
Creates a new Golomb-Rice filter from the data byte array which
contains a serialized filter. Uses the DefaultP value (20).
</summary>
<param name="data">A serialized Golomb-Rice filter.</param>
</member>
<member name="M:NBitcoin.GolombRiceFilter.#ctor(System.Byte[])">
<summary>
Creates a new Golomb-Rice filter from the data byte array which
contains a serialized filter. Uses the DefaultP value (20).
</summary>
<param name="data">A serialized Golomb-Rice filter.</param>
</member>
<member name="M:NBitcoin.GolombRiceFilter.#ctor(System.Byte[],System.Byte,System.UInt32)">
<summary>
Creates a new Golomb-Rice filter from the data byte array which
contains a serialized filter.
</summary>
<param name="data">A serialized Golomb-Rice filter.</param>
<param name="p">The P value to use.</param>
<param name="m">The M value to use.</param>
</member>
<member name="M:NBitcoin.GolombRiceFilter.#ctor(System.Byte[],System.Int32,System.Byte,System.UInt32)">
<summary>
Creates a new Golomb-Rice filter from the data byte array.
</summary>
<param name="data">A serialized Golomb-Rice filter.</param>
<param name="n">The number of elements in the filter.</param>
<param name="p">The P value to use.</param>
<param name="m">The M value to use.</param>
</member>
<member name="M:NBitcoin.GolombRiceFilter.ConstructHashedSet(System.Byte,System.Int32,System.UInt32,System.Byte[],System.Collections.Generic.IEnumerable{System.Byte[]},System.Int32)">
<summary>
Computes the sorted-and-uncompressed list of values to be included in the filter.
/// </summary>
<param name="P">P value used.</param>
<param name="key">Key used for hashing the datalements.</param>
<param name="data">Data elements to be computed in the list.</param>
<returns></returns>
</member>
<member name="M:NBitcoin.GolombRiceFilter.GetHeader(NBitcoin.uint256)">
<summary>
Calculates the filter's header.
</summary>
<param name="previousHeader">Previous filter header.</param>
<returns>The filter header.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilter.Match(System.Byte[],System.Byte[])">
<summary>
Checks if the value passed is in the filter.
</summary>
<param name="data">Data element to check in the filter.</param>
<param name="key">Key used for hashing the data elements.</param>
<returns>true if the element is in the filter, otherwise false.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilter.MatchAny(System.Byte[][],System.Byte[])">
<summary>
Checks if any of the provided elements is in the filter.
</summary>
<param name="data">Data elements to check in the filter.</param>
<param name="key">Key used for hashing the data elements.</param>
<returns>true if at least one of the elements is in the filter, otherwise false.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilter.MatchAny(System.Collections.Generic.IEnumerable{System.Byte[]},System.Byte[])">
<summary>
Checks if any of the provided elements is in the filter.
</summary>
<param name="data">Data elements to check in the filter.</param>
<param name="key">Key used for hashing the data elements.</param>
<returns>true if at least one of the elements is in the filter, otherwise false.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilter.MatchAny(System.Collections.Generic.IEnumerable{System.Byte[]},System.Int32,System.Byte[])">
<summary>
Checks if any of the provided elements is in the filter.
</summary>
<param name="data">Data elements to check in the filter.</param>
<param name="key">Key used for hashing the data elements.</param>
<returns>true if at least one of the elements is in the filter, otherwise false.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilter.ToBytes">
<summary>
Serialize the filter as a array of bytes using [varint(N) | data].
</summary>
<returns>A array of bytes with the serialized filter data.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilter.ToString">
<summary>
Serialize the filter as hexadecimal string.
</summary>
<returns>A string with the serialized filter data</returns>
</member>
<member name="T:NBitcoin.GolombRiceFilterBuilder">
<summary>
Class for creating Golomb-Rice filters for a given block.
It provides methods for building two kind of filters out-of-the-box:
Basic Filters and Extenden Filters.
</summary>
</member>
<member name="T:NBitcoin.GolombRiceFilterBuilder.ByteArrayComparer">
<summary>
Helper class for making sure not two identical data elements are
included in a filter.
</summary>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.BuildBasicFilter(NBitcoin.Block)">
<summary>
Builds the basic filter for a given block.
The basic filter is designed to contain everything that a light client needs to sync a regular Bitcoin wallet.
A basic filter MUST contain exactly the following items for each transaction in a block:
* The outpoint of each input, except for the coinbase transaction
* The scriptPubKey of each output
* The txid of the transaction itself
</summary>
<param name="block">The block used for building the filter.</param>
<returns>The basic filter for the block.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.#ctor">
<summary>
Creates a new Golob-Rice filter builder.
</summary>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.SetKey(NBitcoin.uint256)">
<summary>
Sets the key used for hashing the filter data elements.
The first half of the block hash is used as described in the BIP.
</summary>
<param name="blockHash">The block hash which the hashing key is derived from.</param>
<returns>The updated filter builder instance</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.SetP(System.Int32)">
<summary>
Sets the P value to use.
</summary>
<param name="p">P value</param>
<returns>The updated filter builder instance.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.SetM(System.UInt32)">
<summary>
Sets the M value to use.
</summary>
<param name="m">M value</param>
<returns>The updated filter builder instance.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.AddTxId(NBitcoin.uint256)">
<summary>
Adds a transacion id to the list of elements that will be used for building the filter.
</summary>
<param name="id">The transaction id.</param>
<returns>The updated filter builder instance.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.AddScriptPubkey(NBitcoin.Script)">
<summary>
Adds a scriptPubKey to the list of elements that will be used for building the filter.
</summary>
<param name="scriptPubkey">The scriptPubkey.</param>
<returns>The updated filter builder instance.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.AddScriptSig(NBitcoin.Script)">
<summary>
Adds a scriptSig to the list of elements that will be used for building the filter.
</summary>
<param name="scriptSig">The scriptSig.</param>
<returns>The updated filter builder instance.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.AddWitness(NBitcoin.WitScript)">
<summary>
Adds a witness stack to the list of elements that will be used for building the filter.
</summary>
<param name="witScript">The witScript.</param>
<returns>The updated filter builder instance.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.AddOutPoint(NBitcoin.OutPoint)">
<summary>
Adds an outpoint to the list of elements that will be used for building the filter.
</summary>
<param name="outpoint">The outpoint.</param>
<returns>The updated filter builder instance.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.AddEntries(System.Collections.Generic.IEnumerable{System.Byte[]})">
<summary>
Adds a list of elements to the list of elements that will be used for building the filter.
</summary>
<param name="entries">The entries.</param>
<returns>The updated filter builder instance.</returns>
</member>
<member name="M:NBitcoin.GolombRiceFilterBuilder.Build">
<summary>
Builds the Golomb-Rice filters from the parameters and data elements included.
</summary>
<returns>The built filter.</returns>
</member>
<member name="P:NBitcoin.PSBTSettings.CustomBuilderExtensions">
<summary>
Use custom builder extensions to customize finalization
</summary>
</member>
<member name="P:NBitcoin.PSBTSettings.IsSmart">
<summary>
Try to do anything that is possible to deduce PSBT information from input information
</summary>
</member>
<member name="M:NBitcoin.PSBT.AddTransactions(NBitcoin.Transaction[])">
<summary>
Add transactions to non segwit outputs
</summary>
<param name="parentTransactions">Parent transactions</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.Combine(NBitcoin.PSBT)">
<summary>
If an other PSBT has a specific field and this does not have it, then inject that field to this.
otherwise leave it as it is.
If you need to call this on transactions with different global transaction, use <see cref="M:NBitcoin.PSBT.UpdateFrom(NBitcoin.PSBT)"/> instead.
</summary>
<param name="other">Another PSBT to takes information from</param>
<exception cref="T:System.ArgumentException">Can not Combine PSBT with different global tx.</exception>
<returns>This instance</returns>
</member>
<member name="M:NBitcoin.PSBT.UpdateFrom(NBitcoin.PSBT)">
<summary>
If an other PSBT has a specific field and this does not have it, then inject that field to this.
otherwise leave it as it is.
Contrary to <see cref="M:NBitcoin.PSBT.Combine(NBitcoin.PSBT)"/>, it can be called on PSBT with a different global transaction.
</summary>
<param name="other">Another PSBT to takes information from</param>
<returns>This instance</returns>
</member>
<member name="M:NBitcoin.PSBT.CoinJoin(NBitcoin.PSBT)">
<summary>
Join two PSBT into one CoinJoin PSBT.
This is an immutable method.
TODO: May need assertion for sighash type?
</summary>
<param name="other"></param>
<returns></returns>
</member>
<member name="M:NBitcoin.PSBT.SignAll(NBitcoin.ScriptPubKeyType,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Sign all inputs which derive <paramref name="accountKey"/> of type <paramref name="scriptPubKeyType"/>.
</summary>
<param name="scriptPubKeyType">The way to derive addresses from the accountKey</param>
<param name="accountKey">The account key with which to sign</param>
<param name="accountKeyPath">The account key path (eg. [masterFP]/49'/0'/0')</param>
<param name="sigHash">The SigHash</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.SignAll(NBitcoin.ScriptPubKeyType,NBitcoin.IHDKey)">
<summary>
Sign all inputs which derive <paramref name="accountKey"/> of type <paramref name="scriptPubKeyType"/>.
</summary>
<param name="scriptPubKeyType">The way to derive addresses from the accountKey</param>
<param name="accountKey">The account key with which to sign</param>
<param name="sigHash">The SigHash</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.SignAll(NBitcoin.IHDScriptPubKey,NBitcoin.IHDKey)">
<summary>
Sign all inputs which derive addresses from <paramref name="accountHDScriptPubKey"/> and that need to be signed by <paramref name="accountKey"/>.
</summary>
<param name="accountHDScriptPubKey">The address generator</param>
<param name="accountKey">The account key with which to sign</param>
<param name="sigHash">The SigHash</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.SignAll(NBitcoin.IHDScriptPubKey,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Sign all inputs which derive addresses from <paramref name="accountHDScriptPubKey"/> and that need to be signed by <paramref name="accountKey"/>.
</summary>
<param name="accountHDScriptPubKey">The address generator</param>
<param name="accountKey">The account key with which to sign</param>
<param name="accountKeyPath">The account key path (eg. [masterFP]/49'/0'/0')</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.TryGetFee(NBitcoin.Money@)">
<summary>
Returns the fee of the transaction being signed
</summary>
<param name="fee"></param>
<returns></returns>
</member>
<member name="M:NBitcoin.PSBT.GetFee">
<summary>
Returns the fee of the transaction being signed
</summary>
<returns>The fees</returns>
<exception cref="T:System.InvalidOperationException">Not enough information to know about the fee</exception>
</member>
<member name="M:NBitcoin.PSBT.TryGetEstimatedFeeRate(NBitcoin.FeeRate@)">
<summary>
Returns the fee rate of the transaction. If the PSBT is finalized, then the exact rate is returned, else an estimation is made.
</summary>
<param name="estimatedFeeRate"></param>
<returns>True if could get the estimated fee rate</returns>
</member>
<member name="M:NBitcoin.PSBT.TryGetVirtualSize(System.Int32@)">
<summary>
Returns the virtual transaction size of the transaction. If the PSBT is finalized, then the exact virtual size.
</summary>
<param name="vsize">The calculated virtual size</param>
<returns>True if could get the virtual size could get estimated</returns>
</member>
<member name="M:NBitcoin.PSBT.GetEstimatedFeeRate">
<summary>
Returns the fee rate of the transaction. If the PSBT is finalized, then the exact rate is returned, else an estimation is made.
</summary>
<returns>The estimated fee</returns>
<exception cref="T:System.InvalidOperationException">Not enough information to know about the fee rate</exception>
</member>
<member name="M:NBitcoin.PSBT.PrecomputeTransactionData">
<summary>
Returns a data structure precomputing some hash values that are needed for all inputs to be signed in the transaction.
</summary>
<returns>The PrecomputedTransactionData</returns>
<exception cref="T:NBitcoin.PSBTException">Throw if the PSBT is missing some previous outputs.</exception>
</member>
<member name="M:NBitcoin.PSBT.ExtractTransaction">
<summary>
Extract the fully signed transaction from the PSBT
</summary>
<returns>The fully signed transaction</returns>
<exception cref="T:System.InvalidOperationException">PSBTInputs are not all finalized</exception>
</member>
<member name="M:NBitcoin.PSBT.TryGetFinalizedHash(NBitcoin.uint256@)">
<summary>
Get the expected hash once the transaction is fully signed
</summary>
<param name="hash">The hash once fully signed</param>
<returns>True if we can know the expected hash. False if we can't (unsigned non-segwit).</returns>
</member>
<member name="M:NBitcoin.PSBT.Clone">
<summary>
Clone this PSBT
</summary>
<returns>A cloned PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.Clone(System.Boolean)">
<summary>
Clone this PSBT
</summary>
<param name="keepOriginalTransactionInformation">Whether the original scriptSig and witScript or inputs is saved</param>
<returns>A cloned PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.GetBalance(NBitcoin.ScriptPubKeyType,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Get the balance change if you were signing this transaction.
</summary>
<param name="accountHDScriptPubKey">The hdScriptPubKey used to generate addresses</param>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>The balance change</returns>
</member>
<member name="M:NBitcoin.PSBT.GetBalance(NBitcoin.IHDScriptPubKey,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Get the balance change if you were signing this transaction.
</summary>
<param name="accountHDScriptPubKey">The hdScriptPubKey used to generate addresses</param>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>The balance change</returns>
</member>
<member name="M:NBitcoin.PSBT.CoinsFor(NBitcoin.IHDScriptPubKey,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Filter the coins which contains the <paramref name="accountKey"/> and <paramref name="accountKeyPath"/> in the HDKeys and derive
the same scriptPubKeys as <paramref name="accountHDScriptPubKey"/>.
</summary>
<param name="accountHDScriptPubKey">The hdScriptPubKey used to generate addresses</param>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>Inputs with HD keys matching masterFingerprint and account key</returns>
</member>
<member name="M:NBitcoin.PSBT.HDKeysFor(NBitcoin.IHDScriptPubKey,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Filter the keys which contains the <paramref name="accountKey"/> and <paramref name="accountKeyPath"/> in the HDKeys and whose input/output
the same scriptPubKeys as <paramref name="accountHDScriptPubKey"/>.
</summary>
<param name="accountHDScriptPubKey">The hdScriptPubKey used to generate addresses</param>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>HD Keys matching master root key</returns>
</member>
<member name="M:NBitcoin.PSBT.HDKeysFor(NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Filter the keys which contains the <paramref name="accountKey"/> and <paramref name="accountKeyPath"/>.
</summary>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>HD Keys matching master root key</returns>
</member>
<member name="M:NBitcoin.PSBT.AddKeyPath(NBitcoin.IHDKey,NBitcoin.KeyPath[])">
<summary>
Add keypath information to this PSBT for each input or output involving it
</summary>
<param name="masterKey">The master key of the keypaths</param>
<param name="paths">The path of the public keys</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.AddKeyPath(NBitcoin.IHDKey,System.Tuple{NBitcoin.KeyPath,NBitcoin.Script}[])">
<summary>
Add keypath information to this PSBT for each input or output involving it
</summary>
<param name="masterKey">The master key of the keypaths</param>
<param name="paths">The path of the public keys with their expected scriptPubKey</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.AddKeyPath(NBitcoin.PubKey,NBitcoin.RootedKeyPath)">
<summary>
Add keypath information to this PSBT for each input or output involving it
</summary>
<param name="pubkey">The public key which need to sign</param>
<param name="rootedKeyPath">The keypath to this public key</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.AddKeyPath(NBitcoin.PubKey,NBitcoin.RootedKeyPath,NBitcoin.Script)">
<summary>
Add keypath information to this PSBT, if the PSBT all finalized this operation is a no-op
</summary>
<param name="pubkey">The public key which need to sign</param>
<param name="rootedKeyPath">The keypath to this public key</param>
<param name="scriptPubKey">A specific scriptPubKey this pubkey is involved with</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBT.RebaseKeyPaths(NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Rebase the keypaths.
If a PSBT updater only know the child HD public key but not the root one, another updater knowing the parent master key it is based on
can rebase the paths. If the PSBT is all finalized this operation is a no-op
</summary>
<param name="accountKey">The current account key</param>
<param name="newRoot">The KeyPath with the fingerprint of the new root key</param>
<returns>This PSBT</returns>
</member>
<member name="M:NBitcoin.PSBTCoin.HDKeysFor(NBitcoin.IHDScriptPubKey,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Filter the keys which contains the <paramref name="accountKey"/> and <paramref name="accountKeyPath"/> in the HDKeys and whose input/output
the same scriptPubKeys as <paramref name="accountHDScriptPubKey"/>.
</summary>
<param name="accountHDScriptPubKey">The accountHDScriptPubKey used to generate addresses</param>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>HD Keys matching master root key</returns>
</member>
<member name="P:NBitcoin.PSBTHDKeyMatch.AddressKeyPath">
<summary>
KeyPath relative to the accountKey to PubKey
</summary>
</member>
<member name="M:NBitcoin.PSBTCoinList`1.CoinsFor(NBitcoin.IHDScriptPubKey,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Filter the coins which contains the <paramref name="accountKey"/> and <paramref name="accountKeyPath"/> in the HDKeys and derive
the same scriptPubKeys as <paramref name="accountHDScriptPubKey"/>.
</summary>
<param name="accountHDScriptPubKey">The hdScriptPubKey used to generate addresses</param>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>Inputs with HD keys matching masterFingerprint and account key</returns>
</member>
<member name="M:NBitcoin.PSBTCoinList`1.HDKeysFor(NBitcoin.IHDScriptPubKey,NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Filter the keys which contains the <paramref name="accountKey"/> and <paramref name="accountKeyPath"/> in the HDKeys and whose input/output
the same scriptPubKeys as <paramref name="accountHDScriptPubKey"/>.
</summary>
<param name="accountHDScriptPubKey">The hdScriptPubKey used to generate addresses</param>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>HD Keys matching master root key</returns>
</member>
<member name="M:NBitcoin.PSBTCoinList`1.HDKeysFor(NBitcoin.IHDKey,NBitcoin.RootedKeyPath)">
<summary>
Filter the keys which contains the <paramref name="accountKey"/> and <paramref name="accountKeyPath"/>.
</summary>
<param name="accountKey">The account key that will be used to sign (ie. 49'/0'/0')</param>
<param name="accountKeyPath">The account key path</param>
<returns>HD Keys matching master root key</returns>
</member>
<member name="M:NBitcoin.PSBTInput.SetSequence(System.UInt16)">
<summary>
Changes the nSequence field of the corresponding TxIn.
You should not call this method if any PSBTInput in the same PSBT has a signature.
Because the siagnature usually commits to the old nSequence value.
</summary>
<exception cref="T:System.InvalidOperationException">When at least one signature exists in any other inputs in the PSBT</exception>
</member>
<member name="M:NBitcoin.PSBTInput.UpdateFrom(NBitcoin.PSBTInput)">
<summary>
Import informations contained by <paramref name="other"/> into this instance.
</summary>
<param name="other"></param>
</member>
<member name="M:NBitcoin.PSBTInput.GetPushItems(NBitcoin.Script)">
<summary>
conovert partial sigs to suitable form for ScriptSig (or Witness).
This will preserve the ordering of redeem script even if it did not follow bip67.
</summary>
<param name="redeem"></param>
<returns></returns>
</member>
<member name="M:NBitcoin.PSBTInput.ClearForFinalize">
<summary>
Delete superflous information from a finalized input.
This will not clear utxos since tx extractor might want to check the validity
</summary>
<exception cref="T:System.InvalidOperationException">The input need to be finalized</exception>
</member>
<member name="M:NBitcoin.PSBTInput.GetSignableCoin">
<summary>
Represent this input as a coin that can be used for signing operations.
Returns null if <see cref="P:NBitcoin.PSBTInput.WitnessUtxo"/>, <see cref="P:NBitcoin.PSBTInput.NonWitnessUtxo"/> are not set
or if <see cref="P:NBitcoin.PSBTCoin.WitnessScript"/> or <see cref="P:NBitcoin.PSBTCoin.RedeemScript"/> are missing but needed.
</summary>
<returns>The input as a signable coin</returns>
</member>
<member name="M:NBitcoin.PSBTInput.GetSignableCoin(System.String@)">
<summary>
Represent this input as a coin that can be used for signing operations.
Returns null if <see cref="P:NBitcoin.PSBTInput.WitnessUtxo"/>, <see cref="P:NBitcoin.PSBTInput.NonWitnessUtxo"/> are not set
or if <see cref="P:NBitcoin.PSBTCoin.WitnessScript"/> or <see cref="P:NBitcoin.PSBTCoin.RedeemScript"/> are missing but needed.
</summary>
<param name="error">If it is not possible to retrieve the signable coin, a human readable reason.</param>
<returns>The input as a signable coin</returns>
</member>
<member name="M:NBitcoin.PSBTInput.TrySlimUTXO">
<summary>
Check if this satisfies criteria for witness. if it does, delete non_witness_utxo
This is useful for following reasons.
1. It will make a data smaller which is an obviously good thing.
2. Future HW Wallet may not support non segwit tx and thus won't recognize non_witness_utxo
3. To pass test in BIP174
</summary>
</member>
<member name="M:NBitcoin.PSBTInput.GetCoin">
<summary>
Represent this input as a coin.
Returns null if <see cref="P:NBitcoin.PSBTInput.WitnessUtxo"/> or <see cref="P:NBitcoin.PSBTInput.NonWitnessUtxo"/> is not set.
</summary>
<returns>The input as a coin</returns>
</member>
<member name="M:NBitcoin.PSBTOutput.UpdateFrom(NBitcoin.PSBTOutput)">
<summary>
Import informations contained by <paramref name="other"/> into this instance.
</summary>
<param name="other"></param>
</member>
<member name="T:NBitcoin.BitcoinExtKey">
<summary>
Base58 representation of an ExtKey, within a particular network.
</summary>
</member>
<member name="M:NBitcoin.BitcoinExtKey.#ctor(System.String,NBitcoin.Network)">
<summary>
Constructor. Creates an extended key from the Base58 representation, checking the expected network.
</summary>
</member>
<member name="M:NBitcoin.BitcoinExtKey.#ctor(NBitcoin.ExtKey,NBitcoin.Network)">
<summary>
Constructor. Creates a representation of an extended key, within the specified network.
</summary>
</member>
<member name="P:NBitcoin.BitcoinExtKey.IsValid">
<summary>
Gets whether the data is the correct expected length.
</summary>
</member>
<member name="P:NBitcoin.BitcoinExtKey.ExtKey">
<summary>
Gets the extended key, converting from the Base58 representation.
</summary>
</member>
<member name="P:NBitcoin.BitcoinExtKey.Type">
<summary>
Gets the type of item represented by this Base58 data.
</summary>
</member>
<member name="P:NBitcoin.BitcoinExtKey.ScriptPubKey">
<summary>
Gets the script of the hash of the public key corresponing to the private key
of the extended key of this Base58 item.
</summary>
</member>
<member name="M:NBitcoin.BitcoinExtKey.Neuter">
<summary>
Gets the Base58 representation, in the same network, of the neutered extended key.
</summary>
</member>
<member name="P:NBitcoin.BitcoinExtKey.PrivateKey">
<summary>
Gets the private key of the extended key of this Base58 item.
</summary>
</member>
<member name="M:NBitcoin.BitcoinExtKey.op_Implicit(NBitcoin.BitcoinExtKey)~NBitcoin.ExtKey">
<summary>
Implicit cast from BitcoinExtKey to ExtKey.
</summary>
</member>
<member name="T:NBitcoin.BitcoinExtPubKey">
<summary>
Base58 representation of an ExtPubKey, within a particular network.
</summary>
</member>
<member name="M:NBitcoin.BitcoinExtPubKey.#ctor(System.String,NBitcoin.Network)">
<summary>
Constructor. Creates an extended public key from the Base58 representation, checking the expected network.
</summary>
</member>
<member name="M:NBitcoin.BitcoinExtPubKey.#ctor(NBitcoin.ExtPubKey,NBitcoin.Network)">
<summary>
Constructor. Creates a representation of an extended public key, within the specified network.
</summary>
</member>
<member name="P:NBitcoin.BitcoinExtPubKey.ExtPubKey">
<summary>
Gets the extended public key, converting from the Base58 representation.
</summary>
</member>
<member name="P:NBitcoin.BitcoinExtPubKey.Type">
<summary>
Gets the type of item represented by this Base58 data.
</summary>
</member>
<member name="P:NBitcoin.BitcoinExtPubKey.ScriptPubKey">
<summary>
Gets the script of the hash of the public key of the extended key of this Base58 item.
</summary>
</member>
<member name="M:NBitcoin.BitcoinExtPubKey.op_Implicit(NBitcoin.BitcoinExtPubKey)~NBitcoin.ExtPubKey">
<summary>
Implicit cast from BitcoinExtPubKey to ExtPubKey.
</summary>
</member>
<member name="T:NBitcoin.ExtKey">
<summary>
A private Hierarchical Deterministic key
</summary>
</member>
<member name="M:NBitcoin.ExtKey.Parse(System.String,NBitcoin.Network)">
<summary>
Parses the Base58 data (checking the network if specified), checks it represents the
correct type of item, and then returns the corresponding ExtKey.
</summary>
</member>
<member name="P:NBitcoin.ExtKey.Depth">
<summary>
Gets the depth of this extended key from the root key.
</summary>
</member>
<member name="P:NBitcoin.ExtKey.Child">
<summary>
Gets the child number of this key (in reference to the parent).
</summary>
</member>
<member name="M:NBitcoin.ExtKey.#ctor(NBitcoin.BitcoinExtPubKey,NBitcoin.BitcoinSecret)">
<summary>
Constructor. Reconstructs an extended key from the Base58 representations of
the public key and corresponding private key.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.#ctor(NBitcoin.ExtPubKey,NBitcoin.Key)">
<summary>
Constructor. Creates an extended key from the public key and corresponding private key.
</summary>
<remarks>
<para>
The ExtPubKey has the relevant values for child number, depth, chain code, and fingerprint.
</para>
</remarks>
</member>
<member name="M:NBitcoin.ExtKey.#ctor(NBitcoin.Key,System.Byte[],System.Byte,NBitcoin.HDFingerprint,System.UInt32)">
<summary>
Constructor. Creates an extended key from the private key, and specified values for
chain code, depth, fingerprint, and child number.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.#ctor(NBitcoin.Key,System.Byte[])">
<summary>
Constructor. Creates an extended key from the private key, with the specified value
for chain code. Depth, fingerprint, and child number, will have their default values.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.#ctor">
<summary>
Constructor. Creates a new extended key with a random 64 byte seed.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.#ctor(System.String)">
<summary>
Constructor. Creates a new extended key from the specified seed bytes, from the given hex string.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.#ctor(System.Byte[],System.Boolean)">
<summary>
Constructor. Creates a new extended key from the specified seed bytes.
</summary>
</member>
<member name="P:NBitcoin.ExtKey.PrivateKey">
<summary>
Get the private key of this extended key.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.Neuter">
<summary>
Create the public key from this key.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.Derive(System.UInt32)">
<summary>
Derives a new extended key in the hierarchy as the given child number.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.Derive(System.Int32,System.Boolean)">
<summary>
Derives a new extended key in the hierarchy as the given child number,
setting the high bit if hardened is specified.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.Derive(NBitcoin.KeyPath)">
<summary>
Derives a new extended key in the hierarchy at the given path below the current key,
by deriving the specified child at each step.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.GetWif(NBitcoin.Network)">
<summary>
Converts the extended key to the base58 representation, within the specified network.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.ToString(NBitcoin.Network)">
<summary>
Converts the extended key to the base58 representation, as a string, within the specified network.
</summary>
</member>
<member name="P:NBitcoin.ExtKey.ScriptPubKey">
<summary>
Gets the script of the hash of the public key corresponding to the private key.
</summary>
</member>
<member name="P:NBitcoin.ExtKey.IsHardened">
<summary>
Gets whether or not this extended key is a hardened child.
</summary>
</member>
<member name="M:NBitcoin.ExtKey.GetParentExtKey(NBitcoin.ExtPubKey)">
<summary>
Recreates the private key of the parent from the private key of the child
combinated with the public key of the parent (hardened children cannot be
used to recreate the parent).
</summary>
</member>
<member name="T:NBitcoin.ExtPubKey">
<summary>
A public HD key
</summary>
</member>
<member name="M:NBitcoin.ExtPubKey.#ctor(System.Byte[])">
<summary>
Constructor. Creates a new extended public key from the specified extended public key bytes.
</summary>
</member>
<member name="M:NBitcoin.ExtPubKey.#ctor(System.Byte[],System.Int32,System.Int32)">
<summary>
Creates a new extended public key from the specified extended public key bytes.
</summary>
</member>
<member name="M:NBitcoin.ExtPubKey.#ctor(System.String)">
<summary>
Constructor. Creates a new extended public key from the specified extended public key bytes, from the given hex string.
</summary>
</member>
<member name="P:NBitcoin.ExtPubKey.ScriptPubKey">
<summary>
The P2PKH payment script
</summary>
</member>
<member name="T:NBitcoin.KeyPath">
<summary>
Represent a path in the hierarchy of HD keys (BIP32)
</summary>
</member>
<member name="M:NBitcoin.KeyPath.Parse(System.String)">
<summary>
Parse a KeyPath
</summary>
<param name="path">The KeyPath formated like 10/0/2'/3</param>
<returns></returns>
</member>
<member name="M:NBitcoin.KeyPath.TryParse(System.String,NBitcoin.KeyPath@)">
<summary>
Try Parse a KeyPath
</summary>
<param name="path">The KeyPath formated like 10/0/2'/3</param>
<param name="keyPath">The successfully parsed Key path</param>
<returns>True if the string is parsed successfully; otherwise false</returns>
</member>
<member name="P:NBitcoin.KeyPath.IsHardened">
<summary>
True if the last index in the path is hardened
</summary>
</member>
<member name="M:NBitcoin.KeyPath.GetAddressKeyPath">
<summary>
Returns the longest non-hardened keypath to the leaf.
For example, if the keypath is "49'/0'/0'/1/23", then the address key path is "1/23"
</summary>
<returns>Return the address key path</returns>
</member>
<member name="M:NBitcoin.KeyPath.GetAccountKeyPath">
<summary>
Returns the longest hardened keypath from the root.
For example, if the keypath is "49'/0'/0'/1/23", then the account key path is "49'/0'/0'"
</summary>
<returns>Return the account key path</returns>
</member>
<member name="P:NBitcoin.KeyPath.IsHardenedPath">
<summary>
True if at least one index in the path is hardened
</summary>
</member>
<member name="T:NBitcoin.RootedKeyPath">
<summary>
KeyPath with the fingerprint of the root it should derive from
</summary>
</member>
<member name="M:NBitcoin.RootedKeyPath.GetAccountKeyPath">
<summary>
Returns the longest hardened keypath from the root.
For example, if the keypath is "49'/0'/0'/1/23", then the account key path is "49'/0'/0'"
</summary>
<returns>Return the account key path</returns>
</member>
<member name="M:NBitcoin.RootedKeyPath.ToStringWithEmptyKeyPathAware">
<summary>
Mostly works same with `ToString()`, but if the `KeyPath` is empty, it just returns master finger print
without `/` in the suffix
</summary>
<returns></returns>
</member>
<member name="M:NBitcoin.BitcoinEncryptedSecretEC.HashAddress(NBitcoin.BitcoinAddress)">
<summary>
Take the first four bytes of SHA256(SHA256(generatedaddress)) and call it addresshash.
</summary>
<param name="address"></param>
<returns></returns>
</member>
<member name="M:NBitcoin.BitcoinEncryptedSecret.GetKey(System.String)">
<summary>
Get the decrypted private key
</summary>
<param name="password">The password</param>
<returns>The decrypted key</returns>
<exception cref="T:System.Security.SecurityException">Invalid password</exception>
</member>
<member name="M:NBitcoin.BitcoinEncryptedSecret.TryGetKey(System.String,NBitcoin.Key@)">
<summary>
Get the decrypted private key
</summary>
<param name="password">The password</param>
<param name="key">The decrypted key if successfull</param>
<returns>True if successfull</returns>
</member>
<member name="T:NBitcoin.Mnemonic">
<summary>
A .NET implementation of the Bitcoin Improvement Proposal - 39 (BIP39)
BIP39 specification used as reference located here: https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki
Made by thashiznets@yahoo.com.au
v1.0.1.1
I ♥ Bitcoin :)
Bitcoin:1ETQjMkR1NNh4jwLuN5LxY7bMsHC9PUPSV
</summary>
</member>
<member name="M:NBitcoin.Mnemonic.#ctor(NBitcoin.Wordlist,System.Byte[])">
<summary>
Generate a mnemonic
</summary>
<param name="wordList"></param>
<param name="entropy"></param>
</member>
<member name="M:NBitcoin.Wordlist.#ctor(System.String[],System.Char,System.String)">
<summary>
Constructor used by inheritence only
</summary>
<param name="words">The words to be used in the wordlist</param>
</member>
<member name="M:NBitcoin.Wordlist.WordExists(System.String,System.Int32@)">
<summary>
Method to determine if word exists in word list, great for auto language detection
</summary>
<param name="word">The word to check for existence</param>
<returns>Exists (true/false)</returns>
</member>
<member name="M:NBitcoin.Wordlist.GetWordAtIndex(System.Int32)">
<summary>
Returns a string containing the word at the specified index of the wordlist
</summary>
<param name="index">Index of word to return</param>
<returns>Word</returns>
</member>
<member name="P:NBitcoin.Wordlist.WordCount">
<summary>
The number of all the words in the wordlist
</summary>
</member>
<member name="F:NBitcoin.BIP9DeploymentsParameters.AlwaysActive">
<summary>Special flag for timeout to indicate always active.</summary>
</member>
<member name="T:NBitcoin.BitcoinScriptAddress">
<summary>
Base58 representation of a script hash
</summary>
</member>
<member name="T:NBitcoin.BitcoinAddress">
<summary>
Base58 representation of a bitcoin address
</summary>
</member>
<member name="M:NBitcoin.BitcoinAddress.Create(System.String,NBitcoin.Network)">
<summary>
Detect whether the input base58 is a pubkey hash or a script hash
</summary>
<param name="str">The string to parse</param>
<param name="expectedNetwork">The expected network to which it belongs</param>
<returns>A BitcoinAddress or BitcoinScriptAddress</returns>
<exception cref="T:System.FormatException">Invalid format</exception>
</member>
<member name="T:NBitcoin.BitcoinPubKeyAddress">
<summary>
Base58 representation of a pubkey hash and base class for the representation of a script hash
</summary>
</member>
<member name="P:NBitcoin.BitcoinStream.ConsensusFactory">
<summary>
Set the format to use when serializing and deserializing consensus related types.
</summary>
</member>
<member name="T:NBitcoin.BlockHeader">
<summary>
Nodes collect new transactions into a block, hash them into a hash tree,
and scan through nonce values to make the block's hash satisfy proof-of-work
requirements. When they solve the proof-of-work, they broadcast the block
to everyone and the block is added to the block chain. The first transaction
in the block is a special one that creates a new coin owned by the creator
of the block.
</summary>
</member>
<member name="M:NBitcoin.BlockHeader.PrecomputeHash(System.Boolean,System.Boolean)">
<summary>
Precompute the block header hash so that later calls to GetHash() will returns the precomputed hash
</summary>
<param name="invalidateExisting">If true, the previous precomputed hash is thrown away, else it is reused</param>
<param name="lazily">If true, the hash will be calculated and cached at the first call to GetHash(), else it will be immediately</param>
</member>
<member name="M:NBitcoin.BlockHeader.UpdateTime(NBitcoin.Network,NBitcoin.ChainedBlock)">
<summary>
Set time to consensus acceptable value
</summary>
<param name="network">Network</param>