Correct Pulse contract-interface documentation#1
Open
rawritude wants to merge 2 commits into
Open
Conversation
Align the Pulse oracle documentation with the deployed contract interface: - rename period() to history_retention_period(); add extend_asset_ttl and expires - remove x_*/twap methods and the non-existent cache_size/fee_config/estimate_retention_cost from the generated client trait - keep "immutable once written" and the >50%-of-nodes consensus fact; note that cross-price and TWAP are computed in the consumer contract, not by the oracle - restore the free-reads and default 5-minute-resolution facts
Replace the non-existent twap() call with a consumer-side average over prices(), and correct Asset::Generic to Asset::Other.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Corrects stale facts in the Pulse oracle documentation against the deployed contract interface. Docs-only — no runtime or behavior change.
Interface (
/docs/interface, generated client trait)period()→history_retention_period(); addextend_asset_ttlandexpiresx_*/twapand the non-existentcache_size/fee_config/estimate_retention_costfrom the generated clientExamples (
/docs/examples)twap()call with a consumer-side average overprices()Asset::Generic→Asset::Other