feat: add earn controller package #5210

amitabh94 · 2025-01-29T03:25:34Z

This PR adds the new earn controller that will support both existing products like Pooled staking and upcoming products like stablecoin lending .

This is the first version of the controller and currently initailizes the stake-sdk and implements functions to fetch staking data and update state.

References

Related to STAKE-896

Changelog

`@metamask/earn-controller`

ADDED: Initial release of the EarnController package for managing DeFi earning opportunities
ADDED: Support for pooled staking products with features:
- Automatic state management for staking data
- Real-time updates on network and account changes
- Integration with @metamask/stake-sdk
- Eligibility checks for staking products
ADDED: Support for stablecoin lending products with state management for:
- Vault information (APY, liquidity, supply)

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
I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

This addition enhances the MetaMask ecosystem by providing a dedicated controller for earning functionalities.

…and testing scripts

This commit significantly improves the test suite for EarnController by: - Adding detailed tests for constructor initialization - Implementing mock implementations for SDK and API services - Covering SDK initialization and network change scenarios - Testing data fetching and error handling methods - Verifying subscription handlers for network and account changes

socket-security · 2025-01-29T03:26:50Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected]	network	`0`	184 kB	metamaskbot

View full report↗︎

socket-security · 2025-01-29T03:26:51Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: npm/@metamask/[email protected]

View full report↗︎

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

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

amitabh94 · 2025-01-29T03:32:42Z

@SocketSecurity ignore npm/@metamask/[email protected]

This package is already being used in the mobile codebase adn is dedicated library for earn products

This commit enhances the EarnController by: - Splitting data fetching into separate try-catch blocks for more granular error handling - Improving SDK initialization error logging - Updating method names for clarity (fetchAndUpdateStakingData -> refreshPooledStakingData) - Adding additional test cases for error scenarios and edge cases - Ensuring default state is always initialized for pooled staking

Matt561

LGTM! I'm excited to start using this 😄

eslint-warning-thresholds.json

packages/earn-controller/src/EarnController.ts

mcmire

Hello! Since this is a new controller I wanted to make sure this controller follows the same or similar standards that we have for other controllers. It looks pretty good! I had some tips on better ways to write tests, I spotted a dependency that might not be in the right place, and I noticed a few things in the controller that you might want to take a closer look at. Let me know what you think.

packages/earn-controller/src/EarnController.ts

packages/earn-controller/src/index.ts

packages/earn-controller/package.json

packages/earn-controller/src/EarnController.test.ts

packages/earn-controller/src/EarnController.ts

This commit enhances the EarnController by: - Splitting data fetching methods into separate functions for better modularity - Implementing a more robust error handling approach in refreshPooledStakingData - Updating test suite to match new implementation - Improving network state change detection - Simplifying SDK initialization and network change logic

…pendencies

…am-earn'

nickewansmith

LGTM

mcmire

Just one more question.

packages/earn-controller/src/EarnController.ts

mcmire · 2025-01-31T20:29:00Z

packages/earn-controller/tsconfig.build.json

+    "baseUrl": "./",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "skipLibCheck": true


Hmm, I just noticed this. Generally we do not turn this setting on because it means that this package is not being fully type-checked. Any issues that we would discover with dependencies are being suppressed here and we are likely to run into them again with clients.

Is there a reason why we are doing this?

Good catch! I believe I was looking at accounts-controller while trying to align the initial setup of these files.

I have removed it now and we might want to remove this check from some other controllers as well in a future PR.

mcmire

LGTM! Thanks for your patience in responding to my feedback!

amitabh94 added 8 commits January 28, 2025 20:35

feat: add @metamask/earn-controller package

8a5918c

This addition enhances the MetaMask ecosystem by providing a dedicated controller for earning functionalities.

feat: add stake-sdk dependency and update earn-controller package

ceb6a86

fix: update earn-controller package.json for improved module exports …

aa97f71

…and testing scripts

feat: assign earn-controller to staking team

e7fd2ec

chore: update earn-controller dependencies and typeScript configuration

786d84b

feat: add method to fetch staking data and update state

1051206

refactor: update stablecoin lending product type and default state

4296194

amitabh94 added 2 commits January 28, 2025 21:57

feat: enhance EarnController network change and SDK initialization tests

a29df11

amitabh94 marked this pull request as ready for review January 29, 2025 05:40

amitabh94 enabled auto-merge (squash) January 29, 2025 05:41

amitabh94 requested a review from mcmire January 29, 2025 05:41

Matt561 self-requested a review January 29, 2025 15:16

Matt561 previously approved these changes Jan 29, 2025

View reviewed changes

eslint-warning-thresholds.json Outdated Show resolved Hide resolved

packages/earn-controller/src/EarnController.ts Show resolved Hide resolved

mcmire reviewed Jan 29, 2025

View reviewed changes

nickewansmith reviewed Jan 29, 2025

View reviewed changes

packages/earn-controller/src/EarnController.ts Show resolved Hide resolved

nickewansmith reviewed Jan 29, 2025

View reviewed changes

packages/earn-controller/src/EarnController.ts Outdated Show resolved Hide resolved

amitabh94 added 2 commits January 29, 2025 15:33

chore: revert threshold file change

209b9ee

chore: update CODEOWNERS for earn-controller package

1b006b3

amitabh94 dismissed Matt561’s stale review via f92fe00 January 29, 2025 21:40

amitabh94 requested a review from a team as a code owner January 29, 2025 21:40

chore: update earn-controller package dependencies and peer dependencies

f8272ba

amitabh94 force-pushed the STAKE-896-create-new-earn-controller branch from f92fe00 to f8272ba Compare January 29, 2025 21:54

amitabh94 added 3 commits January 29, 2025 16:29

refactor: simplify EarnController state management and remove enum

472d096

feat: improve EarnController test coverage and error handling

aabeb1d

amitabh94 added 3 commits January 30, 2025 22:20

Merge branch 'main' into STAKE-896-create-new-earn-controller

0cb360a

chore: update @metamask/accounts-controller and network-controller de…

d4c2fe7

…pendencies

chore: update team label for earn-controller from 'team-stake' to 'te…

8f36ebc

…am-earn'

Matt561 self-requested a review January 31, 2025 15:27

nickewansmith previously approved these changes Jan 31, 2025

View reviewed changes

mcmire reviewed Jan 31, 2025

View reviewed changes

amitabh94 added 2 commits January 31, 2025 17:22

feat: add JSDoc for controller methods

edfe0a8

chore: remove skipLibCheck from tsconfig.build.json

db7a6c1

amitabh94 dismissed nickewansmith’s stale review via db7a6c1 January 31, 2025 23:27

Merge branch 'main' into STAKE-896-create-new-earn-controller

b76aed1

Matt561 approved these changes Jan 31, 2025

View reviewed changes

mcmire approved these changes Jan 31, 2025

View reviewed changes

amitabh94 merged commit 2ec8c03 into main Jan 31, 2025
127 checks passed

amitabh94 deleted the STAKE-896-create-new-earn-controller branch January 31, 2025 23:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add earn controller package #5210

feat: add earn controller package #5210

amitabh94 commented Jan 29, 2025 •

edited

Loading

socket-security bot commented Jan 29, 2025 •

edited

Loading

socket-security bot commented Jan 29, 2025 •

edited

Loading

amitabh94 commented Jan 29, 2025

Matt561 left a comment

mcmire left a comment •

edited

Loading

nickewansmith left a comment

mcmire left a comment

mcmire Jan 31, 2025 •

edited

Loading

amitabh94 Jan 31, 2025

mcmire left a comment

feat: add earn controller package #5210

feat: add earn controller package #5210

Conversation

amitabh94 commented Jan 29, 2025 • edited Loading

References

Changelog

@metamask/earn-controller

Checklist

socket-security bot commented Jan 29, 2025 • edited Loading

socket-security bot commented Jan 29, 2025 • edited Loading

Next steps

amitabh94 commented Jan 29, 2025

Matt561 left a comment

Choose a reason for hiding this comment

mcmire left a comment • edited Loading

Choose a reason for hiding this comment

nickewansmith left a comment

Choose a reason for hiding this comment

mcmire left a comment

Choose a reason for hiding this comment

mcmire Jan 31, 2025 • edited Loading

Choose a reason for hiding this comment

amitabh94 Jan 31, 2025

Choose a reason for hiding this comment

mcmire left a comment

Choose a reason for hiding this comment

amitabh94 commented Jan 29, 2025 •

edited

Loading

`@metamask/earn-controller`

socket-security bot commented Jan 29, 2025 •

edited

Loading

socket-security bot commented Jan 29, 2025 •

edited

Loading

mcmire left a comment •

edited

Loading

mcmire Jan 31, 2025 •

edited

Loading