ruint

What's Changed

• fix(algorithms): close soundness and safety-contract gaps by @prestwich in #612
• docs: fix incorrect comments in add/mul/gcd algorithms by @prestwich in #611
• fix: checked_log/log2/log10 panic on tiny bit-widths by @prestwich in #610
• ci: run core test suite on wasm32-wasip1 by @prestwich in #609
• fix: str radix errors now by @prestwich in #608
• fix: try_from_*_slice returns None instead of panicking for BITS % 64 in 57..=63 by @prestwich in #607
• fix: reject non-finite f64 and saturate Uint→f64 at 2^1024 by @prestwich in #606
• z by @prestwich in #605
• chore: infer rustfmt edition by @DaniPopes in #619
• feat: make more Uint methods const by @DaniPopes in #614
• docs: add agent guidelines by @DaniPopes in #618
• perf: open-code Uint PartialEq and is_zero on riscv to avoid memcmp libcall by @Qumeric in #604
• fix: overflowing_shl/overflowing_shr overflow-flag false negatives by @prestwich in #603
• chore: release 1.20.0 by @prestwich in #620

New Contributors

• @Qumeric made their first contribution in #604

Full Changelog: v1.19.0...v1.20.0

Changed

• Open-code PartialEq and is_zero on riscv to avoid memcmp libcalls (#604)
• Run the core test suite on wasm32-wasip1 in CI to catch 32-bit pointer-width bugs (#609)
• Make reverse_bits, most_significant_bits, inv_ring, checked_pow, strict_pow, overflowing_pow, pow, saturating_pow, wrapping_pow, from_limbs_slice, checked_from_limbs_slice, wrapping_from_limbs_slice, overflowing_from_limbs_slice, saturating_from_limbs_slice, from_uint, and checked_from_uint const (#614)

Fixed

• Fix overflowing_shl/overflowing_shr overflow-flag false negatives, which also corrected the dependent checked_*/strict_*/saturating_* shifts and byte() (#603)
• Fix from_str_radix rejecting the lowercase digits g–z in radix 64 (#605)
• Reject non-finite f64 in TryFrom<f64> and saturate Uint→f64 conversions at 2^1024 for large BITS (#606)
• try_from_be_slice/try_from_le_slice now return None instead of panicking for BITS % 64 in 57..=63 (#607)
• from_str_radix and to_base_be no longer hang or silently accept radix/base 0 or 1 (#608)
• checked_log, checked_log2, and checked_log10 no longer panic for small bit-widths where the base constant does not fit the type (#610)
• Fix incorrect doc comments and formulas in the add, mul, and gcd algorithms (#611)
• Mark addmul_nx1/submul_nx1 unsafe and close soundness / safety-contract gaps in the unstable algorithms module (#612)

What's Changed

• fix: resolve easy TODOs and doc issues by @DaniPopes in #571
• chore: remove clippy msrv by @DaniPopes in #573
• perf: optimize shift implementations by @DaniPopes in #574
• perf: optimize bit count helpers by @DaniPopes in #578
• Fix to_be_bytes on big-endian platforms by @kayabaNerve in #576
• chore: fix to_be_bytes by @DaniPopes in #580
• perf: compare using subtraction by @DaniPopes in #579
• feat: add ark-ff-06 by @Robert-MacWha in #584
• docs: update repository links by @DaniPopes in #586
• ci: make Accept gate fail when any required job fails by @prestwich in #585
• refactor: replace double word trait by @DaniPopes in #589
• refactor: add const range macro by @DaniPopes in #592
• feat: make mul fns const by @DaniPopes in #590
• feat: make from_str_radix const by @DaniPopes in #591
• chore(deps): bump actions/checkout from 5 to 7 by @dependabot[bot] in #596
• chore: ignore cargo-deny advisories by @DaniPopes in #598
• chore: clippy by @DaniPopes in #600
• fix(ci): harden issue tracker by @DaniPopes in #601
• chore(meta): update CODEOWNERS by @DaniPopes in #599
• feat: add strict_* operations by @0xMars42 in #595
• chore: group weekly GitHub Actions updates by @DaniPopes in #597
• chore: release 1.19.0 by @prestwich in #602

New Contributors

• @kayabaNerve made their first contribution in #576
• @Robert-MacWha made their first contribution in #584
• @0xMars42 made their first contribution in #595

Full Changelog: v1.18.0...v1.19.0

Added

• strict_* arithmetic operations (#595)
• ark-ff-06 feature flag for conversion to [email protected] types (#584)

Changed

• Made from_str_radix const (#591)
• Made multiplication functions const (#590)
• Optimize Ord::cmp by comparing via subtraction (#579)
• Optimize bit count helpers (leading/trailing zeros, count ones) (#578)
• Optimize shift implementations (#574)

Fixed

• Fix to_be_bytes on big-endian platforms (#576)

What's Changed

• Use rkyv::primitive::ArchivedU64 by @DenisGorbachev in #556
• chore(deps): bump codspeed by @DaniPopes in #558
• perf: specialize cmp, const_eq, const_is_zero for small sizes by @DaniPopes in #561
• perf: optimize from_str_radix by @DaniPopes in #557
• perf: use bit shifts for power-of-two formatting by @DaniPopes in #565
• perf: extract last iteration on mul loop by @DaniPopes in #566
• docs: link to ruint-uniffi for FFI support by @paolodamico in #567
• perf: nudge LLVM codegen good to_bytes_be by @pepyakin in #569
• chore: bump MSRV to 1.90 by @DaniPopes in #570
• chore: release 1.18.0 by @DaniPopes in #572

New Contributors

• @DenisGorbachev made their first contribution in #556
• @paolodamico made their first contribution in #567
• @pepyakin made their first contribution in #569

Full Changelog: v1.17.2...v1.18.0

Changed

• Optimize from_str_radix (#557)
• Specialize Ord::cmp, const_eq, const_is_zero for small sizes (#561)
• Use bit shifts for power-of-two formatting (binary, octal, hex) instead of division (#565)
• Optimize to_be_bytes for full-limb sizes via per-limb swap_bytes (#569)
• Extract last iteration on mul loop to reduce register pressure (#566)

Fixed

• Use rkyv::primitive::ArchivedU64 (#556)

What's Changed

• fix(docsrs): remove doc_auto_cfg by @DaniPopes in #554
• chore: release 1.17.2 by @DaniPopes in #555

Full Changelog: v1.17.1...v1.17.2

Fixed

• fix(docsrs): remove doc_auto_cfg (#554)

What's Changed

• Fix codspeed benches & add most_significant_bits bench by @Evalir in #544
• Fix codspeed benches & add most_significant_bits bench by @prestwich in #543
• chore: update unsafe function and improve documentation and safety notes by @Evalir in #553
• chore: update unsafe function and improve documentation and safety notes by @prestwich in #552

Full Changelog: v1.17.0...v1.17.1

Changed

• Added unsafe to many unstable API functions in algorithms module, and documented their conditions of use (COU). (#552)

What's Changed

• chore: add parse benches by @DaniPopes in #518
• feat: bump MSRV to 1.85 by @DaniPopes in #503
• chore: use const block in add_mod by @DaniPopes in #521
• chore(deps): bump actions/checkout from 4 to 5 by @dependabot[bot] in #517
• feat: add support for ark-ff v0.5.0 by @fabian1409 in #526
• chore(deps): depend on serde_core instead of serde by @DaniPopes in #527
• bench: bench from f64 and f32 by @Evalir in #531
• feat: make *next* functions const by @DaniPopes in #533
• feat: add bincode 2 support by @lightsing in #516
• Enhanced f64 -> Uint conversion by @Pzixel in #524
• chore(deps): bump CodSpeedHQ/action from 3 to 4 by @dependabot[bot] in #528
• Add Uint -> f64/f32 benches by @Pzixel in #536
• Add Uint -> f64 conversion by @Pzixel in #535
• perf: use select_unpredictable by @DaniPopes in #537
• feat: switch to edition 2024 by @DaniPopes in #538
• chore: release 1.17.0 by @DaniPopes in #539

New Contributors

• @fabian1409 made their first contribution in #526
• @Pzixel made their first contribution in #524

Full Changelog: v1.16.0...v1.17.0

Added

• Support for bincode 2 (#516)
• Introduce ark-ff-05 feature flag for conversion to [email protected] types (#526)

Changed

• MSRV bumped to 1.85 (#503)
• Made *next_power_of_two and *next_multiple_of const (#533)
• Reimplemented TryFrom<f64> for Uint to speed it up, fixing edge cases and removing std requirements (#524)
• Reimplemented From<Uint> for f64 and f32 to speed it up, fixing edge cases and removing std requirements ([#535])

What's Changed

• Add Codspeed workflow by @recmo in #468
• ci: update codspeed by @DaniPopes in #461
• benches: reduce codspeed flakiness by @DaniPopes in #470
• benches: batch codspeed routines manually by @DaniPopes in #471
• perf: clean up div, cmp by @DaniPopes in #464
• feat: add shift benchmarks by @Rjected in #473
• perf: make add_mod faster using overflow check by @DaniPopes in #469
• perf: improve conversion to primitive integers by @DaniPopes in #477
• fix: check limb overflow in shift ops by @DaniPopes in #476
• benches: fix shift bench names by @DaniPopes in #479
• fix: gt_u64_max by @DaniPopes in #480
• perf: improve, specialize leading_zeros by @DaniPopes in #485
• feat: support for bigdecimal crate by @klkvr in #486
• perf: roll mul_add_n by @DaniPopes in #492
• feat: implement PartialEq, PartialOrd for primitive integers by @DaniPopes in #491
• chore: add fmt benches by @DaniPopes in #487
• docs: update changelog for 491 by @DaniPopes in #493
• feat: add rkyv support by @lightsing in #483
• fix: rkyv tests with new inference by @Evalir in #495
• perf: improve u128 conversions by @DaniPopes in #496
• feat: remove "alloc" feature requirement from base_convert/fmt by @DaniPopes in #488
• perf: add a stack-allocated to_base_be by @DaniPopes in #490
• perf: special case small integers in fmt by @DaniPopes in #500
• perf: almost remove alloc from serde by @DaniPopes in #501
• perf: improve to_base_le by @DaniPopes in #497
• perf: implement write_char by @DaniPopes in #505
• chore: remove opt comment by @DaniPopes in #508
• perf: clean up algorithms::ops by @DaniPopes in #509
• docs: better document unstability of mod algorithms by @DaniPopes in #511
• perf: implement likely/unlikely using userland cold_path by @DaniPopes in #510
• perf: elide panics in algorithms by @DaniPopes in #512
• perf: inline div in Uint by @DaniPopes in #513
• chore: release 1.16.0 by @DaniPopes in #506

New Contributors

• @klkvr made their first contribution in #486
• @lightsing made their first contribution in #483

Full Changelog: v1.15.0...v1.16.0

Added

• Support rkyv (#483)
• Added bigdecimal support (#486)
• PartialEq and PartialOrd implementations for primitive integers; minor breaking change for type inference (#491)

Changed

• to_base_be and core::fmt trait implementations are available without the "alloc" feature (#488)
• Greatly improved performance across the board, mainly in: conversions, fmt, div/rem, mul, add_mod, leading_zeros

Fixed

• Check limb overflow in shift ops (#476)

What's Changed

• dep: update pyo3 to 0.25 by @Evalir in #460
• chore: add .DS_Store to gitignore by @Rjected in #457
• ci: unpin clippy by @DaniPopes in #463
• chore: improve const-for usability by @DaniPopes in #465
• feat: constify bitwise and shift functions by @DaniPopes in #441
• bench: add cmp.rs benchmarks by @DaniPopes in #462
• chore: release 1.15.0 by @DaniPopes in #467

Full Changelog: v1.14.0...v1.15.0

Added

• Add const fn const_is_zero, const_eq, bit* (#441)

Changed

• Updated Pyo3. This is a non-semver breaking change to address a vulnerability reported on Pyo3. (#460)
• Make rotate*, *sh[lr] functions const (#441)

What's Changed

• chore: clippy by @DaniPopes in #437
• fix: checked_byte bounds check and make it const by @DaniPopes in #438
• docs: update try_from_{b,l}e_slice docs by @DaniPopes in #439
• feat: Constify leading_zeros, leading_ones, count_ones, count_zeros, bit_len, byte_len, is_power_of_two by @kpp in #442
• ci: cache more jobs by @DaniPopes in #446
• chore(deps): update hex-literal requirement from 0.4 to 1.0 by @dependabot in #447
• fix(ci): ignore paste deny lint by @Evalir in #451
• feat: add const ONE by @DaniPopes in #448
• feat: add random, random_with, randomize, randomize_with methods by @DaniPopes in #444
• feat: add support for rand 0.9 by @DaniPopes in #445
• fix: ub in rand by @DaniPopes in #453
• chore: release 1.14.0 by @DaniPopes in #454

New Contributors

• @kpp made their first contribution in #442

Full Changelog: v1.13.1...v1.14.0

Added

• Add const not function (#442)
• Make leading_zeros, leading_ones, count_ones, count_zeros, bit_len, byte_len, is_power_of_two functions const (#442)
• random, random_with, randomize, randomize_with methods (#444)
• rand 0.9 support (#445)
• Add const ONE (#448)

Changed

• Update try_from_{b,l}e_slice documentation (#439)

Fixed

• Fix checked_byte bounds check and make it const (#438)

What's Changed

• fix: no_std build by removing unused dependency by @DaniPopes in #433
• chore: release 0.13.1 by @DaniPopes in #434

Full Changelog: v1.13.0...v1.13.1

Fixed

• Remove unused hex dependencies which broke no_std (#433)

Added

• Support for borsh @ 1.5 (#416)
• copy_le_to_slice family to allow easier writing to pre-allocated buffers (#424)
• add Uint::checked_byte(idx: usize) -> Option<u8> (#429)

Changed

• Unpin proptest (#426)

Fixed

• Update documentation related to Uint::byte and knuth divison (#429)
• fix: swap bytes for as_le_bytes in big endian world (#431)

Added

• Added Uint::square_redc. (#402)
• Support for diesel @ 2.2 (#404)
• Support for sqlx @ 0.8 (#400)
• Support for fastrlp @ 0.4 (#401)
• Added support for subtle and der (#399)

Removed

• Support for sqlx @ 0.7. This is a breaking change, outside of regular semver policy, as 0.7 contains a security vulnerability (#400)

Fixed

• Uint::mul_redc is now alloc free (#402)

Changed

• Use borrowing/carrying ops in add/sub, remove bound checks in shifts (#366)
• Make mul_mod non-allocating (#373)

Fixed

• Add alloc requirement to num-traits feature #363

Fixed

• docs.rs build (#356)
• uint! in item position (#360)

Added

• Wrap the uint! macro to allow usage without needing uint import (#350)

Fixed

• Overflow check in overflowing_shr implementation (#347)

Fixed

• Typo in Shr implementation (#343)

Added

• Enable SSZ (#344)

Added

• bytemuck feature (#292)
• Uint::is_zero() -> bool (#296)
• num-traits features (#298)
• U768 alias (#310)
• Improved add and sub performance (#316)
• Made add and sub functions const (#324)
• Made {from,to}_{b,l}e_bytes const (#329)

Fixed

• Restricted RLP decoding to match the RLP spec and disallow leading zeros (#335)
• leading_ones failed for non-aligned sizes.

Fixed

• Fixed some support features (#289)

Added

• Support for no_std environments (#274)
• alloc feature (#277)

Added

• Introduce ark-ff-04 feature flag for conversion to [email protected] types
• Support for alloy-rlp
• MSRV (Minimum Supported Rust Version) is now set at 1.65.0, from previously undefined
• Implement TryFrom<bool> for Uint
• New method: byte

Changed

• Make serde::Deserialize impl more permissive
• Use Ethereum Quantity encoding for serde serialization when human-readable
• Fix error in from_base_be that allowed instantiation of overflowing Uint
• Updated fastrlp to 0.3, pyo3 to 0.19, and sqlx-core to 0.7
• Improved fastrlp perfomance
• Improved proptest performance
• Made support module and its modules public
• Made more algorithm functions public
• Constified as_le_slice and as_le_bytes

Removed

• Automatic detection of nightly features. Enable them instead with the nightly cargo feature
• Dependency on derive_more

Fixed

• from_base_le implementation by reversing the input iterator

Added

• Support bn-rs, serde and uint! for Bits

Fixed

• Serde human readable now encodes the empty bitstring as 0x0 and rejects zero prefixes.

Added

• Support rlp for Bits

Fixed

• Edge case in which an overflow occurs when parsing a Uint with uint! (#199).

Added

• TryFrom<Uint> for usize
• Bit type aliases (B128, B160, B256, B512, ...)
• From and Into trait implementations for primitive-types bit types
• Support for bn-rs
• Derive Default for Bits

Changed

• (Breaking) Changed the arguments of pow and log to Uint.
• More efficient wrapping_pow implementation.

Changed

• Performance improvements in wrapping_mul and from_bytes_be.

Added

• Add parity-scale-codec support.
• Added unstable algorithms::div module and improved div algorithm.

Changed

• Made primitive-types version flexible.

Added

• Add Pyo3 support.
• from now supports Uint arguments.
• saturating_from, wrapping_from, to, wrapping_to, saturating_to.
• wrapping_from_limbs_slice, overflowing_from_limbs_slice, saturating_from_limbs_slice.
• Add zeroize and valuable support.

Changed

• ToUintError and FromUintError now contain wrapped value and other context.
• from_uint and checked_from_uint are now deprecated.

Added

• Added inv_mod, mul_redc, gcd, gcd_extended, lcm.
• Added sqlx support.

Changed

• Renamed ring_inverse to inv_ring.

Added

• Added reduce_mod, add_mod, mul_mod, pow_mod.
• Added num-bigint and ark-ff support.
• Made algorithms public, but with unstable API for now.

Changed

• Marked Uint::as_limbs_mut as unsafe.
• Unified mul implementations and move to algorithms.

Fixed

• uint! macro incorrectly accepting hex digits in decimal.

Added

• Added saturating_shl.
• Added approx_log, approx_log2, approx_log10 for f64 log approximations.
• Added approx_pow2 to construct from f64 log2 approximation.
• Added root computing integer roots.

Changed

• Made logarithms usize to match BITS in pow, log functions.
• Applied track_caller to div/rem ops to track div-by-zero easier.

Added

• Added comparison.
• Added add, sub, neg and sum functions.
• Added mul functions.
• Added division and remainder functions.
• Added pow and log functions.
• Added next_power_of_two and next_multiple_of functions.
• Added checked_from_limb_slice and from_uint.

Changed

• from_limb_slice now handles arbitrary length slices.

Added

• All the binary operations (not, and, or, xor, shifts, rotate, etc)
• Bits, a newtype wrapped Uint restricted to non-numeric operations.
• Postgres FromSql support and JSON column support.
• from_base_le and from_base_be base conversion.
• from_str_radix string base conversion up to base64.
• FromStr trait with decimal, hex, octal and binary support.

Changed

• reverse_bits is now by value instead of &mut self.

Added

• Extensive Postgres ToSql support supporting many column types.
• TryFrom<Uint> for primitive integer types.
• Added From conversions to f32 and f64.
• Implement all rust formatting: Debug, Display, decimal, hex, etc.
• >>= operator.
• to_base_le and to_base_le base conversion spigots
• reverse_bits, most_sigificant_bits bit methods.
• Optimized as_le_{slice,bytes)_* accessors.

Changed

• Rewrote to_{be,le}_bytes_* to use optimized methods. This has trickle-down effects for a lot of conversions and formatting.

Added

• Changelog
• CI test on stable Rust.
• Common bit-size aliases and nightly-only Uint<BITS> alias.
• Added to_{be/le}_bytes_vec and made try_from_le_byte_iter public.
• Added rlp and fastrlp support.
• Added into_limbs, leading_zeros, bit_len, byte_len, checked_log2.
• Added primitive-types support.

Changed

• Changed to Uint<BITS, LIMBS> to get stable compatibility!
• Added generic BYTES parameter to to_{be/le}_bytes.
• Renamed try_from_{be/le}_slice.

Added

• Const-generic Uint structure.
• Basic overflowing_add implementation.
• Algorithms for division and gcd (currently unused).
• uint! and const_for! macros.
• Documentation with examples.
• Support for rand, arbitrary, quickcheck, proptest, serde
• Github actions for linting, testing, code coverage, cargo-audit.
• Pushed to crates.io.

<!-- links to version -->