-
Notifications
You must be signed in to change notification settings - Fork 37
chore(price-feeds) Rename sponsored Feeds to Push feeds #860
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
The latest updates on your projects. Learn more about Vercel for GitHub.
|
pages/price-feeds/_meta.json
Outdated
}, | ||
|
||
"use-real-time-data": "Use Real-Time Price Data", | ||
"use-real-time-data": "Pull Real-Time Price Data", |
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 like the consistency before
Use Real-time Price Data
Use Historic Price Data
I believe adding Pull if good, but don't like breaking the above consistency?
Do you have any other ideas? @jayantk @KemarTiti
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.
How about
"Pull Latest Price Data"
"Pull Historic Price Data" as we need to pull from benchmarks API and then verify.
This guide explains how to use real-time Pyth data in EVM contracts. For an interactive playground to explore the methods supported by the Pyth contract, see the [EVM API reference](../api-reference/evm/). | ||
This guide explains how to **Pull real-time Pyth** data in EVM contracts. For an interactive playground to explore the methods supported by the Pyth contract, see the [EVM API reference](../api-reference/evm/). | ||
|
||
<Callout type="info" emoji="ℹ️"> |
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 believe we should start with this simple callout in every guide.
If we all feel good with this, then I will add this to every ecosystem guide.
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 code snippet is misleading as the users also need to check that their feeds are being pushed (maybe go pay for it etc). I think it's better to simply send them to a guide that can explain the whole process.
(i'm not strongly convinced of this, so open to discussion)
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.
Push is simple and straightforward to use. It lets experienced users get started without jumping to another page, while still providing just enough information to begin consuming 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.
my point here is that it does not provide enough information to consume prices. What if the feed they want isn't being pushed? That is necessary information that will be covered in the guide.
pages/price-feeds/_meta.json
Outdated
}, | ||
|
||
"use-real-time-data": "Use Real-Time Price Data", | ||
"use-real-time-data": "Pull Real-Time Price Data", |
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.
Wondering if Pyth pro is near real time, should we call core as real time data ?
May be say "Pull the latest Price Data"
pages/price-feeds/pushed-feeds.mdx
Outdated
- [Movement](pushed-feeds/movement) | ||
|
||
<Callout type="info" emoji="ℹ️"> | ||
Push feeds are subject to change with prior notice. Please refer to the [dev |
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.
sorry i'm only suggesting rephrasing the second sentence. it's not entirely clear that the "updates" in that sentence means "changes to the feeds"
This guide explains how to use real-time Pyth data in EVM contracts. For an interactive playground to explore the methods supported by the Pyth contract, see the [EVM API reference](../api-reference/evm/). | ||
This guide explains how to **Pull real-time Pyth** data in EVM contracts. For an interactive playground to explore the methods supported by the Pyth contract, see the [EVM API reference](../api-reference/evm/). | ||
|
||
<Callout type="info" emoji="ℹ️"> |
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 code snippet is misleading as the users also need to check that their feeds are being pushed (maybe go pay for it etc). I think it's better to simply send them to a guide that can explain the whole process.
(i'm not strongly convinced of this, so open to discussion)
It follows a design where price updates are pulled from pythnet, but it can be integrated into applications using push integration as well. | ||
[What is a Pull Oracle](/price-feeds/pull-updates) explains this difference in detail. | ||
|
||
Application developers can [schedule price updates](/price-feeds/schedule-price-updates) by running a [price-pusher](/price-feeds/schedule-price-updates/using-scheduler) to automate the process of updating the on-chain price. |
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.
it's called the scheduler not the price pusher
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.
Let's kepp this to price-pusher
.
Price Pusher is more descriptive that just scheduler
.
We should rename on other pages as well.
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.
We can use schedule as a verb, like schedule price updates using price-pusher
, but let's use scheduler
as the product name. We call price-pusher
in our monorepo as well.
This guide explains how to use real-time Pyth data in EVM contracts. For an interactive playground to explore the methods supported by the Pyth contract, see the [EVM API reference](../api-reference/evm/). | ||
This guide explains how to **Pull real-time Pyth** data in EVM contracts. For an interactive playground to explore the methods supported by the Pyth contract, see the [EVM API reference](../api-reference/evm/). | ||
|
||
<Callout type="info" emoji="ℹ️"> |
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.
my point here is that it does not provide enough information to consume prices. What if the feed they want isn't being pushed? That is necessary information that will be covered in the guide.
pages/price-feeds/use-real-time-data/pull-integration/starknet.mdx
Outdated
Show resolved
Hide resolved
The callout links them to both |
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.
minor nits
|
||
## Choosing Your Integration Method | ||
|
||
**Pull integration** is the default choice for most applications. In this integration, the application retrieves price data from a [webserveice](./how-pyth-works/hermes) and submits it 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.
nit typo webservice
function exampleMethod() public { | ||
// Read the current price from a price feed if it is less than 60 seconds old. | ||
// Each price feed (e.g., ETH/USD) is identified by a price feed ID. | ||
// The complete list of feed IDs is available at https://docs.pyth.network/price-feeds/price-feeds |
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.
can we put this info in callout, difficult to read in code comments.
Consult [Schedule Price Updates](/price-feeds/schedule-price-updates) guide for more information. | ||
|
||
The Pyth Data Association sponsors regular on-chain updates for some price feeds. | ||
See [Sponsored Feeds](./sponsored-feeds.mdx) for the current list of feeds and their update parameters. |
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.
let's call it Push Feeds, let's be consistent as we have renamed the page.
See [Sponsored Feeds](./sponsored-feeds.mdx) for the current list of feeds and their update parameters. | ||
|
||
If you don't find relevant price IDs in the [Sponsored Feeds](./sponsored-feeds.mdx) list, please contact the Pyth team [here](https://tally.so/r/nGz2jj) to run the scheduler/price pusher for the price feed you need. | ||
If you don't find relevant price IDs in the [Sponsored Feeds](./sponsored-feeds.mdx) list, please contact the Pyth team [here](https://tally.so/r/nGz2jj) to run the Price Pusher for the price feed you need. |
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.
let's call it Push Feeds. pls check if any other place still uses the term sponsored feeds and replace it.
Description
Type of Change
Areas Affected
Checklist
pre-commit run --all-files
to check for linting errorsRelated Issues
Closes #
Additional Notes
Contributor Information
Screenshots