# @ensdomains/offchain-resolver-contracts

> This package contains Solidity contracts you can customise and deploy to provide offchain resolution of ENS names.

Latest version **0.2.1** (published 2022-03-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ensdomains/offchain-resolver-contracts
pnpm add @ensdomains/offchain-resolver-contracts
yarn add @ensdomains/offchain-resolver-contracts
bun add @ensdomains/offchain-resolver-contracts
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2022-03-10 |
| First published | 2022-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 42.2 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 147 |
| Author | Nick Johnson |
| Maintainers | taytems, makoto_inoue, decanus, nickjohnson, jefflau, mdt., leeondamiky |

## Links

- npm: https://www.npmjs.com/package/@ensdomains/offchain-resolver-contracts
- Repository: git@github.com:ensdomains/offchain-resolver
- npm.io page: https://npm.io/package/@ensdomains/offchain-resolver-contracts

## Dependencies (3)

- [hardhat-deploy-ethers](https://npm.io/package/hardhat-deploy-ethers.md) ^0.3.0-beta.13
- [@ensdomains/ens-contracts](https://npm.io/package/@ensdomains/ens-contracts.md) ^0.0.8
- [@nomiclabs/hardhat-etherscan](https://npm.io/package/@nomiclabs/hardhat-etherscan.md) ^3.0.0

## Recent versions

- 0.2.1 (latest) — 2022-03-10
- 0.0.2 — 2022-02-09
- 0.0.1 — 2022-02-09

## README

# ENS Offchain Resolver Contracts

This package contains Solidity contracts you can customise and deploy to provide offchain resolution of ENS names.

These contracts implement [ENSIP 10](https://docs.ens.domains/ens-improvement-proposals/ensip-10-wildcard-resolution) (wildcard resolution support) and [EIP 3668](https://eips.ethereum.org/EIPS/eip-3668) (CCIP Read). Together this means that the resolver contract can be very straightforward; it simply needs to respond to all resolution requests with a redirect to your gateway, and verify gateway responses by checking the signature on the returned message.

These contracts can also be used as a starting point for other verification methods, such as allowing the owner of the name to sign the records themselves, or relying on another verification mechanism such as a merkle tree or an L2 such as Optimism. To do so, start by replacing the calls to `SignatureVerifier` in `OffchainResolver` with your own solution.

## Contracts

### [IExtendedResolver.sol](contracts/IExtendedResolver.sol)
This is the interface for wildcard resolution specified in ENSIP 10. In time this will likely be moved to the [@ensdomains/ens-contracts](https://github.com/ensdomains/ens-contracts) repository.

### [SignatureVerifier.sol](contracts/SignatureVerifier.sol)
This library facilitates checking signatures over CCIP read responses.

### [OffchainResolver.sol](contracts/OffchainResolver.sol)
This contract implements the offchain resolution system. Set this contract as the resolver for a name, and that name and all its subdomains that are not present in the ENS registry will be resolved via the provided gateway by supported clients.

---
_Source: https://npm.io/package/@ensdomains/offchain-resolver-contracts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._