-
Notifications
You must be signed in to change notification settings - Fork 297
Chore(dev hub) move pf pro #3091
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
Closed
Closed
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
870f50d
chore(dev-hub) Move price feeds to core & pro
aditya520 8e22d48
chore(dev-hub) Added landing pages
aditya520 3d88118
chore(dev-hub) Updated pro pages
aditya520 0197f8d
chore(dev-hub) Pro Price Feed ID Table
aditya520 359938c
chore(dev-hub) Requested comments
aditya520 9f4e802
chore(dev-hub) Fix style lint
aditya520 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
...hub/content/docs/price-feeds/v1/meta.json → ...b/content/docs/price-feeds/core/meta.json
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
166 changes: 166 additions & 0 deletions
166
apps/developer-hub/content/docs/price-feeds/pro/getting-started.mdx
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,166 @@ | ||
--- | ||
title: "Getting Started" | ||
description: "Get the access token and learn how to subscribe to price updates." | ||
full: false | ||
index: false | ||
--- | ||
|
||
# Getting Started with Pyth Pro | ||
|
||
Pyth Pro is a high-performance, low-latency service that provides real-time financial market data. | ||
This guide will walk you through setting up and running a basic JavaScript example to subscribe to Pyth Pro price feeds. | ||
|
||
## Prerequisites | ||
|
||
Before getting started, make sure you have the following installed: | ||
|
||
- **Node.js** (version 18 or higher) | ||
- **pnpm** package manager | ||
- **Git** for cloning the examples repository | ||
- A **Pyth Pro Access Token** - see [How to Acquire an Access Token](./acquire-access-token) if you don't have one | ||
|
||
<Steps> | ||
|
||
### Clone the Examples Repository | ||
|
||
First, clone the Pyth examples repository which contains the JavaScript SDK example: | ||
|
||
```bash copy | ||
git clone https://github.com/pyth-network/pyth-examples.git | ||
cd pyth-examples/lazer/js | ||
``` | ||
|
||
### Install Dependencies | ||
|
||
Install the required dependencies using pnpm: | ||
|
||
```bash copy | ||
pnpm install | ||
``` | ||
|
||
This will install `@pythnetwork/pyth-lazer-sdk`, which will be used to subscribe to Pyth Pro prices. | ||
|
||
<Callout type="info"> | ||
**Pyth Pro was previously known as Pyth Lazer**. The SDK remains the same. | ||
</Callout> | ||
|
||
### Configure Your Access Token | ||
|
||
Set your Pyth Pro access token as an environment variable: | ||
|
||
```bash copy | ||
export ACCESS_TOKEN=your_actual_token_here | ||
``` | ||
|
||
<Callout type="warning" emoji="⚠️"> | ||
Replace `your_actual_token_here` with your actual PythPro access token. If you | ||
don't have one, follow the [access token guide](./acquire-access-token) to | ||
obtain it. | ||
</Callout> | ||
|
||
### Run the Basic WebSocket Example | ||
|
||
Now you can run the basic example that demonstrates connecting to Pyth Pro and receiving price updates: | ||
|
||
```bash copy | ||
pnpm run start | ||
``` | ||
|
||
This command will subscribe to Pyth Pro updates for two price feeds, receiving streaming updates. | ||
Each update is then printed to the terminal on receipt. | ||
You should see output similar to the following: | ||
|
||
```bash | ||
got message: { | ||
type: 'json', | ||
value: { | ||
type: 'streamUpdated', | ||
subscriptionId: 1, | ||
parsed: { timestampUs: '1758034015200000', priceFeeds: [Array] }, | ||
solana: { | ||
encoding: 'hex', | ||
data: 'b9011a82036df6ced259a33949ab9b2c48a61a2d3b0b9436cba24c3ef8a600b72767927d14a459fcc3abce280b3f8194e16e8b32f9322ac0b84a9c0b792e19857962a60180efc1f480c5615af3fb673d42287e993da9fbc3506b6e41dfa32950820c2e6c2a0075d3c79300a3fa30ec3e060003020100000001009053802f790a00000200000001004234106d67000000' | ||
} | ||
} | ||
} | ||
stream updated for subscription 1 : [ | ||
{ priceFeedId: 1, price: '11515604259728' }, | ||
{ priceFeedId: 2, price: '444211409986' } | ||
] | ||
got message: { | ||
type: 'json', | ||
value: { | ||
type: 'streamUpdated', | ||
subscriptionId: 1, | ||
parsed: { timestampUs: '1758034015400000', priceFeeds: [Array] }, | ||
solana: { | ||
encoding: 'hex', | ||
data: 'b9011a826f5ff7e25ac4056c4ec3a08c428baf38e7b78c46014296ccbcfd5395c38c9f7bc23865a048401c66788e791f0edc3a6701b0ea4a5399f50ec8b1795757854f0180efc1f480c5615af3fb673d42287e993da9fbc3506b6e41dfa32950820c2e6c2a0075d3c79340b0fd30ec3e060003020100000001005821a32f790a00000200000001004334106d67000000' | ||
} | ||
} | ||
} | ||
stream updated for subscription 1 : [ | ||
{ priceFeedId: 1, price: '11515606540632' }, | ||
{ priceFeedId: 2, price: '444211409987' } | ||
] | ||
``` | ||
|
||
### Understanding the Code | ||
|
||
The main example code in `src/index.ts` demonstrates the core Pyth Pro integration pattern: | ||
|
||
```typescript | ||
import { PythLazerClient } from "@pythnetwork/pyth-lazer-sdk"; | ||
|
||
const client = await PythLazerClient.create({ | ||
urls: ["wss://pyth-lazer.dourolabs.app/v1/stream"], | ||
token: process.env.ACCESS_TOKEN!, | ||
}); | ||
|
||
// The message listener is called every time a new message is received. | ||
client.addMessageListener((message) => { | ||
// Add your logic to consume messages here | ||
console.log("got message:", message); | ||
}); | ||
|
||
// Subscribe to price feeds | ||
client.subscribe({ | ||
type: "subscribe", | ||
subscriptionId: 1, | ||
priceFeedIds: [1, 2], | ||
properties: ["price"], | ||
formats: ["solana"], | ||
deliveryFormat: "json", | ||
channel: "fixed_rate@200ms", | ||
jsonBinaryEncoding: "hex", | ||
}); | ||
``` | ||
|
||
NOTE: Every property passed to `client.subscribe` are explained in the [API Reference](./websocket-api-reference). | ||
|
||
</Steps> | ||
|
||
## What's Next? | ||
|
||
Now that you've successfully run the basic Pyth Pro example, you can explore more advanced integration patterns: | ||
|
||
### More Information | ||
|
||
Explore additional Pyth Pro capabilities: | ||
|
||
- **[Subscribe to Price Updates](./subscribe-price-updates)** - Detailed guide on WebSocket subscriptions and message handling | ||
- **[Price Feed IDs](./price-feed-ids)** - Complete list of available price feeds and their identifiers | ||
|
||
### Blockchain Integration | ||
|
||
Learn how to integrate Pyth Pro price feeds into your smart contracts: | ||
|
||
- **[Solana Integration](./integrate-as-consumer/svm)** - Build SVM smart contracts that consume Pyth Pro price feeds with cryptographic verification | ||
- **[EVM Integration](./integrate-as-consumer/evm)** - Integrate Pyth Pro into Ethereum and other EVM-compatible chains | ||
|
||
### Example Applications | ||
|
||
Check out more comprehensive examples in the [pyth-examples repository](https://github.com/pyth-network/pyth-examples/tree/main/lazer): | ||
|
||
- **Solana Examples** - Post price data to Solana smart contracts with Ed25519 and ECDSA verification | ||
- **EVM Examples** - Smart contract integration for Ethereum-compatible chains |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
title: "Pyth Pro" | ||
description: >- | ||
Pyth Pro is a low latency, highly customizable price oracle. | ||
full: false | ||
index: true | ||
--- | ||
|
||
import { ChartBar, Key, Lightning } from "@phosphor-icons/react/dist/ssr"; | ||
import { IntegrationCard } from "../../../../src/components/IntegrationCard"; | ||
|
||
<InfoBox variant="info">Pyth Pro was previously known as Pyth Lazer.</InfoBox> | ||
|
||
Pyth Pro delivers customizable, enterprise-grade price data directly from first-party publishers. | ||
Subscribers can configure their price feeds, update schedules, and usage rights for display or redistribution. | ||
The service is delivered through standard APIs for seamless integration. | ||
|
||
--- | ||
|
||
<div className="grid grid-cols-1 gap-4 sm:grid-cols-2 lg:grid-cols-3"> | ||
<IntegrationCard | ||
icon={<Key />} | ||
title="Get your access token" | ||
href="/price-feeds/pro/acquire-an-access-token" | ||
/> | ||
<IntegrationCard | ||
icon={<Lightning />} | ||
title="Subscribe to prices" | ||
href="/price-feeds/pro/subscribe-to-prices" | ||
/> | ||
<IntegrationCard | ||
icon={<ChartBar />} | ||
title="Pricing" | ||
href="https://www.pyth.network/pricing" | ||
/> | ||
</div> |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions
4
...hub/content/docs/price-feeds/v2/meta.json → ...ub/content/docs/price-feeds/pro/meta.json
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
10 changes: 10 additions & 0 deletions
10
apps/developer-hub/content/docs/price-feeds/pro/price-feed-ids.mdx
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: "Price Feed IDs" | ||
description: "Pyth Pro price feed IDs" | ||
full: false | ||
index: true | ||
--- | ||
|
||
import { PriceFeedsProPriceIdTable } from "../../../../src/components/ProPriceFeedTable"; | ||
|
||
<PriceFeedsProPriceIdTable /> |
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
6 changes: 0 additions & 6 deletions
6
apps/developer-hub/content/docs/price-feeds/v2/getting-started.mdx
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
export { Homepage as default } from "../../components/Pages/Homepage"; | ||
export { PriceFeedsLandingPage as default } from "../../components/Pages/PriceFeedsLandingPage"; |
Oops, something went wrong.
Oops, something went wrong.
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.
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 we should avoid tailwind and use sass for anything we write -- tailwind is used internally by fumadocs but all of this would break if we were to e.g. move to a different markdown renderer.
We should probably see if we can configure the fumadocs built-in tailwind to not look at the
content
folder...