Skip to content

Commit 289c304

Browse files
aaronbassettaaronbassett
authored
Merge pull request #2735 from pyth-network/docs-port-price-feeds
Start porting docs content
2 parents 8aef9af + d3bbb32 commit 289c304

File tree

117 files changed

+6507
-13
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+6507
-13
lines changed

‎apps/developer-hub/content/docs/pyth-core/_meta.json

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
{
2+
"documentation-home": {
3+
"title": "← Documentation Home",
4+
"href": "/home"
5+
},
6+
7+
"-- Price Feeds": {
8+
"title": "Price Feeds",
9+
"type": "separator"
10+
},
11+
"index": "Introduction",
12+
"getting-started": "Getting Started",
13+
14+
"-- Tutorials": {
15+
"title": "Tutorials",
16+
"type": "separator"
17+
},
18+
19+
"create-your-first-pyth-app": "Create Your First Pyth App",
20+
21+
"-- How-to Guides": {
22+
"title": "How-To Guides",
23+
"type": "separator"
24+
},
25+
26+
"use-real-time-data": "Use Real-Time Price Data",
27+
"fetch-price-updates": "Fetch Price Updates",
28+
"schedule-price-updates": "Schedule Price Updates",
29+
"migrate-an-app-to-pyth": "Migrate an App to Pyth",
30+
"use-pyth-for-morpho": "Use Pyth for Morpho Markets",
31+
"publish-data": "Publish Data",
32+
"troubleshoot": "Troubleshoot Errors",
33+
34+
"-- Reference Material": {
35+
"title": "Reference Material",
36+
"type": "separator"
37+
},
38+
39+
"api-reference": "API Reference",
40+
"price-feeds": "Price Feeds",
41+
"current-fees": "Current Fees",
42+
"sponsored-feeds": "Sponsored Feeds",
43+
"market-hours": "Market Hours",
44+
"best-practices": "Best Practices",
45+
"error-codes": "Error Codes",
46+
"api-instances-and-providers": "API Instances and Providers",
47+
"contract-addresses": "Contract Addresses",
48+
"pythnet-reference": "Pythnet Reference",
49+
50+
"examples": {
51+
"title": "Example Applications ↗",
52+
"href": "https://github.com/pyth-network/pyth-examples/tree/main/price_feeds"
53+
},
54+
"-- Understand Pyth": {
55+
"title": "Understanding Pyth",
56+
"type": "separator"
57+
},
58+
59+
"pull-updates": "What is a Pull Oracle?",
60+
"how-pyth-works": "How Pyth Works"
61+
}

‎apps/developer-hub/content/docs/pyth-core/api-instances-and-providers.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: "Access Hermes & Pythnet RPC: Developer API Guide"
3+
description: >-
4+
Streamline integration of Pyth Price Feeds with Hermes and Pythnet RPC. Choose
5+
self-hosted or third-party instances to boost development efficiency.
6+
full: false
7+
index: false
8+
---
9+
10+
# API Instances and Providers
11+
12+
The following documentation explains how to get access to an instance of Hermes or a Pythnet RPC.
13+
Developers may need access to these services in order to use Pyth Price Feeds.
14+
Both services can be self-hosted or accessed through a third-party provider.
15+
See the following guides to learn more about how to access each service:
16+
17+
- [Hermes](api-instances-and-providers/hermes)
18+
- [Pythnet RPC](api-instances-and-providers/pythnet-rpc)

‎apps/developer-hub/content/docs/pyth-core/api-instances-and-providers/_meta.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"hermes": "Hermes",
3+
"pythnet-rpc": "Pythnet RPC"
4+
}

‎apps/developer-hub/content/docs/pyth-core/api-instances-and-providers/hermes.mdx

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
title: "Hermes: Open-Source Service for Pyth Price Updates"
3+
description: >-
4+
Experience real-time Pyth price feeds with Hermes: an open-source REST and
5+
streaming API. Use public endpoints or self-host for reliable, decentralized
6+
data.
7+
full: false
8+
index: false
9+
---
10+
11+
# Hermes
12+
13+
Hermes is an open-source service that listens to the Pythnet and the Wormhole Network for Pyth price updates, and
14+
serves them via a convenient web API.
15+
16+
Hermes allows users to easily [fetch price updates](../fetch-price-updates) via a REST API, or subscribe to server-side streaming
17+
updates.
18+
19+
## Public Endpoints
20+
21+
The Pyth Data Association operates a public endpoint for Hermes, which can be used to test integrations with Pyth
22+
Network:
23+
24+
URL: https://hermes.pyth.network
25+
26+
<InfoBox variant="warning">
27+
For developers building on **Aptos testnet**, **Sui testnet** or **Near testnet**, please use the Hermes Beta endpoint:
28+
29+
URL: https://hermes-beta.pyth.network
30+
31+
</InfoBox>
32+
33+
For production deployments, developers integrating with Pyth Network are **strongly encouraged** to use Node Providers
34+
for maximum resilience and decentralization. Moreover, Hermes is designed to be self-hosted, so developers can run their own
35+
instance of Hermes to fetch Pyth price updates. Please note it is not recommended to use the public endpoint for production as it has rate limits.
36+
37+
## Node Providers
38+
39+
The following node providers offer Hermes:
40+
41+
- [Triton](https://triton.one)
42+
- [P2P](https://p2p.org)
43+
- [extrnode](https://extrnode.com/)
44+
- [Liquify](https://www.liquify.io/)
45+
46+
## Self-Hosting
47+
48+
The Pyth Data Association provides a Helm chart for running Hermes in
49+
[charts](https://github.com/pyth-network/charts/tree/main/charts/hermes) repository. Please refer to the chart's readme
50+
for the configuration values.
51+
You will need a Pythnet RPC to run Hermes; see the [guide for accessing a Pythnet RPC](pythnet-rpc).

‎apps/developer-hub/content/docs/pyth-core/api-instances-and-providers/pythnet-rpc.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "Pythnet RPC: How to Access and Use for Developers"
3+
description: >-
4+
Use Hermes to configure Pythnet RPC. Choose from trusted providers like Triton
5+
or P2P, or self-host a node for secure, reliable data access.
6+
full: false
7+
index: false
8+
---
9+
10+
# Pythnet RPC
11+
12+
You will need a Pythnet RPC to run Hermes, which you can obtain from any of the Pythnet RPC
13+
providers below:
14+
15+
- [Triton](https://triton.one)
16+
- [P2P](https://p2p.org)
17+
- [Blockdaemon](https://blockdaemon.com/)
18+
- [Figment](https://figment.io)
19+
20+
Alternatively, you can host Pythnet RPC yourself, but this is discouraged due to the potential high cost and maintenance
21+
involved in operating it. If you still wish to run it, please contact the Pyth team for more information.

‎apps/developer-hub/content/docs/pyth-core/api-reference.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Pyth API Reference: On- and Off-Chain Developer Tools"
3+
description: >-
4+
Pyth Core’s API reference covers EVM, Aptos, CosmWasm, and Hermes. It provides
5+
interactive documentation and guides for both on-chain and off-chain
6+
integration.
7+
full: false
8+
index: false
9+
---
10+
11+
# API Reference
12+
13+
The API reference is a comprehensive guide to the various APIs -- both on- and off-chain -- that developers can use in their applications.
14+
Developers can consult this reference to better understand what methods exist and what they do.
15+
The API reference is interactive, so developers can try out the APIs from the website to better understand their behavior.
16+
17+
The following on-chain contracts are documented in the API reference:
18+
19+
- [EVM](api-reference/evm)
20+
- [Aptos](api-reference/aptos)
21+
- [CosmWasm](api-reference/cosmwasm)
22+
23+
Hermes also has interactive API documentation hosted by the service itself:
24+
25+
- [Hermes](https://hermes.pyth.network/docs/)

‎apps/developer-hub/content/docs/pyth-core/assets/Push-vs-Pull-Oracle.jpg

579 KB
Loading

0 commit comments

Comments
 (0)