Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REG-1154] - Add ENS DNSSEC smart contracts to configs, artifacts and sandbox #310

Merged
merged 1 commit into from
Nov 8, 2023

Conversation

DeRain
Copy link
Contributor

@DeRain DeRain commented Nov 3, 2023

PR Checklist

1. Contracts versioning

  • Make sure that the patch version of the contracts is increased if changes have been made to the UNSRegistry, MintingManager, ProxyReader, ENSCustody contracts.
  • Make sure that the minor version of the contracts is increased if breaking changes have been made to the UNSRegistry, MintingManager, ProxyReader, ENSCustody contracts. It includes changes of interfaces.

2. Contracts licensing

  • Make sure that no SPDX-License-Identifier defined in contracts.
  • Make sure that the header is added to the new contract files.
    // @author Unstoppable Domains, Inc.
    // @date {Month} {Day}(ordinal), {Year}
    

3. Coverage

  • Make sure that the coverage of contracts has not decreased and strive 100%

4. Configs versioning

  • Make sure that the version of uns-config.json is increased if changes have been made to the config.
  • Make sure that the version of ens-config.json is increased if changes have been made to the config.
  • Make sure that the version of resolver-keys.json is increased if changes have been made to the config.
  • Make sure that the version of ens-resolver-keys.json is increased if changes have been made to the config.

5. Package versioning

  • Make sure that the patch version of package is increased if valuable changes have been made to the package. It includes contracts update, configs update, etc.
  • Make sure that the major.minor version of package is synced with version of UNSRegistry contract.
  • Make sure that the CHANGELOG is updated with short description for the new version.

6. Code review

  • resolver-keys.json code review is required from DevTools team
  • ens-resolver-keys.json code review is required from DevTools team
  • For all other changes code review is required from Registry team

@DeRain DeRain requested a review from a team November 3, 2023 17:01
Copy link

@github-advanced-security github-advanced-security bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slither found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

Copy link

github-actions bot commented Nov 3, 2023

Contracts size report

Contract name Size (KiB) Delta (KiB)
ENSCustody 13.055 0
MintingManager 17.214 0
ProxyReader 15.176 0
UNSRegistry 19.943 0

@codecov-commenter
Copy link

Codecov Report

Merging #310 (4594c05) into main (1f62012) will increase coverage by 11.77%.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@             Coverage Diff             @@
##             main     #310       +/-   ##
===========================================
+ Coverage   86.92%   98.70%   +11.77%     
===========================================
  Files          34       20       -14     
  Lines        1239     1000      -239     
  Branches      181      217       +36     
===========================================
- Hits         1077      987       -90     
+ Misses        162       13      -149     

see 14 files with indirect coverage changes

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

@@ -0,0 +1,166 @@
pragma solidity ^0.8.4;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we include links to initial sources for all of this contracts?

* proof must be the TXT record required by the registrar.
* @param proof The proof record for the first element in input.
*/
function proveAndClaim(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes sense to add a test minting a DNS-proved ENS domain to ensure valid configuration. Probably in sandbox/index.test.ts

Copy link
Member

@nickshatilo nickshatilo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM apart from some minor stuff

@DeRain DeRain merged commit b24f9dd into main Nov 8, 2023
7 checks passed
@DeRain DeRain deleted the REG-1154 branch November 8, 2023 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants