Commit 62f6136
authored
feat(perps): core resolver — providerCredentials, builder fee injection, env var centralization (MetaMask#27899)
## **Description**
Resolves several core-parity and architecture concerns for the perps
controller:
### 1. Backport core-only changes (existing)
- **`stopEligibilityMonitoring()`** — Disables geo-blocking eligibility
checks when `useExternalServices` is toggled off.
- **Dynamic MYX import** — `await import()` → `.then()/.catch()` to
avoid bundling heavy MYX dependencies in extension.
### 2. Nested `providerCredentials` on `PerpsControllerConfig`
- Restructures flat MYX config fields (`myxAppIdTestnet`,
`myxProviderEnabled`, etc.) into `providerCredentials.myx.*`.
- Adds `providerCredentials.hyperliquid.*` for builder fee wallet
addresses.
- New types: `PerpsProviderCredentials`, `HyperLiquidCredentials`,
`MYXCredentials`.
### 3. Builder fee address injection
- `HyperLiquidProvider` accepts optional
`builderAddressTestnet`/`builderAddressMainnet` via constructor.
- Falls back to hardcoded `BUILDER_FEE_CONFIG` defaults when env vars
are empty.
- New env vars in `.js.env.example`:
`MM_PERPS_HL_BUILDER_ADDRESS_TESTNET`,
`MM_PERPS_HL_BUILDER_ADDRESS_MAINNET`.
### 4. Env var centralization in mobile adapter
- New `createMobileClientConfig()` in `mobileInfrastructure.ts` — all
`process.env.*` reads in one place.
- Engine init (`perps-controller/index.ts`) reduced from ~73 to ~37
lines — pure controller wiring, no env var reads.
### 5. MYX dynamic import race condition fix
- `await import()` inside non-async `#createProviders(): void` →
`.then()/.catch()` chain.
- Removes `@ts-expect-error` suppression. Fixes provider setup race
condition flagged by bugbot.
## **Changelog**
CHANGELOG entry: null
## **Related issues**
Fixes: N/A — architecture cleanup + core parity
## **Manual testing steps**
```gherkin
Feature: Provider credentials and builder fee injection
Scenario: HyperLiquid uses env-var builder address when set
Given MM_PERPS_HL_BUILDER_ADDRESS_TESTNET is set in .js.env
When a trade is placed on testnet
Then the builder fee uses the env-var address (not hardcoded default)
Scenario: HyperLiquid falls back to default when env var is empty
Given MM_PERPS_HL_BUILDER_ADDRESS_TESTNET is empty
When a trade is placed on testnet
Then the builder fee uses BUILDER_FEE_CONFIG.TestnetBuilder
Scenario: MYX provider registers via dynamic import
Given MYX provider is enabled
When PerpsController initializes
Then MYX registers asynchronously via .then()/.catch()
And initialization completes without waiting for MYX
Scenario: Engine init uses adapter for config
Given the app starts
When PerpsController is initialized
Then clientConfig comes from createMobileClientConfig()
And no process.env reads exist in the Engine init file
```
## **Screenshots/Recordings**
N/A — no UI changes
## **Pre-merge author checklist**
- [x] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile
Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've completed the PR template to the best of my ability
- [x] I've included tests if applicable
- [x] I've documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I've applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
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.
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Medium Risk**
> Touches Perps provider initialization/selection and geo-eligibility
monitoring, which can impact trading availability and protocol routing
if misconfigured. Changes are largely additive but include
async/dynamic-import ordering and new config wiring that should be
validated across networks/providers.
>
> **Overview**
> **Refactors Perps controller configuration to use a nested
`providerCredentials` structure** and centralizes all Perps
`process.env` reads into `createMobileClientConfig()`, simplifying
`perpsControllerInit` to pure wiring.
>
> **Adds HyperLiquid builder-fee address injection** via new env vars
and passes these through `PerpsController` into `HyperLiquidProvider`,
falling back to hardcoded defaults when env values are empty.
>
> **Hardens MYX provider registration and eligibility controls** by
switching MYX to a dynamic `import()` flow with explicit error
handling/awaiting during initialization, adding
`stopEligibilityMonitoring()` (and messenger action typing) to defer
geolocation checks, and extending tests to cover these behaviors.
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
30f6e0a. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->1 parent 6df8a92 commit 62f6136
13 files changed
Lines changed: 872 additions & 106 deletions
File tree
- app
- components/UI/Perps/adapters
- controllers/perps
- providers
- types
- core/Engine/controllers/perps-controller
- docs/perps
- scripts/perps
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
197 | 197 | | |
198 | 198 | | |
199 | 199 | | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
200 | 203 | | |
201 | 204 | | |
202 | 205 | | |
| |||
Lines changed: 63 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
7 | 10 | | |
8 | 11 | | |
9 | 12 | | |
| |||
212 | 215 | | |
213 | 216 | | |
214 | 217 | | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
| 24 | + | |
24 | 25 | | |
| 26 | + | |
25 | 27 | | |
26 | 28 | | |
27 | 29 | | |
| |||
155 | 157 | | |
156 | 158 | | |
157 | 159 | | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
158 | 198 | | |
159 | 199 | | |
160 | 200 | | |
| |||
Lines changed: 7 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
175 | 175 | | |
176 | 176 | | |
177 | 177 | | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
178 | 183 | | |
179 | 184 | | |
180 | 185 | | |
| |||
210 | 215 | | |
211 | 216 | | |
212 | 217 | | |
213 | | - | |
| 218 | + | |
| 219 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| 27 | + | |
| 28 | + | |
27 | 29 | | |
28 | 30 | | |
29 | 31 | | |
| |||
387 | 389 | | |
388 | 390 | | |
389 | 391 | | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
390 | 402 | | |
391 | 403 | | |
392 | 404 | | |
| |||
800 | 812 | | |
801 | 813 | | |
802 | 814 | | |
| 815 | + | |
| 816 | + | |
| 817 | + | |
| 818 | + | |
| 819 | + | |
| 820 | + | |
| 821 | + | |
| 822 | + | |
| 823 | + | |
| 824 | + | |
| 825 | + | |
| 826 | + | |
| 827 | + | |
| 828 | + | |
| 829 | + | |
| 830 | + | |
| 831 | + | |
| 832 | + | |
| 833 | + | |
| 834 | + | |
| 835 | + | |
| 836 | + | |
| 837 | + | |
| 838 | + | |
| 839 | + | |
| 840 | + | |
| 841 | + | |
| 842 | + | |
| 843 | + | |
803 | 844 | | |
804 | 845 | | |
805 | 846 | | |
| |||
4551 | 4592 | | |
4552 | 4593 | | |
4553 | 4594 | | |
| 4595 | + | |
| 4596 | + | |
| 4597 | + | |
| 4598 | + | |
| 4599 | + | |
| 4600 | + | |
| 4601 | + | |
| 4602 | + | |
| 4603 | + | |
| 4604 | + | |
| 4605 | + | |
4554 | 4606 | | |
4555 | 4607 | | |
4556 | 4608 | | |
| |||
4643 | 4695 | | |
4644 | 4696 | | |
4645 | 4697 | | |
| 4698 | + | |
| 4699 | + | |
| 4700 | + | |
| 4701 | + | |
| 4702 | + | |
| 4703 | + | |
| 4704 | + | |
| 4705 | + | |
| 4706 | + | |
| 4707 | + | |
| 4708 | + | |
| 4709 | + | |
| 4710 | + | |
| 4711 | + | |
| 4712 | + | |
| 4713 | + | |
| 4714 | + | |
| 4715 | + | |
| 4716 | + | |
| 4717 | + | |
| 4718 | + | |
| 4719 | + | |
| 4720 | + | |
| 4721 | + | |
| 4722 | + | |
| 4723 | + | |
| 4724 | + | |
| 4725 | + | |
| 4726 | + | |
| 4727 | + | |
| 4728 | + | |
| 4729 | + | |
| 4730 | + | |
| 4731 | + | |
| 4732 | + | |
| 4733 | + | |
| 4734 | + | |
| 4735 | + | |
| 4736 | + | |
| 4737 | + | |
| 4738 | + | |
| 4739 | + | |
| 4740 | + | |
| 4741 | + | |
| 4742 | + | |
| 4743 | + | |
| 4744 | + | |
| 4745 | + | |
| 4746 | + | |
| 4747 | + | |
| 4748 | + | |
| 4749 | + | |
| 4750 | + | |
4646 | 4751 | | |
4647 | 4752 | | |
4648 | 4753 | | |
| |||
5675 | 5780 | | |
5676 | 5781 | | |
5677 | 5782 | | |
| 5783 | + | |
| 5784 | + | |
| 5785 | + | |
| 5786 | + | |
| 5787 | + | |
| 5788 | + | |
| 5789 | + | |
| 5790 | + | |
| 5791 | + | |
| 5792 | + | |
| 5793 | + | |
| 5794 | + | |
| 5795 | + | |
| 5796 | + | |
| 5797 | + | |
| 5798 | + | |
| 5799 | + | |
| 5800 | + | |
| 5801 | + | |
| 5802 | + | |
| 5803 | + | |
| 5804 | + | |
| 5805 | + | |
| 5806 | + | |
| 5807 | + | |
| 5808 | + | |
| 5809 | + | |
| 5810 | + | |
| 5811 | + | |
| 5812 | + | |
| 5813 | + | |
| 5814 | + | |
| 5815 | + | |
| 5816 | + | |
| 5817 | + | |
| 5818 | + | |
| 5819 | + | |
| 5820 | + | |
| 5821 | + | |
| 5822 | + | |
| 5823 | + | |
| 5824 | + | |
| 5825 | + | |
| 5826 | + | |
| 5827 | + | |
| 5828 | + | |
| 5829 | + | |
| 5830 | + | |
| 5831 | + | |
| 5832 | + | |
| 5833 | + | |
| 5834 | + | |
| 5835 | + | |
| 5836 | + | |
| 5837 | + | |
| 5838 | + | |
| 5839 | + | |
| 5840 | + | |
| 5841 | + | |
| 5842 | + | |
| 5843 | + | |
| 5844 | + | |
| 5845 | + | |
| 5846 | + | |
| 5847 | + | |
| 5848 | + | |
| 5849 | + | |
| 5850 | + | |
| 5851 | + | |
| 5852 | + | |
| 5853 | + | |
| 5854 | + | |
| 5855 | + | |
| 5856 | + | |
| 5857 | + | |
| 5858 | + | |
| 5859 | + | |
| 5860 | + | |
| 5861 | + | |
| 5862 | + | |
| 5863 | + | |
| 5864 | + | |
| 5865 | + | |
| 5866 | + | |
| 5867 | + | |
| 5868 | + | |
| 5869 | + | |
| 5870 | + | |
| 5871 | + | |
| 5872 | + | |
0 commit comments