Skip to content

Commit

Permalink
Monorepo (ensdomains#1)
Browse files Browse the repository at this point in the history
* Copy all files

* Remove obsolute contracts

* Remove reference from subdomain-registrar

* Upgraded sol version to 0.8.4

* Add gitignore

* Remove OldBaseRegistrarImplementation

* Update openzeppelin

* Updata OZ

* Fixed all the compilation error

* Update tests

* Remove sample tests

* Fix artifacts.require

* Replace DummyResolver

* Fix grace period transfer restriction error on test

* Remove package-lock

* Remove console.log

* Delete ReverseRecords.js

* Add .nvmrc

* Add serialNumberGte

* Add util tests

* Move BaseReigstrar to 0.8.4

* Explicit casting

* Remove Migration contracts

* Delete deps.sol

* v0.0.2

* Expose contacts and abi

* Add travis

* Create README.md

* Remove contract structure

* Add MIT license
  • Loading branch information
makoto authored May 19, 2021
1 parent dede026 commit 23aba62
Show file tree
Hide file tree
Showing 69 changed files with 13,970 additions and 14,049 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*.DS_Store
node_modules
build

#Hardhat files
cache
artifacts
5 changes: 5 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*.DS_Store
node_modules/

#Hardhat files
cache/
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v14.15.0
8 changes: 8 additions & 0 deletions .solhint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"extends": "solhint:default",
"rules": {
"indent": 2,
"max-line-length": false,
"quotes": "double"
}
}
21 changes: 21 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
sudo: required

dist: trusty

language: node_js

node_js:
- "14"
env:
- TASK=test
- TASK=lint
matrix:
fast_finish: true
allow_failures:
- env: TASK=lint
script:
- npm run $TASK

notifications:
email: false

7 changes: 7 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright (c) 2018, True Names Limited

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
163 changes: 163 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
# ENS

[![Build Status](https://travis-ci.org/ensdomains/ens-contracts.svg?branch=master)](https://travis-ci.org/ensdomains/ens-contracts)

For documentation of the ENS system, see [docs.ens.domains](https://docs.ens.domains/).

## npm package

This repo doubles as an npm package with the compiled JSON contracts

```js
import {
BaseRegistrar,
BaseRegistrarImplementation,
BulkRenewal,
ENS,
ENSRegistry,
ENSRegistryWithFallback,
ETHRegistrarController,
FIFSRegistrar,
LinearPremiumPriceOracle,
PriceOracle,
PublicResolver,
Resolver,
ReverseRegistrar,
StablePriceOracle,
TestRegistrar
} from '@ensdomains/ens-contracts'
```

## Importing from solidity

```
// Registry
import 'ensdomains-ens-contracts/contracts/registry/ENS.sol';
import 'ensdomains-ens-contracts/contracts/registry/ENSRegistry.sol';
import 'ensdomains-ens-contracts/contracts/registry/ENSRegistryWithFallback.sol';
import 'ensdomains-ens-contracts/contracts/registry/ReverseRegistrar.sol';
import 'ensdomains-ens-contracts/contracts/registry/TestRegistrar.sol';
// EthRegistrar
import 'ensdomains-ens-contracts/contracts/ethregistrar/BaseRegistrar.sol';
import 'ensdomains-ens-contracts/contracts/ethregistrar/BaseRegistrarImplementation.sol';
import 'ensdomains-ens-contracts/contracts/ethregistrar/BulkRenewal.sol';
import 'ensdomains-ens-contracts/contracts/ethregistrar/BaseRegistrar.sol';
import 'ensdomains-ens-contracts/contracts/ethregistrar/ETHRegistrarController.sol';
import 'ensdomains-ens-contracts/contracts/ethregistrar/LinearPremiumPriceOracle.sol';
import 'ensdomains-ens-contracts/contracts/ethregistrar/PriceOracle.sol';
import 'ensdomains-ens-contracts/contracts/ethregistrar/StablePriceOracle.sol';
// Resolvers
import 'ensdomains-ens-contracts/contracts/resolvers/PublicResolver.sol';
import 'ensdomains-ens-contracts/contracts/resolvers/Resolver.sol';
```

## Contracts

## Registry

The ENS registry is the core contract that lies at the heart of ENS resolution. All ENS lookups start by querying the registry. The registry maintains a list of domains, recording the owner, resolver, and TTL for each, and allows the owner of a domain to make changes to that data. It also includes some generic registrars.

### ENS.sol

Interface of the ENS Registry.

### ENSRegistry

Implementation of the ENS Registry, the central contract used to look up resolvers and owners for domains.

### ENSRegistryWithFallback

The new impelmentation of the ENS Registry after [the 2020 ENS Registry Migration](https://docs.ens.domains/ens-migration-february-2020/technical-description#new-ens-deployment).

### FIFSRegistrar

Implementation of a simple first-in-first-served registrar, which issues (sub-)domains to the first account to request them.

### ReverseRegistrar

Implementation of the reverse registrar responsible for managing reverse resolution via the .addr.reverse special-purpose TLD.


### TestRegistrar

Implementation of the `.test` registrar facilitates easy testing of ENS on the Ethereum test networks. Currently deployed on Ropsten network, it provides functionality to instantly claim a domain for test purposes, which expires 28 days after it was claimed.


## EthRegistrar

Implements an [ENS](https://ens.domains/) registrar intended for the .eth TLD.

These contracts were audited by ConsenSys dilligence; the audit report is available [here](https://github.com/ConsenSys/ens-audit-report-2019-02).

### BaseRegistrar

BaseRegistrar is the contract that owns the TLD in the ENS registry. This contract implements a minimal set of functionality:

- The owner of the registrar may add and remove controllers.
- Controllers may register new domains and extend the expiry of (renew) existing domains. They can not change the ownership or reduce the expiration time of existing domains.
- Name owners may transfer ownership to another address.
- Name owners may reclaim ownership in the ENS registry if they have lost it.
- Owners of names in the interim registrar may transfer them to the new registrar, during the 1 year transition period. When they do so, their deposit is returned to them in its entirety.

This separation of concerns provides name owners strong guarantees over continued ownership of their existing names, while still permitting innovation and change in the way names are registered and renewed via the controller mechanism.

### EthRegistrarController

EthRegistrarController is the first implementation of a registration controller for the new registrar. This contract implements the following functionality:

- The owner of the registrar may set a price oracle contract, which determines the cost of registrations and renewals based on the name and the desired registration or renewal duration.
- The owner of the registrar may withdraw any collected funds to their account.
- Users can register new names using a commit/reveal process and by paying the appropriate registration fee.
- Users can renew a name by paying the appropriate fee. Any user may renew a domain, not just the name's owner.

The commit/reveal process is used to avoid frontrunning, and operates as follows:

1. A user commits to a hash, the preimage of which contains the name to be registered and a secret value.
2. After a minimum delay period and before the commitment expires, the user calls the register function with the name to register and the secret value from the commitment. If a valid commitment is found and the other preconditions are met, the name is registered.

The minimum delay and expiry for commitments exist to prevent miners or other users from effectively frontrunnig registrations.

### SimplePriceOracle

SimplePriceOracle is a trivial implementation of the pricing oracle for the EthRegistrarController that always returns a fixed price per domain per year, determined by the contract owner.

### StablePriceOracle

StablePriceOracle is a price oracle implementation that allows the contract owner to specify pricing based on the length of a name, and uses a fiat currency oracle to set a fixed price in fiat per name.

## Resolvers

Resolver implements a general-purpose ENS resolver that is suitable for most standard ENS use-cases. The public resolver permits updates to ENS records by the owner of the corresponding name.

PublicResolver includes the following profiles that implements different EIPs.

─ ABIResolver = EIP 205 - ABI support (`ABI()`).
─ AddrResolver = EIP 137 - Contract address interface. EIP 2304 - Multicoin support (`addr()`).
─ ContentHashResolver = EIP 1577 - Content hash support (`contenthash()`).
─ InterfaceResolver = EIP 165 - Interface Detection (`supportsInterface()`).
─ NameResolver = EIP 181 - Reverse resolution (`name()`).
─ PubkeyResolver = EIP 619 - SECP256k1 public keys (`pubkey()`).
─ TextResolver = EIP 634 - Text records (`text()`).
─ DNSResolver = Experimental support is available for hosting DNS domains on the Ethereum blockchain via ENS. [The more detail](https://veox-ens.readthedocs.io/en/latest/dns.html) is on the old ENS doc.

## Developer guide

### How to setup

```
git clone https://github.com/ensdomains/ens-contracts
cd ens-contracts
yarn
```

### How to run tests

```
yarn test
```

### How to publish

```
yarn pub
```
23 changes: 0 additions & 23 deletions contracts/Greeter.sol

This file was deleted.

Loading

0 comments on commit 23aba62

Please sign in to comment.