feat: NWNT-681: Add useTronStakeApy hook

[Matt561]

Description

Added new useTronStakeApy hook.

Changes:

• Added useTronStakeApy hook which fetches all witness data and returns the APY for the Consensys witness and exposes the following properties:
  • isLoading: returns true if actively fetching witness data.
  • errorMessage: error message if fetch fails
  • apyDecimal: Consensys witness/SR annualizedRate in decimal form
  • apyPercent: Consensys witness/SR annualizedRate in percentage form
  • refetch: Allows refetching of witness data
• Bumped @metamask/stake-sdk to ^3.4.0.
• Added truncateNumber util. This is used to format the Tron staking APY without rounding.

Note: useTronStakeApy calls getWitnesses from the stake-sdk which fetches all witnesses data. Meaning if additional data besides the APR is desired this function can be reused elsewhere.

Changelog

CHANGELOG entry: added useTronStakeApy hook

Related issues

Fixes: NWNT-681: Add tron staking apy to client

Manual testing steps

Feature: my feature name

  Scenario: user [verb for user action]
    Given [describe expected initial app state]

    When user [verb for user action]
    Then [describe expected outcome]

Screenshots/Recordings

Before

N/A

After

N/A

Pre-merge author checklist

• I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
• I've completed the PR template to the best of my ability
• I’ve included tests if applicable
• I’ve documented my code using JSDoc format if applicable
• I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

• I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
• I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

---

Note

Adds useTronStakeApy hook to fetch Consensys TRON witness APY, introduces truncateNumber, exposes tronStakingApiService, and bumps @metamask/stake-sdk to ^3.4.0 with tests.

• Hooks:
  • Add useTronStakeApy to fetch witnesses via tronStakingApiService.getWitnesses (default TRON_MAINNET), compute apyDecimal/apyPercent, handle loading/error, and support refetch/chainId options.
• Utils:
  • Add truncateNumber in app/components/UI/Earn/utils/number.ts for 2-decimal truncation without rounding.
• SDK/Provider:
  • Expose tronStakingApiService from earnApiService.tronStaking in app/components/UI/Stake/sdk/stakeSdkProvider.tsx.
• Dependencies:
  • Bump @metamask/stake-sdk to ^3.4.0.
• Tests:
  • Add comprehensive tests for useTronStakeApy and truncateNumber.

^{Written by Cursor Bugbot for commit a42d1d4. This will update automatically on new commits. Configure here.}

[github-actions]

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.

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	npm/​@​metamask/​stake-sdk@​3.3.0 ⏵ 3.4.0	+1		+1	+6

View full report

[zone-live]

Should we also clear the error on a new fetch? with setErrorMessage(null);
Just in case there's any.
I can add this after its merged.

[zone-live]

Just a minor comment. Looks great 💪🏼

[nickewansmith]

Approved to unblock, with comment

[github-actions]

🔍 Smart E2E Test Selection

• Selected E2E tags: SmokeStake, SmokeTrade
• Risk Level: medium
• AI Confidence: 80%

click to see 🤖 AI reasoning details

The PR introduces TRON staking support by:

1. Upgrading @metamask/stake-sdk from 3.2.0 to 3.4.0 (minor version bump)
2. Adding a new tronStakingApiService export from stakeSdkProvider
3. Creating a new useTronStakeApy hook for TRON staking APY
4. Adding a truncateNumber utility function

The changes are primarily additive (new TRON staking functionality) rather than modifying existing code paths. The stake-sdk upgrade follows semver with a minor version bump, suggesting backward compatibility. However, since this upgrades a core staking SDK dependency and touches the staking infrastructure, running staking-related tests is appropriate.

The existing stake E2E test (stake-action-smoke.spec.ts) uses SmokeTrade tag and tests ETH pooled staking functionality. SmokeStake is also selected to cover any additional staking test coverage that may exist. The changes don't affect confirmations, wallet core, accounts, or other unrelated features.

Unit tests have been added for the new hook and utility function, which increases confidence in the implementation.

View GitHub Actions results

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud