[phishing-controller] Add PhishingDetector from eth-phishing-detector

[mikesposito]

Explanation

This PR adds the PhishingDetector class from eth-phising-detector, along with some utility functions into the @metamask/phishing-controller package, converting all to Typescript and Jest.

References

Changelog

@metamask/phishing-detector

• ADDED: Added PhishingDetector from eth-phising-detector
  • The class, utils and tests have been converted to typescript

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• I've highlighted breaking changes using the "BREAKING" category above as appropriate

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	None	0	21.3 kB	ka-weihe

View full report↗︎

[mikesposito]

Main files from eth-phishing-detector original package have been added in this commit 1775471 for an easier diff

[mikesposito]

These two were originally public in eth-phishing-detector, but looks like they are not used outside of this class - we should be able to prepend # to these without issues

[mikesposito]

This might be confusing, but the main difference between the options passed to the constructor, and the configs saved in #configs (PhishingDetectorConfiguration) is that domains are divided in parts, so each list becomes a matrix

[mikesposito]

This can most likely be merged into the public check method since all the public method does is handle the differences with the legacy result type, so that we don't have two methods with the same name without a clear responsibility distinction.

I'm unsure about doing it in this PR though, since there are many things to review already

[NicholasEllul]

@mikesposito Is the plan to eventually remove the relevant code from https://github.com/MetaMask/eth-phishing-detect/blob/main/src/detector.js and centralize everything here instead?

[mikesposito]

@NicholasEllul exactly! the plan is to leave the eth-phishing-detect package for the configuration only. We'll remove the PhishingDetector implementation from that package once we have it here

[mcmire]

Nice work! A lot of comments here, but most are minor. Only major comments are some questions about the logic in check.

[mcmire]

LGTM!