forked from ethereum/go-ethereum
-
Notifications
You must be signed in to change notification settings - Fork 0
/
NBitcoin.xml
5643 lines (5524 loc) · 287 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[]})">
<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.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.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 ideantical 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.UInt64)">
<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="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,System.Byte[],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[])">
<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="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.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="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 representaiton 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="M:NBitcoin.BitcoinAddress.Create(System.String)">
<summary>
Detect whether the input base58 is a pubkey hash or a script hash
</summary>
<param name="str">The string to parse</param>
<returns>A BitcoinAddress or BitcoinScriptAddress</returns>
<exception cref="T:System.FormatException">Invalid format</exception>
</member>
<member name="M:NBitcoin.BitcoinCore.BlockStore.Enumerate(System.Boolean,System.Int32,System.Int32)">
<summary>
</summary>
<param name="headersOnly"></param>
<param name="blockStart">Inclusive block count</param>
<param name="blockEnd">Exclusive block count</param>
<returns></returns>
</member>
<member name="T:NBitcoin.BitcoinCore.TxInUndo">
Undo information for a CTxIn
Contains the prevout's CTxOut being spent, and if this was the
last output of the affected transaction, its metadata as well
(coinbase or not, height, transaction version)
</member>
<member name="M:NBitcoin.BitcoinCore.DiskBlockPosRange.#ctor(NBitcoin.BitcoinCore.DiskBlockPos,NBitcoin.BitcoinCore.DiskBlockPos)">
<summary>
Represent a disk block range
</summary>
<param name="begin">Beginning of the range (included)</param>
<param name="end">End of the range (excluded)</param>
</member>
<member name="T:NBitcoin.IPubkeyHashUsable">
<summary>
Abstracts an object able to verify messages from which it is possible to extract public key.
</summary>
</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>
<param name="prev">previous block</param>
</member>
<member name="M:NBitcoin.BlockHeader.UpdateTime(NBitcoin.Consensus,NBitcoin.ChainedBlock)">
<summary>
Set time to consensus acceptable value
</summary>
<param name="consensus">Consensus</param>
<param name="prev">previous block</param>
</member>
<member name="M:NBitcoin.BlockHeader.UpdateTime(System.DateTimeOffset,NBitcoin.Consensus,NBitcoin.ChainedBlock)">
<summary>
Set time to consensus acceptable value
</summary>
<param name="now">The expected date</param>
<param name="consensus">Consensus</param>
<param name="prev">previous block</param>
</member>
<member name="M:NBitcoin.BlockHeader.UpdateTime(System.DateTimeOffset,NBitcoin.Network,NBitcoin.ChainedBlock)">
<summary>
Set time to consensus acceptable value
</summary>
<param name="now">The expected date</param>
<param name="network">Network</param>
<param name="prev">previous block</param>
</member>
<member name="M:NBitcoin.Block.WithOptions(NBitcoin.TransactionOptions)">
<summary>
Create a block with the specified option only. (useful for stripping data from a block)
</summary>
<param name="options">Options to keep</param>
<returns>A new block with only the options wanted</returns>
</member>
<member name="M:NBitcoin.Block.Check">
<summary>
Check proof of work and merkle root
</summary>
<returns></returns>
</member>
<member name="M:NBitcoin.Block.Check(NBitcoin.Consensus)">
<summary>
Check proof of work and merkle root
</summary>
<param name="consensus"></param>
<returns></returns>
</member>
<member name="T:NBitcoin.BlockLocator">
<summary>
Compact representation of one's chain position which can be used to find forks with another chain
</summary>
</member>
<member name="T:NBitcoin.BloomFilter">
<summary>
Used by SPV client, represent the set of interesting addresses tracked by SPV client with plausible deniability
</summary>
</member>
<member name="T:NBitcoin.BouncyCastle.Asn1.Asn1InputStream">
a general purpose ASN.1 decoder - note: this class differs from the
others in that it returns null after it has read the last object in
the stream. If an ASN.1 Null is encountered a Der/BER Null object is
returned.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Asn1InputStream.#ctor(System.IO.Stream,System.Int32)">
Create an ASN1InputStream where no DER object will be longer than limit.
@param input stream containing ASN.1 encoded data.
@param limit maximum size of a DER encoded object.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Asn1InputStream.#ctor(System.Byte[])">
Create an ASN1InputStream based on the input byte array. The length of DER objects in
the stream is automatically limited to the length of the input array.
@param input array containing ASN.1 encoded data.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Asn1InputStream.BuildObject(System.Int32,System.Int32,System.Int32)">
build an object given its tag and the number of bytes to construct it from.
</member>
<member name="T:NBitcoin.BouncyCastle.Asn1.Asn1Null">
A Null object.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Asn1Object.FromByteArray(System.Byte[])">
<summary>Create a base ASN.1 object from a byte array.</summary>
<param name="data">The byte array to parse.</param>
<returns>The base ASN.1 object represented by the byte array.</returns>
<exception cref="T:System.IO.IOException">If there is a problem parsing the data.</exception>
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Asn1Object.FromStream(System.IO.Stream)">
<summary>Read a base ASN.1 object from a stream.</summary>
<param name="inStr">The stream to parse.</param>
<returns>The base ASN.1 object represented by the byte array.</returns>
<exception cref="T:System.IO.IOException">If there is a problem parsing the data.</exception>
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Asn1OctetString.#ctor(System.Byte[])">
@param string the octets making up the octet string.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Asn1Sequence.GetInstance(System.Object)">
return an Asn1Sequence from the given object.
@param obj the object we want converted.
@exception ArgumentException if the object cannot be converted.
</member>
<member name="P:NBitcoin.BouncyCastle.Asn1.Asn1Sequence.Item(System.Int32)">
return the object at the sequence position indicated by index.
@param index the sequence number (starting at zero) of the object
@return the object at the sequence position indicated by index.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.DerInteger.GetInstance(System.Object)">
return an integer from the passed in object
@exception ArgumentException if the object cannot be converted.
</member>
<member name="P:NBitcoin.BouncyCastle.Asn1.DerInteger.PositiveValue">
in some cases positive values Get crammed into a space,
that's not quite big enough...
</member>
<member name="T:NBitcoin.BouncyCastle.Asn1.DerNull">
A Null object.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.DerObjectIdentifier.On(NBitcoin.BouncyCastle.Asn1.DerObjectIdentifier)">
Return true if this oid is an extension of the passed in branch, stem.
@param stem the arc or branch that is a possible parent.
@return true if the branch is on the passed in stem, false otherwise.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.DerOctetString.#ctor(System.Byte[])">
<param name="str">The octets making up the octet string.</param>
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.DerSequence.#ctor">
create an empty sequence
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.DerSequence.#ctor(NBitcoin.BouncyCastle.Asn1.Asn1Encodable)">
create a sequence containing one object
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.DerSequence.#ctor(NBitcoin.BouncyCastle.Asn1.Asn1EncodableVector)">
create a sequence containing a vector of objects.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Sec.SecNamedCurves.GetByOid(NBitcoin.BouncyCastle.Asn1.DerObjectIdentifier)">
return the X9ECParameters object for the named curve represented by
the passed in object identifier. Null if the curve isn't present.
@param oid an object identifier representing a named curve, if present.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Sec.SecNamedCurves.GetOid(System.String)">
return the object identifier signified by the passed in name. Null
if there is no object identifier associated with name.
@return the object identifier associated with name, if present.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.Sec.SecNamedCurves.GetName(NBitcoin.BouncyCastle.Asn1.DerObjectIdentifier)">
return the named curve name represented by the given object identifier.
</member>
<member name="F:NBitcoin.BouncyCastle.Asn1.Sec.SecObjectIdentifiers.EllipticCurve">
EllipticCurve OBJECT IDENTIFIER ::= {
iso(1) identified-organization(3) certicom(132) curve(0)
}
</member>
<member name="T:NBitcoin.BouncyCastle.Asn1.X9.X9Curve">
ASN.1 def for Elliptic-Curve Curve structure. See
X9.62, for further details.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.X9.X9Curve.ToAsn1Object">
Produce an object suitable for an Asn1OutputStream.
<pre>
Curve ::= Sequence {
a FieldElement,
b FieldElement,
seed BIT STRING OPTIONAL
}
</pre>
</member>
<member name="T:NBitcoin.BouncyCastle.Asn1.X9.X9ECParameters">
ASN.1 def for Elliptic-Curve ECParameters structure. See
X9.62, for further details.
</member>
<member name="P:NBitcoin.BouncyCastle.Asn1.X9.X9ECParameters.CurveEntry">
Return the ASN.1 entry representing the Curve.
@return the X9Curve for the curve in these parameters.
</member>
<member name="P:NBitcoin.BouncyCastle.Asn1.X9.X9ECParameters.FieldIDEntry">
Return the ASN.1 entry representing the FieldID.
@return the X9FieldID for the FieldID in these parameters.
</member>
<member name="P:NBitcoin.BouncyCastle.Asn1.X9.X9ECParameters.BaseEntry">
Return the ASN.1 entry representing the base point G.
@return the X9ECPoint for the base point in these parameters.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.X9.X9ECParameters.ToAsn1Object">
Produce an object suitable for an Asn1OutputStream.
<pre>
ECParameters ::= Sequence {
version Integer { ecpVer1(1) } (ecpVer1),
fieldID FieldID {{FieldTypes}},
curve X9Curve,
base X9ECPoint,
order Integer,
cofactor Integer OPTIONAL
}
</pre>
</member>
<member name="T:NBitcoin.BouncyCastle.Asn1.X9.X9ECPoint">
class for describing an ECPoint as a Der object.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.X9.X9ECPoint.ToAsn1Object">
Produce an object suitable for an Asn1OutputStream.
<pre>
ECPoint ::= OCTET STRING
</pre>
<p>
Octet string produced using ECPoint.GetEncoded().</p>
</member>
<member name="T:NBitcoin.BouncyCastle.Asn1.X9.X9FieldElement">
Class for processing an ECFieldElement as a DER object.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.X9.X9FieldElement.ToAsn1Object">
Produce an object suitable for an Asn1OutputStream.
<pre>
FieldElement ::= OCTET STRING
</pre>
<p>
<ol>
<li> if <i>q</i> is an odd prime then the field element is
processed as an Integer and converted to an octet string
according to x 9.62 4.3.1.</li>
<li> if <i>q</i> is 2<sup>m</sup> then the bit string
contained in the field element is converted into an octet
string with the same ordering padded at the front if necessary.
</li>
</ol>
</p>
</member>
<member name="T:NBitcoin.BouncyCastle.Asn1.X9.X9FieldID">
ASN.1 def for Elliptic-Curve Field ID structure. See
X9.62, for further details.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.X9.X9FieldID.#ctor(NBitcoin.BouncyCastle.Math.BigInteger)">
Constructor for elliptic curves over prime fields
<code>F<sub>2</sub></code>.
@param primeP The prime <code>p</code> defining the prime field.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.X9.X9FieldID.#ctor(System.Int32,System.Int32)">
Constructor for elliptic curves over binary fields
<code>F<sub>2<sup>m</sup></sub></code>.
@param m The exponent <code>m</code> of
<code>F<sub>2<sup>m</sup></sub></code>.
@param k1 The integer <code>k1</code> where <code>x<sup>m</sup> +
x<sup>k1</sup> + 1</code>
represents the reduction polynomial <code>f(z)</code>.
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.X9.X9FieldID.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
Constructor for elliptic curves over binary fields
<code>F<sub>2<sup>m</sup></sub></code>.
@param m The exponent <code>m</code> of
<code>F<sub>2<sup>m</sup></sub></code>.
@param k1 The integer <code>k1</code> where <code>x<sup>m</sup> +
x<sup>k3</sup> + x<sup>k2</sup> + x<sup>k1</sup> + 1</code>
represents the reduction polynomial <code>f(z)</code>.
@param k2 The integer <code>k2</code> where <code>x<sup>m</sup> +
x<sup>k3</sup> + x<sup>k2</sup> + x<sup>k1</sup> + 1</code>
represents the reduction polynomial <code>f(z)</code>.
@param k3 The integer <code>k3</code> where <code>x<sup>m</sup> +
x<sup>k3</sup> + x<sup>k2</sup> + x<sup>k1</sup> + 1</code>
represents the reduction polynomial <code>f(z)</code>..
</member>
<member name="M:NBitcoin.BouncyCastle.Asn1.X9.X9FieldID.ToAsn1Object">
Produce a Der encoding of the following structure.
<pre>
FieldID ::= Sequence {
fieldType FIELD-ID.&id({IOSet}),
parameters FIELD-ID.&Type({IOSet}{@fieldType})
}
</pre>
</member>
<member name="F:NBitcoin.BouncyCastle.Asn1.X9.X9ObjectIdentifiers.IdDsaWithSha1">
id-dsa-with-sha1 OBJECT IDENTIFIER ::= { iso(1) member-body(2)
us(840) x9-57 (10040) x9cm(4) 3 }
</member>
<member name="F:NBitcoin.BouncyCastle.Asn1.X9.X9ObjectIdentifiers.X9x63Scheme">
X9.63
</member>
<member name="F:NBitcoin.BouncyCastle.Asn1.X9.X9ObjectIdentifiers.ansi_x9_42">
X9.42
</member>
<member name="T:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher">
A wrapper class that allows block ciphers to be used to process data in
a piecemeal fashion. The BufferedBlockCipher outputs a block only when the
buffer is full and more data is being added, or on a doFinal.
<p>
Note: in the case where the underlying cipher is either a CFB cipher or an
OFB one the last block may not be a multiple of the block size.
</p>
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.#ctor">
constructor for subclasses
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.#ctor(NBitcoin.BouncyCastle.Crypto.IBlockCipher)">
Create a buffered block cipher without padding.
@param cipher the underlying block cipher this buffering object wraps.
false otherwise.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.Init(System.Boolean,NBitcoin.BouncyCastle.Crypto.ICipherParameters)">
initialise the cipher.
@param forEncryption if true the cipher is initialised for
encryption, if false for decryption.
@param param the key and other data required by the cipher.
@exception ArgumentException if the parameters argument is
inappropriate.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.GetBlockSize">
return the blocksize for the underlying cipher.
@return the blocksize for the underlying cipher.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.GetUpdateOutputSize(System.Int32)">
return the size of the output buffer required for an update
an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to update
with len bytes of input.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.GetOutputSize(System.Int32)">
return the size of the output buffer required for an update plus a
doFinal with an input of len bytes.
@param len the length of the input.
@return the space required to accommodate a call to update and doFinal
with len bytes of input.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.ProcessByte(System.Byte,System.Byte[],System.Int32)">
process a single byte, producing an output block if necessary.
@param in the input byte.
@param out the space for any output that might be produced.
@param outOff the offset from which the output will be copied.
@return the number of output bytes copied to out.
@exception DataLengthException if there isn't enough space in out.
@exception InvalidOperationException if the cipher isn't initialised.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.ProcessBytes(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
process an array of bytes, producing output if necessary.
@param in the input byte array.
@param inOff the offset at which the input data starts.
@param len the number of bytes to be copied out of the input array.
@param out the space for any output that might be produced.
@param outOff the offset from which the output will be copied.
@return the number of output bytes copied to out.
@exception DataLengthException if there isn't enough space in out.
@exception InvalidOperationException if the cipher isn't initialised.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.DoFinal(System.Byte[],System.Int32)">
Process the last block in the buffer.
@param out the array the block currently being held is copied into.
@param outOff the offset at which the copying starts.
@return the number of output bytes copied to out.
@exception DataLengthException if there is insufficient space in out for
the output, or the input is not block size aligned and should be.
@exception InvalidOperationException if the underlying cipher is not
initialised.
@exception InvalidCipherTextException if padding is expected and not found.
@exception DataLengthException if the input is not block size
aligned.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.BufferedBlockCipher.Reset">
Reset the buffer and cipher. After resetting the object is in the same
state as it was after the last init (if there was one).
</member>
<member name="T:NBitcoin.BouncyCastle.Crypto.DataLengthException">
this exception is thrown if a buffer that is meant to have output
copied into it turns out to be too short, or if we've been given
insufficient input. In general this exception will Get thrown rather
than an ArrayOutOfBounds exception.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.DataLengthException.#ctor">
base constructor.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.DataLengthException.#ctor(System.String)">
create a DataLengthException with the given message.
@param message the message to be carried with the exception.
</member>
<member name="T:NBitcoin.BouncyCastle.Crypto.Digests.GeneralDigest">
base implementation of MD4 family style digest as outlined in
"Handbook of Applied Cryptography", pages 344 - 347.
</member>
<member name="T:NBitcoin.BouncyCastle.Crypto.Digests.LongDigest">
Base class for SHA-384 and SHA-512.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.Digests.LongDigest.#ctor">
Constructor for variable length word
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.Digests.LongDigest.#ctor(NBitcoin.BouncyCastle.Crypto.Digests.LongDigest)">
Copy constructor. We are using copy constructors in place
of the object.Clone() interface as this interface is not
supported by J2ME.
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.Digests.LongDigest.AdjustByteCounts">
adjust the byte counts so that byteCount2 represents the
upper long (less 3 bits) word of the byte count.
</member>
<member name="T:NBitcoin.BouncyCastle.Crypto.Digests.RipeMD160Digest">
implementation of RipeMD see,
http://www.esat.kuleuven.ac.be/~bosselae/ripemd160.html
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.Digests.RipeMD160Digest.#ctor">
Standard constructor
</member>
<member name="M:NBitcoin.BouncyCastle.Crypto.Digests.RipeMD160Digest.#ctor(NBitcoin.BouncyCastle.Crypto.Digests.RipeMD160Digest)">
Copy constructor. This will copy the state of the provided
message digest.