Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/monero-rs/base58-monero
Monero base58 specific encoding format Rust implementation.
https://github.com/monero-rs/base58-monero
base58 base58-check library monero rust
Last synced: 3 months ago
JSON representation
Monero base58 specific encoding format Rust implementation.
- Host: GitHub
- URL: https://github.com/monero-rs/base58-monero
- Owner: monero-rs
- License: mit
- Created: 2019-03-06T00:19:56.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T01:36:01.000Z (about 1 year ago)
- Last Synced: 2024-10-01T06:01:19.089Z (3 months ago)
- Topics: base58, base58-check, library, monero, rust
- Language: Rust
- Homepage: https://docs.rs/base58-monero
- Size: 107 KB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/monero-rs/base58-monero/actions/workflows/build.yml)
[](https://app.codecov.io/gh/monero-rs/base58-monero)
[](https://github.com/rust-secure-code/safety-dance/)
[](https://crates.io/crates/base58-monero)
[](https://docs.rs/base58-monero)
[](https://opensource.org/licenses/MIT)
[](https://blog.rust-lang.org/2022/08/11/Rust-1.63.0.html)
# Rust Monero Base58
Library with support for encoding/decoding Monero base58 strings, with and without checksum
verification.
## Bitcoin base58 vs Monero base58
Monero base58 is not like Bitcoin base58, bytes are converted in 8-byte blocks. The last block can
have less than 8 bytes, but at least 1 byte. Eight bytes converts to 11 or less Base58 characters;
if a particular block converts to `<11` characters, the conversion pads it with "`1`"s (`1` is `0`
in Base58). Likewise, the final block can convert to 11 or less Base58 digits.
Due to the conditional padding, the 69-byte string, like Monero addresses, will always convert to 95
Base58 characters `(8 * 11 + 7)`; where 7 is length of the last block of 5 bytes.
The alphabet is composed of 58 characters visually not similar to avoid confusion, e.g. both `1` and
`l` are not part of the alphabet together, only `1` is present. The full alphabet is composed of:
`123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz`
## Features
By default only the `std` feature is enabled. If you want to opt-out remove default features
features in your project:
```toml
[dependencies.base58-monero]
version = "2"
default-features = false
```
### `std`
Disable this feature if you want to build in a `no_std` environment. This feature is required when `steam`
is enabled.
### `check`
Enables `encode_check` and `decode_check` functions. By default `check` feature is disabled.
### `stream`
**This feature is not extensively tested and have performance issues, use it at your own risk!**
Enables `encode_stream` and `decode_stream` functions. By default `stream` feature is not enable. This
feature enables async stream for encoding/decoding bytes. This should be used when encoding larger
amount of data or in asyncronous environment. `stream` can be used with `check` to enable
`encode_stream_check` and `decode_stream_check`. To use `stream` feature you can add in your Cargo.toml:
```toml
[dependencies.base58-monero]
version = "2"
features = ["stream"]
```
This feature enables the `std` feature.
## Tests
Doctests needs `stream` feature to run, run tests with all features:
```
cargo test --all-features
```
## Benchmarks
Results obtained on an Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz with a standard Monero address as data source.
Performances are shown in nanosecond per iteration of compute, the smaller the better:
| Operation | Regular | `_check` |
| --------- | ---------------- | ------------------ |
| `encode` | 652 ns (+/- 107) | 1,272 ns (+/- 760) |
| `decode` | 612 ns (+/- 82) | 1,187 ns (+/- 541) |
Check versions compute or verify the checksum while encoding or decoding the data.
Benchmarks can be found under `/benches` and run with
```
cargo +nightly bench --all-features
```
## Releases and Changelog
See [CHANGELOG.md](CHANGELOG.md) and [RELEASING.md](RELEASING.md).
## About
This started as a research project sponsored by TrueLevel SA. It is now maintained by community members.
## Licensing
The code in this project is licensed under the [MIT License](LICENSE)