Skip to content

Start porting docs content #2735

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

Merged
merged 23 commits into from
May 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
53e66d2
chore (wip): copy price feeds content from documentation site 'as-is'
aaronbassett May 22, 2025
5d9ed39
chore: update front matter to match new schema
aaronbassett May 22, 2025
f137205
feat: update front matter for all Pyth Core docs
aaronbassett May 27, 2025
24d84c2
fix: use a more developer friendly voice for descriptions and tone do…
aaronbassett May 27, 2025
1e20424
feat: add component to display strings truncated in the middle
aaronbassett May 27, 2025
cf435cd
feat: add copy address component
aaronbassett May 27, 2025
df6a984
feat: add callout component with variant support
aaronbassett May 27, 2025
3f29854
chore: automatically make content components available in MDX pages
aaronbassett May 27, 2025
43a05a7
chore: update eslint and turbo configs
aaronbassett May 27, 2025
7e0aeb5
fix: port across content and fix minor issues
aaronbassett May 27, 2025
3e107f8
feat: add content to sidebar navigation
aaronbassett May 27, 2025
f8f2579
chore (wip): temporarily remove api-reference pages so other content …
aaronbassett May 27, 2025
3067183
chore: fix prettier errors
aaronbassett May 27, 2025
e35da71
fix (prettier): add ignore tags to prevent prettier from breaking fen…
aaronbassett May 28, 2025
02bc77e
fix: make accessibility and configuration improvements to TruncateToM…
aaronbassett May 28, 2025
192f33f
fix: make Callout a thin wrapper around InfoBox to set suitable defaults
aaronbassett May 28, 2025
4a1f940
feat: add text case converter component
aaronbassett May 28, 2025
30f0b00
fix: update CopyAddress to use existing CopyButton component
aaronbassett May 28, 2025
2960b65
fix: linting warnings
aaronbassett May 28, 2025
577c00f
feat: seperate the navigation and copy actions in CopyAddress
aaronbassett May 28, 2025
c8e141a
fix: use .srOnly instead of .sr-only
aaronbassett May 28, 2025
0b9ba45
feat: add defaults to InfoBox
aaronbassett May 30, 2025
d3bbb32
feat: remove Callout component and replace with InfoBox
aaronbassett May 30, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions apps/developer-hub/content/docs/pyth-core/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
{
"documentation-home": {
"title": "← Documentation Home",
"href": "/home"
},

"-- Price Feeds": {
"title": "Price Feeds",
"type": "separator"
},
"index": "Introduction",
"getting-started": "Getting Started",

"-- Tutorials": {
"title": "Tutorials",
"type": "separator"
},

"create-your-first-pyth-app": "Create Your First Pyth App",

"-- How-to Guides": {
"title": "How-To Guides",
"type": "separator"
},

"use-real-time-data": "Use Real-Time Price Data",
"fetch-price-updates": "Fetch Price Updates",
"schedule-price-updates": "Schedule Price Updates",
"migrate-an-app-to-pyth": "Migrate an App to Pyth",
"use-pyth-for-morpho": "Use Pyth for Morpho Markets",
"publish-data": "Publish Data",
"troubleshoot": "Troubleshoot Errors",

"-- Reference Material": {
"title": "Reference Material",
"type": "separator"
},

"api-reference": "API Reference",
"price-feeds": "Price Feeds",
"current-fees": "Current Fees",
"sponsored-feeds": "Sponsored Feeds",
"market-hours": "Market Hours",
"best-practices": "Best Practices",
"error-codes": "Error Codes",
"api-instances-and-providers": "API Instances and Providers",
"contract-addresses": "Contract Addresses",
"pythnet-reference": "Pythnet Reference",

"examples": {
"title": "Example Applications ↗",
"href": "https://github.com/pyth-network/pyth-examples/tree/main/price_feeds"
},
"-- Understand Pyth": {
"title": "Understanding Pyth",
"type": "separator"
},

"pull-updates": "What is a Pull Oracle?",
"how-pyth-works": "How Pyth Works"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Access Hermes & Pythnet RPC: Developer API Guide"
description: >-
Streamline integration of Pyth Price Feeds with Hermes and Pythnet RPC. Choose
self-hosted or third-party instances to boost development efficiency.
full: false
index: false
---

# API Instances and Providers

The following documentation explains how to get access to an instance of Hermes or a Pythnet RPC.
Developers may need access to these services in order to use Pyth Price Feeds.
Both services can be self-hosted or accessed through a third-party provider.
See the following guides to learn more about how to access each service:

- [Hermes](api-instances-and-providers/hermes)
- [Pythnet RPC](api-instances-and-providers/pythnet-rpc)
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"hermes": "Hermes",
"pythnet-rpc": "Pythnet RPC"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: "Hermes: Open-Source Service for Pyth Price Updates"
description: >-
Experience real-time Pyth price feeds with Hermes: an open-source REST and
streaming API. Use public endpoints or self-host for reliable, decentralized
data.
full: false
index: false
---

# Hermes

Hermes is an open-source service that listens to the Pythnet and the Wormhole Network for Pyth price updates, and
serves them via a convenient web API.

Hermes allows users to easily [fetch price updates](../fetch-price-updates) via a REST API, or subscribe to server-side streaming
updates.

## Public Endpoints

The Pyth Data Association operates a public endpoint for Hermes, which can be used to test integrations with Pyth
Network:

URL: https://hermes.pyth.network

<InfoBox variant="warning">
For developers building on **Aptos testnet**, **Sui testnet** or **Near testnet**, please use the Hermes Beta endpoint:

URL: https://hermes-beta.pyth.network

</InfoBox>

For production deployments, developers integrating with Pyth Network are **strongly encouraged** to use Node Providers
for maximum resilience and decentralization. Moreover, Hermes is designed to be self-hosted, so developers can run their own
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.

## Node Providers

The following node providers offer Hermes:

- [Triton](https://triton.one)
- [P2P](https://p2p.org)
- [extrnode](https://extrnode.com/)
- [Liquify](https://www.liquify.io/)

## Self-Hosting

The Pyth Data Association provides a Helm chart for running Hermes in
[charts](https://github.com/pyth-network/charts/tree/main/charts/hermes) repository. Please refer to the chart's readme
for the configuration values.
You will need a Pythnet RPC to run Hermes; see the [guide for accessing a Pythnet RPC](pythnet-rpc).
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Pythnet RPC: How to Access and Use for Developers"
description: >-
Use Hermes to configure Pythnet RPC. Choose from trusted providers like Triton
or P2P, or self-host a node for secure, reliable data access.
full: false
index: false
---

# Pythnet RPC

You will need a Pythnet RPC to run Hermes, which you can obtain from any of the Pythnet RPC
providers below:

- [Triton](https://triton.one)
- [P2P](https://p2p.org)
- [Blockdaemon](https://blockdaemon.com/)
- [Figment](https://figment.io)

Alternatively, you can host Pythnet RPC yourself, but this is discouraged due to the potential high cost and maintenance
involved in operating it. If you still wish to run it, please contact the Pyth team for more information.
25 changes: 25 additions & 0 deletions apps/developer-hub/content/docs/pyth-core/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Pyth API Reference: On- and Off-Chain Developer Tools"
description: >-
Pyth Core’s API reference covers EVM, Aptos, CosmWasm, and Hermes. It provides
interactive documentation and guides for both on-chain and off-chain
integration.
full: false
index: false
---

# API Reference

The API reference is a comprehensive guide to the various APIs -- both on- and off-chain -- that developers can use in their applications.
Developers can consult this reference to better understand what methods exist and what they do.
The API reference is interactive, so developers can try out the APIs from the website to better understand their behavior.

The following on-chain contracts are documented in the API reference:

- [EVM](api-reference/evm)
- [Aptos](api-reference/aptos)
- [CosmWasm](api-reference/cosmwasm)

Hermes also has interactive API documentation hosted by the service itself:

- [Hermes](https://hermes.pyth.network/docs/)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading