-
Notifications
You must be signed in to change notification settings - Fork 18
/
uint.go
586 lines (509 loc) · 13.3 KB
/
uint.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package num
import (
"database/sql/driver"
"errors"
"fmt"
"math/big"
"sort"
"github.com/holiman/uint256"
)
var (
// max uint256 value.
big1 = big.NewInt(1)
maxU256 = new(big.Int).Sub(new(big.Int).Lsh(big1, 256), big1)
// initialise max variable.
maxUint = setMaxUint()
zero = NewUint(0)
one = NewUint(1)
)
// Uint A wrapper for a big unsigned int.
type Uint struct {
u uint256.Int
}
// NewUint creates a new Uint with the value of the
// uint64 passed as a parameter.
func NewUint(val uint64) *Uint {
return &Uint{*uint256.NewInt(val)}
}
func UintOne() *Uint {
return one.Clone()
}
func UintZero() *Uint {
return zero.Clone()
}
// only called once, to initialise maxUint.
func setMaxUint() *Uint {
b, _ := UintFromBig(maxU256)
return b
}
// MaxUint returns max value for uint256.
func MaxUint() *Uint {
return maxUint.Clone()
}
// Min returns the smallest of the 2 numbers.
func Min(a, b *Uint) *Uint {
if a.LT(b) {
return a.Clone()
}
return b.Clone()
}
// Max returns the largest of the 2 numbers.
func Max(a, b *Uint) *Uint {
if a.GT(b) {
return a.Clone()
}
return b.Clone()
}
// UintFromHex instantiate a uint from and hex string.
func UintFromHex(hex string) (*Uint, error) {
u, err := uint256.FromHex(hex)
if err != nil {
return nil, err
}
return &Uint{*u}, nil
}
// UintFromBig construct a new Uint with a big.Int
// returns true if overflow happened.
func UintFromBig(b *big.Int) (*Uint, bool) {
u, ok := uint256.FromBig(b)
// ok means an overflow happened
if ok {
return NewUint(0), true
}
return &Uint{*u}, false
}
// UintFromBig construct a new Uint with a big.Int
// panics if overflow happened.
func MustUintFromBig(b *big.Int) *Uint {
u, ok := uint256.FromBig(b)
// ok means an overflow happened
if ok {
panic("uint underflow")
}
return &Uint{*u}
}
// UintFromBytes allows for the conversion from Uint.Bytes() back to a Uint.
func UintFromBytes(b []byte) *Uint {
u := &Uint{
u: uint256.Int{},
}
u.u.SetBytes(b)
return u
}
// UintFromDecimal returns a decimal version of the Uint, setting the bool to true if overflow occurred.
func UintFromDecimal(d Decimal) (*Uint, bool) {
u, ok := d.Uint()
return &Uint{*u}, ok
}
func UintFromDecimalWithFraction(d Decimal) (*Uint, Decimal) {
u, ok := UintFromDecimal(d)
if ok {
return u, Decimal{}
}
return u, DecimalPart(d)
}
// UintFromUint64 allows for the conversion from uint64.
func UintFromUint64(ui uint64) *Uint {
u := &Uint{
u: uint256.Int{},
}
u.u.SetUint64(ui)
return u
}
// UnmarshalJSON implements the json.Unmarshaler interface.
func (u *Uint) UnmarshalJSON(numericBytes []byte) error {
if string(numericBytes) == "null" {
return nil
}
str, err := unquoteIfQuoted(numericBytes)
if err != nil {
return fmt.Errorf("error decoding string '%s': %s", numericBytes, err)
}
numeric, overflown := UintFromString(str, 10)
if overflown {
return errors.New("overflowing value")
}
*u = *numeric
return nil
}
// MarshalJSON implements the json.Marshaler interface.
func (u Uint) MarshalJSON() ([]byte, error) {
return []byte(u.String()), nil
}
// UnmarshalBinary implements the encoding.BinaryUnmarshaler interface. As a string representation
// is already used when encoding to text, this method stores that string as []byte.
func (u *Uint) UnmarshalBinary(data []byte) error {
u.u.SetBytes(data)
return nil
}
// MarshalBinary implements the encoding.BinaryMarshaler interface.
func (u Uint) MarshalBinary() (data []byte, err error) {
return u.u.Bytes(), nil
}
// Scan implements the sql.Scanner interface for database deserialization.
func (u *Uint) Scan(value interface{}) error {
return u.u.Scan(value)
}
// Value implements the driver.Valuer interface for database serialization.
func (u Uint) Value() (driver.Value, error) {
return u.String(), nil
}
// ToDecimal returns the value of the Uint as a Decimal.
func (u *Uint) ToDecimal() Decimal {
return DecimalFromUint(u)
}
// UintFromString created a new Uint from a string
// interpreted using the give base.
// A big.Int is used to read the string, so
// all error related to big.Int parsing applied here.
// will return true if an error/overflow happened.
func UintFromString(str string, base int) (*Uint, bool) {
b, ok := big.NewInt(0).SetString(str, base)
if !ok {
return NewUint(0), true
}
return UintFromBig(b)
}
// MustUintFromString creates a new Uint from a string
// interpreted using the given base.
// A big.Int is used to read the string, so
// all errors related to big.Int parsing are applied here.
// The core will panic if an error/overflow happens.
func MustUintFromString(str string, base int) *Uint {
b, ok := big.NewInt(0).SetString(str, base)
if !ok {
panic("uint underflow")
}
return MustUintFromBig(b)
}
// Sum just removes the need to write num.NewUint(0).Sum(x, y, z)
// so you can write num.Sum(x, y, z) instead, equivalent to x + y + z.
func Sum(vals ...*Uint) *Uint {
return NewUint(0).AddSum(vals...)
}
func (u *Uint) Set(oth *Uint) *Uint {
u.u.Set(&oth.u)
return u
}
func (u *Uint) SetUint64(val uint64) *Uint {
u.u.SetUint64(val)
return u
}
func (u Uint) Uint64() uint64 {
return u.u.Uint64()
}
func (u Uint) BigInt() *big.Int {
return u.u.ToBig()
}
func (u Uint) Float64() float64 {
d := DecimalFromUint(&u)
retVal, _ := d.Float64()
return retVal
}
// Add will add x and y then store the result
// into u
// this is equivalent to:
// `u = x + y`
// u is returned for convenience, no
// new variable is created.
func (u *Uint) Add(x, y *Uint) *Uint {
u.u.Add(&x.u, &y.u)
return u
}
// AddUint64 will add x and y then store the result
// into u
// this is equivalent to:
// `u = x + y`
// u is returned for convenience, no
// new variable is created.
func (u *Uint) AddUint64(x *Uint, y uint64) *Uint {
u.u.AddUint64(&x.u, y)
return u
}
// AddSum adds multiple values at the same time to a given uint
// so x.AddSum(y, z) is equivalent to x + y + z.
func (u *Uint) AddSum(vals ...*Uint) *Uint {
for _, x := range vals {
u.u.Add(&u.u, &x.u)
}
return u
}
// AddOverflow will subtract y to x then store the result
// into u
// this is equivalent to:
// `u = x - y`
// u is returned for convenience, no
// new variable is created.
// False is returned if an overflow occurred.
func (u *Uint) AddOverflow(x, y *Uint) (*Uint, bool) {
_, ok := u.u.AddOverflow(&x.u, &y.u)
return u, ok
}
// Sub will subtract y from x then store the result
// into u
// this is equivalent to:
// `u = x - y`
// u is returned for convenience, no
// new variable is created.
func (u *Uint) Sub(x, y *Uint) *Uint {
u.u.Sub(&x.u, &y.u)
return u
}
// SubOverflow will subtract y to x then store the result
// into u
// this is equivalent to:
// `u = x - y`
// u is returned for convenience, no
// new variable is created.
// False is returned if an overflow occurred.
func (u *Uint) SubOverflow(x, y *Uint) (*Uint, bool) {
_, ok := u.u.SubOverflow(&x.u, &y.u)
return u, ok
}
// Delta will subtract y from x and store the result
// unless x-y overflowed, in which case the neg field will be set
// and the result of y - x is set instead.
func (u *Uint) Delta(x, y *Uint) (*Uint, bool) {
// y is the bigger value - swap the two
if y.GT(x) {
_ = u.Sub(y, x)
return u, true
}
_ = u.Sub(x, y)
return u, false
}
// DeltaI will subtract y from x and store the result.
func (u *Uint) DeltaI(x, y *Uint) *Int {
d, s := u.Delta(x, y)
return IntFromUint(d, !s)
}
// Mul will multiply x and y then store the result
// into u
// this is equivalent to:
// `u = x * y`
// u is returned for convenience, no
// new variable is created.
func (u *Uint) Mul(x, y *Uint) *Uint {
u.u.Mul(&x.u, &y.u)
return u
}
// Div will divide x by y then store the result
// into u
// this is equivalent to:
// `u = x / y`
// u is returned for convenience, no
// new variable is created.
func (u *Uint) Div(x, y *Uint) *Uint {
u.u.Div(&x.u, &y.u)
return u
}
// Mod sets u to the modulus x%y for y != 0 and returns u.
// If y == 0, u is set to 0.
func (u *Uint) Mod(x, y *Uint) *Uint {
u.u.Mod(&x.u, &y.u)
return u
}
func (u *Uint) Exp(x, y *Uint) *Uint {
u.u.Exp(&x.u, &y.u)
return u
}
func (u *Uint) Sqrt(x *Uint) *Uint {
u.u.Sqrt(&x.u)
return u
}
// LT with check if the value stored in u is
// lesser than oth
// this is equivalent to:
// `u < oth`.
func (u Uint) LT(oth *Uint) bool {
return u.u.Lt(&oth.u)
}
// LTUint64 with check if the value stored in u is
// lesser than oth
// this is equivalent to:
// `u < oth`.
func (u Uint) LTUint64(oth uint64) bool {
return u.u.LtUint64(oth)
}
// LTE with check if the value stored in u is
// lesser than or equal to oth
// this is equivalent to:
// `u <= oth`.
func (u Uint) LTE(oth *Uint) bool {
return u.u.Lt(&oth.u) || u.u.Eq(&oth.u)
}
// LTEUint64 with check if the value stored in u is
// lesser than or equal to oth
// this is equivalent to:
// `u <= oth`.
func (u Uint) LTEUint64(oth uint64) bool {
return u.u.LtUint64(oth) || u.EQUint64(oth)
}
// EQ with check if the value stored in u is
// equal to oth
// this is equivalent to:
// `u == oth`.
func (u Uint) EQ(oth *Uint) bool {
return u.u.Eq(&oth.u)
}
// EQUint64 with check if the value stored in u is
// equal to oth
// this is equivalent to:
// `u == oth`.
func (u Uint) EQUint64(oth uint64) bool {
return u.u.Eq(uint256.NewInt(oth))
}
// NEQ with check if the value stored in u is
// different than oth
// this is equivalent to:
// `u != oth`.
func (u Uint) NEQ(oth *Uint) bool {
return !u.u.Eq(&oth.u)
}
// NEQUint64 with check if the value stored in u is
// different than oth
// this is equivalent to:
// `u != oth`.
func (u Uint) NEQUint64(oth uint64) bool {
return !u.u.Eq(uint256.NewInt(oth))
}
// GT with check if the value stored in u is
// greater than oth
// this is equivalent to:
// `u > oth`.
func (u Uint) GT(oth *Uint) bool {
return u.u.Gt(&oth.u)
}
// GTUint64 with check if the value stored in u is
// greater than oth
// this is equivalent to:
// `u > oth`.
func (u Uint) GTUint64(oth uint64) bool {
return u.u.GtUint64(oth)
}
// GTE with check if the value stored in u is
// greater than or equal to oth
// this is equivalent to:
// `u >= oth`.
func (u Uint) GTE(oth *Uint) bool {
return u.u.Gt(&oth.u) || u.u.Eq(&oth.u)
}
// GTEUint64 with check if the value stored in u is
// greater than or equal to oth
// this is equivalent to:
// `u >= oth`.
func (u Uint) GTEUint64(oth uint64) bool {
return u.u.GtUint64(oth) || u.EQUint64(oth)
}
// IsZero return whether u == 0 or not.
func (u Uint) IsZero() bool {
return u.u.IsZero()
}
// IsNegative returns whether the value is < 0.
func (u Uint) IsNegative() bool {
return u.u.Sign() == -1
}
// Copy create a copy of the uint
// this if the equivalent to:
// u = x.
func (u *Uint) Copy(x *Uint) *Uint {
u.u = x.u
return u
}
// Clone create copy of this value
// this is the equivalent to:
// x := u.
func (u Uint) Clone() *Uint {
return &Uint{u.u}
}
// Hex returns the hexadecimal representation
// of the stored value.
func (u Uint) Hex() string {
return u.u.Hex()
}
// String returns the stored value as a string
// this is internally using big.Int.String().
func (u Uint) String() string {
return u.u.ToBig().String()
}
// Format implement fmt.Formatter.
func (u Uint) Format(s fmt.State, ch rune) {
u.u.Format(s, ch)
}
// Bytes return the internal representation
// of the Uint as [32]bytes, BigEndian encoded
// array.
func (u Uint) Bytes() [32]byte {
return u.u.Bytes32()
}
// UintToUint64 convert a uint to uint64
// return 0 if nil.
func UintToUint64(u *Uint) uint64 {
if u != nil {
return u.Uint64()
}
return 0
}
// UintToString convert a uint to uint64
// return "0" if nil.
func UintToString(u *Uint) string {
if u != nil {
return u.String()
}
return "0"
}
// Median calculates the median of the slice of uints.
// it is assumed that no nils are allowed, no zeros are allowed.
func Median(nums []*Uint) *Uint {
if nums == nil {
return nil
}
numsCopy := make([]*Uint, 0, len(nums))
for _, u := range nums {
if u != nil && !u.IsZero() {
numsCopy = append(numsCopy, u.Clone())
}
}
sort.Slice(numsCopy, func(i, j int) bool {
return numsCopy[i].LT(numsCopy[j])
})
if len(numsCopy) == 0 {
return nil
}
mid := len(numsCopy) / 2
if len(numsCopy)%2 == 1 {
return numsCopy[mid]
}
return UintZero().Div(Sum(numsCopy[mid], numsCopy[mid-1]), NewUint(2))
}
func unquoteIfQuoted(value interface{}) (string, error) {
var bytes []byte
switch v := value.(type) {
case string:
bytes = []byte(v)
case []byte:
bytes = v
default:
return "", fmt.Errorf("could not convert value '%+v' to byte array of type '%T'",
value, value)
}
// If the amount is quoted, strip the quotes
if len(bytes) > 2 && bytes[0] == '"' && bytes[len(bytes)-1] == '"' {
bytes = bytes[1 : len(bytes)-1]
}
return string(bytes), nil
}