Usage

Options

NameGuard

Website

Support

getSecurePrimaryName()

NameGuard is a powerful tool developed by NameHash Labs to identify, and prevent malicious use of Ethereum Name Service (ENS) names.

Introduction

Welcome to NameGuard

Quickstart

NameGuard is a tool for identifying and preventing malicious use of ENS names.

Specification

Chains

Run NameGuard yourself and protect against malicious ENS names.

Self-Hosting

Setup

TypeScript

Returns the full results of all `checks` on all `labels` in a name.

inspectName()

Returns a consolidated NameGuard report for each name (up to 250).

bulkInspectNames()

Inspects the name associated with a namehash.

inspectNamehash()

Inspects the name `"[{labelhash}].{parent}"`.

inspectLabelhash()

fakeEthNameCheck()

inspectGrapheme()

## Inspects a single name with NameGuard.

Provides a `NameGuardReport` including:
1. The details of all checks performed on `name` that consolidates all checks performed on labels and graphemes in `name`.
2. The details of all labels in `name`.
3. A consolidated inspection result of all graphemes in `name`.

This endpoint will attempt automated labelhash resolution through the ENS Subgraph,
using the network specified in `network_name`.

Inspect Name

## Inspects up to 250 names at a time with NameGuard.

Provides a `ConsolidatedNameGuardReport` for each name provided in `request.names`, including:
1. The details of all checks performed on a name that consolidates all checks performed on labels and graphemes in this name.

Each `ConsolidatedNameGuardReport` returned represents an equivalent set of checks as a `NameGuardReport`. However:
1. A `NameGuardReport` contains a lot of additional data that isn't always needed / desired when a `ConsolidatedNameGuardReport` will do.
2. When NameGuard only needs to return a `ConsolidatedNameGuardReport`, some special performance optimizations are possible (and completely safe) that help to accelerate responses in many cases.

This endpoint will attempt automated labelhash resolution through the ENS Subgraph,
using the network specified in `request.network_name`.

Inspect Multiple Names

## Inspects the name associated with a namehash.

NameGuard will attempt to resolve the name associated with the `namehash` through the ENS Subgraph,
using the network specified in `network_name`.

If this resolution succeeds then NameGuard will generate and return a `NameGuardReport` for the name.

If this resolution fails then NameGuard will return an error.

Inspect Namehash GET

## Inspects the name `[{labelhash}].{parent_name}`.

Parent may be a name with any number of labels. The default parent is "eth".

This is a convenience endpoint to generate a `NameGuardReport` in cases when you only have:
1. The labelhash of the "childmost" label of a name.
2. The complete parent name of the "childmost" label.

NameGuard always inspects names, rather than labelhashes. So this endpoint will first attempt
to resolve the "childmost" label associated with the provided labelhash through the ENS Subgraph,
using the network specified in `network_name`.

If this label resolution fails the resulting `NameGuardReport` will be equivalent to requesting
a `NameGuardReport` for the name `[{labelhash}].{parent_name}` which will contain (at least)
one label with an `unknown` `Normalization`.

If this label resolution succeeds the resulting `NameGuardReport` will be equivalent to requesting
a `NameGuardReport` for the name `{label}.{parent_name}`.

Inspect Labelhash GET

## Performs a reverse lookup of an Ethereum `address` to a primary name.

Data sources for the primary name lookup include:
1. The Ethereum Provider configured in the NameGuard instance.
2. For ENS names using CCIP-Read: requests to externally defined gateway servers.

Returns `display_name` to be shown to users and estimates `impersonation_status`.

Reverse lookup of an Ethereum address to a primary name

## Performs a fake .eth ENS name check based on given NFT metadata.

This endpoint checks if the metadata of an NFT looks like a fake .eth ENS name.

NameGuard

SDK

API

getSecurePrimaryName()

Usage

Options

NameGuard

SDK

API

​Usage

​Options

Usage

Options