-
Notifications
You must be signed in to change notification settings - Fork 38
Move 'Why Update Prices' section to Understanding Pyth #909
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Created new page at pages/price-feeds/how-pyth-works/why-update-prices.mdx - Updated EVM guide warning to link to the new page - Added new page to navigation in _meta.json Co-Authored-By: Nidhi Singh <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-Authored-By: Nidhi Singh <[email protected]>
| "pythnet": "Pythnet", | ||
| "oracle-program": "Oracle Program", | ||
| "cross-chain": "Cross-chain", | ||
| "why-update-prices": "Why Update Prices", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this could go up a level (so it shows up in the nav menu for Understanding Pyth) because this is a pretty common question
| @@ -0,0 +1,17 @@ | |||
| # Why Update Prices | |||
|
|
|||
| Pyth uses a pull-based oracle model. Unlike traditional push oracles that automatically update prices on-chain at regular intervals, Pyth requires users to explicitly update the on-chain price before reading it. | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
uses a pull oracle model -- we don't say "pull-based"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pls learn this for future references
| - **Lower latency**: You can fetch the latest price update directly from Pyth's low-latency oracle network and submit it on-chain immediately | ||
| - **Flexibility**: Different applications can update prices at different frequencies based on their needs | ||
|
|
||
| In the Pull integration pattern, your contract must: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no caps for Pull here
| too stale, calls to `getPriceNoOlderThan()` will revert with a `StalePrice` | ||
| error (0x19abf40e). See [how to fetch price | ||
| updates](../../fetch-price-updates) for more details. | ||
| **Important**: Pyth uses a pull-based oracle model that requires users to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pull oracle (no pull-based)
- Changed 'pull-based oracle model' to 'pull oracle model' (2 occurrences) - Changed 'Pull integration pattern' to 'pull integration pattern' (lowercase) - Moved why-update-prices.mdx from how-pyth-works/ to price-feeds/ level - Updated navigation to show in main 'Understanding Pyth' section - Updated all links to reflect new file location Co-Authored-By: Nidhi Singh <[email protected]>
Co-Authored-By: Nidhi Singh <[email protected]>
|
All feedback has been addressed! ✅ Changes made:
Current status:
The page now appears in the "Understanding Pyth" section in the main navigation, making it easily discoverable for all users. I've noted the correct terminology ("pull oracle model" not "pull-based oracle model") for future reference. |
Description
Refactored the "Why Update Prices" section from the EVM integration guide into a standalone page under the "Understanding Pyth" section (How Pyth Works). The EVM guide now includes a concise warning that links to this new dedicated page.
This change improves documentation organization by:
Type of Change
Areas Affected
pages/price-feeds/how-pyth-works/why-update-prices.mdxpages/price-feeds/use-real-time-data/pull-integration/evm.mdx(removed section, updated warning)pages/price-feeds/how-pyth-works/_meta.json(added navigation entry)Checklist
npm run lintto check for linting errorsnpm run dev)Key Review Points
Please verify:
./hermesand../fetch-price-updates- confirm these resolve correctlyRelated Issues
Requested by: Nidhi Singh (@nidhi-singh02)
Additional Notes
Contributor Information