BREAKING: TS Refactor

[gantunesr]

BREAKING: TS Migration

This PR introduces the following changes,

• Refactors the KeyringController code and tests to TypeScript.
• Add guards logic to ensure the correct logic flow.
• Updates the package configuration
• Updates error messages

Description

Itemize the changes you have made into the categories below

• BREAKING:

  • The addNewKeyring method now expects an object containing the property privateKeys of type string[] in the case the keyring to be added is a "Simple Keyring".

• FIXED:

  • Method getKeyringForAccount
    • Add async keyword for method returning a Promise
    • Update conditional statements

• CHANGED:

  • Method createNewVaultAndRestore
    • Add guard logic in case keyring is undefined.
  • Method addNewKeyring
    • Add guard logic in case keyring is undefined.
    • Add guard logic in case the method generateRandomMnemonic doesn't exist in the current keyring
  • Method exportAccount
    • Add guard logic in case the method exportAccount doesn't exist in the current keyring
  • Method signTransaction
    • Add guard logic in case the method signTransaction doesn't exist in the current keyring
  • Method signMessage
    • Add guard logic in case the method signMessage doesn't exist in the current keyring
  • Method signPersonalMessage
    • Add guard logic in case the method signPersonalMessage doesn't exist in the current keyring
  • Method getEncryptionPublicKey
    • Add guard logic in case the method getEncryptionPublicKey doesn't exist in the current keyring
  • Method decryptMessage
    • Add guard logic in case the method decryptMessage doesn't exist in the current keyring
  • Method getAppKeyAddress
    • Add guard logic in case the method getAppKeyAddress doesn't exist in the current keyring
  • Method unlockKeyrings
    • Add guard logic in case the encryptionKey data type is not a string
    • Add guard logic in case the password data type is not a string
    • Logic updated to handle errors
  • Method getKeyringForAccount
    • Update conditional statements
  • Method restoreKeyring
    • Now is a private method
    • Logic updated to handle errors
  • Method clearKeyrings
    • Now is a private method
  • Method newKeyring
    • Now is a private method

Checklist

• Tests are included if applicable
• Any added code is fully documented

Issue

Progresses #195

[mcmire]

Did a second pass comparing the JS and TS implementations. Looks like there's still one comment from me and @Gudahtt that is outstanding, but other than that this all seems to make sense to me, so nice job. I just found a few more things other than that, mostly minor.

One thing I noticed is that some of the methods that were previously public (but placed in a private section) are now actually private. Is it worth noting these in the PR description?

[gantunesr]

Hey @mcmire,

Thanks for the review, I wasn't able to dedicate time to find the best solution for the unresolved comments,

• encryptor type (BREAKING: TS Refactor #202 (comment))
• The ObservableStore comment, this one particularly is throwing this error Cannot use namespace 'ObservableStore' as a type. (BREAKING: TS Refactor #202 (comment))

[mcmire]

@gantunesr Okay no problem! Thanks for trying. Maybe we can address the encryptor one at least in the future.

[socket-security]

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 foo@1.0.0 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
@metamask/utils@5.0.0	None	+30	metamaskbot
@metamask/eslint-config-typescript@11.1.0	None	+5	metamaskbot
@ethereumjs/tx@4.1.1	None	+26	holgerd77
depcheck@1.4.3	filesystem	+30	rumpl
ts-node@10.9.1	filesystem, shell, environment	+15	cspotcode
@types/sinon@10.0.13	None	+1	types
ts-jest@29.0.5	filesystem, environment	+77	kul
eslint-plugin-jsdoc@40.1.0	None	+2	gajus
@types/jest@29.5.0	None	+14	types
@typescript-eslint/parser@5.57.0	None	+0	jameshenry
@typescript-eslint/eslint-plugin@5.57.0	None	+3	jameshenry
typedoc@0.23.28	filesystem, shell, environment	+9	typedoc-bot

⬆️ Updated Package	Version Diff	Capability Access	+/- Transitive Count	Publisher
jest@29.5.0	27.5.1...29.5.0	None	+73/-103	simenb
sinon@15.0.3	11.1.2...15.0.3	None	+2/-3	fatso83

🚮 Removed packages:@metamask/eslint-config-commonjs@11.1.0

[mcmire]

Noticed some more typecasts in the tests. We should also try to remove those in future PRs. I was curious about one of them, but it isn't blocking. LGTM.