test(perps): add client recipe validation smoke by abretonc7s · Pull Request #8893 · MetaMask/core

abretonc7s · 2026-05-25T23:47:53Z

Explanation

Adds a minimal headless recipe validation path for @metamask/perps-controller that matches the intended Mobile/Extension boundary: a client calls PerpsController:* messenger actions, and the controller delegates to its services/providers.

This replaces the previous standalone HyperLiquid e2e scripts. The recipe/test no longer imports or constructs HyperLiquid SDK clients directly.

Changes

Removes direct packages/perps-controller/e2e/* HyperLiquid scripts.
Adds @farmslot/recipe-harness as a dev dependency.
Adds packages/perps-controller/recipes/client-smoke.recipe.json plus a small official-action manifest.
Adds packages/perps-controller/recipes/README.md explaining recipes as structured agentic-loop validation compatible with Extension/Mobile validation usage.
Keeps package scripts unchanged; the recipe can be invoked explicitly through yarn workspace @metamask/perps-controller exec farmslot-recipe ....
Adds PerpsController.client-smoke.test.ts, which simulates an installed MetaMask client dispatching controller messenger actions:
- PerpsController:getMarkets
- PerpsController:getPositions
- PerpsController:getAccountState
- PerpsController:placeOrder
- PerpsController:cancelOrder

Farmslot dependency

Already published under the @farmslot npm scope:

@farmslot/protocol@0.5.0
@farmslot/recipe-harness@0.1.0

Validation

yarn install --immutable
NODE_OPTIONS=--experimental-vm-modules yarn workspace @metamask/perps-controller jest --runInBand --no-coverage --runTestsByPath tests/src/PerpsController.client-smoke.test.ts --verbose
yarn workspace @metamask/perps-controller exec farmslot-recipe run recipes/client-smoke.recipe.json --artifacts-dir ../../.recipe-artifacts/perps-controller/client-smoke --action-manifest recipes/headless.action-manifest.json --project-root .
- recipe status: pass
yarn lint
pre-push hook via normal git push

References

Related to feat(perps): sync perps controller may 21 2026 (final) #8871
Related to test(perps): migrate controller unit tests to core #8840
Jira: TAT-2878

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 communicated my changes to consumers by updating changelogs for packages I've changed
I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

Note

Low Risk
Test-only and dev-tooling changes; no published controller API or runtime behavior changes.

Overview
Adds a Farmslot recipe path for @metamask/perps-controller so agentic validation can run repeatable headless checks and collect Jest JSON evidence under gitignored repo-root temp/, without changing package scripts.

The recipe (client-smoke.recipe.json) runs PerpsController.client-smoke.test.ts, asserts exit code and Jest report fields, and indexes artifacts. @farmslot/recipe-harness is added as a dev-only dependency with a small official-action manifest and README for explicit farmslot-recipe invocation.

The new smoke test models Mobile/Extension usage: a client dispatches PerpsController:* messenger actions (getMarkets, getPositions, getAccountState, placeOrder, cancelOrder) through a dispatching mock messenger, with services/providers mocked and no direct HyperLiquid/protocol SDK usage.

^{Reviewed by Cursor Bugbot for commit 17fb836. Bugbot is set up for automated code reviews on this repo. Configure here.}

…upport

socket-security · 2026-05-26T00:30:17Z

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

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@farmslot/recipe-harness@0.2.0

View full report

socket-security · 2026-05-26T00:30:19Z

All alerts resolved. Learn more about Socket for GitHub.

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

View full report

The close order's slippage price was computed from the mid price fetched at script start (step 1), but the close happens at step 6 after leverage setup, order placement, and optional TP/SL — potentially minutes later. Stale price could cause the IOC close to miss and leave the position open.

…efore close - Change TP/SL order grouping from 'na' to 'positionTpsl' so HyperLiquid properly associates trigger orders with the open position. - Re-fetch mid price immediately before computing close order price to avoid stale price from script start causing IOC close to not fill.

abretonc7s · 2026-05-27T03:31:16Z

Automated pr-complete run — #8893

Metric	Value
Run	`6051ea71`
Duration	?
Model	claude/opus
Nudges	0

Worker report

PR #8893 — Comments Report

PR Comments/Checks Addressed

cursor[bot] Review Comments (2 issues)

1. TP/SL orders use wrong grouping value (Medium Severity)

File: packages/perps-controller/e2e/trading-lifecycle.ts:213
Issue: TP/SL orders used grouping: 'na' instead of grouping: 'positionTpsl'. HyperLiquid requires positionTpsl grouping to associate trigger orders with an existing position.
Fix: Changed grouping: 'na' → grouping: 'positionTpsl' on the TP/SL order call.

2. Close order uses stale price from script start (Medium Severity)

File: packages/perps-controller/e2e/trading-lifecycle.ts:225
Issue: Close order derived slippage price from midPrice fetched at script start (step 1), but the close happens much later (step 6). If the market moves >3% during the window, the IOC close order won't fill.
Fix: Added a fresh info.allMids() call immediately before computing closePrice.

Bot Comments (not actionable)

socket-security[bot]: Dependency audit — informational only (viem update), no action needed.

CI Checks

Check changelog: FAILURE — pre-existing; e2e scripts in e2e/ do not require changelog entries (not published).
All lint, build, test, and security checks: SUCCESS.

Files Changed

File	Change
`packages/perps-controller/e2e/trading-lifecycle.ts`	Fixed TP/SL grouping (`na` → `positionTpsl`); re-fetch mid price before close order

Downstream Compatibility Assessment

No impact. Changes are limited to e2e/trading-lifecycle.ts, which is an e2e test script outside the published src/ directory. No public API changes, no type changes, no exports affected. Mobile and Extension clients are not impacted.

Validation Results

Unit tests: 58 suites, 1725 passed, 40 skipped — all green.
Build: Pre-existing TS6305 errors from unbuilt dependency outputs (not related to this change).
Recipe: No inherited recipe artifact present; skipped.

…tion

…feat/perps-e2e-validation # Conflicts: # packages/perps-controller/e2e/trading-lifecycle.ts

…tion

The e2e limit-order script could continue into cancellation and final removal verification after failing to extract a resting order id. The final removal check then compared open orders against null, which made the cleanup verification look successful even though the script did not have a concrete exchange order to cancel or verify.\n\nThe script now records an explicit failure when no resting order id is extracted and exits with the accumulated runner result before any cancellation/removal checks run.\n\nConstraint: Review feedback targeted the e2e script behavior only; keep the production controller surface unchanged.\nRejected: Leave the final null comparison in place | it preserves the misleading cleanup signal reported by Bugbot.\nConfidence: high\nScope-risk: narrow\nTested: yarn workspace @metamask/perps-controller test --bail --no-coverage\nTested: yarn exec eslint packages/perps-controller/e2e/limit-orders.ts\nNot-tested: Live trading scenario execution; HL_E2E_PRIVATE_KEY is not configured in this slot.

…tion

## Explanation Adds a self-contained Recipe v1 headless example for `@metamask/perps-controller`, stacked on #8893. This version avoids using the direct HyperLiquid e2e scripts as the proof path. The recipes now exercise public `PerpsController` methods through a headless in-memory provider so the proof demonstrates controller/service/provider orchestration without UI, wallet credentials, or direct exchange calls. Included recipes: - `market-data.recipe.json`: calls `PerpsController.getMarkets` and asserts the returned market data. - `trading-lifecycle.recipe.json`: calls `placeOrder`, `updatePositionTPSL`, and `closePosition` and asserts each controller result. Also adds local ignore entries for AI/temp artifacts so the pre-push lint hook does not scan local-only state directories. ## Validation - `yarn eslint eslint.config.mjs packages/perps-controller/recipe-v1/runner.ts` - `yarn lint:misc --check packages/perps-controller/package.json packages/perps-controller/tsconfig.json packages/perps-controller/recipe-v1/manifests/perps.action-manifest.json packages/perps-controller/recipe-v1/recipes/market-data.recipe.json packages/perps-controller/recipe-v1/recipes/trading-lifecycle.recipe.json` - `yarn workspace @metamask/perps-controller recipe:market-data` - `yarn workspace @metamask/perps-controller recipe:trading-lifecycle` - `git push` pre-push hook: `yarn lint` passed ## References - Stacked on #8893 ## Checklist - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've updated the test suite for new or updated code as appropriate - [ ] I've updated changelogs for packages I've changed, or this change is internal/dev-only tooling - [ ] I've introduced breaking changes and prepared consumer PRs if needed

This reverts commit b113454.

abretonc7s · 2026-06-01T16:05:07Z

Heads up: PR #8955 was merged into this branch accidentally and then reverted in 93bc64bf2 because that Recipe v1 shape was too intrusive for core.

Replacement direction is to keep core minimal and consume the reusable Farmslot headless harness once @farmslot/protocol + @farmslot/recipe-harness are publishable, instead of embedding a full runner under packages/perps-controller/recipe-v1.

abretonc7s · 2026-06-02T00:32:34Z

@SocketSecurity ignore npm/@farmslot/recipe-harness@0.1.0

Reviewed for this PR: @farmslot/recipe-harness is a dev-only validation runner used by an explicit yarn workspace @metamask/perps-controller exec farmslot-recipe ... command, not production/runtime code. The command execution sink is expected for a trusted, checked-in recipe runner; this PR's recipe runs only the checked-in client-smoke Jest validation through PerpsController:* actions, and the package network capability is not used by the checked-in recipe.

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 6c7cd07. Configure here.}

geositta

Thanks for adding a package native PerpsController client smoke test and a Farmslot recipe around it. The test itself passes, the recipe schema validates, formatting passes, and git diff --check origin/main...HEAD passes.

I am requesting changes because the new headless recipe currently depends on Jest's default Watchman behavior. In a headless agent workspace, the documented recipe command fails before producing the JSON evidence artifact.

Please add --watchman=false to the recipe’s Jest command so the validation recipe runs deterministically in the environment it is designed for.

…tion Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # .gitignore # packages/perps-controller/package.json # yarn.lock

Add --watchman=false to the client-smoke recipe Jest command so headless Farmslot validation does not fail when Watchman is unavailable. Co-authored-by: Cursor <cursoragent@cursor.com>

Move Farmslot artifact paths out of the root .gitignore into a package-local ignore file and use package-local recipe artifact dirs. Co-authored-by: Cursor <cursoragent@cursor.com>

Route client-smoke recipe output and Farmslot evidence under temp/perps-controller/ and ignore temp/ at the repo root instead of maintaining package-local artifact directories. Co-authored-by: Cursor <cursoragent@cursor.com>

abretonc7s · 2026-06-11T01:25:22Z

Closing — superseded by a different design. Recipe/e2e validation for @metamask/perps-controller will be driven externally by the MetaMask recipe runner (the same way Mobile and Extension are driven), so @metamask/core carries no @farmslot/* dependency at all. The real HyperLiquid testnet e2e (order placement, client-bug reproduction) belongs in the runner's headless adapter layer, not as a controller-package dev dependency, and the mocked client-smoke recipe isn't needed standalone.

abretonc7s added 5 commits May 25, 2026 23:51

feat(perps): add e2e validation scripts for real HyperLiquid API testing
17a8f47

chore(perps): include e2e directory in tsconfig
0135d89

fix(perps): resolve eslint errors in e2e scripts
cee9282

style(perps): format e2e scripts with prettier
9ace003

style(perps): format e2e with oxfmt
6893f4d

abretonc7s requested a review from a team as a code owner May 25, 2026 23:47

abretonc7s temporarily deployed to default-branch May 25, 2026 23:48 — with GitHub Actions Inactive

abretonc7s added 2 commits May 26, 2026 08:22

feat(perps): add parameterized trading e2e scripts with viem wallet s…
f3b9ab3
…upport

chore: dedupe yarn.lock after viem addition
241d242

abretonc7s requested a review from a team as a code owner May 26, 2026 00:29

docs(perps): remove farmslot reference from e2e README
9e4489d

cursorBot reviewed May 26, 2026
View reviewed changes

Comment threadpackages/perps-controller/e2e/trading-lifecycle.ts Outdated

style(perps): format README
1954756

cursorBot reviewed May 26, 2026
View reviewed changes

Comment threadpackages/perps-controller/e2e/trading-lifecycle.ts Outdated

abretonc7s added 2 commits May 27, 2026 10:55

Merge remote-tracking branch 'origin/main' into feat/perps-e2e-valida…
8ceeb88
…tion

abretonc7s enabled auto-merge May 27, 2026 03:47

cursorBot reviewed May 27, 2026
View reviewed changes

Comment threadpackages/perps-controller/e2e/limit-orders.ts Outdated

abretonc7s added 3 commits May 28, 2026 23:09

Merge remote-tracking branch 'origin/feat/perps-e2e-validation' into …
a8cc25a
…feat/perps-e2e-validation # Conflicts: # packages/perps-controller/e2e/trading-lifecycle.ts

Merge remote-tracking branch 'origin/main' into feat/perps-e2e-valida…
d45558d
…tion

fix(perps): address PR feedback
8215682

cursorBot reviewed May 28, 2026
View reviewed changes

Comment threadpackages/perps-controller/e2e/limit-orders.ts Outdated

abretonc7s added 3 commits May 29, 2026 16:38

Merge remote-tracking branch 'origin/main' into feat/perps-e2e-valida…
c430634
…tion

Merge remote-tracking branch 'origin/main' into feat/perps-e2e-valida…
2b5f856
…tion

abretonc7s added the no-changelog label May 31, 2026

abretonc7sand others added 2 commits May 31, 2026 20:28

fix(perps): address PR feedback
21e61dd

Merge branch 'main' into feat/perps-e2e-validation
2775a7f

abretonc7s mentioned this pull request Jun 1, 2026
feat(perps): add headless recipe v1 controller example #8955
Merged

cursorBot reviewed Jun 1, 2026
View reviewed changes

Comment threadpackages/perps-controller/e2e/trading-lifecycle.ts Outdated
Comment threadpackages/perps-controller/recipe-v1/runner.ts Outdated

Revert "feat(perps): add headless recipe v1 controller example (#8955)"
93bc64b
This reverts commit b113454.

cursorBot reviewed Jun 1, 2026
View reviewed changes

Comment threadpackages/perps-controller/e2e/trading-lifecycle.ts Outdated
Comment threadpackages/perps-controller/e2e/trading-lifecycle.ts Outdated

abretonc7s mentioned this pull request Jun 1, 2026
test(perps): add Farmslot headless recipe smoke #8957
Closed

abretonc7s added 2 commits June 2, 2026 07:34

test(perps): add Farmslot headless recipe smoke
c23bd40

test(perps): validate client recipe through controller
19ab7d2

abretonc7s changed the title ~~feat(perps): add e2e validation scripts for HyperLiquid API testing~~test(perps): add client recipe validation smokeJun 2, 2026

abretonc7s added 2 commits June 2, 2026 08:11

test(perps): avoid package script for recipe smoke
0b271a7

docs(perps): explain validation recipes
0dbd496

cursorBot reviewed Jun 2, 2026
View reviewed changes

Comment threadpackages/perps-controller/package.json Outdated

cursorBot reviewed Jun 2, 2026
View reviewed changes

Comment threadpackages/perps-controller/tsconfig.json Outdated

fix(perps): remove stale recipe dependencies
2bbe6fa

cursorBot reviewed Jun 2, 2026
View reviewed changes

Comment thread.yarnrc.yml Outdated

abretonc7s added 2 commits June 2, 2026 08:43

fix: keep farmslot behind npm age gate
8e6e15e

test(perps): update Farmslot recipe harness
6c7cd07

cursorBot reviewed Jun 2, 2026
View reviewed changes

Comment thread.gitignore Outdated

geositta requested changes Jun 2, 2026
View reviewed changes

Comment threadpackages/perps-controller/recipes/client-smoke.recipe.json Outdated

abretonc7sand others added 4 commits June 6, 2026 13:24

Merge remote-tracking branch 'origin/main' into feat/perps-e2e-valida…
f35bbcd
…tion Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # .gitignore # packages/perps-controller/package.json # yarn.lock

fix(perps): address PR feedback
1869045
Add --watchman=false to the client-smoke recipe Jest command so headless Farmslot validation does not fail when Watchman is unavailable. Co-authored-by: Cursor <cursoragent@cursor.com>

fix(perps): scope recipe ignores to perps-controller package
5c60e21
Move Farmslot artifact paths out of the root .gitignore into a package-local ignore file and use package-local recipe artifact dirs. Co-authored-by: Cursor <cursoragent@cursor.com>

fix(perps): use gitignored temp/ for recipe artifacts
17fb836
Route client-smoke recipe output and Farmslot evidence under temp/perps-controller/ and ignore temp/ at the repo root instead of maintaining package-local artifact directories. Co-authored-by: Cursor <cursoragent@cursor.com>

abretonc7s closed this Jun 11, 2026

auto-merge was automatically disabled June 11, 2026 01:25
Pull request was closed

Uh oh!

Uh oh!

Conversation

abretonc7s commented May 25, 2026• edited by cursor BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

Changes

Farmslot dependency

Validation

References

Checklist

Uh oh!

socket-securityBot commented May 26, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-securityBot commented May 26, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abretonc7s commented May 27, 2026

Automated pr-complete run — #8893

PR #8893 — Comments Report

PR Comments/Checks Addressed

cursor[bot] Review Comments (2 issues)

Bot Comments (not actionable)

CI Checks

Files Changed

Downstream Compatibility Assessment

Validation Results

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abretonc7s commented Jun 1, 2026

Uh oh!

Uh oh!

Uh oh!

abretonc7s commented Jun 2, 2026

Uh oh!

Uh oh!

cursorBot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

geositta left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abretonc7s commented Jun 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

abretonc7s commented May 25, 2026•
edited by cursor Bot
Loading

socket-securityBot commented May 26, 2026•
edited
Loading

socket-securityBot commented May 26, 2026•
edited
Loading