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

Introduces useTronStakeApy to fetch Consensys witness APY on Tron (mainnet/Nile), adds truncateNumber util, wires tronStakingApiService, and bumps @metamask/stake-sdk to ^3.4.0.

• Earn:
  • Hook: Add useTronStakeApy (app/components/UI/Earn/hooks/useTronStakeApy.ts)
    • Fetches witnesses via tronStakingApiService.getWitnesses(chainId) and extracts Consensys APY.
    • Exposes isLoading, errorMessage, apyDecimal, apyPercent, refetch; supports fetchOnMount and ChainId.TRON_MAINNET|TRON_NILE.
  • Utils: Add truncateNumber in app/components/UI/Earn/utils/number.ts for 2-decimal truncation without rounding.
• SDK provider:
  • Export tronStakingApiService from app/components/UI/Stake/sdk/stakeSdkProvider.tsx.
• Tests:
  • Add comprehensive tests for useTronStakeApy and truncateNumber.
• Dependencies:
  • Bump @metamask/stake-sdk to ^3.4.0.

^{Written by Cursor Bugbot for commit 3fae5ca. 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

[github-actions]

🔍 Smart E2E Test Selection

• Selected E2E tags: SmokeStake
• Risk Level: medium
• AI Confidence: 85%

click to see 🤖 AI reasoning details

The PR introduces Tron staking support through several focused changes:

1. SDK Upgrade: @metamask/stake-sdk upgraded from v3.2.0 to v3.4.0 - this is a minor version bump that likely adds Tron staking support

2. New Tron Staking Service: A new tronStakingApiService export is added to stakeSdkProvider.tsx which exposes Tron staking functionality from the upgraded SDK

3. New Hook - useTronStakeApy: Creates a React hook for fetching Tron staking APY from Consensys witnesses for both TRON_MAINNET and TRON_NILE chains

4. Utility Function: A new truncateNumber function for formatting APY display values

All changes are confined to the Stake/Earn feature area:

• app/components/UI/Stake/sdk/ - SDK provider modifications
• app/components/UI/Earn/hooks/ - New Tron APY hook
• app/components/UI/Earn/utils/ - Number formatting utilities

The changes don't affect core wallet functionality, confirmations, account management, or network switching. The SDK provider is only imported by stake/earn-related components based on the importer analysis. This is a feature addition with proper unit tests, making it a medium-risk change that should be validated with the SmokeStake tag.

View GitHub Actions results

[cursor]

Bug: Error message persists after successful fetch

The fetchConsensysWitness function does not clear errorMessage on success. While refetch properly calls setErrorMessage(null) before fetching, the useEffect calls fetchConsensysWitness directly. If chainId changes after a previous fetch failure, the subsequent successful fetch will update apyDecimal and apyPercent but leave the stale errorMessage in state, resulting in an inconsistent hook return where valid APY data coexists with an error message.

 

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
1 Security Hotspot
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud