[abretonc7s]

Explanation

Controller perps events did not record which screen started the action. PERPS_EVENT_PROPERTY.ENVIRONMENT_TYPE already maps to environment_type, and no caller copied a value onto it.

TrackingData, TPSLTrackingData, and WithdrawParams now accept an optional environmentType string. Trade, close, cancel, order, flip, and TP/SL events that already copy attribution include environment_type when the string is set. An order edit includes only environment_type from newOrder.trackingData. It does not copy entry_point, discovery_source, perp_discovery_source, or hl_fee_rate. The withdrawal executed event and both withdrawal failed events include environment_type the same way. When the field is absent, those events stay unchanged.

The controller emits no deposit event, so deposit params are unchanged and the deposit clause of TAT-4006 is deferred.

The value is not stored on withdrawal requests, and it is not sent to the venue. Later withdrawal completion events still omit it, because they no longer have the original params.

Extension still has to pass getEnvironmentType() from buildTrackingData, buildTpslTrackingData, and the withdraw call site. That is not enough on its own. createMetrics().trackPerpsEvent in app/scripts/controllers/perps/infrastructure.ts calls trackEvent without options, and buildTrackEventPayload in app/scripts/controllers/analytics/analytics.ts spreads the properties, then sets environment_type to options.environmentType, which defaults to background. trackPerpsEvent must pass properties.environment_type as the environmentType option, or the Core value is overwritten. Deposit call sites have nothing to pass until a registered deposit event exists. That client work follows this package release.

A client recipe builds PerpsController with a real messenger. It calls placeOrder, updatePositionTPSL, and withdraw with environmentType set to sidepanel, then again without the field. The messenger captures AnalyticsController:trackEvent. The sidepanel calls emit environment_type=sidepanel. The calls without the field omit the key. depositWithConfirmation emits no controller analytics event. Unit tests still cover order edits.

References

• https://consensyssoftware.atlassian.net/browse/TAT-4006

Validation Recipe

recipe.json (16 nodes — Perps environment_type through PerpsController)

{
  "$schema": "https://farmslot.io/schemas/recipe-v1.schema.json",
  "title": "Perps environment_type through PerpsController",
  "description": "Drives PerpsController the way Extension does. A real Messenger receives AnalyticsController:trackEvent. placeOrder, updatePositionTPSL, and withdraw run with environmentType sidepanel, then again without it. The HyperLiquid SDK is replaced at the network boundary. depositWithConfirmation is a guard: the controller emits no deposit analytics event, so the field has nothing to attach to.",
  "proofTargets": [
    {
      "id": "AC-1",
      "kind": "acceptance",
      "proofMode": "state",
      "claim": "Core (`@metamask/perps-controller`): accept an optional `environmentType` in `TrackingData` / `TPSLTrackingData` and in the withdraw/deposit params. Emit it as `PERPS_EVENT_PROPERTY.ENVIRONMENT_TYPE` (the key already exists)."
    },
    {
      "id": "AC-2",
      "kind": "acceptance",
      "proofMode": "state",
      "claim": "When `environmentType` is absent, event properties are unchanged; unit tests cover `environmentType` present and absent on trade, TP/SL, withdraw and deposit events."
    }
  ],
  "workflow": {
    "entry": "build-controller",
    "nodes": {
      "build-controller": {
        "action": "command",
        "intent": "Compile @metamask/perps-controller so the client import matches this checkout",
        "cmd": "yarn workspace @metamask/perps-controller run build",
        "timeout_ms": 300000,
        "next": "run-trade-present"
      },
      "run-trade-present": {
        "action": "command",
        "intent": "placeOrder with trackingData.environmentType sidepanel",
        "timeout_ms": 120000,
        "allow_failure": true,
        "next": "assert-trade-present"
      },
      "assert-trade-present": {
        "action": "assert_output",
        "intent": "The trade event includes environment_type sidepanel",
        "source": "run-trade-present",
        "stream": "stdout",
        "contains": "PROOF trade present event=\"Perp Trade Transaction\" environment_type=sidepanel",
        "proves": [
          "AC-1",
          "AC-2"
        ],
        "next": "run-trade-absent"
      },
      "run-trade-absent": {
        "action": "command",
        "intent": "placeOrder with no environmentType",
        "timeout_ms": 120000,
        "next": "assert-trade-absent"
      },
      "assert-trade-absent": {
        "action": "assert_output",
        "intent": "The trade event omits environment_type",
        "source": "run-trade-absent",
        "stream": "stdout",
        "contains": "PROOF trade absent event=\"Perp Trade Transaction\" environment_type_absent",
        "proves": [
          "AC-2"
        ],
        "next": "run-tpsl-present"
      },
      "run-tpsl-present": {
        "action": "command",
        "intent": "updatePositionTPSL with trackingData.environmentType sidepanel",
        "timeout_ms": 120000,
        "allow_failure": true,
        "next": "assert-tpsl-present"
      },
      "assert-tpsl-present": {
        "action": "assert_output",
        "intent": "The TP/SL event includes environment_type sidepanel",
        "source": "run-tpsl-present",
        "stream": "stdout",
        "contains": "PROOF tpsl present event=\"Perp Risk Management\" environment_type=sidepanel",
        "proves": [
          "AC-1",
          "AC-2"
        ],
        "next": "run-tpsl-absent"
      },
      "run-tpsl-absent": {
        "action": "command",
        "intent": "updatePositionTPSL with no environmentType",
        "timeout_ms": 120000,
        "next": "assert-tpsl-absent"
      },
      "assert-tpsl-absent": {
        "action": "assert_output",
        "intent": "The TP/SL event omits environment_type",
        "source": "run-tpsl-absent",
        "stream": "stdout",
        "contains": "PROOF tpsl absent event=\"Perp Risk Management\" environment_type_absent",
        "proves": [
          "AC-2"
        ],
        "next": "run-withdraw-present"
      },
      "run-withdraw-present": {
        "action": "command",
        "intent": "withdraw with environmentType sidepanel",
        "timeout_ms": 120000,
        "allow_failure": true,
        "next": "assert-withdraw-present"
      },
      "assert-withdraw-present": {
        "action": "assert_output",
        "intent": "The withdrawal event includes environment_type sidepanel",
        "source": "run-withdraw-present",
        "stream": "stdout",
        "contains": "PROOF withdraw present event=\"Perp Withdrawal Transaction\" environment_type=sidepanel",
        "proves": [
          "AC-1",
          "AC-2"
        ],
        "next": "run-withdraw-absent"
      },
      "run-withdraw-absent": {
        "action": "command",
        "intent": "withdraw with no environmentType",
        "timeout_ms": 120000,
        "next": "assert-withdraw-absent"
      },
      "assert-withdraw-absent": {
        "action": "assert_output",
        "intent": "The withdrawal event omits environment_type",
        "source": "run-withdraw-absent",
        "stream": "stdout",
        "contains": "PROOF withdraw absent event=\"Perp Withdrawal Transaction\" environment_type_absent",
        "proves": [
          "AC-2"
        ],
        "next": "run-deposit-none"
      },
      "run-deposit-none": {
        "action": "command",
        "intent": "depositWithConfirmation emits no controller analytics event",
        "timeout_ms": 120000,
        "next": "assert-deposit-none"
      },
      "assert-deposit-none": {
        "action": "assert_output",
        "intent": "Deposit has no controller analytics event to carry environment_type",
        "source": "run-deposit-none",
        "stream": "stdout",
        "contains": "PROOF deposit none analytics_events=0",
        "next": "done"
      },
      "done": {
        "action": "end",
        "status": "pass"
      }
    }
  }
}

Validation Logs

Run: f55b84c3-a90f-4b8d-948e-3dc70f183593

Runner: @metamask/recipe-runner

Runner revision: unknown

Recipe digest: sha256:8fd47e936c57d84ed2da64dca6e1be55c83e94d4ec8b2f4cf3e0444aa405ba56

Full output (16/16 passed, pass)

# MetaMask Recipe Run

Status: pass
Duration: 22s
Nodes: 16/16 passed

## Steps
- PASS build-controller (command, 3.4s): exitCode=0
- PASS run-trade-present (command, 2.1s): exitCode=0, stdout=PROOF trade present event="Perp Trade Transaction" environment_type=sidepanel

- PASS assert-trade-present (assert_output, 147ms): source=run-trade-present, stream=stdout, contains=PROOF trade present event="Perp Trade Transaction" environment_type=sidepanel
- PASS run-trade-absent (command, 2.6s): exitCode=0, stdout=PROOF trade absent event="Perp Trade Transaction" environment_type_absent

- PASS assert-trade-absent (assert_output, 156ms): source=run-trade-absent, stream=stdout, contains=PROOF trade absent event="Perp Trade Transaction" environment_type_absent
- PASS run-tpsl-present (command, 2.5s): exitCode=0, stdout=PROOF tpsl present event="Perp Risk Management" environment_type=sidepanel

- PASS assert-tpsl-present (assert_output, 289ms): source=run-tpsl-present, stream=stdout, contains=PROOF tpsl present event="Perp Risk Management" environment_type=sidepanel
- PASS run-tpsl-absent (command, 3.4s): exitCode=0, stdout=PROOF tpsl absent event="Perp Risk Management" environment_type_absent

- PASS assert-tpsl-absent (assert_output, 88ms): source=run-tpsl-absent, stream=stdout, contains=PROOF tpsl absent event="Perp Risk Management" environment_type_absent
- PASS run-withdraw-present (command, 1.6s): exitCode=0, stdout=PROOF withdraw present event="Perp Withdrawal Transaction" environment_type=sidepanel

- PASS assert-withdraw-present (assert_output, 176ms): source=run-withdraw-present, stream=stdout, contains=PROOF withdraw present event="Perp Withdrawal Transaction" environment_type=sidepanel
- PASS run-withdraw-absent (command, 1.8s): exitCode=0, stdout=PROOF withdraw absent event="Perp Withdrawal Transaction" environment_type_absent

- PASS assert-withdraw-absent (assert_output, 113ms): source=run-withdraw-absent, stream=stdout, contains=PROOF withdraw absent event="Perp Withdrawal Transaction" environment_type_absent
- PASS run-deposit-none (command, 1.7s): exitCode=0, stdout=PROOF deposit none analytics_events=0

- PASS assert-deposit-none (assert_output, 147ms): source=run-deposit-none, stream=stdout, contains=PROOF deposit none analytics_events=0
- PASS done (end, 0ms)

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

Publication approval

Arthur · person · arthur · 2026-10-20T07:54:16.756Z
Package: 4f15b6a70f50d82a11d9a97ff1fb1438c92d52e3201c259f59dde77012781528. Visual receipts: none.

Accepted review findings

Accepted by Arthur (arthur) at 2026-10-20T07:54:16.756Z.
Head: ec2db26d96db4155d25123b57288d67d721d9108. Findings digest: sha256:5795a70a7ce39001832b15612a6eecc12ebc28451c1768adc0d5b40e8ab1c8f7.

Reason:

Deposit descoped: the controller emits no deposit analytics event. AC-1/AC-2 proven for trade, TP/SL and withdraw.

Accepted findings:

• temp/tasks/feat/tat-4006-1019-171024/artifacts/acceptance-status.json:10: Owner gate decision. No code change is requested. AC-1 and AC-2 are marked proven (lines 10 and 32), and recipe-coverage.md:5-8 reports 2/2 PROVEN with untestable: none. Both criteria name deposit. DepositParams (packages/perps-controller/src/types/index.ts:1294) and DepositWithConfirmationParams (:1303) take no environmentType, and no deposit present/absent test exists. Leaving deposit out of the code is correct, because PerpsAnalyticsEvent has no deposit event. recipe-quality.json (warn, deposit-clause-unproven) states the gap. The mm-harness validator refused a separate deposit claim. The owner must descope the deposit clause, mark it untestable with a reason, or amend TAT-4006 at the gate before AC-1 and AC-2 count as met. The round-7 mechanical findings are cleared: the CHANGELOG line is committed in ec2db26, and the evidence-manifest summary cites run 20261019141414956-15828. The changelog PR-link placeholder is pending a PR number. (review review-7721a02b-ceda-431a-a741-d743837c40b4-844d8a6e-246c-4c1b-a818-d9578c3b5588)

---

Note

Low Risk
Analytics-only optional fields and property spreading; no trading, withdrawal routing, or persistence behavior changes.

Overview
Adds optional environmentType on TrackingData, TPSLTrackingData, and WithdrawParams so clients can tag which UI surface started a perps action.

A shared environmentTypeProperty helper maps that value to the existing environment_type analytics key and is omitted when unset. Trading flows that already spread attribution (trade, close, cancel, flip, TP/SL, etc.) now include environment_type when provided; order edit events only add environment_type from newOrder.trackingData, not other attribution fields. withdraw() adds it on executed and failed withdrawal events; later withdrawal status/completion paths are unchanged.

Unit tests cover present vs absent environment_type for place order, edit order, TP/SL, and withdraw.

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