Self-Hosting - NameGuard

Quickstart

Install NameGuard

pip install nameguard

Configure API keys

export PROVIDER_URI_MAINNET=https://eth-mainnet.g.alchemy.com/v2/[YOUR_ALCHEMY_API_KEY]
export PROVIDER_URI_SEPOLIA=https://eth-sepolia.g.alchemy.com/v2/[YOUR_ALCHEMY_API_KEY]

Install a server

pip install 'uvicorn[standard]'

Start the web server

uvicorn nameguard.web_api:app

Local Development

To run NameGuard locally, make sure to clone the repo:

git clone https://github.com/namehash/nameguard

Then install the dependencies using poetry:

cd nameguard
poetry install

You can now run the tests for all checks outlined in the specification. From the root of the project, run the following command:

pytest ./api/tests/

​Quickstart

​Local Development

Quickstart

Local Development