@bsv/sdk 1.4.22 → 1.4.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/dist/cjs/package.json +1 -1
  2. package/dist/cjs/src/auth/certificates/VerifiableCertificate.js +10 -0
  3. package/dist/cjs/src/auth/certificates/VerifiableCertificate.js.map +1 -1
  4. package/dist/cjs/src/auth/clients/AuthFetch.js.map +1 -1
  5. package/dist/cjs/src/transaction/broadcasters/Teranode.js +64 -0
  6. package/dist/cjs/src/transaction/broadcasters/Teranode.js.map +1 -0
  7. package/dist/cjs/src/transaction/broadcasters/index.js +3 -1
  8. package/dist/cjs/src/transaction/broadcasters/index.js.map +1 -1
  9. package/dist/cjs/src/transaction/http/BinaryFetchClient.js +94 -0
  10. package/dist/cjs/src/transaction/http/BinaryFetchClient.js.map +1 -0
  11. package/dist/cjs/src/transaction/http/NodejsHttpClient.js.map +1 -1
  12. package/dist/cjs/src/transaction/http/index.js +3 -1
  13. package/dist/cjs/src/transaction/http/index.js.map +1 -1
  14. package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
  15. package/dist/esm/src/auth/certificates/VerifiableCertificate.js +10 -0
  16. package/dist/esm/src/auth/certificates/VerifiableCertificate.js.map +1 -1
  17. package/dist/esm/src/auth/clients/AuthFetch.js.map +1 -1
  18. package/dist/esm/src/transaction/broadcasters/Teranode.js +62 -0
  19. package/dist/esm/src/transaction/broadcasters/Teranode.js.map +1 -0
  20. package/dist/esm/src/transaction/broadcasters/index.js +1 -0
  21. package/dist/esm/src/transaction/broadcasters/index.js.map +1 -1
  22. package/dist/esm/src/transaction/http/BinaryFetchClient.js +90 -0
  23. package/dist/esm/src/transaction/http/BinaryFetchClient.js.map +1 -0
  24. package/dist/esm/src/transaction/http/NodejsHttpClient.js.map +1 -1
  25. package/dist/esm/src/transaction/http/index.js +1 -0
  26. package/dist/esm/src/transaction/http/index.js.map +1 -1
  27. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  28. package/dist/types/src/auth/certificates/VerifiableCertificate.d.ts +9 -1
  29. package/dist/types/src/auth/certificates/VerifiableCertificate.d.ts.map +1 -1
  30. package/dist/types/src/auth/clients/AuthFetch.d.ts.map +1 -1
  31. package/dist/types/src/transaction/broadcasters/Teranode.d.ts +25 -0
  32. package/dist/types/src/transaction/broadcasters/Teranode.d.ts.map +1 -0
  33. package/dist/types/src/transaction/broadcasters/index.d.ts +1 -0
  34. package/dist/types/src/transaction/broadcasters/index.d.ts.map +1 -1
  35. package/dist/types/src/transaction/http/BinaryFetchClient.d.ts +50 -0
  36. package/dist/types/src/transaction/http/BinaryFetchClient.d.ts.map +1 -0
  37. package/dist/types/src/transaction/http/index.d.ts +1 -0
  38. package/dist/types/src/transaction/http/index.d.ts.map +1 -1
  39. package/dist/types/tsconfig.types.tsbuildinfo +1 -1
  40. package/dist/umd/bundle.js +1 -1
  41. package/docs/auth.md +120 -46
  42. package/docs/compat.md +48 -24
  43. package/docs/identity.md +14 -8
  44. package/docs/kvstore.md +9 -3
  45. package/docs/messages.md +4 -4
  46. package/docs/overlay-tools.md +69 -21
  47. package/docs/primitives.md +379 -235
  48. package/docs/registry.md +20 -14
  49. package/docs/script.md +87 -33
  50. package/docs/storage.md +17 -11
  51. package/docs/totp.md +11 -5
  52. package/docs/transaction.md +145 -67
  53. package/docs/wallet.md +169 -133
  54. package/package.json +1 -1
  55. package/src/auth/certificates/VerifiableCertificate.ts +24 -0
  56. package/src/auth/certificates/__tests/VerifiableCertificate.test.ts +28 -1
  57. package/src/auth/clients/AuthFetch.ts +2 -0
  58. package/src/transaction/broadcasters/Teranode.ts +77 -0
  59. package/src/transaction/broadcasters/index.ts +1 -0
  60. package/src/transaction/http/BinaryFetchClient.ts +141 -0
  61. package/src/transaction/http/NodejsHttpClient.ts +1 -1
  62. package/src/transaction/http/index.ts +1 -0
@@ -47,7 +47,7 @@ export default abstract class BasePoint {
47
47
  }
48
48
  ```
49
49
 
50
- See also: [Curve](./primitives.md#class-curve)
50
+ See also: [Curve](#class-curve)
51
51
 
52
52
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
53
53
 
@@ -203,7 +203,11 @@ export default class BigNumber {
203
203
  }
204
204
  ```
205
205
 
206
- See also: [ReductionContext](./primitives.md#class-reductioncontext), [toArray](./primitives.md#variable-toarray), [toHex](./primitives.md#variable-tohex)
206
+ See also: [ReductionContext](#class-reductioncontext), [toArray](#variable-toarray), [toHex](#variable-tohex)
207
+
208
+ <details>
209
+
210
+ <summary>Class BigNumber Details</summary>
207
211
 
208
212
  #### Constructor
209
213
 
@@ -266,7 +270,7 @@ Reduction context of the big number.
266
270
  ```ts
267
271
  red: ReductionContext | null
268
272
  ```
269
- See also: [ReductionContext](./primitives.md#class-reductioncontext)
273
+ See also: [ReductionContext](#class-reductioncontext)
270
274
 
271
275
  #### Property wordSize
272
276
 
@@ -305,7 +309,7 @@ The multiplicative inverse is a number which when multiplied with the current Bi
305
309
  ```ts
306
310
  _invmp(p: BigNumber): BigNumber
307
311
  ```
308
- See also: [BigNumber](./primitives.md#class-bignumber)
312
+ See also: [BigNumber](#class-bignumber)
309
313
 
310
314
  Returns
311
315
 
@@ -332,7 +336,7 @@ This method modifies the existing BigNumber instance.
332
336
  ```ts
333
337
  _ishlnsubmul(num: BigNumber, mul, shift: number): this
334
338
  ```
335
- See also: [BigNumber](./primitives.md#class-bignumber)
339
+ See also: [BigNumber](#class-bignumber)
336
340
 
337
341
  Returns
338
342
 
@@ -363,7 +367,7 @@ This operation does not affect the actual object but instead returns a new insta
363
367
  ```ts
364
368
  abs(): BigNumber
365
369
  ```
366
- See also: [BigNumber](./primitives.md#class-bignumber)
370
+ See also: [BigNumber](#class-bignumber)
367
371
 
368
372
  Returns
369
373
 
@@ -384,7 +388,7 @@ Add `num` to `this` BigNumber.
384
388
  ```ts
385
389
  add(num: BigNumber): BigNumber
386
390
  ```
387
- See also: [BigNumber](./primitives.md#class-bignumber)
391
+ See also: [BigNumber](#class-bignumber)
388
392
 
389
393
  Returns
390
394
 
@@ -410,7 +414,7 @@ Returns a new BigNumber that is the result of adding a plain number to the origi
410
414
  ```ts
411
415
  addn(num: number): BigNumber
412
416
  ```
413
- See also: [BigNumber](./primitives.md#class-bignumber)
417
+ See also: [BigNumber](#class-bignumber)
414
418
 
415
419
  Returns
416
420
 
@@ -436,7 +440,7 @@ set in the result only if the corresponding bit is set in both operands.
436
440
  ```ts
437
441
  and(num: BigNumber): BigNumber
438
442
  ```
439
- See also: [BigNumber](./primitives.md#class-bignumber)
443
+ See also: [BigNumber](#class-bignumber)
440
444
 
441
445
  Returns
442
446
 
@@ -544,7 +548,7 @@ Creates a copy of the current BigNumber instance.
544
548
  ```ts
545
549
  clone(): BigNumber
546
550
  ```
547
- See also: [BigNumber](./primitives.md#class-bignumber)
551
+ See also: [BigNumber](#class-bignumber)
548
552
 
549
553
  Returns
550
554
 
@@ -564,7 +568,7 @@ Compare this big number with another big number.
564
568
  ```ts
565
569
  cmp(num: BigNumber): 1 | 0 | -1
566
570
  ```
567
- See also: [BigNumber](./primitives.md#class-bignumber)
571
+ See also: [BigNumber](#class-bignumber)
568
572
 
569
573
  Returns
570
574
 
@@ -619,7 +623,7 @@ The copy method copies the state of this BigNumber into an exsiting `dest` BigNu
619
623
  ```ts
620
624
  copy(dest: BigNumber): void
621
625
  ```
622
- See also: [BigNumber](./primitives.md#class-bignumber)
626
+ See also: [BigNumber](#class-bignumber)
623
627
 
624
628
  Argument Details
625
629
 
@@ -642,7 +646,7 @@ Divides a BigNumber instance by another BigNumber and returns result. This does
642
646
  ```ts
643
647
  div(num: BigNumber): BigNumber
644
648
  ```
645
- See also: [BigNumber](./primitives.md#class-bignumber)
649
+ See also: [BigNumber](#class-bignumber)
646
650
 
647
651
  Returns
648
652
 
@@ -668,7 +672,7 @@ Returns the rounded quotient after division of one `BigNumber` by another `BigNu
668
672
  ```ts
669
673
  divRound(num: BigNumber): BigNumber
670
674
  ```
671
- See also: [BigNumber](./primitives.md#class-bignumber)
675
+ See also: [BigNumber](#class-bignumber)
672
676
 
673
677
  Returns
674
678
 
@@ -695,7 +699,7 @@ If the mode parameter is not provided, both division and modulus results are ret
695
699
  ```ts
696
700
  divmod(num: BigNumber, mode?: "div" | "mod", positive?: boolean): any
697
701
  ```
698
- See also: [BigNumber](./primitives.md#class-bignumber)
702
+ See also: [BigNumber](#class-bignumber)
699
703
 
700
704
  Returns
701
705
 
@@ -726,7 +730,7 @@ Returns the quotient `BigNumber` after division of one `BigNumber` by a primitiv
726
730
  ```ts
727
731
  divn(num: number): BigNumber
728
732
  ```
729
- See also: [BigNumber](./primitives.md#class-bignumber)
733
+ See also: [BigNumber](#class-bignumber)
730
734
 
731
735
  Returns
732
736
 
@@ -757,7 +761,7 @@ egcd(p: BigNumber): {
757
761
  gcd: BigNumber;
758
762
  }
759
763
  ```
760
- See also: [BigNumber](./primitives.md#class-bignumber)
764
+ See also: [BigNumber](#class-bignumber)
761
765
 
762
766
  Returns
763
767
 
@@ -783,7 +787,7 @@ Compares the current BigNumber with the given number and returns whether they're
783
787
  ```ts
784
788
  eq(num: BigNumber): boolean
785
789
  ```
786
- See also: [BigNumber](./primitives.md#class-bignumber)
790
+ See also: [BigNumber](#class-bignumber)
787
791
 
788
792
  Returns
789
793
 
@@ -856,7 +860,7 @@ Forces the current BigNumber into a reduction context, irrespective of the BigNu
856
860
  ```ts
857
861
  forceRed(ctx: ReductionContext): this
858
862
  ```
859
- See also: [ReductionContext](./primitives.md#class-reductioncontext)
863
+ See also: [ReductionContext](#class-reductioncontext)
860
864
 
861
865
  Returns
862
866
 
@@ -882,7 +886,7 @@ Creates a BigNumber from a number representing the "bits" value in a block heade
882
886
  ```ts
883
887
  static fromBits(bits: number, strict: boolean = false): BigNumber
884
888
  ```
885
- See also: [BigNumber](./primitives.md#class-bignumber)
889
+ See also: [BigNumber](#class-bignumber)
886
890
 
887
891
  Returns
888
892
 
@@ -913,7 +917,7 @@ Creates a BigNumber from a hexadecimal string.
913
917
  ```ts
914
918
  static fromHex(hex: string, endian?: "little" | "big"): BigNumber
915
919
  ```
916
- See also: [BigNumber](./primitives.md#class-bignumber)
920
+ See also: [BigNumber](#class-bignumber)
917
921
 
918
922
  Returns
919
923
 
@@ -938,7 +942,7 @@ Creates a BigNumber from a JSON-serialized string.
938
942
  ```ts
939
943
  static fromJSON(str: string): BigNumber
940
944
  ```
941
- See also: [BigNumber](./primitives.md#class-bignumber)
945
+ See also: [BigNumber](#class-bignumber)
942
946
 
943
947
  Returns
944
948
 
@@ -963,7 +967,7 @@ Creates a BigNumber from a number.
963
967
  ```ts
964
968
  static fromNumber(n: number): BigNumber
965
969
  ```
966
- See also: [BigNumber](./primitives.md#class-bignumber)
970
+ See also: [BigNumber](#class-bignumber)
967
971
 
968
972
  Returns
969
973
 
@@ -989,7 +993,7 @@ Throws an error in case the number is not in a reduction context.
989
993
  ```ts
990
994
  fromRed(): BigNumber
991
995
  ```
992
- See also: [BigNumber](./primitives.md#class-bignumber)
996
+ See also: [BigNumber](#class-bignumber)
993
997
 
994
998
  Returns
995
999
 
@@ -1011,7 +1015,7 @@ Creates a BigNumber from the format used in Bitcoin scripts.
1011
1015
  ```ts
1012
1016
  static fromScriptNum(num: number[], requireMinimal?: boolean, maxNumSize?: number): BigNumber
1013
1017
  ```
1014
- See also: [BigNumber](./primitives.md#class-bignumber)
1018
+ See also: [BigNumber](#class-bignumber)
1015
1019
 
1016
1020
  Returns
1017
1021
 
@@ -1044,7 +1048,7 @@ Creates a BigNumber from a signed magnitude number.
1044
1048
  ```ts
1045
1049
  static fromSm(num: number[], endian: "big" | "little" = "big"): BigNumber
1046
1050
  ```
1047
- See also: [BigNumber](./primitives.md#class-bignumber)
1051
+ See also: [BigNumber](#class-bignumber)
1048
1052
 
1049
1053
  Returns
1050
1054
 
@@ -1071,7 +1075,7 @@ Creates a BigNumber from a string, considering an optional base.
1071
1075
  ```ts
1072
1076
  static fromString(str: string, base?: number | "hex"): BigNumber
1073
1077
  ```
1074
- See also: [BigNumber](./primitives.md#class-bignumber)
1078
+ See also: [BigNumber](#class-bignumber)
1075
1079
 
1076
1080
  Returns
1077
1081
 
@@ -1098,7 +1102,7 @@ Converts this big number from two's complement with a specified bit width.
1098
1102
  ```ts
1099
1103
  fromTwos(width: number): BigNumber
1100
1104
  ```
1101
- See also: [BigNumber](./primitives.md#class-bignumber)
1105
+ See also: [BigNumber](#class-bignumber)
1102
1106
 
1103
1107
  Returns
1104
1108
 
@@ -1124,7 +1128,7 @@ Computes and returns the greatest common divisor (GCD) of this BigNumber and the
1124
1128
  ```ts
1125
1129
  gcd(num: BigNumber): BigNumber
1126
1130
  ```
1127
- See also: [BigNumber](./primitives.md#class-bignumber)
1131
+ See also: [BigNumber](#class-bignumber)
1128
1132
 
1129
1133
  Returns
1130
1134
 
@@ -1150,7 +1154,7 @@ Checks if this BigNumber instance is greater than another BigNumber.
1150
1154
  ```ts
1151
1155
  gt(num: BigNumber): boolean
1152
1156
  ```
1153
- See also: [BigNumber](./primitives.md#class-bignumber)
1157
+ See also: [BigNumber](#class-bignumber)
1154
1158
 
1155
1159
  Returns
1156
1160
 
@@ -1176,7 +1180,7 @@ Checks if this BigNumber instance is greater than or equal to another BigNumber.
1176
1180
  ```ts
1177
1181
  gte(num: BigNumber): boolean
1178
1182
  ```
1179
- See also: [BigNumber](./primitives.md#class-bignumber)
1183
+ See also: [BigNumber](#class-bignumber)
1180
1184
 
1181
1185
  Returns
1182
1186
 
@@ -1269,7 +1273,7 @@ Add `num` to `this` BigNumber in-place.
1269
1273
  ```ts
1270
1274
  iadd(num: BigNumber): this
1271
1275
  ```
1272
- See also: [BigNumber](./primitives.md#class-bignumber)
1276
+ See also: [BigNumber](#class-bignumber)
1273
1277
 
1274
1278
  Returns
1275
1279
 
@@ -1295,7 +1299,7 @@ Performs an in-place addition of a plain number to the BigNumber.
1295
1299
  ```ts
1296
1300
  iaddn(num: number): BigNumber
1297
1301
  ```
1298
- See also: [BigNumber](./primitives.md#class-bignumber)
1302
+ See also: [BigNumber](#class-bignumber)
1299
1303
 
1300
1304
  Returns
1301
1305
 
@@ -1327,7 +1331,7 @@ checks for negative values before operation.
1327
1331
  ```ts
1328
1332
  iand(num: BigNumber): BigNumber
1329
1333
  ```
1330
- See also: [BigNumber](./primitives.md#class-bignumber)
1334
+ See also: [BigNumber](#class-bignumber)
1331
1335
 
1332
1336
  Returns
1333
1337
 
@@ -1353,7 +1357,7 @@ Performs an in-place division of a `BigNumber` by a primitive number.
1353
1357
  ```ts
1354
1358
  idivn(num: number): BigNumber
1355
1359
  ```
1356
- See also: [BigNumber](./primitives.md#class-bignumber)
1360
+ See also: [BigNumber](#class-bignumber)
1357
1361
 
1358
1362
  Returns
1359
1363
 
@@ -1410,7 +1414,7 @@ Performs an in-place multiplication of the BigNumber instance by a given BigNumb
1410
1414
  ```ts
1411
1415
  imul(num: BigNumber): BigNumber
1412
1416
  ```
1413
- See also: [BigNumber](./primitives.md#class-bignumber)
1417
+ See also: [BigNumber](#class-bignumber)
1414
1418
 
1415
1419
  Returns
1416
1420
 
@@ -1438,7 +1442,7 @@ If negavtive number is provided, the resulting BigNumber will be inversely negat
1438
1442
  ```ts
1439
1443
  imuln(num: number): BigNumber
1440
1444
  ```
1441
- See also: [BigNumber](./primitives.md#class-bignumber)
1445
+ See also: [BigNumber](#class-bignumber)
1442
1446
 
1443
1447
  Returns
1444
1448
 
@@ -1463,7 +1467,7 @@ Negates the big number in-place.
1463
1467
  ```ts
1464
1468
  ineg(): BigNumber
1465
1469
  ```
1466
- See also: [BigNumber](./primitives.md#class-bignumber)
1470
+ See also: [BigNumber](#class-bignumber)
1467
1471
 
1468
1472
  Returns
1469
1473
 
@@ -1484,7 +1488,7 @@ In-place method that performs a bitwise NOT operation on a BigNumber up to a spe
1484
1488
  ```ts
1485
1489
  inotn(width: number): BigNumber
1486
1490
  ```
1487
- See also: [BigNumber](./primitives.md#class-bignumber)
1491
+ See also: [BigNumber](#class-bignumber)
1488
1492
 
1489
1493
  Returns
1490
1494
 
@@ -1529,7 +1533,7 @@ Computes and returns the modular multiplicative inverse of this BigNumber in the
1529
1533
  ```ts
1530
1534
  invm(num: BigNumber): BigNumber
1531
1535
  ```
1532
- See also: [BigNumber](./primitives.md#class-bignumber)
1536
+ See also: [BigNumber](#class-bignumber)
1533
1537
 
1534
1538
  Returns
1535
1539
 
@@ -1556,7 +1560,7 @@ that neither of the numbers can be negative. Stores the result in this BigNumber
1556
1560
  ```ts
1557
1561
  ior(num: BigNumber): BigNumber
1558
1562
  ```
1559
- See also: [BigNumber](./primitives.md#class-bignumber)
1563
+ See also: [BigNumber](#class-bignumber)
1560
1564
 
1561
1565
  Returns
1562
1566
 
@@ -1742,7 +1746,7 @@ Performs in-place multiplication of the BigNumber instance by itself.
1742
1746
  ```ts
1743
1747
  isqr(): BigNumber
1744
1748
  ```
1745
- See also: [BigNumber](./primitives.md#class-bignumber)
1749
+ See also: [BigNumber](#class-bignumber)
1746
1750
 
1747
1751
  Returns
1748
1752
 
@@ -1762,7 +1766,7 @@ Subtract `num` from `this` BigNumber in-place.
1762
1766
  ```ts
1763
1767
  isub(num: BigNumber): BigNumber
1764
1768
  ```
1765
- See also: [BigNumber](./primitives.md#class-bignumber)
1769
+ See also: [BigNumber](#class-bignumber)
1766
1770
 
1767
1771
  Returns
1768
1772
 
@@ -1788,7 +1792,7 @@ Performs an in-place subtraction of a plain number from the BigNumber.
1788
1792
  ```ts
1789
1793
  isubn(num: number): BigNumber
1790
1794
  ```
1791
- See also: [BigNumber](./primitives.md#class-bignumber)
1795
+ See also: [BigNumber](#class-bignumber)
1792
1796
 
1793
1797
  Returns
1794
1798
 
@@ -1820,7 +1824,7 @@ in both operands.
1820
1824
  ```ts
1821
1825
  iuand(num: BigNumber): BigNumber
1822
1826
  ```
1823
- See also: [BigNumber](./primitives.md#class-bignumber)
1827
+ See also: [BigNumber](#class-bignumber)
1824
1828
 
1825
1829
  Returns
1826
1830
 
@@ -1847,7 +1851,7 @@ the result in this BigNumber.
1847
1851
  ```ts
1848
1852
  iuor(num: BigNumber): BigNumber
1849
1853
  ```
1850
- See also: [BigNumber](./primitives.md#class-bignumber)
1854
+ See also: [BigNumber](#class-bignumber)
1851
1855
 
1852
1856
  Returns
1853
1857
 
@@ -1898,7 +1902,7 @@ Performs an in-place unsigned bitwise right shift operation on the BigNumber ins
1898
1902
  ```ts
1899
1903
  iushrn(bits: number, hint?: number, extended?: BigNumber): this
1900
1904
  ```
1901
- See also: [BigNumber](./primitives.md#class-bignumber)
1905
+ See also: [BigNumber](#class-bignumber)
1902
1906
 
1903
1907
  Returns
1904
1908
 
@@ -1929,7 +1933,7 @@ corresponding bits in the operands are different.
1929
1933
  ```ts
1930
1934
  iuxor(num: BigNumber): this
1931
1935
  ```
1932
- See also: [BigNumber](./primitives.md#class-bignumber)
1936
+ See also: [BigNumber](#class-bignumber)
1933
1937
 
1934
1938
  Returns
1935
1939
 
@@ -1958,7 +1962,7 @@ checks for negative values before operation.
1958
1962
  ```ts
1959
1963
  ixor(num: BigNumber): this
1960
1964
  ```
1961
- See also: [BigNumber](./primitives.md#class-bignumber)
1965
+ See also: [BigNumber](#class-bignumber)
1962
1966
 
1963
1967
  Returns
1964
1968
 
@@ -1984,7 +1988,7 @@ Checks if this BigNumber instance is less than another BigNumber.
1984
1988
  ```ts
1985
1989
  lt(num: BigNumber): boolean
1986
1990
  ```
1987
- See also: [BigNumber](./primitives.md#class-bignumber)
1991
+ See also: [BigNumber](#class-bignumber)
1988
1992
 
1989
1993
  Returns
1990
1994
 
@@ -2010,7 +2014,7 @@ Checks if this BigNumber instance is less than or equal to another BigNumber.
2010
2014
  ```ts
2011
2015
  lte(num: BigNumber): boolean
2012
2016
  ```
2013
- See also: [BigNumber](./primitives.md#class-bignumber)
2017
+ See also: [BigNumber](#class-bignumber)
2014
2018
 
2015
2019
  Returns
2016
2020
 
@@ -2084,7 +2088,7 @@ Returns a new BigNumber that keeps only the lower bits of the original number.
2084
2088
  ```ts
2085
2089
  maskn(bits): BigNumber
2086
2090
  ```
2087
- See also: [BigNumber](./primitives.md#class-bignumber)
2091
+ See also: [BigNumber](#class-bignumber)
2088
2092
 
2089
2093
  Returns
2090
2094
 
@@ -2109,7 +2113,7 @@ Returns the bigger value between two BigNumbers
2109
2113
  ```ts
2110
2114
  static max(left: BigNumber, right: BigNumber): BigNumber
2111
2115
  ```
2112
- See also: [BigNumber](./primitives.md#class-bignumber)
2116
+ See also: [BigNumber](#class-bignumber)
2113
2117
 
2114
2118
  Returns
2115
2119
 
@@ -2137,7 +2141,7 @@ Returns the smaller value between two BigNumbers
2137
2141
  ```ts
2138
2142
  static min(left: BigNumber, right: BigNumber): BigNumber
2139
2143
  ```
2140
- See also: [BigNumber](./primitives.md#class-bignumber)
2144
+ See also: [BigNumber](#class-bignumber)
2141
2145
 
2142
2146
  Returns
2143
2147
 
@@ -2165,7 +2169,7 @@ Returns the remainder after division of one `BigNumber` by another `BigNumber`.
2165
2169
  ```ts
2166
2170
  mod(num: BigNumber): BigNumber
2167
2171
  ```
2168
- See also: [BigNumber](./primitives.md#class-bignumber)
2172
+ See also: [BigNumber](#class-bignumber)
2169
2173
 
2170
2174
  Returns
2171
2175
 
@@ -2217,7 +2221,7 @@ Directly transfers the attributes of the source BigNumber to the destination Big
2217
2221
  ```ts
2218
2222
  static move(dest: BigNumber, src: BigNumber): void
2219
2223
  ```
2220
- See also: [BigNumber](./primitives.md#class-bignumber)
2224
+ See also: [BigNumber](#class-bignumber)
2221
2225
 
2222
2226
  Argument Details
2223
2227
 
@@ -2243,7 +2247,7 @@ It creates a new BigNumber to store the result.
2243
2247
  ```ts
2244
2248
  mul(num: BigNumber): BigNumber
2245
2249
  ```
2246
- See also: [BigNumber](./primitives.md#class-bignumber)
2250
+ See also: [BigNumber](#class-bignumber)
2247
2251
 
2248
2252
  Returns
2249
2253
 
@@ -2270,7 +2274,7 @@ It chooses the multiplication method based on the lengths of the numbers to opti
2270
2274
  ```ts
2271
2275
  mulTo(num: BigNumber, out: BigNumber): BigNumber
2272
2276
  ```
2273
- See also: [BigNumber](./primitives.md#class-bignumber)
2277
+ See also: [BigNumber](#class-bignumber)
2274
2278
 
2275
2279
  Returns
2276
2280
 
@@ -2300,7 +2304,7 @@ It performs the multiplication operation in-place to a cloned BigNumber.
2300
2304
  ```ts
2301
2305
  muln(num: number): BigNumber
2302
2306
  ```
2303
- See also: [BigNumber](./primitives.md#class-bignumber)
2307
+ See also: [BigNumber](#class-bignumber)
2304
2308
 
2305
2309
  Returns
2306
2310
 
@@ -2325,7 +2329,7 @@ Negates the big number and returns a new instance.
2325
2329
  ```ts
2326
2330
  neg(): BigNumber
2327
2331
  ```
2328
- See also: [BigNumber](./primitives.md#class-bignumber)
2332
+ See also: [BigNumber](#class-bignumber)
2329
2333
 
2330
2334
  Returns
2331
2335
 
@@ -2365,7 +2369,7 @@ Performs a bitwise NOT operation on a BigNumber up to a specified bit width. Ret
2365
2369
  ```ts
2366
2370
  notn(width: number): BigNumber
2367
2371
  ```
2368
- See also: [BigNumber](./primitives.md#class-bignumber)
2372
+ See also: [BigNumber](#class-bignumber)
2369
2373
 
2370
2374
  Returns
2371
2375
 
@@ -2394,7 +2398,7 @@ the corresponding bit in the first operand or the second operand is
2394
2398
  ```ts
2395
2399
  or(num: BigNumber): BigNumber
2396
2400
  ```
2397
- See also: [BigNumber](./primitives.md#class-bignumber)
2401
+ See also: [BigNumber](#class-bignumber)
2398
2402
 
2399
2403
  Returns
2400
2404
 
@@ -2420,7 +2424,7 @@ Raises the BigNumber instance to the power of the specified BigNumber.
2420
2424
  ```ts
2421
2425
  pow(num: BigNumber): BigNumber
2422
2426
  ```
2423
- See also: [BigNumber](./primitives.md#class-bignumber)
2427
+ See also: [BigNumber](#class-bignumber)
2424
2428
 
2425
2429
  Returns
2426
2430
 
@@ -2447,7 +2451,7 @@ Throws an error in case the number is not in a reduction context.
2447
2451
  ```ts
2448
2452
  redAdd(num: BigNumber): BigNumber
2449
2453
  ```
2450
- See also: [BigNumber](./primitives.md#class-bignumber)
2454
+ See also: [BigNumber](#class-bignumber)
2451
2455
 
2452
2456
  Returns
2453
2457
 
@@ -2475,7 +2479,7 @@ Throws an error in case the number is not in a reduction context.
2475
2479
  ```ts
2476
2480
  redIAdd(num: BigNumber): BigNumber
2477
2481
  ```
2478
- See also: [BigNumber](./primitives.md#class-bignumber)
2482
+ See also: [BigNumber](#class-bignumber)
2479
2483
 
2480
2484
  Returns
2481
2485
 
@@ -2503,7 +2507,7 @@ Expects that this BigNumber is within the reduction context i.e., it has been re
2503
2507
  ```ts
2504
2508
  redIMul(num: BigNumber): BigNumber
2505
2509
  ```
2506
- See also: [BigNumber](./primitives.md#class-bignumber)
2510
+ See also: [BigNumber](#class-bignumber)
2507
2511
 
2508
2512
  Returns
2509
2513
 
@@ -2532,7 +2536,7 @@ if it has a `red` field that points to a reduction context object.
2532
2536
  ```ts
2533
2537
  redISqr(): BigNumber
2534
2538
  ```
2535
- See also: [BigNumber](./primitives.md#class-bignumber)
2539
+ See also: [BigNumber](#class-bignumber)
2536
2540
 
2537
2541
  Returns
2538
2542
 
@@ -2558,7 +2562,7 @@ Throws an error in case the number is not in a reduction context.
2558
2562
  ```ts
2559
2563
  redISub(num: BigNumber): BigNumber
2560
2564
  ```
2561
- See also: [BigNumber](./primitives.md#class-bignumber)
2565
+ See also: [BigNumber](#class-bignumber)
2562
2566
 
2563
2567
  Returns
2564
2568
 
@@ -2586,7 +2590,7 @@ The method works only on numbers that have a reduction context set.
2586
2590
  ```ts
2587
2591
  redInvm(): BigNumber
2588
2592
  ```
2589
- See also: [BigNumber](./primitives.md#class-bignumber)
2593
+ See also: [BigNumber](#class-bignumber)
2590
2594
 
2591
2595
  Returns
2592
2596
 
@@ -2612,7 +2616,7 @@ Throws an error in case the number is not in a reduction context.
2612
2616
  ```ts
2613
2617
  redMul(num: BigNumber): BigNumber
2614
2618
  ```
2615
- See also: [BigNumber](./primitives.md#class-bignumber)
2619
+ See also: [BigNumber](#class-bignumber)
2616
2620
 
2617
2621
  Returns
2618
2622
 
@@ -2640,7 +2644,7 @@ The method works only on numbers that have a reduction context set.
2640
2644
  ```ts
2641
2645
  redNeg(): BigNumber
2642
2646
  ```
2643
- See also: [BigNumber](./primitives.md#class-bignumber)
2647
+ See also: [BigNumber](#class-bignumber)
2644
2648
 
2645
2649
  Returns
2646
2650
 
@@ -2666,7 +2670,7 @@ Note that 'num' must not have a reduction context set.
2666
2670
  ```ts
2667
2671
  redPow(num: BigNumber): BigNumber
2668
2672
  ```
2669
- See also: [BigNumber](./primitives.md#class-bignumber)
2673
+ See also: [BigNumber](#class-bignumber)
2670
2674
 
2671
2675
  Returns
2672
2676
 
@@ -2698,7 +2702,7 @@ Throws an error in case the number is not in a reduction context.
2698
2702
  ```ts
2699
2703
  redShl(num: number): BigNumber
2700
2704
  ```
2701
- See also: [BigNumber](./primitives.md#class-bignumber)
2705
+ See also: [BigNumber](#class-bignumber)
2702
2706
 
2703
2707
  Returns
2704
2708
 
@@ -2728,7 +2732,7 @@ if it has a `red` field that points to a reduction context object.
2728
2732
  ```ts
2729
2733
  redSqr(): BigNumber
2730
2734
  ```
2731
- See also: [BigNumber](./primitives.md#class-bignumber)
2735
+ See also: [BigNumber](#class-bignumber)
2732
2736
 
2733
2737
  Returns
2734
2738
 
@@ -2757,7 +2761,7 @@ field that points to a reduction context object.
2757
2761
  ```ts
2758
2762
  redSqrt(): BigNumber
2759
2763
  ```
2760
- See also: [BigNumber](./primitives.md#class-bignumber)
2764
+ See also: [BigNumber](#class-bignumber)
2761
2765
 
2762
2766
  Returns
2763
2767
 
@@ -2783,7 +2787,7 @@ Throws an error in case the number is not in a reduction context.
2783
2787
  ```ts
2784
2788
  redSub(num: BigNumber): BigNumber
2785
2789
  ```
2786
- See also: [BigNumber](./primitives.md#class-bignumber)
2790
+ See also: [BigNumber](#class-bignumber)
2787
2791
 
2788
2792
  Returns
2789
2793
 
@@ -2838,7 +2842,7 @@ Performs a bitwise left shift operation on a clone of the BigNumber instance.
2838
2842
  ```ts
2839
2843
  shln(bits): BigNumber
2840
2844
  ```
2841
- See also: [BigNumber](./primitives.md#class-bignumber)
2845
+ See also: [BigNumber](#class-bignumber)
2842
2846
 
2843
2847
  Returns
2844
2848
 
@@ -2864,7 +2868,7 @@ Performs a bitwise right shift operation on a clone of the BigNumber instance.
2864
2868
  ```ts
2865
2869
  shrn(bits): BigNumber
2866
2870
  ```
2867
- See also: [BigNumber](./primitives.md#class-bignumber)
2871
+ See also: [BigNumber](#class-bignumber)
2868
2872
 
2869
2873
  Returns
2870
2874
 
@@ -2890,7 +2894,7 @@ Squares the BigNumber instance.
2890
2894
  ```ts
2891
2895
  sqr(): BigNumber
2892
2896
  ```
2893
- See also: [BigNumber](./primitives.md#class-bignumber)
2897
+ See also: [BigNumber](#class-bignumber)
2894
2898
 
2895
2899
  Returns
2896
2900
 
@@ -2930,7 +2934,7 @@ Subtract `num` from `this` BigNumber.
2930
2934
  ```ts
2931
2935
  sub(num: BigNumber): BigNumber
2932
2936
  ```
2933
- See also: [BigNumber](./primitives.md#class-bignumber)
2937
+ See also: [BigNumber](#class-bignumber)
2934
2938
 
2935
2939
  Returns
2936
2940
 
@@ -2956,7 +2960,7 @@ Returns a new BigNumber that is the result of subtracting a plain number from th
2956
2960
  ```ts
2957
2961
  subn(num: number): BigNumber
2958
2962
  ```
2959
- See also: [BigNumber](./primitives.md#class-bignumber)
2963
+ See also: [BigNumber](#class-bignumber)
2960
2964
 
2961
2965
  Returns
2962
2966
 
@@ -3032,7 +3036,7 @@ a binary number, where each array index is a bit.
3032
3036
  ```ts
3033
3037
  static toBitArray(num: BigNumber): Array<0 | 1>
3034
3038
  ```
3035
- See also: [BigNumber](./primitives.md#class-bignumber)
3039
+ See also: [BigNumber](#class-bignumber)
3036
3040
 
3037
3041
  Returns
3038
3042
 
@@ -3167,7 +3171,7 @@ Throws an error in case the number is either negative or already in a reduction
3167
3171
  ```ts
3168
3172
  toRed(ctx: ReductionContext): BigNumber
3169
3173
  ```
3170
- See also: [BigNumber](./primitives.md#class-bignumber), [ReductionContext](./primitives.md#class-reductioncontext)
3174
+ See also: [BigNumber](#class-bignumber), [ReductionContext](#class-reductioncontext)
3171
3175
 
3172
3176
  Returns
3173
3177
 
@@ -3268,7 +3272,7 @@ Converts this big number to two's complement with a specified bit width.
3268
3272
  ```ts
3269
3273
  toTwos(width: number): BigNumber
3270
3274
  ```
3271
- See also: [BigNumber](./primitives.md#class-bignumber)
3275
+ See also: [BigNumber](#class-bignumber)
3272
3276
 
3273
3277
  Returns
3274
3278
 
@@ -3295,7 +3299,7 @@ Performs a bitwise AND operation without considering signed bit
3295
3299
  ```ts
3296
3300
  uand(num: BigNumber): BigNumber
3297
3301
  ```
3298
- See also: [BigNumber](./primitives.md#class-bignumber)
3302
+ See also: [BigNumber](#class-bignumber)
3299
3303
 
3300
3304
  Returns
3301
3305
 
@@ -3321,7 +3325,7 @@ Performs an unsigned comparison between this BigNumber instance and another.
3321
3325
  ```ts
3322
3326
  ucmp(num: BigNumber): 1 | 0 | -1
3323
3327
  ```
3324
- See also: [BigNumber](./primitives.md#class-bignumber)
3328
+ See also: [BigNumber](#class-bignumber)
3325
3329
 
3326
3330
  Returns
3327
3331
 
@@ -3347,7 +3351,7 @@ Returns the remainder after unsigned division of one `BigNumber` by another `Big
3347
3351
  ```ts
3348
3352
  umod(num: BigNumber): BigNumber
3349
3353
  ```
3350
- See also: [BigNumber](./primitives.md#class-bignumber)
3354
+ See also: [BigNumber](#class-bignumber)
3351
3355
 
3352
3356
  Returns
3353
3357
 
@@ -3376,7 +3380,7 @@ similar to the `or` method.
3376
3380
  ```ts
3377
3381
  uor(num: BigNumber): BigNumber
3378
3382
  ```
3379
- See also: [BigNumber](./primitives.md#class-bignumber)
3383
+ See also: [BigNumber](#class-bignumber)
3380
3384
 
3381
3385
  Returns
3382
3386
 
@@ -3402,7 +3406,7 @@ Performs an unsigned bitwise shift left operation on a clone of the BigNumber in
3402
3406
  ```ts
3403
3407
  ushln(bits): BigNumber
3404
3408
  ```
3405
- See also: [BigNumber](./primitives.md#class-bignumber)
3409
+ See also: [BigNumber](#class-bignumber)
3406
3410
 
3407
3411
  Returns
3408
3412
 
@@ -3428,7 +3432,7 @@ Performs an unsigned bitwise shift right operation on a clone of the BigNumber i
3428
3432
  ```ts
3429
3433
  ushrn(bits): BigNumber
3430
3434
  ```
3431
- See also: [BigNumber](./primitives.md#class-bignumber)
3435
+ See also: [BigNumber](#class-bignumber)
3432
3436
 
3433
3437
  Returns
3434
3438
 
@@ -3454,7 +3458,7 @@ Performs an unsigned XOR operation on this BigNumber with the supplied BigNumber
3454
3458
  ```ts
3455
3459
  uxor(num: BigNumber): BigNumber
3456
3460
  ```
3457
- See also: [BigNumber](./primitives.md#class-bignumber)
3461
+ See also: [BigNumber](#class-bignumber)
3458
3462
 
3459
3463
  Returns
3460
3464
 
@@ -3481,7 +3485,7 @@ set in the result only if the corresponding bits in the operands are different.
3481
3485
  ```ts
3482
3486
  xor(num: BigNumber): BigNumber
3483
3487
  ```
3484
- See also: [BigNumber](./primitives.md#class-bignumber)
3488
+ See also: [BigNumber](#class-bignumber)
3485
3489
 
3486
3490
  Returns
3487
3491
 
@@ -3521,6 +3525,8 @@ const bn = new BigNumber('8'); // binary: 1000
3521
3525
  const zeroBits = bn.zeroBits(); // 3
3522
3526
  ```
3523
3527
 
3528
+ </details>
3529
+
3524
3530
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3525
3531
 
3526
3532
  ---
@@ -3593,7 +3599,7 @@ export default class Curve {
3593
3599
  }
3594
3600
  ```
3595
3601
 
3596
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point), [ReductionContext](./primitives.md#class-reductioncontext)
3602
+ See also: [BigNumber](#class-bignumber), [Point](#class-point), [ReductionContext](#class-reductioncontext)
3597
3603
 
3598
3604
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3599
3605
 
@@ -3619,7 +3625,11 @@ export default class DRBG {
3619
3625
  }
3620
3626
  ```
3621
3627
 
3622
- See also: [SHA256HMAC](./primitives.md#class-sha256hmac)
3628
+ See also: [SHA256HMAC](#class-sha256hmac)
3629
+
3630
+ <details>
3631
+
3632
+ <summary>Class DRBG Details</summary>
3623
3633
 
3624
3634
  #### Method generate
3625
3635
 
@@ -3652,7 +3662,7 @@ Generates HMAC using the K value of the instance. This method is used internally
3652
3662
  ```ts
3653
3663
  hmac(): SHA256HMAC
3654
3664
  ```
3655
- See also: [SHA256HMAC](./primitives.md#class-sha256hmac)
3665
+ See also: [SHA256HMAC](#class-sha256hmac)
3656
3666
 
3657
3667
  Returns
3658
3668
 
@@ -3688,6 +3698,8 @@ Example
3688
3698
  drbg.update('e13af...');
3689
3699
  ```
3690
3700
 
3701
+ </details>
3702
+
3691
3703
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
3692
3704
 
3693
3705
  ---
@@ -3724,7 +3736,11 @@ export default class JacobianPoint extends BasePoint {
3724
3736
  }
3725
3737
  ```
3726
3738
 
3727
- See also: [BasePoint](./primitives.md#class-basepoint), [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point)
3739
+ See also: [BasePoint](#class-basepoint), [BigNumber](#class-bignumber), [Point](#class-point)
3740
+
3741
+ <details>
3742
+
3743
+ <summary>Class JacobianPoint Details</summary>
3728
3744
 
3729
3745
  #### Constructor
3730
3746
 
@@ -3733,7 +3749,7 @@ Constructs a new `JacobianPoint` instance.
3733
3749
  ```ts
3734
3750
  constructor(x: string | BigNumber | null, y: string | BigNumber | null, z: string | BigNumber | null)
3735
3751
  ```
3736
- See also: [BigNumber](./primitives.md#class-bignumber)
3752
+ See also: [BigNumber](#class-bignumber)
3737
3753
 
3738
3754
  Argument Details
3739
3755
 
@@ -3761,7 +3777,7 @@ The `x` coordinate of the point in the Jacobian form.
3761
3777
  ```ts
3762
3778
  x: BigNumber
3763
3779
  ```
3764
- See also: [BigNumber](./primitives.md#class-bignumber)
3780
+ See also: [BigNumber](#class-bignumber)
3765
3781
 
3766
3782
  #### Property y
3767
3783
 
@@ -3770,7 +3786,7 @@ The `y` coordinate of the point in the Jacobian form.
3770
3786
  ```ts
3771
3787
  y: BigNumber
3772
3788
  ```
3773
- See also: [BigNumber](./primitives.md#class-bignumber)
3789
+ See also: [BigNumber](#class-bignumber)
3774
3790
 
3775
3791
  #### Property z
3776
3792
 
@@ -3779,7 +3795,7 @@ The `z` coordinate of the point in the Jacobian form.
3779
3795
  ```ts
3780
3796
  z: BigNumber
3781
3797
  ```
3782
- See also: [BigNumber](./primitives.md#class-bignumber)
3798
+ See also: [BigNumber](#class-bignumber)
3783
3799
 
3784
3800
  #### Property zOne
3785
3801
 
@@ -3798,7 +3814,7 @@ when either one of the points is the point at infinity, it will return the other
3798
3814
  ```ts
3799
3815
  add(p: JacobianPoint): JacobianPoint
3800
3816
  ```
3801
- See also: [JacobianPoint](./primitives.md#class-jacobianpoint)
3817
+ See also: [JacobianPoint](#class-jacobianpoint)
3802
3818
 
3803
3819
  Returns
3804
3820
 
@@ -3824,7 +3840,7 @@ Point doubling operation in the Jacobian coordinates. A special case is when the
3824
3840
  ```ts
3825
3841
  dbl(): JacobianPoint
3826
3842
  ```
3827
- See also: [JacobianPoint](./primitives.md#class-jacobianpoint)
3843
+ See also: [JacobianPoint](#class-jacobianpoint)
3828
3844
 
3829
3845
  Returns
3830
3846
 
@@ -3844,7 +3860,7 @@ Multiple doubling operation. It doubles the Jacobian point as many times as the
3844
3860
  ```ts
3845
3861
  dblp(pow: number): JacobianPoint
3846
3862
  ```
3847
- See also: [JacobianPoint](./primitives.md#class-jacobianpoint)
3863
+ See also: [JacobianPoint](#class-jacobianpoint)
3848
3864
 
3849
3865
  Returns
3850
3866
 
@@ -3869,7 +3885,7 @@ Equality check operation. It checks whether the affine or Jacobian point is equa
3869
3885
  ```ts
3870
3886
  eq(p: Point | JacobianPoint): boolean
3871
3887
  ```
3872
- See also: [JacobianPoint](./primitives.md#class-jacobianpoint), [Point](./primitives.md#class-point)
3888
+ See also: [JacobianPoint](#class-jacobianpoint), [Point](#class-point)
3873
3889
 
3874
3890
  Returns
3875
3891
 
@@ -3897,7 +3913,7 @@ of a point in projective coordinates.
3897
3913
  ```ts
3898
3914
  eqXToP(x: BigNumber): boolean
3899
3915
  ```
3900
- See also: [BigNumber](./primitives.md#class-bignumber)
3916
+ See also: [BigNumber](#class-bignumber)
3901
3917
 
3902
3918
  Returns
3903
3919
 
@@ -3962,7 +3978,7 @@ the affine point to Jacobian, and then preforms the addition.
3962
3978
  ```ts
3963
3979
  mixedAdd(p: Point): JacobianPoint
3964
3980
  ```
3965
- See also: [JacobianPoint](./primitives.md#class-jacobianpoint), [Point](./primitives.md#class-point)
3981
+ See also: [JacobianPoint](#class-jacobianpoint), [Point](#class-point)
3966
3982
 
3967
3983
  Returns
3968
3984
 
@@ -3988,7 +4004,7 @@ Negation operation. It returns the additive inverse of the Jacobian point.
3988
4004
  ```ts
3989
4005
  neg(): JacobianPoint
3990
4006
  ```
3991
- See also: [JacobianPoint](./primitives.md#class-jacobianpoint)
4007
+ See also: [JacobianPoint](#class-jacobianpoint)
3992
4008
 
3993
4009
  Returns
3994
4010
 
@@ -4008,7 +4024,7 @@ Converts the `JacobianPoint` object instance to standard affine `Point` format a
4008
4024
  ```ts
4009
4025
  toP(): Point
4010
4026
  ```
4011
- See also: [Point](./primitives.md#class-point)
4027
+ See also: [Point](#class-point)
4012
4028
 
4013
4029
  Returns
4014
4030
 
@@ -4023,6 +4039,8 @@ const pointJ = new JacobianPoint('3', '4', '1');
4023
4039
  const pointP = pointJ.toP(); // The point in affine coordinates.
4024
4040
  ```
4025
4041
 
4042
+ </details>
4043
+
4026
4044
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4027
4045
 
4028
4046
  ---
@@ -4046,7 +4064,11 @@ export default class K256 extends Mersenne {
4046
4064
  }
4047
4065
  ```
4048
4066
 
4049
- See also: [BigNumber](./primitives.md#class-bignumber), [Mersenne](./primitives.md#class-mersenne)
4067
+ See also: [BigNumber](#class-bignumber), [Mersenne](#class-mersenne)
4068
+
4069
+ <details>
4070
+
4071
+ <summary>Class K256 Details</summary>
4050
4072
 
4051
4073
  #### Constructor
4052
4074
 
@@ -4071,7 +4093,7 @@ Multiplies a BigNumber ('num') with the constant 'K' in-place and returns the re
4071
4093
  ```ts
4072
4094
  imulK(num: BigNumber): BigNumber
4073
4095
  ```
4074
- See also: [BigNumber](./primitives.md#class-bignumber)
4096
+ See also: [BigNumber](#class-bignumber)
4075
4097
 
4076
4098
  Returns
4077
4099
 
@@ -4097,7 +4119,7 @@ rules. This method modifies the input and output big numbers.
4097
4119
  ```ts
4098
4120
  split(input: BigNumber, output: BigNumber): void
4099
4121
  ```
4100
- See also: [BigNumber](./primitives.md#class-bignumber)
4122
+ See also: [BigNumber](#class-bignumber)
4101
4123
 
4102
4124
  Argument Details
4103
4125
 
@@ -4114,6 +4136,8 @@ const output = new BigNumber(0);
4114
4136
  k256.split(input, output);
4115
4137
  ```
4116
4138
 
4139
+ </details>
4140
+
4117
4141
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4118
4142
 
4119
4143
  ---
@@ -4136,7 +4160,7 @@ export class KeyShares {
4136
4160
  }
4137
4161
  ```
4138
4162
 
4139
- See also: [PointInFiniteField](./primitives.md#class-pointinfinitefield)
4163
+ See also: [PointInFiniteField](#class-pointinfinitefield)
4140
4164
 
4141
4165
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4142
4166
 
@@ -4159,7 +4183,11 @@ export default class Mersenne {
4159
4183
  }
4160
4184
  ```
4161
4185
 
4162
- See also: [BigNumber](./primitives.md#class-bignumber)
4186
+ See also: [BigNumber](#class-bignumber)
4187
+
4188
+ <details>
4189
+
4190
+ <summary>Class Mersenne Details</summary>
4163
4191
 
4164
4192
  #### Constructor
4165
4193
 
@@ -4187,7 +4215,7 @@ The constant subtracted from 2^n to derive a pseudo-Mersenne prime.
4187
4215
  ```ts
4188
4216
  k: BigNumber
4189
4217
  ```
4190
- See also: [BigNumber](./primitives.md#class-bignumber)
4218
+ See also: [BigNumber](#class-bignumber)
4191
4219
 
4192
4220
  #### Property n
4193
4221
 
@@ -4212,7 +4240,7 @@ BigNumber equivalent to 2^n - k.
4212
4240
  ```ts
4213
4241
  p: BigNumber
4214
4242
  ```
4215
- See also: [BigNumber](./primitives.md#class-bignumber)
4243
+ See also: [BigNumber](#class-bignumber)
4216
4244
 
4217
4245
  #### Method imulK
4218
4246
 
@@ -4221,7 +4249,7 @@ Performs an in-place multiplication of the parameter by constant k.
4221
4249
  ```ts
4222
4250
  imulK(num: BigNumber): BigNumber
4223
4251
  ```
4224
- See also: [BigNumber](./primitives.md#class-bignumber)
4252
+ See also: [BigNumber](#class-bignumber)
4225
4253
 
4226
4254
  Returns
4227
4255
 
@@ -4246,7 +4274,7 @@ it is less than the square of the pseudo-Mersenne prime.
4246
4274
  ```ts
4247
4275
  ireduce(num: BigNumber): BigNumber
4248
4276
  ```
4249
- See also: [BigNumber](./primitives.md#class-bignumber)
4277
+ See also: [BigNumber](#class-bignumber)
4250
4278
 
4251
4279
  Returns
4252
4280
 
@@ -4271,7 +4299,7 @@ to meet the magnitude of the pseudo-Mersenne prime.
4271
4299
  ```ts
4272
4300
  split(input: BigNumber, out: BigNumber): void
4273
4301
  ```
4274
- See also: [BigNumber](./primitives.md#class-bignumber)
4302
+ See also: [BigNumber](#class-bignumber)
4275
4303
 
4276
4304
  Argument Details
4277
4305
 
@@ -4286,6 +4314,8 @@ Example
4286
4314
  mersenne.split(new BigNumber('2345', 16), new BigNumber());
4287
4315
  ```
4288
4316
 
4317
+ </details>
4318
+
4289
4319
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4290
4320
 
4291
4321
  ---
@@ -4316,14 +4346,18 @@ export default class MontgomoryMethod extends ReductionContext {
4316
4346
  }
4317
4347
  ```
4318
4348
 
4319
- See also: [BigNumber](./primitives.md#class-bignumber), [ReductionContext](./primitives.md#class-reductioncontext)
4349
+ See also: [BigNumber](#class-bignumber), [ReductionContext](#class-reductioncontext)
4350
+
4351
+ <details>
4352
+
4353
+ <summary>Class MontgomoryMethod Details</summary>
4320
4354
 
4321
4355
  #### Constructor
4322
4356
 
4323
4357
  ```ts
4324
4358
  constructor(m: BigNumber | "k256")
4325
4359
  ```
4326
- See also: [BigNumber](./primitives.md#class-bignumber)
4360
+ See also: [BigNumber](#class-bignumber)
4327
4361
 
4328
4362
  Argument Details
4329
4363
 
@@ -4337,7 +4371,7 @@ The modular multiplicative inverse of `m` mod `r`.
4337
4371
  ```ts
4338
4372
  minv: BigNumber
4339
4373
  ```
4340
- See also: [BigNumber](./primitives.md#class-bignumber)
4374
+ See also: [BigNumber](#class-bignumber)
4341
4375
 
4342
4376
  #### Property r
4343
4377
 
@@ -4346,7 +4380,7 @@ The 2^shift, shifted left by the bit length of modulus `m`.
4346
4380
  ```ts
4347
4381
  r: BigNumber
4348
4382
  ```
4349
- See also: [BigNumber](./primitives.md#class-bignumber)
4383
+ See also: [BigNumber](#class-bignumber)
4350
4384
 
4351
4385
  #### Property r2
4352
4386
 
@@ -4355,7 +4389,7 @@ The square of `r` modulo `m`.
4355
4389
  ```ts
4356
4390
  r2: BigNumber
4357
4391
  ```
4358
- See also: [BigNumber](./primitives.md#class-bignumber)
4392
+ See also: [BigNumber](#class-bignumber)
4359
4393
 
4360
4394
  #### Property rinv
4361
4395
 
@@ -4364,7 +4398,7 @@ The modular multiplicative inverse of `r` mod `m`.
4364
4398
  ```ts
4365
4399
  rinv: BigNumber
4366
4400
  ```
4367
- See also: [BigNumber](./primitives.md#class-bignumber)
4401
+ See also: [BigNumber](#class-bignumber)
4368
4402
 
4369
4403
  #### Property shift
4370
4404
 
@@ -4381,7 +4415,7 @@ Converts a number from the Montgomery domain back to the original domain.
4381
4415
  ```ts
4382
4416
  convertFrom(num: BigNumber): BigNumber
4383
4417
  ```
4384
- See also: [BigNumber](./primitives.md#class-bignumber)
4418
+ See also: [BigNumber](#class-bignumber)
4385
4419
 
4386
4420
  Returns
4387
4421
 
@@ -4406,7 +4440,7 @@ Converts a number into the Montgomery domain.
4406
4440
  ```ts
4407
4441
  convertTo(num: BigNumber): BigNumber
4408
4442
  ```
4409
- See also: [BigNumber](./primitives.md#class-bignumber)
4443
+ See also: [BigNumber](#class-bignumber)
4410
4444
 
4411
4445
  Returns
4412
4446
 
@@ -4431,7 +4465,7 @@ Performs an in-place multiplication of two numbers in the Montgomery domain.
4431
4465
  ```ts
4432
4466
  imul(a: BigNumber, b: BigNumber): BigNumber
4433
4467
  ```
4434
- See also: [BigNumber](./primitives.md#class-bignumber)
4468
+ See also: [BigNumber](#class-bignumber)
4435
4469
 
4436
4470
  Returns
4437
4471
 
@@ -4458,7 +4492,7 @@ Calculates the modular multiplicative inverse of a number in the Montgomery doma
4458
4492
  ```ts
4459
4493
  invm(a: BigNumber): BigNumber
4460
4494
  ```
4461
- See also: [BigNumber](./primitives.md#class-bignumber)
4495
+ See also: [BigNumber](#class-bignumber)
4462
4496
 
4463
4497
  Returns
4464
4498
 
@@ -4483,7 +4517,7 @@ Performs the multiplication of two numbers in the Montgomery domain.
4483
4517
  ```ts
4484
4518
  mul(a: BigNumber, b: BigNumber): BigNumber
4485
4519
  ```
4486
- See also: [BigNumber](./primitives.md#class-bignumber)
4520
+ See also: [BigNumber](#class-bignumber)
4487
4521
 
4488
4522
  Returns
4489
4523
 
@@ -4503,6 +4537,8 @@ const montMethod = new MontgomoryMethod(m);
4503
4537
  const product = montMethod.mul(a, b);
4504
4538
  ```
4505
4539
 
4540
+ </details>
4541
+
4506
4542
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
4507
4543
 
4508
4544
  ---
@@ -4556,14 +4592,18 @@ export default class Point extends BasePoint {
4556
4592
  }
4557
4593
  ```
4558
4594
 
4559
- See also: [BasePoint](./primitives.md#class-basepoint), [BigNumber](./primitives.md#class-bignumber), [encode](./primitives.md#variable-encode)
4595
+ See also: [BasePoint](#class-basepoint), [BigNumber](#class-bignumber), [encode](#variable-encode)
4596
+
4597
+ <details>
4598
+
4599
+ <summary>Class Point Details</summary>
4560
4600
 
4561
4601
  #### Constructor
4562
4602
 
4563
4603
  ```ts
4564
4604
  constructor(x: BigNumber | number | number[] | string | null, y: BigNumber | number | number[] | string | null, isRed: boolean = true)
4565
4605
  ```
4566
- See also: [BigNumber](./primitives.md#class-bignumber)
4606
+ See also: [BigNumber](#class-bignumber)
4567
4607
 
4568
4608
  Argument Details
4569
4609
 
@@ -4596,7 +4636,7 @@ The x-coordinate of the point.
4596
4636
  ```ts
4597
4637
  x: BigNumber | null
4598
4638
  ```
4599
- See also: [BigNumber](./primitives.md#class-bignumber)
4639
+ See also: [BigNumber](#class-bignumber)
4600
4640
 
4601
4641
  #### Property y
4602
4642
 
@@ -4605,7 +4645,7 @@ The y-coordinate of the point.
4605
4645
  ```ts
4606
4646
  y: BigNumber | null
4607
4647
  ```
4608
- See also: [BigNumber](./primitives.md#class-bignumber)
4648
+ See also: [BigNumber](#class-bignumber)
4609
4649
 
4610
4650
  #### Method add
4611
4651
 
@@ -4614,7 +4654,7 @@ Adds another Point to this Point, returning a new Point.
4614
4654
  ```ts
4615
4655
  add(p: Point): Point
4616
4656
  ```
4617
- See also: [Point](./primitives.md#class-point)
4657
+ See also: [Point](#class-point)
4618
4658
 
4619
4659
  Returns
4620
4660
 
@@ -4640,7 +4680,7 @@ Doubles the current point.
4640
4680
  ```ts
4641
4681
  dbl(): Point
4642
4682
  ```
4643
- See also: [Point](./primitives.md#class-point)
4683
+ See also: [Point](#class-point)
4644
4684
 
4645
4685
  Example
4646
4686
 
@@ -4659,7 +4699,7 @@ a point at infinity is still infinity.
4659
4699
  ```ts
4660
4700
  dblp(k: number): Point
4661
4701
  ```
4662
- See also: [Point](./primitives.md#class-point)
4702
+ See also: [Point](#class-point)
4663
4703
 
4664
4704
  Returns
4665
4705
 
@@ -4716,7 +4756,7 @@ Checks if the Point instance is equal to another given Point.
4716
4756
  ```ts
4717
4757
  eq(p: Point): boolean
4718
4758
  ```
4719
- See also: [Point](./primitives.md#class-point)
4759
+ See also: [Point](#class-point)
4720
4760
 
4721
4761
  Returns
4722
4762
 
@@ -4744,7 +4784,7 @@ The function verifies the integrity of the provided data and throws errors if in
4744
4784
  ```ts
4745
4785
  static fromDER(bytes: number[]): Point
4746
4786
  ```
4747
- See also: [Point](./primitives.md#class-point)
4787
+ See also: [Point](#class-point)
4748
4788
 
4749
4789
  Returns
4750
4790
 
@@ -4777,7 +4817,7 @@ JSON points into proper Point objects.
4777
4817
  ```ts
4778
4818
  static fromJSON(obj: string | any[], isRed: boolean): Point
4779
4819
  ```
4780
- See also: [Point](./primitives.md#class-point)
4820
+ See also: [Point](#class-point)
4781
4821
 
4782
4822
  Returns
4783
4823
 
@@ -4806,7 +4846,7 @@ The function verifies the integrity of the provided data and throws errors if in
4806
4846
  ```ts
4807
4847
  static fromString(str: string): Point
4808
4848
  ```
4809
- See also: [Point](./primitives.md#class-point)
4849
+ See also: [Point](#class-point)
4810
4850
 
4811
4851
  Returns
4812
4852
 
@@ -4838,7 +4878,7 @@ y coordinate is odd.
4838
4878
  ```ts
4839
4879
  static fromX(x: BigNumber | number | number[] | string, odd: boolean): Point
4840
4880
  ```
4841
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point)
4881
+ See also: [BigNumber](#class-bignumber), [Point](#class-point)
4842
4882
 
4843
4883
  Returns
4844
4884
 
@@ -4869,7 +4909,7 @@ Returns X coordinate of point
4869
4909
  ```ts
4870
4910
  getX(): BigNumber
4871
4911
  ```
4872
- See also: [BigNumber](./primitives.md#class-bignumber)
4912
+ See also: [BigNumber](#class-bignumber)
4873
4913
 
4874
4914
  Example
4875
4915
 
@@ -4885,7 +4925,7 @@ Returns X coordinate of point
4885
4925
  ```ts
4886
4926
  getY(): BigNumber
4887
4927
  ```
4888
- See also: [BigNumber](./primitives.md#class-bignumber)
4928
+ See also: [BigNumber](#class-bignumber)
4889
4929
 
4890
4930
  Example
4891
4931
 
@@ -4940,7 +4980,7 @@ step. Instead of returning a regular Point, the result is a JacobianPoint.
4940
4980
  ```ts
4941
4981
  jmulAdd(k1: BigNumber, p2: Point, k2: BigNumber): JPoint
4942
4982
  ```
4943
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point)
4983
+ See also: [BigNumber](#class-bignumber), [Point](#class-point)
4944
4984
 
4945
4985
  Returns
4946
4986
 
@@ -4970,7 +5010,7 @@ Multiplies this Point by a scalar value, returning a new Point.
4970
5010
  ```ts
4971
5011
  mul(k: BigNumber | number | number[] | string): Point
4972
5012
  ```
4973
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point)
5013
+ See also: [BigNumber](#class-bignumber), [Point](#class-point)
4974
5014
 
4975
5015
  Returns
4976
5016
 
@@ -4996,7 +5036,7 @@ Multiplies this Point by k1, adds the resulting Point to the result of p2 multip
4996
5036
  ```ts
4997
5037
  mulAdd(k1: BigNumber, p2: Point, k2: BigNumber): Point
4998
5038
  ```
4999
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point)
5039
+ See also: [BigNumber](#class-bignumber), [Point](#class-point)
5000
5040
 
5001
5041
  Returns
5002
5042
 
@@ -5026,7 +5066,7 @@ Negate a point. The negation of a point P is the mirror of P about x-axis.
5026
5066
  ```ts
5027
5067
  neg(_precompute?: boolean): Point
5028
5068
  ```
5029
- See also: [Point](./primitives.md#class-point)
5069
+ See also: [Point](#class-point)
5030
5070
 
5031
5071
  Example
5032
5072
 
@@ -5075,7 +5115,7 @@ toJSON(): [
5075
5115
  }?
5076
5116
  ]
5077
5117
  ```
5078
- See also: [BigNumber](./primitives.md#class-bignumber)
5118
+ See also: [BigNumber](#class-bignumber)
5079
5119
 
5080
5120
  Returns
5081
5121
 
@@ -5130,6 +5170,8 @@ const aPoint = new Point(x, y);
5130
5170
  const isValid = aPoint.validate();
5131
5171
  ```
5132
5172
 
5173
+ </details>
5174
+
5133
5175
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
5134
5176
 
5135
5177
  ---
@@ -5145,7 +5187,11 @@ export class PointInFiniteField {
5145
5187
  }
5146
5188
  ```
5147
5189
 
5148
- See also: [BigNumber](./primitives.md#class-bignumber)
5190
+ See also: [BigNumber](#class-bignumber)
5191
+
5192
+ <details>
5193
+
5194
+ <summary>Class PointInFiniteField Details</summary>
5149
5195
 
5150
5196
  #### Method toString
5151
5197
 
@@ -5155,6 +5201,8 @@ function toString() { [native code] }
5155
5201
  toString(): string
5156
5202
  ```
5157
5203
 
5204
+ </details>
5205
+
5158
5206
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
5159
5207
 
5160
5208
  ---
@@ -5183,7 +5231,7 @@ export default class Polynomial {
5183
5231
  }
5184
5232
  ```
5185
5233
 
5186
- See also: [BigNumber](./primitives.md#class-bignumber), [PointInFiniteField](./primitives.md#class-pointinfinitefield), [PrivateKey](./primitives.md#class-privatekey)
5234
+ See also: [BigNumber](#class-bignumber), [PointInFiniteField](#class-pointinfinitefield), [PrivateKey](#class-privatekey)
5187
5235
 
5188
5236
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
5189
5237
 
@@ -5223,14 +5271,18 @@ export default class PrivateKey extends BigNumber {
5223
5271
  }
5224
5272
  ```
5225
5273
 
5226
- See also: [BigNumber](./primitives.md#class-bignumber), [KeyShares](./primitives.md#class-keyshares), [Point](./primitives.md#class-point), [PublicKey](./primitives.md#class-publickey), [Signature](./primitives.md#class-signature), [sign](./compat.md#variable-sign), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
5274
+ See also: [BigNumber](#class-bignumber), [KeyShares](#class-keyshares), [Point](#class-point), [PublicKey](#class-publickey), [Signature](#class-signature), [sign](#variable-sign), [toHex](#variable-tohex), [verify](#variable-verify)
5275
+
5276
+ <details>
5277
+
5278
+ <summary>Class PrivateKey Details</summary>
5227
5279
 
5228
5280
  #### Constructor
5229
5281
 
5230
5282
  ```ts
5231
5283
  constructor(number: BigNumber | number | string | number[] = 0, base: number | "be" | "le" | "hex" = 10, endian: "be" | "le" = "be", modN: "apply" | "nocheck" | "error" = "apply")
5232
5284
  ```
5233
- See also: [BigNumber](./primitives.md#class-bignumber)
5285
+ See also: [BigNumber](#class-bignumber)
5234
5286
 
5235
5287
  Argument Details
5236
5288
 
@@ -5261,7 +5313,7 @@ checkInField(): {
5261
5313
  modN: BigNumber;
5262
5314
  }
5263
5315
  ```
5264
- See also: [BigNumber](./primitives.md#class-bignumber)
5316
+ See also: [BigNumber](#class-bignumber)
5265
5317
 
5266
5318
  Returns
5267
5319
 
@@ -5274,7 +5326,7 @@ Derives a child key with BRC-42.
5274
5326
  ```ts
5275
5327
  deriveChild(publicKey: PublicKey, invoiceNumber: string): PrivateKey
5276
5328
  ```
5277
- See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
5329
+ See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
5278
5330
 
5279
5331
  Returns
5280
5332
 
@@ -5294,7 +5346,7 @@ Derives a shared secret from the public key.
5294
5346
  ```ts
5295
5347
  deriveSharedSecret(key: PublicKey): Point
5296
5348
  ```
5297
- See also: [Point](./primitives.md#class-point), [PublicKey](./primitives.md#class-publickey)
5349
+ See also: [Point](#class-point), [PublicKey](#class-publickey)
5298
5350
 
5299
5351
  Returns
5300
5352
 
@@ -5322,7 +5374,7 @@ const sharedSecret = privateKey.deriveSharedSecret(publicKey);
5322
5374
  ```ts
5323
5375
  static fromBackupShares(shares: string[]): PrivateKey
5324
5376
  ```
5325
- See also: [PrivateKey](./primitives.md#class-privatekey)
5377
+ See also: [PrivateKey](#class-privatekey)
5326
5378
 
5327
5379
  Returns
5328
5380
 
@@ -5344,7 +5396,7 @@ Generates a private key from a hexadecimal string.
5344
5396
  ```ts
5345
5397
  static fromHex(str: string): PrivateKey
5346
5398
  ```
5347
- See also: [PrivateKey](./primitives.md#class-privatekey)
5399
+ See also: [PrivateKey](#class-privatekey)
5348
5400
 
5349
5401
  Returns
5350
5402
 
@@ -5366,7 +5418,7 @@ Combines shares to reconstruct the private key.
5366
5418
  ```ts
5367
5419
  static fromKeyShares(keyShares: KeyShares): PrivateKey
5368
5420
  ```
5369
- See also: [KeyShares](./primitives.md#class-keyshares), [PrivateKey](./primitives.md#class-privatekey)
5421
+ See also: [KeyShares](#class-keyshares), [PrivateKey](#class-privatekey)
5370
5422
 
5371
5423
  Returns
5372
5424
 
@@ -5386,7 +5438,7 @@ Generates a private key randomly.
5386
5438
  ```ts
5387
5439
  static fromRandom(): PrivateKey
5388
5440
  ```
5389
- See also: [PrivateKey](./primitives.md#class-privatekey)
5441
+ See also: [PrivateKey](#class-privatekey)
5390
5442
 
5391
5443
  Returns
5392
5444
 
@@ -5405,7 +5457,7 @@ Generates a private key from a string.
5405
5457
  ```ts
5406
5458
  static fromString(str: string, base: number | "hex" = "hex"): PrivateKey
5407
5459
  ```
5408
- See also: [PrivateKey](./primitives.md#class-privatekey)
5460
+ See also: [PrivateKey](#class-privatekey)
5409
5461
 
5410
5462
  Returns
5411
5463
 
@@ -5429,7 +5481,7 @@ Generates a private key from a WIF (Wallet Import Format) string.
5429
5481
  ```ts
5430
5482
  static fromWif(wif: string, prefixLength: number = 1): PrivateKey
5431
5483
  ```
5432
- See also: [PrivateKey](./primitives.md#class-privatekey)
5484
+ See also: [PrivateKey](#class-privatekey)
5433
5485
 
5434
5486
  Returns
5435
5487
 
@@ -5463,7 +5515,7 @@ Signs a message using the private key.
5463
5515
  ```ts
5464
5516
  sign(msg: number[] | string, enc?: "hex" | "utf8", forceLowS: boolean = true, customK?: ((iter: number) => BigNumber) | BigNumber): Signature
5465
5517
  ```
5466
- See also: [BigNumber](./primitives.md#class-bignumber), [Signature](./primitives.md#class-signature)
5518
+ See also: [BigNumber](#class-bignumber), [Signature](#class-signature)
5467
5519
 
5468
5520
  Returns
5469
5521
 
@@ -5558,7 +5610,7 @@ Splits the private key into shares using Shamir's Secret Sharing Scheme.
5558
5610
  ```ts
5559
5611
  toKeyShares(threshold: number, totalShares: number): KeyShares
5560
5612
  ```
5561
- See also: [KeyShares](./primitives.md#class-keyshares)
5613
+ See also: [KeyShares](#class-keyshares)
5562
5614
 
5563
5615
  Returns
5564
5616
 
@@ -5589,7 +5641,7 @@ The public key is generated by multiplying the base point G of the curve and the
5589
5641
  ```ts
5590
5642
  toPublicKey(): PublicKey
5591
5643
  ```
5592
- See also: [PublicKey](./primitives.md#class-publickey)
5644
+ See also: [PublicKey](#class-publickey)
5593
5645
 
5594
5646
  Returns
5595
5647
 
@@ -5662,7 +5714,7 @@ Verifies a message's signature using the public key associated with this private
5662
5714
  ```ts
5663
5715
  verify(msg: number[] | string, sig: Signature, enc?: "hex"): boolean
5664
5716
  ```
5665
- See also: [Signature](./primitives.md#class-signature)
5717
+ See also: [Signature](#class-signature)
5666
5718
 
5667
5719
  Returns
5668
5720
 
@@ -5685,6 +5737,8 @@ const signature = privateKey.sign('Hello, World!');
5685
5737
  const isSignatureValid = privateKey.verify('Hello, World!', signature);
5686
5738
  ```
5687
5739
 
5740
+ </details>
5741
+
5688
5742
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
5689
5743
 
5690
5744
  ---
@@ -5709,14 +5763,18 @@ export default class PublicKey extends Point {
5709
5763
  }
5710
5764
  ```
5711
5765
 
5712
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey), [Signature](./primitives.md#class-signature), [verify](./compat.md#variable-verify)
5766
+ See also: [BigNumber](#class-bignumber), [Point](#class-point), [PrivateKey](#class-privatekey), [Signature](#class-signature), [verify](#variable-verify)
5767
+
5768
+ <details>
5769
+
5770
+ <summary>Class PublicKey Details</summary>
5713
5771
 
5714
5772
  #### Constructor
5715
5773
 
5716
5774
  ```ts
5717
5775
  constructor(x: Point | BigNumber | number | number[] | string | null, y: BigNumber | number | number[] | string | null = null, isRed: boolean = true)
5718
5776
  ```
5719
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point)
5777
+ See also: [BigNumber](#class-bignumber), [Point](#class-point)
5720
5778
 
5721
5779
  Argument Details
5722
5780
 
@@ -5741,7 +5799,7 @@ Derives a child key with BRC-42.
5741
5799
  ```ts
5742
5800
  deriveChild(privateKey: PrivateKey, invoiceNumber: string): PublicKey
5743
5801
  ```
5744
- See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
5802
+ See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
5745
5803
 
5746
5804
  Returns
5747
5805
 
@@ -5762,7 +5820,7 @@ This method multiplies the public key (an instance of Point) with a private key.
5762
5820
  ```ts
5763
5821
  deriveSharedSecret(priv: PrivateKey): Point
5764
5822
  ```
5765
- See also: [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey)
5823
+ See also: [Point](#class-point), [PrivateKey](#class-privatekey)
5766
5824
 
5767
5825
  Returns
5768
5826
 
@@ -5791,7 +5849,7 @@ Static factory method to create a PublicKey instance from a number array.
5791
5849
  ```ts
5792
5850
  static fromDER(bytes: number[]): PublicKey
5793
5851
  ```
5794
- See also: [PublicKey](./primitives.md#class-publickey)
5852
+ See also: [PublicKey](#class-publickey)
5795
5853
 
5796
5854
  Returns
5797
5855
 
@@ -5820,7 +5878,7 @@ The range represents the recovery param which can be 0,1,2,3.
5820
5878
  ```ts
5821
5879
  static fromMsgHashAndCompactSignature(msgHash: BigNumber, signature: number[] | string, enc?: "hex" | "base64"): PublicKey
5822
5880
  ```
5823
- See also: [BigNumber](./primitives.md#class-bignumber), [PublicKey](./primitives.md#class-publickey)
5881
+ See also: [BigNumber](#class-bignumber), [PublicKey](#class-publickey)
5824
5882
 
5825
5883
  Returns
5826
5884
 
@@ -5849,7 +5907,7 @@ It multiplies the generator point 'g' on the elliptic curve by the private key.
5849
5907
  ```ts
5850
5908
  static fromPrivateKey(key: PrivateKey): PublicKey
5851
5909
  ```
5852
- See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
5910
+ See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
5853
5911
 
5854
5912
  Returns
5855
5913
 
@@ -5874,7 +5932,7 @@ Static factory method to create a PublicKey instance from a string.
5874
5932
  ```ts
5875
5933
  static fromString(str: string): PublicKey
5876
5934
  ```
5877
- See also: [PublicKey](./primitives.md#class-publickey)
5935
+ See also: [PublicKey](#class-publickey)
5878
5936
 
5879
5937
  Returns
5880
5938
 
@@ -5966,7 +6024,7 @@ Verify a signature of a message using this public key.
5966
6024
  ```ts
5967
6025
  verify(msg: number[] | string, sig: Signature, enc?: "hex" | "utf8"): boolean
5968
6026
  ```
5969
- See also: [Signature](./primitives.md#class-signature)
6027
+ See also: [Signature](#class-signature)
5970
6028
 
5971
6029
  Returns
5972
6030
 
@@ -5989,6 +6047,8 @@ const mySignature = new Signature(...)
5989
6047
  const isVerified = myPubKey.verify(myMessage, mySignature)
5990
6048
  ```
5991
6049
 
6050
+ </details>
6051
+
5992
6052
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
5993
6053
 
5994
6054
  ---
@@ -6015,6 +6075,10 @@ export class RIPEMD160 extends BaseHash {
6015
6075
  }
6016
6076
  ```
6017
6077
 
6078
+ <details>
6079
+
6080
+ <summary>Class RIPEMD160 Details</summary>
6081
+
6018
6082
  #### Property h
6019
6083
 
6020
6084
  Array that is updated iteratively as part of hashing computation.
@@ -6023,6 +6087,8 @@ Array that is updated iteratively as part of hashing computation.
6023
6087
  h: number[]
6024
6088
  ```
6025
6089
 
6090
+ </details>
6091
+
6026
6092
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
6027
6093
 
6028
6094
  ---
@@ -6054,7 +6120,7 @@ export class Reader {
6054
6120
  }
6055
6121
  ```
6056
6122
 
6057
- See also: [BigNumber](./primitives.md#class-bignumber)
6123
+ See also: [BigNumber](#class-bignumber)
6058
6124
 
6059
6125
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
6060
6126
 
@@ -6091,7 +6157,11 @@ export default class ReductionContext {
6091
6157
  }
6092
6158
  ```
6093
6159
 
6094
- See also: [BigNumber](./primitives.md#class-bignumber), [Mersenne](./primitives.md#class-mersenne)
6160
+ See also: [BigNumber](#class-bignumber), [Mersenne](#class-mersenne)
6161
+
6162
+ <details>
6163
+
6164
+ <summary>Class ReductionContext Details</summary>
6095
6165
 
6096
6166
  #### Constructor
6097
6167
 
@@ -6100,7 +6170,7 @@ Constructs a new ReductionContext.
6100
6170
  ```ts
6101
6171
  constructor(m: BigNumber | "k256")
6102
6172
  ```
6103
- See also: [BigNumber](./primitives.md#class-bignumber)
6173
+ See also: [BigNumber](#class-bignumber)
6104
6174
 
6105
6175
  Argument Details
6106
6176
 
@@ -6121,7 +6191,7 @@ The modulus used for reduction operations.
6121
6191
  ```ts
6122
6192
  m: BigNumber
6123
6193
  ```
6124
- See also: [BigNumber](./primitives.md#class-bignumber)
6194
+ See also: [BigNumber](#class-bignumber)
6125
6195
 
6126
6196
  #### Property prime
6127
6197
 
@@ -6130,7 +6200,7 @@ The prime number utilised in the reduction context, typically an instance of Mer
6130
6200
  ```ts
6131
6201
  prime: Mersenne | null
6132
6202
  ```
6133
- See also: [Mersenne](./primitives.md#class-mersenne)
6203
+ See also: [Mersenne](#class-mersenne)
6134
6204
 
6135
6205
  #### Method add
6136
6206
 
@@ -6139,7 +6209,7 @@ Performs the addition operation on two BigNumbers in the reduction context.
6139
6209
  ```ts
6140
6210
  add(a: BigNumber, b: BigNumber): BigNumber
6141
6211
  ```
6142
- See also: [BigNumber](./primitives.md#class-bignumber)
6212
+ See also: [BigNumber](#class-bignumber)
6143
6213
 
6144
6214
  Returns
6145
6215
 
@@ -6166,7 +6236,7 @@ Converts a BigNumber from reduction context to its regular form.
6166
6236
  ```ts
6167
6237
  convertFrom(num: BigNumber): BigNumber
6168
6238
  ```
6169
- See also: [BigNumber](./primitives.md#class-bignumber)
6239
+ See also: [BigNumber](#class-bignumber)
6170
6240
 
6171
6241
  Returns
6172
6242
 
@@ -6192,7 +6262,7 @@ Converts a BigNumber to its equivalent in the reduction context.
6192
6262
  ```ts
6193
6263
  convertTo(num: BigNumber): BigNumber
6194
6264
  ```
6195
- See also: [BigNumber](./primitives.md#class-bignumber)
6265
+ See also: [BigNumber](#class-bignumber)
6196
6266
 
6197
6267
  Returns
6198
6268
 
@@ -6218,7 +6288,7 @@ in order to avoid creating a new BigNumber, it modifies the first one with the r
6218
6288
  ```ts
6219
6289
  iadd(a: BigNumber, b: BigNumber): BigNumber
6220
6290
  ```
6221
- See also: [BigNumber](./primitives.md#class-bignumber)
6291
+ See also: [BigNumber](#class-bignumber)
6222
6292
 
6223
6293
  Returns
6224
6294
 
@@ -6246,7 +6316,7 @@ Performs an in-place reduction of the given BigNumber by the modulus of the redu
6246
6316
  ```ts
6247
6317
  imod(a: BigNumber): BigNumber
6248
6318
  ```
6249
- See also: [BigNumber](./primitives.md#class-bignumber)
6319
+ See also: [BigNumber](#class-bignumber)
6250
6320
 
6251
6321
  Returns
6252
6322
 
@@ -6272,7 +6342,7 @@ modifying the first BigNumber with the result.
6272
6342
  ```ts
6273
6343
  imul(a: BigNumber, b: BigNumber): BigNumber
6274
6344
  ```
6275
- See also: [BigNumber](./primitives.md#class-bignumber)
6345
+ See also: [BigNumber](#class-bignumber)
6276
6346
 
6277
6347
  Returns
6278
6348
 
@@ -6300,7 +6370,7 @@ Calculates the multiplicative inverse of a BigNumber in the reduction context.
6300
6370
  ```ts
6301
6371
  invm(a: BigNumber): BigNumber
6302
6372
  ```
6303
- See also: [BigNumber](./primitives.md#class-bignumber)
6373
+ See also: [BigNumber](#class-bignumber)
6304
6374
 
6305
6375
  Returns
6306
6376
 
@@ -6326,7 +6396,7 @@ modifying the original BigNumber with the result.
6326
6396
  ```ts
6327
6397
  isqr(a: BigNumber): BigNumber
6328
6398
  ```
6329
- See also: [BigNumber](./primitives.md#class-bignumber)
6399
+ See also: [BigNumber](#class-bignumber)
6330
6400
 
6331
6401
  Returns
6332
6402
 
@@ -6353,7 +6423,7 @@ it modifies the first BigNumber with the result.
6353
6423
  ```ts
6354
6424
  isub(a: BigNumber, b: BigNumber): BigNumber
6355
6425
  ```
6356
- See also: [BigNumber](./primitives.md#class-bignumber)
6426
+ See also: [BigNumber](#class-bignumber)
6357
6427
 
6358
6428
  Returns
6359
6429
 
@@ -6381,7 +6451,7 @@ Multiplies two BigNumbers in the reduction context.
6381
6451
  ```ts
6382
6452
  mul(a: BigNumber, b: BigNumber): BigNumber
6383
6453
  ```
6384
- See also: [BigNumber](./primitives.md#class-bignumber)
6454
+ See also: [BigNumber](#class-bignumber)
6385
6455
 
6386
6456
  Returns
6387
6457
 
@@ -6408,7 +6478,7 @@ Negates a BigNumber in the context of the modulus.
6408
6478
  ```ts
6409
6479
  neg(a: BigNumber): BigNumber
6410
6480
  ```
6411
- See also: [BigNumber](./primitives.md#class-bignumber)
6481
+ See also: [BigNumber](#class-bignumber)
6412
6482
 
6413
6483
  Returns
6414
6484
 
@@ -6433,7 +6503,7 @@ Raises a BigNumber to a power in the reduction context.
6433
6503
  ```ts
6434
6504
  pow(a: BigNumber, num: BigNumber): BigNumber
6435
6505
  ```
6436
- See also: [BigNumber](./primitives.md#class-bignumber)
6506
+ See also: [BigNumber](#class-bignumber)
6437
6507
 
6438
6508
  Returns
6439
6509
 
@@ -6460,7 +6530,7 @@ Performs bitwise shift left operation on a BigNumber in the reduction context.
6460
6530
  ```ts
6461
6531
  shl(a: BigNumber, num: number): BigNumber
6462
6532
  ```
6463
- See also: [BigNumber](./primitives.md#class-bignumber)
6533
+ See also: [BigNumber](#class-bignumber)
6464
6534
 
6465
6535
  Returns
6466
6536
 
@@ -6487,7 +6557,7 @@ Calculates the square of a BigNumber in the reduction context.
6487
6557
  ```ts
6488
6558
  sqr(a: BigNumber): BigNumber
6489
6559
  ```
6490
- See also: [BigNumber](./primitives.md#class-bignumber)
6560
+ See also: [BigNumber](#class-bignumber)
6491
6561
 
6492
6562
  Returns
6493
6563
 
@@ -6512,7 +6582,7 @@ Calculates the square root of a BigNumber in the reduction context.
6512
6582
  ```ts
6513
6583
  sqrt(a: BigNumber): BigNumber
6514
6584
  ```
6515
- See also: [BigNumber](./primitives.md#class-bignumber)
6585
+ See also: [BigNumber](#class-bignumber)
6516
6586
 
6517
6587
  Returns
6518
6588
 
@@ -6537,7 +6607,7 @@ Subtracts one BigNumber from another BigNumber in the reduction context.
6537
6607
  ```ts
6538
6608
  sub(a: BigNumber, b: BigNumber): BigNumber
6539
6609
  ```
6540
- See also: [BigNumber](./primitives.md#class-bignumber)
6610
+ See also: [BigNumber](#class-bignumber)
6541
6611
 
6542
6612
  Returns
6543
6613
 
@@ -6565,7 +6635,7 @@ conditions are not met.
6565
6635
  ```ts
6566
6636
  verify1(a: BigNumber): void
6567
6637
  ```
6568
- See also: [BigNumber](./primitives.md#class-bignumber)
6638
+ See also: [BigNumber](#class-bignumber)
6569
6639
 
6570
6640
  Argument Details
6571
6641
 
@@ -6589,7 +6659,7 @@ conditions are not met.
6589
6659
  ```ts
6590
6660
  verify2(a: BigNumber, b: BigNumber): void
6591
6661
  ```
6592
- See also: [BigNumber](./primitives.md#class-bignumber)
6662
+ See also: [BigNumber](#class-bignumber)
6593
6663
 
6594
6664
  Argument Details
6595
6665
 
@@ -6606,6 +6676,8 @@ this.verify2(new BigNumber(-10).toRed(this), new BigNumber(20).toRed(this)); //t
6606
6676
  this.verify2(new BigNumber(10).toRed(this), new BigNumber(20)); //throws an Error
6607
6677
  ```
6608
6678
 
6679
+ </details>
6680
+
6609
6681
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
6610
6682
 
6611
6683
  ---
@@ -6634,6 +6706,10 @@ export class SHA1 extends BaseHash {
6634
6706
  }
6635
6707
  ```
6636
6708
 
6709
+ <details>
6710
+
6711
+ <summary>Class SHA1 Details</summary>
6712
+
6637
6713
  #### Property W
6638
6714
 
6639
6715
  Provides a way to recycle usage of the array memory.
@@ -6658,6 +6734,8 @@ The round constants used for each round of SHA-1.
6658
6734
  k: number[]
6659
6735
  ```
6660
6736
 
6737
+ </details>
6738
+
6661
6739
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
6662
6740
 
6663
6741
  ---
@@ -6675,7 +6753,7 @@ export class SHA1HMAC {
6675
6753
  }
6676
6754
  ```
6677
6755
 
6678
- See also: [SHA1](./primitives.md#class-sha1)
6756
+ See also: [SHA1](#class-sha1)
6679
6757
 
6680
6758
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
6681
6759
 
@@ -6705,6 +6783,10 @@ export class SHA256 extends BaseHash {
6705
6783
  }
6706
6784
  ```
6707
6785
 
6786
+ <details>
6787
+
6788
+ <summary>Class SHA256 Details</summary>
6789
+
6708
6790
  #### Property W
6709
6791
 
6710
6792
  Provides a way to recycle usage of the array memory.
@@ -6729,6 +6811,8 @@ The round constants used for each round of SHA-256
6729
6811
  k: number[]
6730
6812
  ```
6731
6813
 
6814
+ </details>
6815
+
6732
6816
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
6733
6817
 
6734
6818
  ---
@@ -6753,7 +6837,11 @@ export class SHA256HMAC {
6753
6837
  }
6754
6838
  ```
6755
6839
 
6756
- See also: [SHA256](./primitives.md#class-sha256)
6840
+ See also: [SHA256](#class-sha256)
6841
+
6842
+ <details>
6843
+
6844
+ <summary>Class SHA256HMAC Details</summary>
6757
6845
 
6758
6846
  #### Constructor
6759
6847
 
@@ -6793,7 +6881,7 @@ Represents the inner hash of SHA-256.
6793
6881
  ```ts
6794
6882
  inner: SHA256
6795
6883
  ```
6796
- See also: [SHA256](./primitives.md#class-sha256)
6884
+ See also: [SHA256](#class-sha256)
6797
6885
 
6798
6886
  #### Property outSize
6799
6887
 
@@ -6810,7 +6898,7 @@ Represents the outer hash of SHA-256.
6810
6898
  ```ts
6811
6899
  outer: SHA256
6812
6900
  ```
6813
- See also: [SHA256](./primitives.md#class-sha256)
6901
+ See also: [SHA256](#class-sha256)
6814
6902
 
6815
6903
  #### Method digest
6816
6904
 
@@ -6855,7 +6943,7 @@ Updates the `SHA256HMAC` object with part of the message to be hashed.
6855
6943
  ```ts
6856
6944
  update(msg: number[] | string, enc?: "hex"): SHA256HMAC
6857
6945
  ```
6858
- See also: [SHA256HMAC](./primitives.md#class-sha256hmac)
6946
+ See also: [SHA256HMAC](#class-sha256hmac)
6859
6947
 
6860
6948
  Returns
6861
6949
 
@@ -6874,6 +6962,8 @@ Example
6874
6962
  myHMAC.update('deadbeef', 'hex');
6875
6963
  ```
6876
6964
 
6965
+ </details>
6966
+
6877
6967
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
6878
6968
 
6879
6969
  ---
@@ -6903,6 +6993,10 @@ export class SHA512 extends BaseHash {
6903
6993
  }
6904
6994
  ```
6905
6995
 
6996
+ <details>
6997
+
6998
+ <summary>Class SHA512 Details</summary>
6999
+
6906
7000
  #### Property W
6907
7001
 
6908
7002
  Provides a way to recycle usage of the array memory.
@@ -6927,6 +7021,8 @@ The round constants used for each round of SHA-512.
6927
7021
  k: number[]
6928
7022
  ```
6929
7023
 
7024
+ </details>
7025
+
6930
7026
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
6931
7027
 
6932
7028
  ---
@@ -6951,7 +7047,11 @@ export class SHA512HMAC {
6951
7047
  }
6952
7048
  ```
6953
7049
 
6954
- See also: [SHA512](./primitives.md#class-sha512)
7050
+ See also: [SHA512](#class-sha512)
7051
+
7052
+ <details>
7053
+
7054
+ <summary>Class SHA512HMAC Details</summary>
6955
7055
 
6956
7056
  #### Constructor
6957
7057
 
@@ -6991,7 +7091,7 @@ Represents the inner hash of SHA-512.
6991
7091
  ```ts
6992
7092
  inner: SHA512
6993
7093
  ```
6994
- See also: [SHA512](./primitives.md#class-sha512)
7094
+ See also: [SHA512](#class-sha512)
6995
7095
 
6996
7096
  #### Property outSize
6997
7097
 
@@ -7008,7 +7108,7 @@ Represents the outer hash of SHA-512.
7008
7108
  ```ts
7009
7109
  outer: SHA512
7010
7110
  ```
7011
- See also: [SHA512](./primitives.md#class-sha512)
7111
+ See also: [SHA512](#class-sha512)
7012
7112
 
7013
7113
  #### Method digest
7014
7114
 
@@ -7053,7 +7153,7 @@ Updates the `SHA512HMAC` object with part of the message to be hashed.
7053
7153
  ```ts
7054
7154
  update(msg: number[] | string, enc?: "hex" | "utf8"): SHA512HMAC
7055
7155
  ```
7056
- See also: [SHA512HMAC](./primitives.md#class-sha512hmac)
7156
+ See also: [SHA512HMAC](#class-sha512hmac)
7057
7157
 
7058
7158
  Returns
7059
7159
 
@@ -7072,6 +7172,8 @@ Example
7072
7172
  myHMAC.update('deadbeef', 'hex');
7073
7173
  ```
7074
7174
 
7175
+ </details>
7176
+
7075
7177
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7076
7178
 
7077
7179
  ---
@@ -7122,7 +7224,11 @@ export default class Schnorr {
7122
7224
  }
7123
7225
  ```
7124
7226
 
7125
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
7227
+ See also: [BigNumber](#class-bignumber), [Point](#class-point), [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
7228
+
7229
+ <details>
7230
+
7231
+ <summary>Class Schnorr Details</summary>
7126
7232
 
7127
7233
  #### Method generateProof
7128
7234
 
@@ -7135,7 +7241,7 @@ generateProof(aArg: PrivateKey, AArg: PublicKey, BArg: PublicKey, S: Point): {
7135
7241
  z: BigNumber;
7136
7242
  }
7137
7243
  ```
7138
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
7244
+ See also: [BigNumber](#class-bignumber), [Point](#class-point), [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
7139
7245
 
7140
7246
  Returns
7141
7247
 
@@ -7163,7 +7269,7 @@ verifyProof(A: Point, B: Point, S: Point, proof: {
7163
7269
  z: BigNumber;
7164
7270
  }): boolean
7165
7271
  ```
7166
- See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point)
7272
+ See also: [BigNumber](#class-bignumber), [Point](#class-point)
7167
7273
 
7168
7274
  Returns
7169
7275
 
@@ -7180,6 +7286,8 @@ Argument Details
7180
7286
  + **proof**
7181
7287
  + Proof (R, S', z)
7182
7288
 
7289
+ </details>
7290
+
7183
7291
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7184
7292
 
7185
7293
  ---
@@ -7208,7 +7316,11 @@ export default class Signature {
7208
7316
  }
7209
7317
  ```
7210
7318
 
7211
- See also: [BigNumber](./primitives.md#class-bignumber), [PublicKey](./primitives.md#class-publickey), [verify](./compat.md#variable-verify)
7319
+ See also: [BigNumber](#class-bignumber), [PublicKey](#class-publickey), [verify](#variable-verify)
7320
+
7321
+ <details>
7322
+
7323
+ <summary>Class Signature Details</summary>
7212
7324
 
7213
7325
  #### Constructor
7214
7326
 
@@ -7217,7 +7329,7 @@ Creates an instance of the Signature class.
7217
7329
  ```ts
7218
7330
  constructor(r: BigNumber, s: BigNumber)
7219
7331
  ```
7220
- See also: [BigNumber](./primitives.md#class-bignumber)
7332
+ See also: [BigNumber](#class-bignumber)
7221
7333
 
7222
7334
  Argument Details
7223
7335
 
@@ -7244,7 +7356,7 @@ The recovery factor is a number between 0 and 3.
7244
7356
  ```ts
7245
7357
  CalculateRecoveryFactor(pubkey: PublicKey, msgHash: BigNumber): number
7246
7358
  ```
7247
- See also: [BigNumber](./primitives.md#class-bignumber), [PublicKey](./primitives.md#class-publickey)
7359
+ See also: [BigNumber](#class-bignumber), [PublicKey](#class-publickey)
7248
7360
 
7249
7361
  Returns
7250
7362
 
@@ -7272,7 +7384,7 @@ The recovery factor is a number between 0 and 3.
7272
7384
  ```ts
7273
7385
  RecoverPublicKey(recovery: number, e: BigNumber): PublicKey
7274
7386
  ```
7275
- See also: [BigNumber](./primitives.md#class-bignumber), [PublicKey](./primitives.md#class-publickey)
7387
+ See also: [BigNumber](#class-bignumber), [PublicKey](#class-publickey)
7276
7388
 
7277
7389
  Returns
7278
7390
 
@@ -7304,7 +7416,7 @@ We could support recovery functions in future if there's demand.
7304
7416
  ```ts
7305
7417
  static fromCompact(data: number[] | string, enc?: "hex" | "base64"): Signature
7306
7418
  ```
7307
- See also: [Signature](./primitives.md#class-signature)
7419
+ See also: [Signature](#class-signature)
7308
7420
 
7309
7421
  Returns
7310
7422
 
@@ -7332,7 +7444,7 @@ If a string is provided, it is assumed to represent a hexadecimal sequence.
7332
7444
  ```ts
7333
7445
  static fromDER(data: number[] | string, enc?: "hex" | "base64"): Signature
7334
7446
  ```
7335
- See also: [Signature](./primitives.md#class-signature)
7447
+ See also: [Signature](#class-signature)
7336
7448
 
7337
7449
  Returns
7338
7450
 
@@ -7445,7 +7557,7 @@ If the data or key do not match the signature, the function returns false.
7445
7557
  ```ts
7446
7558
  verify(msg: number[] | string, key: PublicKey, enc?: "hex"): boolean
7447
7559
  ```
7448
- See also: [PublicKey](./primitives.md#class-publickey)
7560
+ See also: [PublicKey](#class-publickey)
7449
7561
 
7450
7562
  Returns
7451
7563
 
@@ -7468,6 +7580,8 @@ const publicKey = PublicKey.fromString('04188ca1050...');
7468
7580
  const isVerified = signature.verify(msg, publicKey);
7469
7581
  ```
7470
7582
 
7583
+ </details>
7584
+
7471
7585
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7472
7586
 
7473
7587
  ---
@@ -7485,7 +7599,11 @@ export default class SymmetricKey extends BigNumber {
7485
7599
  }
7486
7600
  ```
7487
7601
 
7488
- See also: [BigNumber](./primitives.md#class-bignumber), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt)
7602
+ See also: [BigNumber](#class-bignumber)
7603
+
7604
+ <details>
7605
+
7606
+ <summary>Class SymmetricKey Details</summary>
7489
7607
 
7490
7608
  #### Method decrypt
7491
7609
 
@@ -7554,7 +7672,7 @@ Generates a symmetric key randomly.
7554
7672
  ```ts
7555
7673
  static fromRandom(): SymmetricKey
7556
7674
  ```
7557
- See also: [SymmetricKey](./primitives.md#class-symmetrickey)
7675
+ See also: [SymmetricKey](#class-symmetrickey)
7558
7676
 
7559
7677
  Returns
7560
7678
 
@@ -7566,6 +7684,8 @@ Example
7566
7684
  const symmetricKey = SymmetricKey.fromRandom();
7567
7685
  ```
7568
7686
 
7687
+ </details>
7688
+
7569
7689
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7570
7690
 
7571
7691
  ---
@@ -7599,7 +7719,11 @@ export default class TransactionSignature extends Signature {
7599
7719
  }
7600
7720
  ```
7601
7721
 
7602
- See also: [BigNumber](./primitives.md#class-bignumber), [Script](./script.md#class-script), [Signature](./primitives.md#class-signature), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput)
7722
+ See also: [BigNumber](#class-bignumber), [Script](#class-script), [Signature](#class-signature), [TransactionInput](#interface-transactioninput), [TransactionOutput](#interface-transactionoutput)
7723
+
7724
+ <details>
7725
+
7726
+ <summary>Class TransactionSignature Details</summary>
7603
7727
 
7604
7728
  #### Method hasLowS
7605
7729
 
@@ -7611,6 +7735,8 @@ See also Bip 62, "low S values in signatures"
7611
7735
  public hasLowS(): boolean
7612
7736
  ```
7613
7737
 
7738
+ </details>
7739
+
7614
7740
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7615
7741
 
7616
7742
  ---
@@ -7644,7 +7770,7 @@ export class Writer {
7644
7770
  }
7645
7771
  ```
7646
7772
 
7647
- See also: [BigNumber](./primitives.md#class-bignumber), [toArray](./primitives.md#variable-toarray)
7773
+ See also: [BigNumber](#class-bignumber), [toArray](#variable-toarray)
7648
7774
 
7649
7775
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7650
7776
 
@@ -7712,6 +7838,10 @@ Limited SHA-512-only PBKDF2 function for use in deprecated BIP39 code.
7712
7838
  export function pbkdf2(password: number[], salt: number[], iterations: number, keylen: number, digest = "sha512"): number[]
7713
7839
  ```
7714
7840
 
7841
+ <details>
7842
+
7843
+ <summary>Function pbkdf2 Details</summary>
7844
+
7715
7845
  Returns
7716
7846
 
7717
7847
  The computed key
@@ -7729,6 +7859,8 @@ Argument Details
7729
7859
  + **digest**
7730
7860
  + The digest (must be sha512 for this implementation)
7731
7861
 
7862
+ </details>
7863
+
7732
7864
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7733
7865
 
7734
7866
  ---
@@ -7738,6 +7870,10 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
7738
7870
  export function toArray(msg: number[] | string, enc?: "hex" | "utf8"): number[]
7739
7871
  ```
7740
7872
 
7873
+ <details>
7874
+
7875
+ <summary>Function toArray Details</summary>
7876
+
7741
7877
  Returns
7742
7878
 
7743
7879
  array of byte values from msg. If msg is an array, a copy is returned.
@@ -7747,6 +7883,8 @@ Argument Details
7747
7883
  + **enc**
7748
7884
  + Optional. Encoding to use if msg is string. Default is 'utf8'.
7749
7885
 
7886
+ </details>
7887
+
7750
7888
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7751
7889
 
7752
7890
  ---
@@ -7765,6 +7903,10 @@ console.log(toBase64(bytes)); // Outputs: SGVsbG8=
7765
7903
  export function toBase64(byteArray: number[]): string
7766
7904
  ```
7767
7905
 
7906
+ <details>
7907
+
7908
+ <summary>Function toBase64 Details</summary>
7909
+
7768
7910
  Returns
7769
7911
 
7770
7912
  The base64 encoded string.
@@ -7774,6 +7916,8 @@ Argument Details
7774
7916
  + **byteArray**
7775
7917
  + An array of numbers where each number is a byte (0-255).
7776
7918
 
7919
+ </details>
7920
+
7777
7921
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7778
7922
 
7779
7923
  ---
@@ -7825,7 +7969,7 @@ encode = (arr: number[], enc?: "hex" | "utf8"): string | number[] => {
7825
7969
  }
7826
7970
  ```
7827
7971
 
7828
- See also: [toHex](./primitives.md#variable-tohex), [toUTF8](./primitives.md#variable-toutf8)
7972
+ See also: [toHex](#variable-tohex), [toUTF8](#variable-toutf8)
7829
7973
 
7830
7974
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7831
7975
 
@@ -7907,7 +8051,7 @@ fromBase58Check = (str: string, enc?: "hex", prefixLength: number = 1): {
7907
8051
  }
7908
8052
  ```
7909
8053
 
7910
- See also: [fromBase58](./primitives.md#variable-frombase58), [hash256](./primitives.md#variable-hash256), [toHex](./primitives.md#variable-tohex)
8054
+ See also: [fromBase58](#variable-frombase58), [hash256](#variable-hash256), [toHex](#variable-tohex)
7911
8055
 
7912
8056
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7913
8057
 
@@ -7937,7 +8081,7 @@ hash160 = (msg: number[] | string, enc?: "hex" | "utf8"): number[] => {
7937
8081
  }
7938
8082
  ```
7939
8083
 
7940
- See also: [RIPEMD160](./primitives.md#class-ripemd160), [SHA256](./primitives.md#class-sha256)
8084
+ See also: [RIPEMD160](#class-ripemd160), [SHA256](#class-sha256)
7941
8085
 
7942
8086
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7943
8087
 
@@ -7951,7 +8095,7 @@ hash256 = (msg: number[] | string, enc?: "hex" | "utf8"): number[] => {
7951
8095
  }
7952
8096
  ```
7953
8097
 
7954
- See also: [SHA256](./primitives.md#class-sha256)
8098
+ See also: [SHA256](#class-sha256)
7955
8099
 
7956
8100
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
7957
8101
 
@@ -8039,7 +8183,7 @@ multiply = function (block0: number[], block1: number[]): number[] {
8039
8183
  }
8040
8184
  ```
8041
8185
 
8042
- See also: [checkBit](./primitives.md#variable-checkbit), [exclusiveOR](./primitives.md#variable-exclusiveor), [rightShift](./primitives.md#variable-rightshift)
8186
+ See also: [checkBit](#variable-checkbit), [exclusiveOR](#variable-exclusiveor), [rightShift](#variable-rightshift)
8043
8187
 
8044
8188
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8045
8189
 
@@ -8074,7 +8218,7 @@ ripemd160 = (msg: number[] | string, enc?: "hex" | "utf8"): number[] => {
8074
8218
  }
8075
8219
  ```
8076
8220
 
8077
- See also: [RIPEMD160](./primitives.md#class-ripemd160)
8221
+ See also: [RIPEMD160](#class-ripemd160)
8078
8222
 
8079
8223
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8080
8224
 
@@ -8087,7 +8231,7 @@ sha1 = (msg: number[] | string, enc?: "hex" | "utf8"): number[] => {
8087
8231
  }
8088
8232
  ```
8089
8233
 
8090
- See also: [SHA1](./primitives.md#class-sha1)
8234
+ See also: [SHA1](#class-sha1)
8091
8235
 
8092
8236
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8093
8237
 
@@ -8100,7 +8244,7 @@ sha256 = (msg: number[] | string, enc?: "hex" | "utf8"): number[] => {
8100
8244
  }
8101
8245
  ```
8102
8246
 
8103
- See also: [SHA256](./primitives.md#class-sha256)
8247
+ See also: [SHA256](#class-sha256)
8104
8248
 
8105
8249
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8106
8250
 
@@ -8113,7 +8257,7 @@ sha256hmac = (key: number[] | string, msg: number[] | string, enc?: "hex"): numb
8113
8257
  }
8114
8258
  ```
8115
8259
 
8116
- See also: [SHA256HMAC](./primitives.md#class-sha256hmac)
8260
+ See also: [SHA256HMAC](#class-sha256hmac)
8117
8261
 
8118
8262
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8119
8263
 
@@ -8126,7 +8270,7 @@ sha512 = (msg: number[] | string, enc?: "hex" | "utf8"): number[] => {
8126
8270
  }
8127
8271
  ```
8128
8272
 
8129
- See also: [SHA512](./primitives.md#class-sha512)
8273
+ See also: [SHA512](#class-sha512)
8130
8274
 
8131
8275
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8132
8276
 
@@ -8139,7 +8283,7 @@ sha512hmac = (key: number[] | string, msg: number[] | string, enc?: "hex"): numb
8139
8283
  }
8140
8284
  ```
8141
8285
 
8142
- See also: [SHA512HMAC](./primitives.md#class-sha512hmac)
8286
+ See also: [SHA512HMAC](#class-sha512hmac)
8143
8287
 
8144
8288
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8145
8289
 
@@ -8402,7 +8546,7 @@ sign = (msg: BigNumber, key: BigNumber, forceLowS: boolean = false, customK?: Bi
8402
8546
  }
8403
8547
  ```
8404
8548
 
8405
- See also: [BigNumber](./primitives.md#class-bignumber), [Curve](./primitives.md#class-curve), [DRBG](./primitives.md#class-drbg), [Signature](./primitives.md#class-signature), [toArray](./primitives.md#variable-toarray)
8549
+ See also: [BigNumber](#class-bignumber), [Curve](#class-curve), [DRBG](#class-drbg), [Signature](#class-signature), [toArray](#variable-toarray)
8406
8550
 
8407
8551
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8408
8552
 
@@ -8477,7 +8621,7 @@ toBase58Check = (bin: number[], prefix: number[] = [0]): string => {
8477
8621
  }
8478
8622
  ```
8479
8623
 
8480
- See also: [hash256](./primitives.md#variable-hash256), [toBase58](./primitives.md#variable-tobase58)
8624
+ See also: [hash256](#variable-hash256), [toBase58](#variable-tobase58)
8481
8625
 
8482
8626
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8483
8627
 
@@ -8494,7 +8638,7 @@ toHex = (msg: number[]): string => {
8494
8638
  }
8495
8639
  ```
8496
8640
 
8497
- See also: [zero2](./primitives.md#variable-zero2)
8641
+ See also: [zero2](#variable-zero2)
8498
8642
 
8499
8643
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8500
8644
 
@@ -8712,7 +8856,7 @@ verify = (msg: BigNumber, sig: Signature, key: Point): boolean => {
8712
8856
  }
8713
8857
  ```
8714
8858
 
8715
- See also: [BigNumber](./primitives.md#class-bignumber), [Curve](./primitives.md#class-curve), [JacobianPoint](./primitives.md#class-jacobianpoint), [Point](./primitives.md#class-point), [Signature](./primitives.md#class-signature)
8859
+ See also: [BigNumber](#class-bignumber), [Curve](#class-curve), [JacobianPoint](#class-jacobianpoint), [Point](#class-point), [Signature](#class-signature)
8716
8860
 
8717
8861
  Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
8718
8862