Skip to main content

​
Quickstart

1

Install NameGuard

pip install nameguard
2

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]
export ALCHEMY_URI_MAINNET=https://eth-mainnet.g.alchemy.com/v2/[YOUR_ALCHEMY_API_KEY]
export ALCHEMY_URI_SEPOLIA=https://eth-sepolia.g.alchemy.com/v2/[YOUR_ALCHEMY_API_KEY]
export ENS_SUBGRAPH_URL_MAINNET="https://gateway-arbitrum.network.thegraph.com/api/[YOUR_SUBGRAPH_API_KEY]/subgraphs/id/5XqPmWe6gjyrJtFn9cLy237i4cWw2j9HcUJEXsP5qGtH"
export ENS_SUBGRAPH_URL_SEPOLIA="https://gateway-arbitrum.network.thegraph.com/api/[YOUR_SUBGRAPH_API_KEY]/subgraphs/id/DmMXLtMZnGbQXASJ7p1jfzLUbBYnYUD9zNBTxpkjHYXV"
3

Install a server

pip install 'uvicorn[standard]'
4

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/namekit
Then install the dependencies using poetry: 
cd packages/nameguard-python
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 ./packages/nameguard-python/tests/