-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #167 from ensdomains/deprecate
Update README
- Loading branch information
Showing
1 changed file
with
1 addition
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1 @@ | ||
| # DNSSEC Oracle | ||
|
|
||
| [](https://travis-ci.org/ensdomains/dnssec-oracle) | ||
| [](LICENSE) | ||
|
|
||
| This is an implementation of a DNSSEC oracle for Ethereum. With it, you | ||
| can securely prove the contents of any DNSSEC-signed DNS record on the | ||
| Ethereum blockchain, as long as it was signed using supported public key | ||
| schemes and digests. Presently, the oracle only supports RSA and | ||
| SHA-256; fortunately, over 3/4 of TLDs use this combination of | ||
| algorithms. | ||
|
|
||
| Once a record is proven to the oracle, any contract or external caller | ||
| can fetch it with the `rrsets` constant function, allowing other | ||
| contracts to read data from DNS. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| These instructions will get you a copy of the project up and running on | ||
| your local machine for development and testing purposes. | ||
|
|
||
| ### Installing | ||
|
|
||
| The DNSSEC Oracle uses npm to manage dependencies, therefore the | ||
| installation process is kept simple: | ||
|
|
||
| ``` | ||
| npm install | ||
| ``` | ||
|
|
||
| ### Running tests | ||
|
|
||
| The DNSSEC Oracle uses hardhat for its ethereum development environment. | ||
| All tests can be run using hardhat: | ||
|
|
||
| ``` | ||
| npx hardhat test | ||
| ``` | ||
|
|
||
| To run linting, use solium: | ||
|
|
||
| ``` | ||
| solium --dir ./contracts | ||
| ``` | ||
|
|
||
| ## Including DNSSEC Oracle in your project | ||
|
|
||
| ### Installation | ||
|
|
||
| ``` | ||
| npm install dnssec-oracle --save | ||
| ``` | ||
|
|
||
| ### Within Your contracts | ||
|
|
||
| ``` | ||
| import "@ensdomains/dnssec-oracle/build/contracts/DNSSEC" | ||
| ``` | ||
|
|
||
| ### Within Javascript code | ||
|
|
||
| ``` | ||
| var data = require("@ensdomains/dnssec-oracle/build/contracts/DNSSEC.json") | ||
| ``` | ||
|
|
||
| The JSON file is same as the one generated using `hardhat compile`. You | ||
| can pass the loaded data to `truffle-contract` or use it via web3 by | ||
| passing `data.abi`. | ||
|
|
||
| ### Usage | ||
|
|
||
| A [command line utility](https://github.com/arachnid/dnsprove) is | ||
| available that automates the task of generating the necessary proofs | ||
| from DNS data and submitting them to the oracle. | ||
|
|
||
| The oracle is still in alpha, and does not yet have any official | ||
| deployments on the main network or test networks. | ||
|
|
||
| ## Built With | ||
|
|
||
| - [Hardhat](https://hardhat.org/) - Ethereum | ||
| development environment | ||
|
|
||
| ## Authors | ||
|
|
||
| - **Nick Johnson** - [Arachnid](https://github.com/Arachnid) | ||
|
|
||
| See also the list of | ||
| [contributors](https://github.com/ensdomains/dnssec-oracle/contributors) | ||
| who participated in this project. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the BSD 2-clause "Simplified" License - | ||
| see the [LICENSE](LICENSE) file for details | ||
| This repo is now consolidated into https://github.com/ensdomains/ens-contracts |