ens-normalize-rs 0.2.0

Ethereum Name Service (ENS) name normalization
Documentation

ens-normalize-rs

tests Crates.io Version

A Rust implementation of ENS (Ethereum Name Service) name normalization.

Description

ens-normalize-rs is a robust Rust library for normalizing and validating ENS names according to ENSIP-15 specifications. It handles Unicode normalization, validation, beautification of ENS names ensuring correct, consistent and idempotent behavior.

Installation

cargo add ens-normalize-rs

Or pin a semver range in Cargo.toml (see crates.io for the latest version):

[dependencies]
ens-normalize-rs = "0.1"

Usage

fn main() {
    fn main() {
    // Using normalizer to reuse preloaded data
    let normalizer = ens_normalize_rs::EnsNameNormalizer::default();
    let name = "🅰️🅱.eth";
    let processed = normalizer.process(name).unwrap();
    let beautified_name = processed.beautify();
    let normalized_name = processed.normalize();

    assert_eq!(normalized_name, "🅰🅱.eth");
    assert_eq!(beautified_name, "🅰️🅱️.eth");

    // Using normalize directly
    let normalized = normalizer.normalize("Levvv.eth").unwrap();
    assert_eq!(normalized, "levvv.eth");

    // Handling errors
    assert!(matches!(
        normalizer.normalize("Levvv..eth"),
        Err(ens_normalize_rs::ProcessError::DisallowedSequence(
            ens_normalize_rs::DisallowedSequence::EmptyLabel
        ))
    ));
    assert!(matches!(
        // U+200D ZERO WIDTH JOINER
        normalizer.normalize("Ni‍ck.ETH"),
        Err(ens_normalize_rs::ProcessError::DisallowedSequence(
            ens_normalize_rs::DisallowedSequence::InvisibleCharacter(0x200d)
        ))
    ));
}
}

Testing

Crate contains several types of tests:

To run all tests simply run:

cargo test

Releasing (maintainers)

Releases are automated with release-plz:

  1. Merge PRs using Conventional Commits (feat: → minor, fix: → patch, feat!: / BREAKING: → major).
  2. release-plz opens or updates a Release PR (version bump in Cargo.toml + CHANGELOG.md).
  3. Merge the Release PR → CI tags the release and runs cargo publish to crates.io.

One-time setup: add a crates.io API token with publish permission for ens-normalize-rs as the GitHub Actions secret CARGO_REGISTRY_TOKEN (repo → Settings → Secrets and variables → Actions).

Roadmap

  • Tokenization
  • Normalization
  • Beautification
  • ENSIP-15 Validation Tests
  • Unicode Normalization Tests
  • CLI to update specs.json and nf.json
  • analog of ens_cure function
  • analog of ens_normalizations function

License

This project is licensed under the MIT License - see the LICENSE file for details.