@summa-tx/rmn-btc

Bitcoin-oriented dev toolboxes for native and browser apps 🎈 🎈

Showing:

Popularity

Downloads/wk

1

GitHub Stars

42

Maintenance

Last Commit

7d ago

Contributors

11

Package

Dependencies

0

License

LGPL-3.0-or-later

Type Definitions

Built-In

Tree-Shakeable

Yes?

Categories

Readme

coins & bitcoins

Coverage Status

coins is a set of transaction construction libraries for UTXO-based chains. It aims to provide high-quality tooling for constructing transactions, and to enable use in the browser via wasm-bindgen.

Building & running tests

  • install rustup
  • Run all the tests $ ./build.sh
  • build the docs: $ cargo rustdoc

Project Goals

  • Easy to use Bitcoin tooling
  • Generic traits supporting multiple networks
  • WASM compatibility in all packages
  • Support essential BIPs

Project Architecture

The project is built around the coins-core crate which defines high-level traits and interfaces. Chain-specific libraries use these traits to provide a consistent developer experience across chains.

We have provided a bitcoins crate with a Bitcoin-targeted implementation. See its documentation for usage instruction and details.

Other than that:

  • coins-bip32 provides tooling for BIP32 HDKey derivation
  • bitcoins-provider gives a simple consistent interface to chain data with swappable backends.

Project Status

While this is feature-complete, and there are some tests, much of it is alpha software. There will be rough edges, and the interfaces are subject to change.

Specificallly:

  • core, bip32, and bitcoins are relatively stable.
  • provider is working, but does not yet have a stable API
  • ledger, and ledger-btc are essentially alpha

License Notes

Some work in the ledger crate is reproduced under the APACHE 2.0 license. See the readme for documentation

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100