Skip to content

docs(perps-controller): client timings come from one overridable config - #11603

Merged
abretonc7s merged 1 commit into
mainfrom
perps-client-contract-timings-config
Nov 18, 2026
Merged

abretonc7s merged 1 commit into
mainfrom
perps-client-contract-timings-config

Conversation

@abretonc7s

@abretonc7s abretonc7s commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Explanation

Clarifies the timing line of the client contract (TAT-4656). It required clients to use the PERPS_CONSTANTS timings "instead of local values", which reads as "never configurable". The intent is one source per client: a connection config that defaults to PERPS_CONSTANTS, where any override lives, with no scattered literals.

Also notes that the controller itself never reads these three timings; each client's connection owner does. A controller-level option is tracked with the shared stream manager spike (TAT-4660), since it is only useful once Core owns the connection lifecycle.

Docs only, no code change.

References

Checklist

  • Docs only; no changelog entry

Note

Low Risk
Documentation-only clarification of an existing client contract; no code or connection logic changes.

Overview
Updates the perps-controller architecture doc so the TAT-4656 client contract no longer reads as “always use PERPS_CONSTANTS, never override.”

The Connection section now states that PERPS_CONSTANTS holds default connection timings and that the controller does not consume ConnectionGracePeriodMs, ConnectionAttemptTimeoutMs, or ConnectRetryDelayMs—each client’s connection owner does.

The What a client must do bullet is reframed: clients should read timings from one per-client connection config that defaults to those PERPS_CONSTANTS values, with any overrides living in that config instead of scattered local literals.

Docs only; no runtime behavior change.

Reviewed by Cursor Bugbot for commit b529522. Bugbot is set up for automated code reviews on this repo. Configure here.

@abretonc7s
abretonc7s requested a review from a team as a code owner November 18, 2026 01:20
@abretonc7s
abretonc7s enabled auto-merge November 18, 2026 01:20
@github-actions

Copy link
Copy Markdown
Contributor

🛑 Files requiring codeowner review

To merge this PR, you'll need to get approvals from the following owners.

@MetaMask/perps (1 file)
  • packages/perps-controller/docs/architecture.md

abretonc7s added a commit to MetaMask/skills that referenced this pull request Nov 18, 2026
)

Regenerates perps-review-pr from
MetaMask/experimental-metamask-recipe-perps#78. The inline-timeout rule
now allows a connection-timing override in the client's one connection
config (default `PERPS_CONSTANTS`), matching the clarified client
contract in MetaMask/core#11603. Literals elsewhere are still a finding.
`--check` passes. Skill-only change; no CHANGELOG entry.
@abretonc7s
abretonc7s added this pull request to the merge queue Nov 18, 2026
Merged via the queue into main with commit 8c11772 Nov 18, 2026
51 checks passed
@abretonc7s
abretonc7s deleted the perps-client-contract-timings-config branch November 18, 2026 01:31

This branch was previously deployed

1 inactive deployment
default-branch — b5295225 Deployed Nov 18, 2026 by abretonc7s via Determine whether this PR is a release PR #7242
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants