Skip to content

[codex] Document SDK feed parameter units#17

Closed
tamlut-modnys wants to merge 1 commit into
mainfrom
codex/feed-parameter-units-sdk
Closed

[codex] Document SDK feed parameter units#17
tamlut-modnys wants to merge 1 commit into
mainfrom
codex/feed-parameter-units-sdk

Conversation

@tamlut-modnys

Copy link
Copy Markdown
Collaborator

Summary

  • Clarify SDK README guidance for raw v2 feed parameters, SDK helper maxVariance, quorum fields, and value scaling.
  • Update JS/TS JSDoc and Rustdoc comments so helper-level maxVariance and raw scaled fields are not confused.
  • Add comments to Aptos example scripts and Surge metadata code where maxVariance / max_job_range_pct values appear.

Why

The same concept is exposed through multiple surfaces with different units. SDK helpers may accept human percentages and scale internally, while raw gateway and v2 feed fields expect 1e9-scaled integers.

Validation

  • Ran the user-docs boundary scanner on touched README files.
  • Ran a search audit for maxJobRangePct|max_job_range_pct|maxVariance|max_variance|max_range_percent|minJobResponses|minOracleSamples|RangeExceeded.
  • Ran git diff --check.
  • TypeScript checks were not run because codex-in-container could not start Colima: ha.sock ... connection refused before entering the container.

@tamlut-modnys tamlut-modnys marked this pull request as ready for review June 22, 2026 15:56
@tamlut-modnys tamlut-modnys requested review from mgild and removed request for mgild June 22, 2026 15:56
@tamlut-modnys

Copy link
Copy Markdown
Collaborator Author

Closing this direct SDK PR because SDK changes should be authored in sbv3 and synced into switchboard-sdk by Copybara. Replacement PR: https://github.com/switchboard-xyz/sbv3/pull/1029

@tamlut-modnys tamlut-modnys deleted the codex/feed-parameter-units-sdk branch June 22, 2026 16:09
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.

1 participant