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

ERC-7529 Refactor #1056

Draft
wants to merge 5 commits into
base: develop
Choose a base branch
from
Draft

ERC-7529 Refactor #1056

wants to merge 5 commits into from

Conversation

SnickerChar
Copy link
Contributor

@SnickerChar SnickerChar commented Oct 31, 2023

Release Notes

JIRA Link

Summary:

This refactors the core to use our ERC-7529 package. It removes the DNS repository and methods from the consent contract repository, in favor of our package. It update the ERC-7529 package to be backwards-compatible with the existing snickerdoodle-protocol TXT records as well as the new ERC-7529 ones. Along the way, I found a really crazy method that I removed, as it wasn't used anywhere, was a total pain to refactor, and was really expensive and inefficient if it ever was called.

Intended results:

This should be completely transparent. DNS-based public invitations should continue to work, with both the TXT record at snickerdoodle-protocol.{domain} AND the new ERC-7529 compliant erc-7529.${chainId}._domaincontracts.{domain}.

Potential Failures:

Existing DNS based public invitations could break. The method I removed could be used somewhere that's not apparent and not caught by the compiler, though I doubt it. Contracts that include more than the ETLD+1 (phoebe.com), such as a subdomain (child.phoebe.com) or a path (phoebe.com/child), will almost certainly break- and this is to be expected. We'll have to update the IP so that when you are entering domains on an audience you can only enter the ETLD+1.

Testing Notes:

ERC-7529 was unit and integration tested. Unit tests for invitation service (that was refactored) were updated.

Pre-Flight Checks

  • Has QA approved this change for dev?
  • Are all unit tests passing?
  • Have you added this description to this week's release notes?

It's a really expensive, nonsensical, and unused method.
Refactored to use ERC7529Utils.
Removed DNSRepository (ERC7529Utils does this now).
Removed unused ConsentContractRepositoryError
@SnickerChar SnickerChar added the DEMO-03 Code is merged to DEMO-03 Sandbox label Oct 31, 2023
@SnickerChar SnickerChar removed the DEMO-03 Code is merged to DEMO-03 Sandbox label Mar 4, 2024
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.

1 participant