[![MIT license](https://img.shields.io/github/license/Groestlcoin/groestlcoin_slices)](https://github.com/Groestlcoin/groestlcoin_slices/blob/master/LICENSE)
[![Crates](https://img.shields.io/crates/v/groestlcoin_slices.svg)](https://crates.io/crates/groestlcoin_slices)
[![Docs](https://img.shields.io/badge/docs.rs-groestlcoin_slices-green)](https://docs.rs/groestlcoin_slices)

# Groestlcoin slices

ZERO allocations parse library for Groestlcoin data structures such as [`bsl::Transaction`]s, [`bsl::Block`]s
and others available in the [`bsl`] module.

Data is accessed by providing [`Visitor`] structs for the data the user is interested in.

```rust
// Calculate the amount of outputs in mainnet block 702861 in satoshi
use groestlcoin_slices::{bsl, Visit, Visitor};
struct Sum(pub u64);
impl Visitor for Sum {
    fn visit_tx_out(&mut self, _vout: usize, tx_out: &bsl::TxOut) -> core::ops::ControlFlow<()>  {
        self.0 += tx_out.value();
        core::ops::ControlFlow::Continue(())
    }
}
let mut sum = Sum(0);
let block_bytes: &[u8] = bitcoin_test_data::blocks::mainnet_702861();
let block = bsl::Block::visit(block_bytes, &mut sum).unwrap();
assert_eq!(sum.0, 2_883_682_728_990)
```

Data structures are read-only and parsed data must be in memory, no streaming API.

## Tradeoffs

Check the CONS before using this library, use [rust-groestlcoin](https://github.com/Groestlcoin/rust-groestlcoin) if they are too restrictive for your case.

### Pros

* Deserialization is [amazingly fast](#bench), since no allocation is made during parsing.
* Serialization is instant, since a slice of the serialized data is kept in the structure.
* [`bsl`] types are suitable for db key and values, in fact there is a specific `redb` [feature](#redb)
* hashing a little faster because slice are ready without the need of re-serializing data.
* No mandatory dependency.
* No standard.
* Calculate txid and block hash via optional dep `groestlcoin_hashes` or `sha2`.
* Visitor pattern to visit just what you are interested in.

### Cons

* Full data must be in memory, there is no streaming (Read/Write) API.
* Data structure are read-only, cannot be modified.
* Visitor pattern requires user-built data structure for visiting.

## Features

### Hashing

Use feature `sha2` or `groestlcoin_hashes` to calculate hashes of blocks and transactions.
The former is faster, the latter is more likely to be in your tree if you work with rust-groestlcoin 
ecosystem's crates.

### redb

With the `redb` feature activated some type allows to be used as value and key in the 
[redb](https://github.com/cberner/redb) database. groestlcoin slices types are well suited to be used
as key and values in the database because conversion from/to slices is immediate.

```rust
#[cfg(feature = "redb")]
{
    use groestlcoin_slices::{bsl, redb, Parse, redb::ReadableTable};
    const UTXOS_TABLE: redb::TableDefinition<bsl::OutPoint, bsl::TxOut> = redb::TableDefinition::new("utxos");
    let path = tempfile::NamedTempFile::new().unwrap().into_temp_path();
    let db = redb::Database::create(path).unwrap();
    let write_txn = db.begin_write().unwrap();
    let tx_out_bytes = hex_lit::hex!("ffffffffffffffff0100");
    let out_point_bytes = [0u8; 36];
    let tx_out = bsl::TxOut::parse(&tx_out_bytes).unwrap().parsed_owned();
    let out_point = bsl::OutPoint::parse(&out_point_bytes).unwrap().parsed_owned();
    {
        let mut table = write_txn.open_table(UTXOS_TABLE).unwrap();
        table.insert(&out_point, &tx_out).unwrap();
    }
    write_txn.commit().unwrap();

    let read_txn = db.begin_read().unwrap();
    let table = read_txn.open_table(UTXOS_TABLE).unwrap();
    assert_eq!(table.get(&out_point).unwrap().unwrap().value(), tx_out);
}
```

### rust-groestlcoin

With the feature `groestlcoin` activated some types allows to be converted in the `rust-groestlcoin` 
counterpart: for example `bsl::TxOut` could be converted in `groestlcoin::TxOut`. 
You may think if you need `groestlcoin::TxOut` you can decode the bytes directly into it without
using this library, and it is mostly true, but sometimes it may be convenient to use both types, for
example using groestlcoin slices with datatabases, but you may need to access fields more conveniently 
than writing a visitor for it and thus convert to rust-groestlcoin types. 
Moreover, conversions may leverage type invariants and be faster than starting from a generic byte stream.

``` rust
#[cfg(feature = "groestlcoin")]
{
    use groestlcoin_slices::{bsl, groestlcoin, Parse};

    let tx_out_bytes = hex_lit::hex!("ffffffffffffffff0100");
    let tx_out = bsl::TxOut::parse(&tx_out_bytes).unwrap().parsed_owned();
    let tx_out_groestlcoin: groestlcoin::TxOut =
        groestlcoin::consensus::deserialize(&tx_out_bytes[..]).unwrap();

    let tx_out_back: groestlcoin::TxOut = tx_out.into();

    assert_eq!(tx_out_back, tx_out_groestlcoin);
}
```

## Test

```sh
cargo test
```

## Bench

```sh
RUSTFLAGS='--cfg=bench' cargo +nightly bench --all-features
```

```sh
test bsl::block::bench::block_deserialize            ... bench:     289,421 ns/iter (+/- 46,179)
test bsl::block::bench::block_deserialize_groestlcoin    ... bench:   2,719,666 ns/iter (+/- 459,186)
test bsl::block::bench::block_sum_outputs            ... bench:     288,248 ns/iter (+/- 39,013)
test bsl::block::bench::block_sum_outputs_groestlcoin    ... bench:   2,607,791 ns/iter (+/- 321,212)
test bsl::block::bench::find_tx                      ... bench:   1,012,297 ns/iter (+/- 6,278)
test bsl::block::bench::find_tx_groestlcoin              ... bench:   8,632,416 ns/iter (+/- 89,751)
test bsl::block::bench::hash_block_txs               ... bench:   8,406,341 ns/iter (+/- 938,119)
test bsl::block::bench::hash_block_txs_groestlcoin       ... bench:  11,843,590 ns/iter (+/- 1,052,109)
test bsl::block::bench::hash_block_txs_sha2          ... bench:   7,891,956 ns/iter (+/- 1,047,439)
test bsl::block_header::bench::block_hash            ... bench:       1,399 ns/iter (+/- 205)
test bsl::block_header::bench::block_hash_groestlcoin    ... bench:       1,510 ns/iter (+/- 222)
test bsl::transaction::bench::tx_deserialize         ... bench:          38 ns/iter (+/- 8)
test bsl::transaction::bench::tx_deserialize_groestlcoin ... bench:         219 ns/iter (+/- 30)
test bsl::transaction::bench::txid                   ... bench:       2,185 ns/iter (+/- 166)
test bsl::transaction::bench::txid_groestlcoin           ... bench:       2,416 ns/iter (+/- 213)
test bsl::transaction::bench::txid_sha2              ... bench:       2,085 ns/iter (+/- 216)
```

* benches ending with `_groestlcoin` use `rust-groestlcoin`
* benches ending with `_sha2` use `sha2` lib instead of `groestlcoin_hashes`

### Comparison against rust-groestlcoin

`block_deserialize` is almost 10 times faster then `block_deserialize_groestlcoin`. It may see unfair 
comparison since you can't for example iterate transactions from the resulted object in case of 
`block_deserialize`, but looking at the `sum_outputs` example where a visitor is used to access 
every outputs in a block we se there isn't noticeable difference.

### Hashing 

`block_hash` and `block_hash_groestlcoin` use the same code to hash, however groestlcoin_slice is about 7% 
faster because use a slice already available instead of serializing back data.
Similar results apply between `txid` and `txid_groestlcoin`.
The performance increase is more notable (30%) between `hash_block_txs` and `hash_block_txs_groestlcoin`.

`*_sha2` are not really representative on virtual CI machines since they are not hardware-accellerated. 

## Fuzz

Use [cargo fuzz](https://github.com/rust-fuzz/cargo-fuzz)
Run fuzzing with transaction as target.

```sh
cargo +nightly fuzz run transaction
```

Other target available in `fuzz/fuzz_targets`


Minimize corpus:
```sh
cargo +nightly fuzz cmin transaction
```

## Doc

To build docs:

```sh
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --open
```

## MSRV

Minimum Supported Rust Version of this crate is 1.60.0 without `redb`,`slice_cache` features, (double check with what is running in the CI)
With `slice_cache` feature MSRV is 1.64.0.
With `redb` feature MSRV is 1.66.0.



## Previous work and credits

* [Bitiodine](https://github.com/mikispag/bitiodine) use similar visitor pattern (parser credited to Mathias Svensson) 
* Some previous work on the idea to parse while reducing allocations in this [PR](https://github.com/rust-bitcoin/rust-bitcoin/pull/672)
* Matt Corallo mentioned something like this in a [comment](https://github.com/rust-bitcoin/rust-bitcoin/pull/672#pullrequestreview-769198159) in that PR