ens-normalize 0.1.1

Rust port of adraffy's ENS normalizer
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# ens-normalize-rs

Rust implementation of ENS normalization, ported from
[`@adraffy/ens-normalize`](https://github.com/adraffy/ens-normalize.js).
The crates.io package is named `ens-normalize`, which imports as
`ens_normalize`.

The crate embeds the same upstream derived data (`spec.json` and `nf.json`) and
tests against the upstream validation corpus from `@adraffy/ens-normalize`
`1.11.1` (Unicode `17.0.0`, CLDR `47`).

```rust
use ens_normalize::ens_normalize;

let name = ens_normalize("RaFfY.eth")?;
assert_eq!(name, "raffy.eth");
# Ok::<(), ens_normalize::EnsError>(())
```

Core API:

- `ens_normalize(name) -> Result<String>`
- `ens_beautify(name) -> Result<String>`
- `ens_normalize_fragment(fragment, decompose) -> Result<String>`
- `ens_split(name, preserve_emoji) -> Vec<Label>`
- `ens_tokenize(name) -> Vec<Token>`
- `nfc(cps)` and `nfd(cps)` using the embedded Unicode data

## Verification

```sh
cargo test
cargo clippy --all-targets -- -D warnings
```

The Rust tests reuse the upstream fixture files in `tests/fixtures`.

For the JS/WASM compatibility harness, install `wasm-pack` and run:

```sh
cargo install wasm-pack --locked
scripts/test-js-compat.sh
```

## Benchmarks

```sh
cargo bench
```

To compare against `ens-normalize.js` after running `cargo bench`:

```sh
ENS_NORMALIZE_JS_DIR=/path/to/ens-normalize.js scripts/bench-js-compare.mjs
```

## Updating Upstream Data

To refresh from `ens-normalize.js`:

```sh
scripts/update-upstream.sh main
```

The script runs the upstream JS test suite, copies the derived data and
fixtures into this repo, then runs the Rust tests.