> For the complete documentation index, see [llms.txt](https://freename-1.gitbook.io/freename-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://freename-1.gitbook.io/freename-docs/freename-web3-resolver/knowledge-base.md).

# Knowledge Base

Freename resolution snap is using the official Snap SDK to develop an add-on that can be installed on Metamask and provides resolution to a domain name using the Freename resolver API.\
\
The development is done on the repository <https://github.com/FreenameDomains/freename-resolution-snap-dev>, while the release version is managed on <https://github.com/FreenameDomains/freename-resolution-snap> .

The dev repo is providing additional functionality to ease the development process. It exposes a simple webpage on localhost:8000 which can be used to connect to the local snap.

It is based on the [snap monorepo official template](https://github.com/MetaMask/template-snap-monorepo) and using a very limited set of functionality. Namely `endowment:network-access` (to allow the extension to communicate with the resolver API) & `endowment:name-lookup` (to define under which networks on Metamask, should domains be resolved).

## Development

* Clone the repo
* Install required packages (yarn)
* Run locally yarn start
* Under the packages folder there are two sub-folders. site holds the supporting webpage, snap holds the snap code itself
* You can access the site on localhost:8000 the code itself is very simple and self explanatory

## Demo

<https://freename-doc.s3.eu-central-1.amazonaws.com/snap-demo.mp4>