Unstoppable Domains IPFS Resolution #16664

V-Shadbolt · 2022-11-23T19:12:51Z

Explanation

Adds IPFS resolution for unstoppable domains. Much like the ENS IPFS resolution with .eth/ but adds support for the Unstoppable TLDs.

Usage

Simply type the UD into your browser’s address bar with a ‘/’ at the end
On Chrome, Brave or other chrome based browsers it should

Resolve all UD TLDs EXCEPT .888
Redirect to IPFS website if a site exists
Redirect to UD search page if IPFS website does not exist

On Firefox it should

Resolve all UD TLDs
Redirect to UD search page if IPFS website does not exist

More Information

Spinning off of this pull request: #15817

Pre-merge author checklist

I've clearly explained:
- What problem this PR is solving
- How this problem was solved
- How reviewers can test my changes
Sufficient automated test coverage has been added

Pre-merge reviewer checklist

Manual testing (e.g. pull and build branch, run in browser, test code being changed)
PR is linked to the appropriate GitHub issue
IF this PR fixes a bug in the release milestone, add this PR to the release milestone

github-actions · 2022-11-23T19:13:04Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

brad-decker · 2022-11-23T19:38:34Z

yarn.lock

@@ -7293,7 +7309,7 @@ bn.js@>4.0.0, bn.js@^5.1.1, bn.js@^5.1.2, bn.js@^5.1.3, bn.js@^5.2.0, bn.js@^5.2
  resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-5.2.1.tgz#0bc527a6a0d18d0aa8d5b0538ce4a77dccfa7b70"
  integrity sha512-eXRvHzWyYPBuB4NBy0cmYQjGitUrtqwbvlzP3G6VFnNRbsZQIxQ10PbKKHt8gZ/HW/D/747aDl+QkDqg3KQLMQ==

-bn.js@^4.0.0, bn.js@^4.1.0, bn.js@^4.1.1, bn.js@^4.11.0, bn.js@^4.11.6, bn.js@^4.11.7, bn.js@^4.11.8, bn.js@^4.11.9:
+bn.js@^4.0.0, bn.js@^4.1.0, bn.js@^4.1.1, bn.js@^4.11.0, bn.js@^4.11.6, bn.js@^4.11.7, bn.js@^4.11.8, bn.js@^4.11.9, bn.js@^4.4.0:


@kumavis has a PR open to deduplicate a bunch of these #16410 -- Could you see if you can pin your package to use a version that is corresponding to that PR?

I'll dig into this Brad and see if we can't get it aligned

Hey Brad!

We tried a couple things to pin the dependency but it looks like the node v16 (dictating the npm version) in the .nvmrc as well as the pinned yarn v1.6 in the package.json engines flag are too outdated to appropriately do this.

Regarding the npm version: It looks like node v16 is using npm v8.17. The NPM overrides call dictated here that can be used to pin nested dependencies is only supported on v8.30 and up.

Regarding the yarn version: We tried doing different variations of this

"resolutions": { ... "@unstoppabledomains/resolution/**/bn.js": "^4.11.6" },

But because the unstoppable package name includes a '/' (@unstoppabledomains/resolution) is seems there is a bug in yarn that won't recognize the pin. It was fixed in yarn 2.0 and wasn't backported. related yarn issue here

Very open to any ideas you might have to pin as the devDependency for the resolution library uses bn.js v4.11.6 which is referenced in #16410 so if we can find a way to pin the dependency to that we should be OK.

brad-decker · 2022-11-23T19:39:28Z

yarn.lock

+crypto-js@^4.1.1:
+  version "4.1.1"
+  resolved "https://registry.yarnpkg.com/crypto-js/-/crypto-js-4.1.1.tgz#9e485bcf03521041bd85844786b83fb7619736cf"
+  integrity sha512-o2JlM7ydqd3Qk9CA0L4NL6mTzU2sdx96a+oOfPu8Mkl/PK51vSyoi8/rQ8NknZtk44vq15lmhAj9CIAGwgeWKw==
+


Can you describe what crypto-js is used for in your package? Links to code is fine.

I can ask our dev team for specifics (might not get a clear answer) - I don't know what crypto.js does. Here's a link to their repo. https://github.com/brix/crypto-js

i meant how its being used in these packages, not what the library does, just to clarify

We're using the crypto.js package for hashing algorithms: eip137 (sha3) and zns (sha256) in the resolution library.

https://github.com/unstoppabledomains/resolution/blob/09079329a3545d0f344585d898f9f19cac4eeb9b/src/utils/namehash.ts

brad-decker · 2022-11-23T19:52:22Z

app/scripts/lib/ipfs-resolution/setup.js

    const { tabId, url } = details;
+    console.log('details', details);
    // ignore requests that are not associated with tabs
-    // only attempt ENS resolution on mainnet
+    // only attempt resolution on mainnet
    if (tabId === -1 || getCurrentChainId() !== '0x1') {
      return;
    }
-    // parse ens name
+    // parse domain name
    const { hostname: name, pathname, search, hash: fragment } = new URL(url);
+    // if domain name contains an Unstoppable TLD, it will attempt tp resolve to IPFS
+    udTlds.forEach((tld) => {
+      if (name.toLowerCase().endsWith(`.${tld}`)) {
+        attemptResolveUns(tabId, name);
+      }
+    });
+
    const domainParts = name.split('.');
    const topLevelDomain = domainParts[domainParts.length - 1];
    // if unsupported TLD, abort
-    if (!supportedTopLevelDomains.includes(topLevelDomain)) {
+    if (!supportedEnsTopLevelDomains.includes(topLevelDomain)) {
      return;
    }
-    // otherwise attempt resolve
-    attemptResolve({ tabId, name, pathname, search, fragment });
+    // otherwise attempt resolve for ENS
+    attemptResolveEns({ tabId, name, pathname, search, fragment });


@bbehrman10 i'm a noob at IPFS resolution. Will a domain that was registered via ENS be resolved through the 'attemptResolveUns' method? I'm trying to get a sense for if the order you inserted the logic is going to result in a meaningful change to the amount of traffic that MetaMask sends ENS. If its feasible that this change will result in a decrease in ENS usage from within MetaMask then we need to provide a user preference toggle for ENS vs UD resolution and re-order our checks so that it follows that preference. In that case we need to default to ENS for that preference and put in a "whats new" thing explaining that they can now use UD. In any case we can always fall back to the other if it isn't resolved via the user's preference.

So in the case of ENS preferred we attempt ENS resolution and if not then UD, if UD is preferred, reverse the paradigm.

ENS addresses will resolve using the attemptResolveEns (it's the same function as it was before we just added the Ens identifier

it will not impact ENS traffic at all - UD does not resolve the .eth TLD at this time. If that changes, I agree we will need to create an option to toggle preference

my question is if a .eth address is purchased via ENS and then we attempt to resolve it using UD what will the result be?

the way it's written, .eth will always go to ENS and the UD TLDs will all go to UD

Hi Makoto from ENS team. Please be aware that ENS is not just .eth but the users can import DNS names as ENS, such as .xyz, .io, etc.

https://medium.com/the-ethereum-name-service/announcing-support-for-xyz-on-ens-7f5bc7fe1b24
https://medium.com/the-ethereum-name-service/full-dns-namespace-integration-to-ens-now-on-mainnet-9d37270807d3

Even if UD never extends to .eth, it has the danger of future conflicts with the DNS imported ENS names whenever ICANN extends tlds (the last extension happened back in 2012 so the new round is expected to happen soon).

brad-decker · 2022-11-23T19:53:11Z

app/manifest/v2/_base.json

+    "*://*.wallet/",
+    "*://*.blockchain/",
+    "*://*.888/",
+    "*://*.zil/",


We'll need to look into what changes we might need to make to manifest v3 as well

yeah, weren't sure what was needed in manifest v3

Doesn't look like the ENS ipfs resolution needed to be in manifest v3 but we'll need to defer to you @brad-decker if this is something we need to add.

V-Shadbolt · 2022-11-29T18:19:42Z

Hey @brad-decker ! Just wanted to ping incase the above got missed. Looking forward to the feedback!

V-Shadbolt · 2022-12-12T17:07:29Z

Hey @brad-decker ! Just following up. Have you had the opportunity to look through the above?

V-Shadbolt · 2023-01-09T23:46:17Z

Hey @brad-decker. Any update for @bbehrman10 and I?

socket-security · 2023-04-11T19:31:38Z

New dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No new dependency issues detected in pull request

Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore [email protected] bar@* or ignore all packages with @SocketSecurity ignore-all

Pull request alert summary

Issue	Status
Install scripts	✅ 0 issues
Native code	✅ 0 issues
Bin script shell injection	✅ 0 issues
Unresolved require	✅ 0 issues
Invalid package.json	✅ 0 issues
HTTP dependency	✅ 0 issues
Git dependency	✅ 0 issues
Potential typo squat	✅ 0 issues
Known Malware	✅ 0 issues
Telemetry	✅ 0 issues
Protestware/Troll package	✅ 0 issues

📊 Modified Dependency Overview:

➕ Added Package	Capability Access	`+/-` Transitive Count	Publisher
@unstoppabledomains/[email protected]	None	`+0`	vshadbolt
@unstoppabledomains/[email protected]	None	`+1`	dchan0319

github-actions · 2023-07-20T13:46:16Z

This PR has been automatically marked as stale because it has not had recent activity in the last 60 days. It will be closed in 14 days. Thank you for your contributions.

github-actions · 2023-09-23T22:04:27Z

This PR has been automatically marked as stale because it has not had recent activity in the last 60 days. It will be closed in 14 days. Thank you for your contributions.

github-actions · 2023-12-05T00:16:15Z

This PR has been automatically marked as stale because it has not had recent activity in the last 60 days. It will be closed in 14 days. Thank you for your contributions.

github-actions · 2023-12-19T02:14:48Z

This PR was closed because there has been no follow up activity in the last 14 days. Thank you for your contributions.

V-Shadbolt and others added 5 commits November 21, 2022 16:58

add unstoppable domains packages

b20e124

add uns ipfs resolution

f9c0432

combines ENS & UNS IPFS resolution, still needs lavamoat fixes

07d0417

fixes policy file problems

722d70b

Merge branch 'MetaMask:develop' into uns-ipfs

88dc87b

V-Shadbolt requested review from a team and kumavis as code owners November 23, 2022 19:12

V-Shadbolt requested a review from ryanml November 23, 2022 19:12

bbehrman10 mentioned this pull request Nov 23, 2022

Add ud resolution #15817

Closed

6 tasks

linting

974b506

brad-decker suggested changes Nov 23, 2022

View reviewed changes

V-Shadbolt added 9 commits March 9, 2023 10:33

Merge branch 'develop' into uns-ipfs

1d7f9ea

fix merge conflicts and policy files

f6467ea

updated uns ipfs tlds and logic

ff8381a

flask and mozilla lint test fixes

61ca4be

Merge branch 'develop' into uns-ipfs

c51f355

Merge branch 'develop' into uns-ipfs

e9c9382

improved error messaging and tld support

9ce42f7

minor renaming for consistency

2c2370f

Merge branch 'develop' into uns-ipfs

51fc8e8

github-actions bot added the stale issues and PRs marked as stale label Jul 20, 2023

updated tlds resolver keys package

9619f3a

V-Shadbolt requested review from a team as code owners July 25, 2023 21:41

github-actions bot removed the stale issues and PRs marked as stale label Jul 25, 2023

github-actions bot added the stale issues and PRs marked as stale label Sep 23, 2023

updated tlds resolver keys package to latest

04648a2

github-actions bot removed the stale issues and PRs marked as stale label Oct 6, 2023

github-actions bot added the stale issues and PRs marked as stale label Dec 5, 2023

github-actions bot closed this Dec 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unstoppable Domains IPFS Resolution #16664

Unstoppable Domains IPFS Resolution #16664

V-Shadbolt commented Nov 23, 2022

github-actions bot commented Nov 23, 2022

brad-decker Nov 23, 2022

V-Shadbolt Nov 23, 2022

V-Shadbolt Nov 25, 2022

brad-decker Nov 23, 2022

bbehrman10 Nov 23, 2022

brad-decker Nov 23, 2022

V-Shadbolt Nov 23, 2022

bbehrman10 Nov 23, 2022

brad-decker Nov 23, 2022

bbehrman10 Nov 23, 2022

bbehrman10 Nov 23, 2022 •

edited

Loading

brad-decker Nov 23, 2022

bbehrman10 Nov 23, 2022

makoto Mar 3, 2023

brad-decker Nov 23, 2022

bbehrman10 Nov 23, 2022

V-Shadbolt Nov 24, 2022

V-Shadbolt commented Nov 29, 2022

V-Shadbolt commented Dec 12, 2022

V-Shadbolt commented Jan 9, 2023

socket-security bot commented Apr 11, 2023

github-actions bot commented Jul 20, 2023

github-actions bot commented Sep 23, 2023

github-actions bot commented Dec 5, 2023

github-actions bot commented Dec 19, 2023

Unstoppable Domains IPFS Resolution #16664

Unstoppable Domains IPFS Resolution #16664

Conversation

V-Shadbolt commented Nov 23, 2022

Explanation

Usage

More Information

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Nov 23, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bbehrman10 Nov 23, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

V-Shadbolt commented Nov 29, 2022

V-Shadbolt commented Dec 12, 2022

V-Shadbolt commented Jan 9, 2023

socket-security bot commented Apr 11, 2023

github-actions bot commented Jul 20, 2023

github-actions bot commented Sep 23, 2023

github-actions bot commented Dec 5, 2023

github-actions bot commented Dec 19, 2023

bbehrman10 Nov 23, 2022 •

edited

Loading