nada 0.2.0

Compression-focused encoding for zero-heavy solidity calldata and bytecode
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

# nada

[![nada](https://github.com/bestinslot-xyz/nada-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/bestinslot-xyz/nada-rs/actions)

Compression-focused encoding for zero-heavy Solidity calldata and bytecode.

`nada` provides an efficient way to encode and decode byte arrays where runs of `0x00` are replaced with a compact marker (`0xFF`) followed by the length of the run. This is particularly useful for reducing the size of calldata and bytecode in environments like Ethereum.

## How it Works

- `0xFF 0x00` is a reserved sequence
- `0xFF 0x01` encodes a single `0xFF`
- `0xFF 0x02` encodes a double `0xFF`
- `0xFF N` (3 ≤ N ≤ 255) encodes `N` zero bytes
- All other bytes are passed through unchanged

This encoding helps reduce the size of sequences with a high proportion of zero bytes, which are common in Solidity calldata and bytecode.

### Example

| Input                          | Encoded                          |
|--------------------------------|----------------------------------|
| `[0x00, 0x00, 0x02, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00, 0xFF]`    | `[0x00, 0x00, 0x02, 0xFF, 0x02, 0xFF, 0x04, 0xFF, 0x01]` |


## Installation

To add `nada` to your project, use

```bash
> cargo add nada
```

### Usage
Here is a simple example of how to use the encode and decode functions:

```rust
let data = vec![0x01, 0x00, 0x00, 0xFF];
let encoded = nada::encode(&data);
let decoded = nada::decode(&encoded);

assert_eq!(decoded, Ok(data));
```

`decode` returns a `DecodeError` if the input ends unexpectedly, such as when a `0xFF` marker is found without a following run length byte, indicating incomplete or malformed encoded data. It also returns an error if the reserved sequence `0xFF00` is encountered.

### License

Apache License, Version 2.0