ENS Offchain Resolver Gateway

[!NOTE] See gskril/ens-offchain-registrar for a more modern example.

This repo implements a simple CCIP-read gateway server for ENS offchain resolution that fetches name data from an external API.

Usage:

Modify fetchOffchainName() in db.ts to read from your API and format the response.

Set your PRIVATE_KEY env var. This should be an Ethereum private key that will be used to sign messages. You should configure your resolver contract to expect messages to be signed using the corresponding address.

Deploy this repo to a publicly accessible URL and set it as the url on your resolver contract in the format https://<your-domain>/{sender}/{data}.json.

Customisation

The backend is implemented in db.ts, and implements the Database interface from server.ts. You can replace this with your own database service by implementing the methods provided in that interface. If a record does not exist, you should return the zero value for that type - for example, requests for nonexistent text records should be responded to with the empty string, and requests for nonexistent addresses should be responded to with the all-zero address.