#bip21 #parser #newtype #bitcoin

no-std bip21

Rust-idiomatic, compliant, flexible and performant BIP21 crate

8 releases (4 breaking)

0.5.0 Aug 1, 2024
0.4.0 Feb 8, 2024
0.3.1 May 26, 2023
0.3.0 Mar 22, 2023
0.1.1 Nov 22, 2021

#39 in #newtype

Download history 1144/week @ 2024-12-15 315/week @ 2024-12-22 681/week @ 2024-12-29 836/week @ 2025-01-05 1750/week @ 2025-01-12 1395/week @ 2025-01-19 1868/week @ 2025-01-26 1654/week @ 2025-02-02 1264/week @ 2025-02-09 997/week @ 2025-02-16 734/week @ 2025-02-23 972/week @ 2025-03-02 1065/week @ 2025-03-09 2513/week @ 2025-03-16 2806/week @ 2025-03-23 1525/week @ 2025-03-30

7,958 downloads per month
Used in 11 crates (2 directly)

MITNFA license

39KB
620 lines

Rust implementation of BIP21

Rust-idiomatic, compliant, flexible and performant BIP21 crate.

About

Important: while lot of work went into polishing the crate it's still considered early-development!

  • Rust-idiomatic: uses strong types, standard traits and other things
  • Compliant: implements all requirements of BIP21, including protections to not forget about req-. (But see features.)
  • Flexible: enables parsing/serializing additional arguments not defined by BIP21.
  • Performant: uses zero-copy deserialization and lazy evaluation wherever possible.

Serialization and deserialization is inspired by serde with these important differences:

  • Deserialization signals if the field is known so that req- fields can be rejected.
  • Much simpler API - we don't need all the features.
  • Use of Param<'a> to enable lazy evaluation.

The crate is no_std but does require alloc.

Features

  • std enables integration with std - mainly std::error::Error.
  • non-compliant-bytes - enables use of non-compliant API that can parse non-UTF-8 URI values.

MSRV

1.56.1

License

MITNFA

Dependencies

~7.5MB
~91K SLoC