#bitcoin #parsing #newtypes

no-std bip21

Rust-idiomatic, compliant, flexible and performant BIP21 crate

7 unstable releases

0.4.0 Feb 8, 2024
0.3.1 May 26, 2023
0.3.0 Mar 22, 2023
0.2.0 Oct 18, 2022
0.1.1 Nov 22, 2021

#271 in Magic Beans

Download history 385/week @ 2023-10-28 733/week @ 2023-11-04 681/week @ 2023-11-11 707/week @ 2023-11-18 809/week @ 2023-11-25 664/week @ 2023-12-02 1038/week @ 2023-12-09 900/week @ 2023-12-16 523/week @ 2023-12-23 895/week @ 2023-12-30 1104/week @ 2024-01-06 996/week @ 2024-01-13 1066/week @ 2024-01-20 683/week @ 2024-01-27 1093/week @ 2024-02-03 1372/week @ 2024-02-10

4,429 downloads per month
Used in 6 crates (3 directly)

MITNFA license

39KB
625 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.48.0

License

MITNFA

Dependencies

~7MB
~81K SLoC