base58-monero's Introduction

Rust Monero Library

Library with support for de/serialization on block data structures and key/address generation and scanning related to Monero cryptocurrency.

Supports (or should support)

De/serialization of Monero blocks and transactions (consensus encoding)
Address and subaddress creation, de/serialization and validation
Private keys and one-time keys creation, de/serialization and validation
Transaction owned output detection and amount recovery with view keypair
Serde support on most structures with feature serde

Documentation

Currently can be found on docs.rs/monero. Patches to add usage examples and to expand on existing docs would be extremely appreciated.

Features

`serde`

The serde feature enables implementation of serde on serializable types across the library.

`experimental`

The experimental feature enable the method signature_hash in Transaction, the method computes the message to be signed by the CLSAG signature algorithm. This method is featured as experimental at the moment because it lacks reviews and tests.

Contributing

Contributions are generally welcome. If you intend to make larger changes please discuss them in an issue before PRing them to avoid duplicate work and architectural mismatches.

Releases and Changelog

See CHANGELOG.md and RELEASING.md.

About

This started as a research project sponsored by TrueLevel SA, it is now developed and maintained by the Monero Rust Contributors and NOT by the Monero Core Team.

Licensing

The code in this project is licensed under the MIT License

base58-monero's People

Contributors

Stargazers

Watchers

base58-monero's Issues

Add MSRV in Cargo manifest

Use rust = "1.30" field in cargo manifest to state the MSRV.

Remove stream feature enabled by default

The stream feature should be opt-in and not opt-out as it brings all async context with it.

Crate isn't #![no_std], making it incompatible with Rust for embedded systems

As the title explains, this crate is simple enough that it can be converted to not rely on the entire std library so that embedded Rust projects can depend on it. Please see https://docs.rust-embedded.org/book/intro/no-std.html on the necessity of a no_std Rust environment for embedded systems. There are many embedded systems that we can create, such as a hardware wallet.

I'm happy to attempt a PR, which will simply remove/replace the unnecessary std::io reference and use libcore/alloc where needed once the #![no_std] is added.

Thoughts?

Publish 1.1.0

1.1.0 exists in this git repo yet was never published. I recently built monero-serai in a no-std environment and had to use a git dependency accordingly. Would it be possible for 1.1.0 to be published so I don't need a git dependency?

Recommend Projects