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